software.amazon.awssdk.services.storagegateway.model

Interface CreateSnapshotRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateSnapshotRequest.Builder,CreateSnapshotRequest>, SdkBuilder<CreateSnapshotRequest.Builder,CreateSnapshotRequest>, SdkPojo, SdkRequest.Builder, StorageGatewayRequest.Builder

Enclosing class:

CreateSnapshotRequest

public static interface CreateSnapshotRequest.Builder
extends StorageGatewayRequest.Builder, SdkPojo, CopyableBuilder<CreateSnapshotRequest.Builder,CreateSnapshotRequest>

Method Summary

Modifier and Type	Method and Description
CreateSnapshotRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateSnapshotRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateSnapshotRequest.Builder	snapshotDescription(String snapshotDescription) Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the Storage Gateway snapshot Details pane, Description field.
CreateSnapshotRequest.Builder	tags(Collection<Tag> tags) A list of up to 50 tags that can be assigned to a snapshot.
CreateSnapshotRequest.Builder	tags(Consumer<Tag.Builder>... tags) A list of up to 50 tags that can be assigned to a snapshot.
CreateSnapshotRequest.Builder	tags(Tag... tags) A list of up to 50 tags that can be assigned to a snapshot.
CreateSnapshotRequest.Builder	volumeARN(String volumeARN) The Amazon Resource Name (ARN) of the volume.

Methods inherited from interface software.amazon.awssdk.services.storagegateway.model.StorageGatewayRequest.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

volumeARN

CreateSnapshotRequest.Builder volumeARN(String volumeARN)

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Parameters:

volumeARN - The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Returns:

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

snapshotDescription

CreateSnapshotRequest.Builder snapshotDescription(String snapshotDescription)

Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the Storage Gateway snapshot Details pane, Description field.

Parameters:

snapshotDescription - Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the Storage Gateway snapshot Details pane, Description field.

Returns:

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

tags

CreateSnapshotRequest.Builder tags(Collection<Tag> tags)

A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Parameters:

tags - A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Returns:

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

tags

CreateSnapshotRequest.Builder tags(Tag... tags)

A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Parameters:

tags - A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Returns:

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

tags

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

A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

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

Returns:

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

See Also:

#tags(java.util.Collection)

overrideConfiguration

CreateSnapshotRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder