ec2_create_snapshot: Creates a snapshot of an EBS volume and stores it in Amazon S3

Description

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.

See https://www.paws-r-sdk.com/docs/ec2_create_snapshot/ for full documentation.

Usage

ec2_create_snapshot(
  Description = NULL,
  OutpostArn = NULL,
  VolumeId,
  TagSpecifications = NULL,
  Location = NULL,
  DryRun = NULL
)

Arguments

Description

A description for the snapshot.

OutpostArn

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

To create the snapshot on the same Outpost as the source volume, specify the ARN of that Outpost. The snapshot must be created on the same Outpost as the volume.
To create the snapshot 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.

VolumeId

[required] The ID of the Amazon EBS volume.

TagSpecifications

The tags to apply to the snapshot during creation.

Location

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

To create a local snapshot in the same Local Zone as the source volume, specify local.
To create a regional snapshot in the parent Region of the Local Zone, specify regional or omit this parameter.

Default value: regional

DryRun

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.