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) True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
CreateStorediScsiVolumeRequest.Builder	kmsKey(String kmsKey) The Amazon Resource Name (ARN) of the KMS key 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) Add an optional request override configuration.
CreateStorediScsiVolumeRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateStorediScsiVolumeRequest.Builder	preserveExistingData(Boolean preserveExistingData) Specify this field as true if you want to preserve the data on the local disk.
CreateStorediScsiVolumeRequest.Builder	snapshotId(String snapshotId) The snapshot ID (e.g.
CreateStorediScsiVolumeRequest.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.

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

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)

Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume.

Valid Values: true, false

Parameters:

preserveExistingData - Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates 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 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.

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)

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

CreateStorediScsiVolumeRequest.Builder kmsKey(String kmsKey)

The Amazon Resource Name (ARN) of the 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 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

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

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