You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EBS::Types::StartSnapshotRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StartSnapshotRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  volume_size: 1, # required
  parent_snapshot_id: "SnapshotId",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  description: "Description",
  client_token: "IdempotencyToken",
  encrypted: false,
  kms_key_arn: "KmsKeyArn",
  timeout: 1,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#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.

Returns:

  • (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

#description ⇒ String

A description for the snapshot.

Returns:

  • (String) —

    A description for the snapshot.

#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.

Returns:

  • (Boolean) —

    Indicates whether to encrypt the snapshot.

#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.

Returns:

  • (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.

#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.

Returns:

  • (String) —

    The ID of the parent snapshot.

#tags ⇒ Array<Types::Tag>

The tags to apply to the snapshot.

Returns:

  • (Array<Types::Tag>) —

    The tags to apply to the snapshot.

#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.

Returns:

  • (Integer) —

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

#volume_size ⇒ Integer

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

Returns:

  • (Integer) —

    The size of the volume, in GiB.