software.amazon.awssdk.services.storagegateway.model

Interface CreateCachediScsiVolumeRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateCachediScsiVolumeRequest

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

Method Summary

Modifier and Type	Method and Description
CreateCachediScsiVolumeRequest.Builder	clientToken(String clientToken) A unique identifier that you use to retry a request.
CreateCachediScsiVolumeRequest.Builder	gatewayARN(String gatewayARN) Sets the value of the GatewayARN property for this object.
CreateCachediScsiVolumeRequest.Builder	kmsEncrypted(Boolean kmsEncrypted) True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
CreateCachediScsiVolumeRequest.Builder	kmsKey(String kmsKey) The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption.
CreateCachediScsiVolumeRequest.Builder	networkInterfaceId(String networkInterfaceId) The network interface of the gateway on which to expose the iSCSI target.
CreateCachediScsiVolumeRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateCachediScsiVolumeRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateCachediScsiVolumeRequest.Builder	snapshotId(String snapshotId) The snapshot ID (e.g.
CreateCachediScsiVolumeRequest.Builder	sourceVolumeARN(String sourceVolumeARN) The ARN for an existing volume.
CreateCachediScsiVolumeRequest.Builder	targetName(String targetName) The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN.
CreateCachediScsiVolumeRequest.Builder	volumeSizeInBytes(Long volumeSizeInBytes) The size of the volume in bytes.

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

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

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

volumeSizeInBytes

CreateCachediScsiVolumeRequest.Builder volumeSizeInBytes(Long volumeSizeInBytes)

The size of the volume in bytes.

Parameters:

volumeSizeInBytes - The size of the volume in bytes.

Returns:

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

snapshotId

CreateCachediScsiVolumeRequest.Builder snapshotId(String snapshotId)

The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached 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 cached 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.

targetName

CreateCachediScsiVolumeRequest.Builder targetName(String targetName)

The name of the iSCSI target used by initiators to connect to the target and 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 of a gateway.

Parameters:

targetName - The name of the iSCSI target used by initiators to connect to the target and 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 of a gateway.

Returns:

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

sourceVolumeARN

CreateCachediScsiVolumeRequest.Builder sourceVolumeARN(String sourceVolumeARN)

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

Parameters:

sourceVolumeARN - The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

Returns:

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

networkInterfaceId

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

clientToken

CreateCachediScsiVolumeRequest.Builder clientToken(String clientToken)

A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

Parameters:

clientToken - A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

Returns:

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

kmsEncrypted

CreateCachediScsiVolumeRequest.Builder kmsEncrypted(Boolean kmsEncrypted)

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

Parameters:

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

Returns:

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

kmsKey

CreateCachediScsiVolumeRequest.Builder kmsKey(String kmsKey)

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

Parameters:

kmsKey - The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. 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.

overrideConfiguration

CreateCachediScsiVolumeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.