software.amazon.awssdk.services.storagegateway.model

Interface CreateStorediScsiVolumeRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateStorediScsiVolumeRequest

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

Method Summary

Modifier and Type	Method and Description
CreateStorediScsiVolumeRequest.Builder	diskId(String diskId) The unique identifier for the gateway local disk that is configured as a stored volume.
CreateStorediScsiVolumeRequest.Builder	gatewayARN(String gatewayARN) Sets the value of the GatewayARN property for this object.
CreateStorediScsiVolumeRequest.Builder	kmsEncrypted(Boolean kmsEncrypted) Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3.
CreateStorediScsiVolumeRequest.Builder	kmsKey(String kmsKey) The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
CreateStorediScsiVolumeRequest.Builder	networkInterfaceId(String networkInterfaceId) The network interface of the gateway on which to expose the iSCSI target.
CreateStorediScsiVolumeRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateStorediScsiVolumeRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateStorediScsiVolumeRequest.Builder	preserveExistingData(Boolean preserveExistingData) Set to true if you want to preserve the data on the local disk.
CreateStorediScsiVolumeRequest.Builder	snapshotId(String snapshotId) The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored volume.
CreateStorediScsiVolumeRequest.Builder	tags(Collection<Tag> tags) A list of up to 50 tags that can be assigned to a stored volume.
CreateStorediScsiVolumeRequest.Builder	tags(Consumer<Tag.Builder>... tags) A list of up to 50 tags that can be assigned to a stored volume.
CreateStorediScsiVolumeRequest.Builder	tags(Tag... tags) A list of up to 50 tags that can be assigned to a stored volume.
CreateStorediScsiVolumeRequest.Builder	targetName(String targetName) The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN.

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

gatewayARN

CreateStorediScsiVolumeRequest.Builder gatewayARN(String gatewayARN)

Sets the value of the GatewayARN property for this object.

Parameters:

gatewayARN - The new value for the GatewayARN property for this object.

Returns:

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

diskId

CreateStorediScsiVolumeRequest.Builder diskId(String diskId)

The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.

Parameters:

diskId - The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.

Returns:

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

snapshotId

CreateStorediScsiVolumeRequest.Builder snapshotId(String snapshotId)

The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

Parameters:

snapshotId - The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

Returns:

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

preserveExistingData

CreateStorediScsiVolumeRequest.Builder preserveExistingData(Boolean preserveExistingData)

Set to true if you want to preserve the data on the local disk. Otherwise, set to false to create an empty volume.

Valid Values: true | false

Parameters:

preserveExistingData - Set to true if you want to preserve the data on the local disk. Otherwise, set to false to create an empty volume.

Valid Values: true | false

Returns:

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

targetName

CreateStorediScsiVolumeRequest.Builder targetName(String targetName)

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume . The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Parameters:

targetName - The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume . The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Returns:

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

networkInterfaceId

CreateStorediScsiVolumeRequest.Builder networkInterfaceId(String networkInterfaceId)

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

Parameters:

networkInterfaceId - The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

Returns:

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

kmsEncrypted

CreateStorediScsiVolumeRequest.Builder kmsEncrypted(Boolean kmsEncrypted)

Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

Parameters:

kmsEncrypted - Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

Returns:

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

kmsKey

CreateStorediScsiVolumeRequest.Builder kmsKey(String kmsKey)

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

Parameters:

kmsKey - The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

Returns:

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

tags

CreateStorediScsiVolumeRequest.Builder tags(Collection<Tag> tags)

A list of up to 50 tags that can be assigned to a stored volume. 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 stored volume. 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

CreateStorediScsiVolumeRequest.Builder tags(Tag... tags)

A list of up to 50 tags that can be assigned to a stored volume. 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 stored volume. 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

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

A list of up to 50 tags that can be assigned to a stored volume. 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 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)

overrideConfiguration

CreateStorediScsiVolumeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder