CfnClusterProps

class aws_cdk.aws_dsql.CfnClusterProps(*, deletion_protection_enabled=None, kms_encryption_key=None, multi_region_properties=None, tags=None)

Bases: object

Properties for defining a CfnCluster.

Parameters:

  • deletion_protection_enabled (Union[bool, IResolvable, None]) – Whether deletion protection is enabled on this cluster.

  • kms_encryption_key (Optional[str]) – The KMS key that encrypts data on the cluster.

  • multi_region_properties (Union[IResolvable, MultiRegionPropertiesProperty, Dict[str, Any], None]) – Defines the structure for multi-Region cluster configurations, containing the witness Region and peered cluster settings.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A map of key and value pairs this cluster is tagged with.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_dsql as dsql

cfn_cluster_props = dsql.CfnClusterProps(
    deletion_protection_enabled=False,
    kms_encryption_key="kmsEncryptionKey",
    multi_region_properties=dsql.CfnCluster.MultiRegionPropertiesProperty(
        clusters=["clusters"],
        witness_region="witnessRegion"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

deletion_protection_enabled

Whether deletion protection is enabled on this cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#cfn-dsql-cluster-deletionprotectionenabled

kms_encryption_key

The KMS key that encrypts data on the cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#cfn-dsql-cluster-kmsencryptionkey

multi_region_properties

Defines the structure for multi-Region cluster configurations, containing the witness Region and peered cluster settings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#cfn-dsql-cluster-multiregionproperties

tags

A map of key and value pairs this cluster is tagged with.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#cfn-dsql-cluster-tags