CfnSnapshotPropsMixin

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

Bases: Mixin

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-snapshot.html

CloudformationResource:

AWS::ElastiCache::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_elasticache as elasticache
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_snapshot_props_mixin = elasticache.CfnSnapshotPropsMixin(elasticache.CfnSnapshotMixinProps(
    cache_cluster_id="cacheClusterId",
    kms_key_id="kmsKeyId",
    replication_group_id="replicationGroupId",
    snapshot_name="snapshotName",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::ElastiCache::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 = ['cacheClusterId', 'kmsKeyId', 'replicationGroupId', '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.

NodeSnapshotProperty

class CfnSnapshotPropsMixin.NodeSnapshotProperty(*, cache_cluster_id=None, cache_node_create_time=None, cache_node_id=None, cache_size=None, node_group_id=None, snapshot_create_time=None)

Bases: object

Parameters:
  • cache_cluster_id (Optional[str]) – A unique identifier for the source cluster.

  • cache_node_create_time (Optional[str]) – The date and time when the cache node was created in the source cluster.

  • cache_node_id (Optional[str]) – The cache node identifier for the node in the source cluster.

  • cache_size (Optional[str]) – The size of the cache on the source cache node.

  • node_group_id (Optional[str]) – A unique identifier for the source node group (shard).

  • snapshot_create_time (Optional[str]) – The date and time when the source node’s metadata and cache data set was obtained for the snapshot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-snapshot-nodesnapshot.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_elasticache as elasticache

node_snapshot_property = elasticache.CfnSnapshotPropsMixin.NodeSnapshotProperty(
    cache_cluster_id="cacheClusterId",
    cache_node_create_time="cacheNodeCreateTime",
    cache_node_id="cacheNodeId",
    cache_size="cacheSize",
    node_group_id="nodeGroupId",
    snapshot_create_time="snapshotCreateTime"
)

Attributes

cache_cluster_id

A unique identifier for the source cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-snapshot-nodesnapshot.html#cfn-elasticache-snapshot-nodesnapshot-cacheclusterid

cache_node_create_time

The date and time when the cache node was created in the source cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-snapshot-nodesnapshot.html#cfn-elasticache-snapshot-nodesnapshot-cachenodecreatetime

cache_node_id

The cache node identifier for the node in the source cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-snapshot-nodesnapshot.html#cfn-elasticache-snapshot-nodesnapshot-cachenodeid

cache_size

The size of the cache on the source cache node.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-snapshot-nodesnapshot.html#cfn-elasticache-snapshot-nodesnapshot-cachesize

node_group_id

A unique identifier for the source node group (shard).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-snapshot-nodesnapshot.html#cfn-elasticache-snapshot-nodesnapshot-nodegroupid

snapshot_create_time

The date and time when the source node’s metadata and cache data set was obtained for the snapshot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-snapshot-nodesnapshot.html#cfn-elasticache-snapshot-nodesnapshot-snapshotcreatetime