Learn R Programming

paws.compute (version 0.7.0)

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,
  DryRun = NULL
)

Arguments

Description

A description for the snapshot.

OutpostArn

The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.

  • To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.

  • To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.

  • To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.

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.

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.