CfnClusterPropsMixin

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

Bases: Mixin

Specifies a cluster .

All nodes in the cluster run the same protocol-compliant engine software.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html
CloudformationResource:: AWS::MemoryDB::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_memorydb import mixins as memorydb_mixins

cfn_cluster_props_mixin = memorydb_mixins.CfnClusterPropsMixin(memorydb_mixins.CfnClusterMixinProps(
    acl_name="aclName",
    auto_minor_version_upgrade=False,
    cluster_endpoint=memorydb_mixins.CfnClusterPropsMixin.EndpointProperty(
        address="address",
        port=123
    ),
    cluster_name="clusterName",
    data_tiering="dataTiering",
    description="description",
    engine="engine",
    engine_version="engineVersion",
    final_snapshot_name="finalSnapshotName",
    ip_discovery="ipDiscovery",
    kms_key_id="kmsKeyId",
    maintenance_window="maintenanceWindow",
    multi_region_cluster_name="multiRegionClusterName",
    network_type="networkType",
    node_type="nodeType",
    num_replicas_per_shard=123,
    num_shards=123,
    parameter_group_name="parameterGroupName",
    port=123,
    security_group_ids=["securityGroupIds"],
    snapshot_arns=["snapshotArns"],
    snapshot_name="snapshotName",
    snapshot_retention_limit=123,
    snapshot_window="snapshotWindow",
    sns_topic_arn="snsTopicArn",
    sns_topic_status="snsTopicStatus",
    subnet_group_name="subnetGroupName",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    tls_enabled=False
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::MemoryDB::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 = ['aclName', 'autoMinorVersionUpgrade', 'clusterEndpoint', 'clusterName', 'dataTiering', 'description', 'engine', 'engineVersion', 'finalSnapshotName', 'ipDiscovery', 'kmsKeyId', 'maintenanceWindow', 'multiRegionClusterName', 'networkType', 'nodeType', 'numReplicasPerShard', 'numShards', 'parameterGroupName', 'port', 'securityGroupIds', 'snapshotArns', 'snapshotName', 'snapshotRetentionLimit', 'snapshotWindow', 'snsTopicArn', 'snsTopicStatus', 'subnetGroupName', 'tags', 'tlsEnabled']

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

EndpointProperty

class CfnClusterPropsMixin.EndpointProperty(*, address=None, port=None)

Bases: object

Represents the information required for client programs to connect to the cluster and its nodes.

Parameters:

address (Optional[str]) – The DNS hostname of the node.
port (Union[int, float, None]) – The port number that the engine is listening on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-memorydb-cluster-endpoint.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.mixins_preview.aws_memorydb import mixins as memorydb_mixins

endpoint_property = memorydb_mixins.CfnClusterPropsMixin.EndpointProperty(
    address="address",
    port=123
)

Attributes

address

The DNS hostname of the node.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-memorydb-cluster-endpoint.html#cfn-memorydb-cluster-endpoint-address

port

The port number that the engine is listening on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-memorydb-cluster-endpoint.html#cfn-memorydb-cluster-endpoint-port