com.amazonaws.services.storagegateway.model

Class CreateCachediSCSIVolumeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.storagegateway.model.CreateCachediSCSIVolumeRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateCachediSCSIVolumeRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateCachediSCSIVolumeRequest()

Method Summary

Modifier and Type	Method and Description
CreateCachediSCSIVolumeRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() A unique identifier that you use to retry a request.
String	getGatewayARN()
Boolean	getKMSEncrypted() 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.
String	getKMSKey() The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
String	getNetworkInterfaceId() The network interface of the gateway on which to expose the iSCSI target.
String	getSnapshotId() The snapshot ID (e.g.
String	getSourceVolumeARN() The ARN for an existing volume.
List<Tag>	getTags() A list of up to 50 tags that you can assign to a cached volume.
String	getTargetName() The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN.
Long	getVolumeSizeInBytes() The size of the volume in bytes.
int	hashCode()
Boolean	isKMSEncrypted() 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.
void	setClientToken(String clientToken) A unique identifier that you use to retry a request.
void	setGatewayARN(String gatewayARN)
void	setKMSEncrypted(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.
void	setKMSKey(String kMSKey) The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
void	setNetworkInterfaceId(String networkInterfaceId) The network interface of the gateway on which to expose the iSCSI target.
void	setSnapshotId(String snapshotId) The snapshot ID (e.g.
void	setSourceVolumeARN(String sourceVolumeARN) The ARN for an existing volume.
void	setTags(Collection<Tag> tags) A list of up to 50 tags that you can assign to a cached volume.
void	setTargetName(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.
void	setVolumeSizeInBytes(Long volumeSizeInBytes) The size of the volume in bytes.
String	toString() Returns a string representation of this object.
CreateCachediSCSIVolumeRequest	withClientToken(String clientToken) A unique identifier that you use to retry a request.
CreateCachediSCSIVolumeRequest	withGatewayARN(String gatewayARN)
CreateCachediSCSIVolumeRequest	withKMSEncrypted(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.
CreateCachediSCSIVolumeRequest	withKMSKey(String kMSKey) The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
CreateCachediSCSIVolumeRequest	withNetworkInterfaceId(String networkInterfaceId) The network interface of the gateway on which to expose the iSCSI target.
CreateCachediSCSIVolumeRequest	withSnapshotId(String snapshotId) The snapshot ID (e.g.
CreateCachediSCSIVolumeRequest	withSourceVolumeARN(String sourceVolumeARN) The ARN for an existing volume.
CreateCachediSCSIVolumeRequest	withTags(Collection<Tag> tags) A list of up to 50 tags that you can assign to a cached volume.
CreateCachediSCSIVolumeRequest	withTags(Tag... tags) A list of up to 50 tags that you can assign to a cached volume.
CreateCachediSCSIVolumeRequest	withTargetName(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.
CreateCachediSCSIVolumeRequest	withVolumeSizeInBytes(Long volumeSizeInBytes) The size of the volume in bytes.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateCachediSCSIVolumeRequest

public CreateCachediSCSIVolumeRequest()

Method Detail

setGatewayARN

public void setGatewayARN(String gatewayARN)

Parameters:

gatewayARN -

getGatewayARN

public String getGatewayARN()

Returns:

withGatewayARN

public CreateCachediSCSIVolumeRequest withGatewayARN(String gatewayARN)

Parameters:

gatewayARN -

Returns:

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

setVolumeSizeInBytes

public void setVolumeSizeInBytes(Long volumeSizeInBytes)

The size of the volume in bytes.

Parameters:

volumeSizeInBytes - The size of the volume in bytes.

getVolumeSizeInBytes

public Long getVolumeSizeInBytes()

The size of the volume in bytes.

Returns:

The size of the volume in bytes.

withVolumeSizeInBytes

public CreateCachediSCSIVolumeRequest withVolumeSizeInBytes(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.

setSnapshotId

public void setSnapshotId(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.

getSnapshotId

public String getSnapshotId()

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.

withSnapshotId

public CreateCachediSCSIVolumeRequest withSnapshotId(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.

setTargetName

public void setTargetName(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.

getTargetName

public String getTargetName()

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:

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.

withTargetName

public CreateCachediSCSIVolumeRequest withTargetName(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.

setSourceVolumeARN

public void setSourceVolumeARN(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.

getSourceVolumeARN

public String getSourceVolumeARN()

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.

withSourceVolumeARN

public CreateCachediSCSIVolumeRequest withSourceVolumeARN(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.

setNetworkInterfaceId

public void setNetworkInterfaceId(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.

getNetworkInterfaceId

public String getNetworkInterfaceId()

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.

withNetworkInterfaceId

public CreateCachediSCSIVolumeRequest withNetworkInterfaceId(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.

setClientToken

public void setClientToken(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.

getClientToken

public String getClientToken()

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.

withClientToken

public CreateCachediSCSIVolumeRequest withClientToken(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.

setKMSEncrypted

public void setKMSEncrypted(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

getKMSEncrypted

public Boolean getKMSEncrypted()

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:

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

withKMSEncrypted

public CreateCachediSCSIVolumeRequest withKMSEncrypted(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.

isKMSEncrypted

public Boolean isKMSEncrypted()

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:

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

setKMSKey

public void setKMSKey(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.

getKMSKey

public String getKMSKey()

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:

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.

withKMSKey

public CreateCachediSCSIVolumeRequest withKMSKey(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.

getTags

public List<Tag> getTags()

A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers that you can represent 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 characters.

Returns:

A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers that you can represent 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 characters.

setTags

public void setTags(Collection<Tag> tags)

A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers that you can represent 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 characters.

Parameters:

tags - A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers that you can represent 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 characters.

withTags

public CreateCachediSCSIVolumeRequest withTags(Tag... tags)

A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers that you can represent 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 characters.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers that you can represent 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 characters.

Returns:

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

withTags

public CreateCachediSCSIVolumeRequest withTags(Collection<Tag> tags)

A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers that you can represent 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 characters.

Parameters:

tags - A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers that you can represent 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 characters.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateCachediSCSIVolumeRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()