CfnClusterPropsMixin

class aws_cdk.mixins_preview.aws_docdbelastic.mixins.CfnClusterPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html
CloudformationResource:: AWS::DocDBElastic::Cluster
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_docdbelastic import mixins as docdbelastic_mixins

cfn_cluster_props_mixin = docdbelastic_mixins.CfnClusterPropsMixin(docdbelastic_mixins.CfnClusterMixinProps(
    admin_user_name="adminUserName",
    admin_user_password="adminUserPassword",
    auth_type="authType",
    backup_retention_period=123,
    cluster_name="clusterName",
    kms_key_id="kmsKeyId",
    preferred_backup_window="preferredBackupWindow",
    preferred_maintenance_window="preferredMaintenanceWindow",
    shard_capacity=123,
    shard_count=123,
    shard_instance_count=123,
    subnet_ids=["subnetIds"],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_security_group_ids=["vpcSecurityGroupIds"]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::DocDBElastic::Cluster.

Parameters:

props (Union[CfnClusterMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['adminUserName', 'adminUserPassword', 'authType', 'backupRetentionPeriod', 'clusterName', 'kmsKeyId', 'preferredBackupWindow', 'preferredMaintenanceWindow', 'shardCapacity', 'shardCount', 'shardInstanceCount', 'subnetIds', 'tags', 'vpcSecurityGroupIds']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental