CfnSnapshotPropsMixin

class aws_cdk.cfn_property_mixins.aws_memorydb.CfnSnapshotPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::MemoryDB::Snapshot.

Represents a copy of an entire cluster as of the time when the snapshot was taken.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-snapshot.html
CloudformationResource:: AWS::MemoryDB::Snapshot
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.cfn_property_mixins import aws_memorydb as memorydb
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_snapshot_props_mixin = memorydb.CfnSnapshotPropsMixin(memorydb.CfnSnapshotMixinProps(
    cluster_name="clusterName",
    kms_key_id="kmsKeyId",
    snapshot_name="snapshotName",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::MemoryDB::Snapshot.

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['clusterName', 'kmsKeyId', 'snapshotName', 'tags']

Static Methods

classmethod is_mixin(x)

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.

ClusterConfigurationProperty

class CfnSnapshotPropsMixin.ClusterConfigurationProperty(*, description=None, engine=None, engine_version=None, maintenance_window=None, name=None, node_type=None, num_shards=None, parameter_group_name=None, port=None, snapshot_retention_limit=None, snapshot_window=None, subnet_group_name=None, topic_arn=None, vpc_id=None)

Bases: object

Parameters:

description (Optional[str]) – The description of the cluster configuration.
engine (Optional[str]) – The name of the engine used by the cluster configuration.
engine_version (Optional[str]) – The Redis OSS engine version used by the cluster.
maintenance_window (Optional[str]) – The specified maintenance window for the cluster.
name (Optional[str]) – The name of the cluster.
node_type (Optional[str]) – The node type used for the cluster.
num_shards (Union[int, float, None]) – The number of shards in the cluster.
parameter_group_name (Optional[str]) – The name of parameter group used by the cluster.
port (Union[int, float, None]) – The port used by the cluster.
snapshot_retention_limit (Union[int, float, None]) – The snapshot retention limit set by the cluster.
snapshot_window (Optional[str]) – The snapshot window set by the cluster.
subnet_group_name (Optional[str]) – The name of the subnet group used by the cluster.
topic_arn (Optional[str]) – The Amazon Resource Name (ARN) of the SNS notification topic for the cluster.
vpc_id (Optional[str]) – The ID of the VPC the cluster belongs to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-memorydb-snapshot-clusterconfiguration.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.cfn_property_mixins import aws_memorydb as memorydb

cluster_configuration_property = memorydb.CfnSnapshotPropsMixin.ClusterConfigurationProperty(
    description="description",
    engine="engine",
    engine_version="engineVersion",
    maintenance_window="maintenanceWindow",
    name="name",
    node_type="nodeType",
    num_shards=123,
    parameter_group_name="parameterGroupName",
    port=123,
    snapshot_retention_limit=123,
    snapshot_window="snapshotWindow",
    subnet_group_name="subnetGroupName",
    topic_arn="topicArn",
    vpc_id="vpcId"
)