Skip to content

CreateClusterInput

Source code in docs_src/capo_dsql/types/create_cluster_input.py
class CreateClusterInput(TypedDict, closed=True):
    deletion_protection_enabled: (
        "capo_dsql.types.deletion_protection_enabled.DeletionProtectionEnabled"
    )
    """<p>If enabled, you can't delete your cluster. You must first disable this property before you can delete 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>"""
    tags: NotRequired["capo_dsql.types.tag_map.TagMap"]
    """<p>A map of key and value pairs to use to tag your cluster.</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 configuration settings when creating a multi-Region cluster, including the witness region and linked cluster properties.</p>"""
    policy: NotRequired["capo_dsql.types.policy_document.PolicyDocument"]
    """<p>An optional resource-based policy document in JSON format that defines access permissions for the cluster.</p>"""
    bypass_policy_lockout_safety_check: "capo_dsql.types.bypass_policy_lockout_safety_check.BypassPolicyLockoutSafetyCheck"
    """<p>An optional field that controls whether to bypass the lockout prevention check. When set to true, this parameter allows you to apply a policy that might lock you out of the cluster. Use with caution.</p>"""

bypass_policy_lockout_safety_check instance-attribute

bypass_policy_lockout_safety_check: BypassPolicyLockoutSafetyCheck

An optional field that controls whether to bypass the lockout prevention check. When set to true, this parameter allows you to apply a policy that might lock you out of the cluster. Use with caution.

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: DeletionProtectionEnabled

If enabled, you can't delete your cluster. You must first disable this property before you can delete your cluster.

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.

multi_region_properties instance-attribute

multi_region_properties: NotRequired[MultiRegionProperties]

The configuration settings when creating a multi-Region cluster, including the witness region and linked cluster properties.

policy instance-attribute

policy: NotRequired[PolicyDocument]

An optional resource-based policy document in JSON format that defines access permissions for the cluster.

tags instance-attribute

tags: NotRequired[TagMap]

A map of key and value pairs to use to tag your cluster.