[ aws . ebs ]

start-snapshot

Description

Creates a new Amazon EBS snapshot. The new snapshot enters the pending state after the request completes.

After creating the snapshot, use PutSnapshotBlock to write blocks of data to the snapshot.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  start-snapshot
--volume-size <value>
[--parent-snapshot-id <value>]
[--tags <value>]
[--description <value>]
[--client-token <value>]
[--encrypted | --no-encrypted]
[--kms-key-arn <value>]
[--timeout <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--volume-size (long)

The size of the volume, in GiB. The maximum size is 16384 GiB (16 TiB).

--parent-snapshot-id (string)

The ID of the parent snapshot. If there is no parent snapshot, or if you are creating the first snapshot for an on-premises volume, omit this parameter.

If your account is enabled for encryption by default, you cannot use an unencrypted snapshot as a parent snapshot. You must first create an encrypted copy of the parent snapshot using CopySnapshot .

--tags (list)

The tags to apply to the snapshot.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Value -> (string)

The value of the tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--description (string)

A description for the snapshot.

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

If you do not specify a client token, one is automatically generated by the AWS SDK.

For more information, see Idempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide .

--encrypted | --no-encrypted (boolean)

Indicates whether to encrypt the snapshot. To create an encrypted snapshot, specify true . To create an unencrypted snapshot, omit this parameter.

If you specify a value for ParentSnapshotId , omit this parameter.

If you specify true , the snapshot is encrypted using the CMK specified using the KmsKeyArn parameter. If no value is specified for KmsKeyArn , the default CMK for your account is used. If no default CMK has been specified for your account, the AWS managed CMK is used. To set a default CMK for your account, use ModifyEbsDefaultKmsKeyId .

If your account is enabled for encryption by default, you cannot set this parameter to false . In this case, you can omit this parameter.

For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide .

--kms-key-arn (string)

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) to be used to encrypt the snapshot. If you do not specify a CMK, the default AWS managed CMK is used.

If you specify a ParentSnapshotId , omit this parameter; the snapshot will be encrypted using the same CMK that was used to encrypt the parent snapshot.

If Encrypted is set to true , you must specify a CMK ARN.

--timeout (integer)

The amount of time (in minutes) after which the snapshot is automatically cancelled if:

• No blocks are written to the snapshot.

• The snapshot is not completed after writing the last block of data.

If no value is specified, the timeout defaults to 60 minutes.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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

Description -> (string)

The description of the snapshot.

SnapshotId -> (string)

The ID of the snapshot.

OwnerId -> (string)

The AWS account ID of the snapshot owner.

Status -> (string)

The status of the snapshot.

StartTime -> (timestamp)

The timestamp when the snapshot was created.

VolumeSize -> (long)

The size of the volume, in GiB.

BlockSize -> (integer)

The size of the blocks in the snapshot, in bytes.

Tags -> (list)

The tags applied to the snapshot. You can specify up to 50 tags per snapshot. For more information, see Tagging your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide .

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Value -> (string)

The value of the tag.

ParentSnapshotId -> (string)

The ID of the parent snapshot.

KmsKeyArn -> (string)

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) used to encrypt the snapshot.