software.amazon.awssdk.services.storagegateway.model

Class CreateStorediScsiVolumeRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.storagegateway.model.StorageGatewayRequest

software.amazon.awssdk.services.storagegateway.model.CreateStorediScsiVolumeRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateStorediScsiVolumeRequest.Builder,CreateStorediScsiVolumeRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateStorediScsiVolumeRequest
extends StorageGatewayRequest
implements ToCopyableBuilder<CreateStorediScsiVolumeRequest.Builder,CreateStorediScsiVolumeRequest>

A JSON object containing one or more of the following fields:

• CreateStorediSCSIVolumeInput$DiskId

• CreateStorediSCSIVolumeInput$NetworkInterfaceId

• CreateStorediSCSIVolumeInput$PreserveExistingData

• CreateStorediSCSIVolumeInput$SnapshotId

• CreateStorediSCSIVolumeInput$TargetName

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateStorediScsiVolumeRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateStorediScsiVolumeRequest.Builder	builder()
String	diskId() The unique identifier for the gateway local disk that is configured as a stored volume.
boolean	equals(Object obj)
String	gatewayARN() Returns the value of the GatewayARN property for this object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
String	kmsKey() The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side encryption.
String	networkInterfaceId() The network interface of the gateway on which to expose the iSCSI target.
Boolean	preserveExistingData() Specify this field as true if you want to preserve the data on the local disk.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateStorediScsiVolumeRequest.Builder>	serializableBuilderClass()
String	snapshotId() The snapshot ID (e.g.
String	targetName() The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN.
CreateStorediScsiVolumeRequest.Builder	toBuilder()
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

gatewayARN

public String gatewayARN()

Returns the value of the GatewayARN property for this object.

Returns:

The value of the GatewayARN property for this object.

diskId

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

Returns:

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

snapshotId

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

Returns:

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.

preserveExistingData

public 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

Returns:

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

targetName

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

Returns:

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.

networkInterfaceId

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

Returns:

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.

kmsEncrypted

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

Returns:

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.

kmsKey

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

Returns:

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.

toBuilder

public CreateStorediScsiVolumeRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateStorediScsiVolumeRequest.Builder,CreateStorediScsiVolumeRequest>

Specified by:

toBuilder in class StorageGatewayRequest

builder

public static CreateStorediScsiVolumeRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateStorediScsiVolumeRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo