Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ec2 ]

create-snapshots

Description

Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance. Boot volumes can be excluded by changing the paramaters.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-snapshots
[--description <value>]
--instance-specification <value>
[--tag-specifications <value>]
[--dry-run | --no-dry-run]
[--copy-tags-from-source <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--description (string)

A description propagated to every snapshot specified by the instance.

--instance-specification (structure)

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

Shorthand Syntax:

InstanceId=string,ExcludeBootVolume=boolean

JSON Syntax:

{
  "InstanceId": "string",
  "ExcludeBootVolume": true|false
}

--tag-specifications (list)

Tags to apply to every snapshot specified by the instance.

Shorthand Syntax:

ResourceType=string,Tags=[{Key=string,Value=string},{Key=string,Value=string}] ...

JSON Syntax:

[
  {
    "ResourceType": "client-vpn-endpoint"|"customer-gateway"|"dedicated-host"|"dhcp-options"|"elastic-ip"|"fleet"|"fpga-image"|"host-reservation"|"image"|"instance"|"internet-gateway"|"launch-template"|"natgateway"|"network-acl"|"network-interface"|"reserved-instances"|"route-table"|"security-group"|"snapshot"|"spot-instances-request"|"subnet"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-route-table"|"volume"|"vpc"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ]
  }
  ...
]

--dry-run | --no-dry-run (boolean)

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

--copy-tags-from-source (string)

Copies the tags from the specified instance to all snapshots.

Possible values:

  • volume

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Snapshots -> (list)

List of snapshots.

(structure)

Information about a snapshot.

Description -> (string)

Description specified by the CreateSnapshotRequest that has been applied to all snapshots.

Tags -> (list)

Tags associated with this snapshot.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

Encrypted -> (boolean)

Indicates whether the snapshot is encrypted.

VolumeId -> (string)

Source volume from which this snapshot was created.

State -> (string)

Current state of the snapshot.

VolumeSize -> (integer)

Size of the volume from which this snapshot was created.

StartTime -> (timestamp)

Time this snapshot was started. This is the same for all snapshots initiated by the same request.

Progress -> (string)

Progress this snapshot has made towards completing.

OwnerId -> (string)

Account id used when creating this snapshot.

SnapshotId -> (string)

Snapshot id that can be used to describe this snapshot.