software.amazon.awssdk.services.storagegateway.model

Class CreateCachediScsiVolumeRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateCachediScsiVolumeRequest.Builder,CreateCachediScsiVolumeRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateCachediScsiVolumeRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateCachediScsiVolumeRequest.Builder	builder()
String	clientToken() A unique identifier that you use to retry a request.
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 AWS KMS key used for Amazon S3 server side encryption.
String	networkInterfaceId() The network interface of the gateway on which to expose the iSCSI target.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateCachediScsiVolumeRequest.Builder>	serializableBuilderClass()
String	snapshotId() The snapshot ID (e.g.
String	sourceVolumeARN() The ARN for an existing volume.
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	toBuilder()
String	toString()
Long	volumeSizeInBytes() The size of the volume in bytes.

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.

volumeSizeInBytes

public Long volumeSizeInBytes()

The size of the volume in bytes.

Returns:

The size of the volume in bytes.

snapshotId

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

Returns:

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.

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.

sourceVolumeARN

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

Returns:

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.

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.

clientToken

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

Returns:

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.

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 AWS 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 AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

toBuilder

public CreateCachediScsiVolumeRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateCachediScsiVolumeRequest.Builder,CreateCachediScsiVolumeRequest>

Specified by:

toBuilder in class StorageGatewayRequest

builder

public static CreateCachediScsiVolumeRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateCachediScsiVolumeRequest.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