software.amazon.awssdk.services.ebs.model

Interface StartSnapshotRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartSnapshotRequest.Builder,StartSnapshotRequest>, EbsRequest.Builder, SdkBuilder<StartSnapshotRequest.Builder,StartSnapshotRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartSnapshotRequest

public static interface StartSnapshotRequest.Builder
extends EbsRequest.Builder, SdkPojo, CopyableBuilder<StartSnapshotRequest.Builder,StartSnapshotRequest>

Method Summary

Modifier and Type	Method and Description
StartSnapshotRequest.Builder	clientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
StartSnapshotRequest.Builder	description(String description) A description for the snapshot.
StartSnapshotRequest.Builder	encrypted(Boolean encrypted) Indicates whether to encrypt the snapshot.
StartSnapshotRequest.Builder	kmsKeyArn(String kmsKeyArn) The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to be used to encrypt the snapshot.
StartSnapshotRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartSnapshotRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StartSnapshotRequest.Builder	parentSnapshotId(String parentSnapshotId) The ID of the parent snapshot.
StartSnapshotRequest.Builder	tags(Collection<Tag> tags) The tags to apply to the snapshot.
StartSnapshotRequest.Builder	tags(Consumer<Tag.Builder>... tags) The tags to apply to the snapshot.
StartSnapshotRequest.Builder	tags(Tag... tags) The tags to apply to the snapshot.
StartSnapshotRequest.Builder	timeout(Integer timeout) The amount of time (in minutes) after which the snapshot is automatically cancelled if:
StartSnapshotRequest.Builder	volumeSize(Long volumeSize) The size of the volume, in GiB.

Methods inherited from interface software.amazon.awssdk.services.ebs.model.EbsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

volumeSize

StartSnapshotRequest.Builder volumeSize(Long volumeSize)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

parentSnapshotId

StartSnapshotRequest.Builder parentSnapshotId(String parentSnapshotId)

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.

Parameters:

parentSnapshotId - 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:

Returns a reference to this object so that method calls can be chained together.

tags

StartSnapshotRequest.Builder tags(Collection<Tag> tags)

The tags to apply to the snapshot.

Parameters:

tags - The tags to apply to the snapshot.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

StartSnapshotRequest.Builder tags(Tag... tags)

The tags to apply to the snapshot.

Parameters:

tags - The tags to apply to the snapshot.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

StartSnapshotRequest.Builder tags(Consumer<Tag.Builder>... tags)

The tags to apply to the snapshot.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(List)

description

StartSnapshotRequest.Builder description(String description)

A description for the snapshot.

Parameters:

description - A description for the snapshot.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientToken

StartSnapshotRequest.Builder clientToken(String clientToken)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

encrypted

StartSnapshotRequest.Builder encrypted(Boolean encrypted)

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 KMS key specified using the KmsKeyArn parameter. If no value is specified for KmsKeyArn, the default KMS key for your account is used. If no default KMS key has been specified for your account, the Amazon Web Services managed KMS key is used. To set a default KMS key 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.

Parameters:

encrypted - 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 KMS key specified using the KmsKeyArn parameter. If no value is specified for KmsKeyArn, the default KMS key for your account is used. If no default KMS key has been specified for your account, the Amazon Web Services managed KMS key is used. To set a default KMS key 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:

Returns a reference to this object so that method calls can be chained together.

kmsKeyArn

StartSnapshotRequest.Builder kmsKeyArn(String kmsKeyArn)

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

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

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

Parameters:

kmsKeyArn - The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to be used to encrypt the snapshot. If you do not specify a KMS key, the default Amazon Web Services managed KMS key is used.

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

timeout

StartSnapshotRequest.Builder timeout(Integer timeout)

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.

Parameters:

timeout - 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:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

StartSnapshotRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

StartSnapshotRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder