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

Inherits:

Struct

• Object
• Struct
• Aws::EBS::Types::StartSnapshotRequest

Defined in:

gems/aws-sdk-ebs/lib/aws-sdk-ebs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:kms_key_arn]

Instance Attribute Summary

• #client_token ⇒ String

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

• #description ⇒ String

  A description for the snapshot.

• #encrypted ⇒ Boolean

  Indicates whether to encrypt the snapshot.

• #kms_key_arn ⇒ String

  The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to be used to encrypt the snapshot.

• #parent_snapshot_id ⇒ String

  The ID of the parent snapshot.

• #tags ⇒ 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:.

• #volume_size ⇒ Integer

  The size of the volume, in GiB.

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 Amazon Web Services SDK.

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

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-ebs/lib/aws-sdk-ebs/types.rb', line 690

class StartSnapshotRequest < Struct.new(
  :volume_size,
  :parent_snapshot_id,
  :tags,
  :description,
  :client_token,
  :encrypted,
  :kms_key_arn,
  :timeout)
  SENSITIVE = [:kms_key_arn]
  include Aws::Structure
end

#description ⇒ String

A description for the snapshot.

Returns:

• (String)

# File 'gems/aws-sdk-ebs/lib/aws-sdk-ebs/types.rb', line 690

class StartSnapshotRequest < Struct.new(
  :volume_size,
  :parent_snapshot_id,
  :tags,
  :description,
  :client_token,
  :encrypted,
  :kms_key_arn,
  :timeout)
  SENSITIVE = [:kms_key_arn]
  include Aws::Structure
end

#encrypted ⇒ Boolean

Indicates whether to encrypt the snapshot.

You can't specify Encrypted and ParentSnapshotId in the same request. If you specify both parameters, the request fails with ValidationException.

The encryption status of the snapshot depends on the values that you specify for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web Services account is enabled for encryption by default. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.

To create an encrypted snapshot, you must have permission to use the KMS key. For more information, see Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User Guide.

Returns:

• (Boolean)

# File 'gems/aws-sdk-ebs/lib/aws-sdk-ebs/types.rb', line 690

class StartSnapshotRequest < Struct.new(
  :volume_size,
  :parent_snapshot_id,
  :tags,
  :description,
  :client_token,
  :encrypted,
  :kms_key_arn,
  :timeout)
  SENSITIVE = [:kms_key_arn]
  include Aws::Structure
end

#kms_key_arn ⇒ String

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to be used to encrypt the snapshot.

The encryption status of the snapshot depends on the values that you specify for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web Services account is enabled for encryption by default. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.

To create an encrypted snapshot, you must have permission to use the KMS key. For more information, see Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User Guide.

Returns:

• (String)

# File 'gems/aws-sdk-ebs/lib/aws-sdk-ebs/types.rb', line 690

class StartSnapshotRequest < Struct.new(
  :volume_size,
  :parent_snapshot_id,
  :tags,
  :description,
  :client_token,
  :encrypted,
  :kms_key_arn,
  :timeout)
  SENSITIVE = [:kms_key_arn]
  include Aws::Structure
end

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

You can't specify ParentSnapshotId and Encrypted in the same request. If you specify both parameters, the request fails with ValidationException.

The encryption status of the snapshot depends on the values that you specify for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web Services account is enabled for encryption by default. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.

If you specify an encrypted parent snapshot, you must have permission to use the KMS key that was used to encrypt the parent snapshot. For more information, see Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User Guide.

Returns:

• (String)

# File 'gems/aws-sdk-ebs/lib/aws-sdk-ebs/types.rb', line 690

class StartSnapshotRequest < Struct.new(
  :volume_size,
  :parent_snapshot_id,
  :tags,
  :description,
  :client_token,
  :encrypted,
  :kms_key_arn,
  :timeout)
  SENSITIVE = [:kms_key_arn]
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags to apply to the snapshot.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-ebs/lib/aws-sdk-ebs/types.rb', line 690

class StartSnapshotRequest < Struct.new(
  :volume_size,
  :parent_snapshot_id,
  :tags,
  :description,
  :client_token,
  :encrypted,
  :kms_key_arn,
  :timeout)
  SENSITIVE = [:kms_key_arn]
  include Aws::Structure
end

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

# File 'gems/aws-sdk-ebs/lib/aws-sdk-ebs/types.rb', line 690

class StartSnapshotRequest < Struct.new(
  :volume_size,
  :parent_snapshot_id,
  :tags,
  :description,
  :client_token,
  :encrypted,
  :kms_key_arn,
  :timeout)
  SENSITIVE = [:kms_key_arn]
  include Aws::Structure
end

#volume_size ⇒ Integer

The size of the volume, in GiB. The maximum size is 65536 GiB (64 TiB).

Returns:

• (Integer)

# File 'gems/aws-sdk-ebs/lib/aws-sdk-ebs/types.rb', line 690

class StartSnapshotRequest < Struct.new(
  :volume_size,
  :parent_snapshot_id,
  :tags,
  :description,
  :client_token,
  :encrypted,
  :kms_key_arn,
  :timeout)
  SENSITIVE = [:kms_key_arn]
  include Aws::Structure
end