Skip to content

CopySnapshotMessage

Source code in docs_src/capo_elasticache/types/copy_snapshot_message.py
class CopySnapshotMessage(TypedDict, closed=True):
    source_snapshot_name: NotRequired["capo_elasticache.types.string.String"]
    """<p>The name of an existing snapshot from which to make a copy.</p>"""
    target_snapshot_name: NotRequired["capo_elasticache.types.string.String"]
    """<p>A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting. This value is stored as a lowercase string.</p>"""
    target_bucket: NotRequired["capo_elasticache.types.string.String"]
    """<p>The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.</p> <p>When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html#backups-exporting-grant-access">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the <i>Amazon ElastiCache User Guide</i>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/backups-exporting.html">Exporting a Snapshot</a> in the <i>Amazon ElastiCache User Guide</i>.</p>"""
    kms_key_id: NotRequired["capo_elasticache.types.string.String"]
    """<p>The ID of the KMS key used to encrypt the target snapshot.</p>"""
    tags: NotRequired["capo_elasticache.types.tag_list.TagList"]
    """<p>A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.</p>"""

kms_key_id instance-attribute

kms_key_id: NotRequired[String]

The ID of the KMS key used to encrypt the target snapshot.

source_snapshot_name instance-attribute

source_snapshot_name: NotRequired[String]

The name of an existing snapshot from which to make a copy.

tags instance-attribute

tags: NotRequired[TagList]

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

target_bucket instance-attribute

target_bucket: NotRequired[String]

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

target_snapshot_name instance-attribute

target_snapshot_name: NotRequired[String]

A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting. This value is stored as a lowercase string.