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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ebs/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:kms_key_arn]

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-direct-api-idempotency.html

Returns:

  • (String) 


690
691
692
693
694
695
696
697
698
699
700
701
 
# File '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) 


690
691
692
693
694
695
696
697
698
699
700
701
 
# File '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*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html [3]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions

Returns:

  • (Boolean) 


690
691
692
693
694
695
696
697
698
699
700
701
 
# File '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*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html [3]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions

Returns:

  • (String) 


690
691
692
693
694
695
696
697
698
699
700
701
 
# File '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*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html [3]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions

Returns:

  • (String) 


690
691
692
693
694
695
696
697
698
699
700
701
 
# File '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:



690
691
692
693
694
695
696
697
698
699
700
701
 
# File '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) 


690
691
692
693
694
695
696
697
698
699
700
701
 
# File '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) 


690
691
692
693
694
695
696
697
698
699
700
701
 
# File '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