Skip to content

CreateSnapshotsRequest

Source code in docs_src/capo_ec2/types/create_snapshots_request.py
class CreateSnapshotsRequest(TypedDict, closed=True):
    description: NotRequired["capo_ec2.types.string.String"]
    """<p> A description propagated to every snapshot specified by the instance.</p>"""
    instance_specification: NotRequired[
        "capo_ec2.types.instance_specification.InstanceSpecification"
    ]
    """<p>The instance to specify which volumes should be included in the snapshots.</p>"""
    outpost_arn: NotRequired["capo_ec2.types.string.String"]
    """<note> <p>Only supported for instances on Outposts. If the source instance is not on an Outpost, omit this parameter.</p> </note> <ul> <li> <p>To create the snapshots on the same Outpost as the source instance, specify the ARN of that Outpost. The snapshots must be created on the same Outpost as the instance.</p> </li> <li> <p>To create the snapshots in the parent Region of the Outpost, omit this parameter.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#create-snapshot"> Create local snapshots from volumes on an Outpost</a> in the <i>Amazon EBS User Guide</i>.</p>"""
    tag_specifications: NotRequired[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ]
    """<p>Tags to apply to every snapshot specified by the instance.</p>"""
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"""
    copy_tags_from_source: NotRequired[
        "capo_ec2.types.copy_tags_from_source.CopyTagsFromSource"
    ]
    """<p>Copies the tags from the specified volume to corresponding snapshot.</p>"""
    location: NotRequired["capo_ec2.types.snapshot_location_enum.SnapshotLocationEnum"]
    """<note> <p>Only supported for instances in Local Zones. If the source instance is not in a Local Zone, omit this parameter.</p> </note> <ul> <li> <p>To create local snapshots in the same Local Zone as the source instance, specify <code>local</code>.</p> </li> <li> <p>To create regional snapshots in the parent Region of the Local Zone, specify <code>regional</code> or omit this parameter.</p> </li> </ul> <p>Default value: <code>regional</code> </p>"""

copy_tags_from_source instance-attribute

copy_tags_from_source: NotRequired[CopyTagsFromSource]

Copies the tags from the specified volume to corresponding snapshot.

description instance-attribute

description: NotRequired[String]

A description propagated to every snapshot specified by the instance.

dry_run instance-attribute

dry_run: NotRequired[Boolean]

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

instance_specification instance-attribute

instance_specification: NotRequired[InstanceSpecification]

The instance to specify which volumes should be included in the snapshots.

location instance-attribute

location: NotRequired[SnapshotLocationEnum]

Only supported for instances in Local Zones. If the source instance is not in a Local Zone, omit this parameter.

  • To create local snapshots in the same Local Zone as the source instance, specify local.

  • To create regional snapshots in the parent Region of the Local Zone, specify regional or omit this parameter.

Default value: regional

outpost_arn instance-attribute

outpost_arn: NotRequired[String]

Only supported for instances on Outposts. If the source instance is not on an Outpost, omit this parameter.

  • To create the snapshots on the same Outpost as the source instance, specify the ARN of that Outpost. The snapshots must be created on the same Outpost as the instance.

  • To create the snapshots in the parent Region of the Outpost, omit this parameter.

For more information, see Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.

tag_specifications instance-attribute

tag_specifications: NotRequired[TagSpecificationList]

Tags to apply to every snapshot specified by the instance.