Values.UpdateClusterInputSourceThe UpdateCluster API allows you to modify both single-Region and multi-Region cluster configurations. With the multiRegionProperties parameter, you can add or modify witness Region support and manage peer relationships with clusters in other Regions. Note that updating multi-Region clusters requires additional IAM permissions beyond those needed for standard cluster updates, as detailed in the Permissions section. Required permissions dsql:UpdateCluster Permission to update a DSQL cluster. Resources: arn:aws:dsql:region:account-id:cluster/cluster-id dsql:PutMultiRegionProperties Permission to configure multi-Region properties for a cluster. Resources: arn:aws:dsql:region:account-id:cluster/cluster-id dsql:GetCluster Permission to retrieve cluster information. Resources: arn:aws:dsql:region:account-id:cluster/cluster-id dsql:AddPeerCluster Permission to add peer clusters. Resources: Local cluster: arn:aws:dsql:region:account-id:cluster/cluster-id Each peer cluster: exact ARN of each specified peer cluster dsql:RemovePeerCluster Permission to remove peer clusters. The dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates. Resources: arn:aws:dsql:*:account-id:cluster/* dsql:PutWitnessRegion Permission to set a witness Region. Resources: arn:aws:dsql:region:account-id:cluster/cluster-id Condition Keys: dsql:WitnessRegion (matching the specified witness Region) This permission is checked both in the cluster Region and in the witness Region. The witness region specified in multiRegionProperties.witnessRegion cannot be the same as the cluster's Region. When updating clusters with peer relationships, permissions are checked for both adding and removing peers. The dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates.
type nonrec t = {identifier : ClusterId.t;The ID of the cluster you want to update.
*)deletionProtectionEnabled : DeletionProtectionEnabled.t option;Specifies whether to enable deletion protection in your cluster.
*)kmsEncryptionKey : KmsEncryptionKey.t option;The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.
*)clientToken : ClientToken.t option;A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the Amazon Web Services SDK automatically generates one.
*)multiRegionProperties : MultiRegionProperties.t option;The new multi-Region cluster configuration settings to be applied during an update operation.
*)}val make :
?deletionProtectionEnabled:??? ->
?kmsEncryptionKey:??? ->
?clientToken:??? ->
?multiRegionProperties:??? ->
identifier:ClusterId.t ->
unit ->
tval to_value :
t ->
[> `Structure of
(string
* [> `Boolean of DeletionProtectionEnabled.t
| `String of ClusterId.t
| `Structure of
(string
* [> `List of [> `String of ClusterArn.t ] list
| `String of Region.t ])
list ])
list ]