Skip to content

UpdateClusterInput

Source code in docs_src/capo_dsql/types/update_cluster_input.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class UpdateClusterInput(TypedDict, closed=True):
    identifier: "capo_dsql.types.cluster_id.ClusterId"
    """<p>The ID of the cluster you want to update.</p>"""
    deletion_protection_enabled: NotRequired[
        "capo_dsql.types.deletion_protection_enabled.DeletionProtectionEnabled"
    ]
    """<p>Specifies whether to enable deletion protection in your cluster.</p>"""
    kms_encryption_key: NotRequired[
        "capo_dsql.types.kms_encryption_key.KmsEncryptionKey"
    ]
    """<p>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.</p> <p>To switch to the key owned by Amazon Web Services, specify the reserved value <code>AWS_OWNED_KMS_KEY</code>.</p>"""
    client_token: NotRequired["capo_dsql.types.client_token.ClientToken"]
    """<p>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.</p> <p>If you don't specify a client token, the Amazon Web Services SDK automatically generates one.</p>"""
    multi_region_properties: NotRequired[
        "capo_dsql.types.multi_region_properties.MultiRegionProperties"
    ]
    """<p>The new multi-Region cluster configuration settings to be applied during an update operation.</p>"""

client_token instance-attribute 

client_token: NotRequired[ClientToken]

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.

deletion_protection_enabled instance-attribute 

deletion_protection_enabled: NotRequired[DeletionProtectionEnabled]

Specifies whether to enable deletion protection in your cluster.

identifier instance-attribute 

identifier: ClusterId

The ID of the cluster you want to update.

kms_encryption_key instance-attribute 

kms_encryption_key: NotRequired[KmsEncryptionKey]

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.

To switch to the key owned by Amazon Web Services, specify the reserved value AWS_OWNED_KMS_KEY.

multi_region_properties instance-attribute 

multi_region_properties: NotRequired[MultiRegionProperties]

The new multi-Region cluster configuration settings to be applied during an update operation.