com.amazonaws.services.storagegateway.model
Class CreateCachediSCSIVolumeRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.storagegateway.model.CreateCachediSCSIVolumeRequest

All Implemented Interfaces:

Serializable

public class CreateCachediSCSIVolumeRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the CreateCachediSCSIVolume operation.

This operation creates a cached volume on a specified cached gateway. This operation is supported only for the gateway-cached volume architecture.

NOTE:Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway.

In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, AWS Storage Gateway creates the volume and returns information about it such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

See Also:

AWSStorageGateway.createCachediSCSIVolume(CreateCachediSCSIVolumeRequest), Serialized Form

Constructor Summary

CreateCachediSCSIVolumeRequest()

Method Summary

boolean	equals(Object obj)
String	getClientToken() A unique identifying string for the cached volume.
String	getGatewayARN() The Amazon Resource Name (ARN) of the gateway.
String	getNetworkInterfaceId() The network interface of the gateway on which to expose the iSCSI target.
String	getSnapshotId() The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored volume.
String	getTargetName() The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN.
Long	getVolumeSizeInBytes() The size of the cached volume.
int	hashCode()
void	setClientToken(String clientToken) A unique identifying string for the cached volume.
void	setGatewayARN(String gatewayARN) The Amazon Resource Name (ARN) of the gateway.
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., "snap-1122aabb") of the snapshot to restore as the new stored volume.
void	setTargetName(String targetName) The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN.
void	setVolumeSizeInBytes(Long volumeSizeInBytes) The size of the cached volume.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateCachediSCSIVolumeRequest	withClientToken(String clientToken) A unique identifying string for the cached volume.
CreateCachediSCSIVolumeRequest	withGatewayARN(String gatewayARN) The Amazon Resource Name (ARN) of the gateway.
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., "snap-1122aabb") of the snapshot to restore as the new stored volume.
CreateCachediSCSIVolumeRequest	withTargetName(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	withVolumeSizeInBytes(Long volumeSizeInBytes) The size of the cached volume.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateCachediSCSIVolumeRequest

public CreateCachediSCSIVolumeRequest()

Method Detail

getGatewayARN

public String getGatewayARN()

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Returns:

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

setGatewayARN

public void setGatewayARN(String gatewayARN)

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Parameters:

gatewayARN - The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

withGatewayARN

public CreateCachediSCSIVolumeRequest withGatewayARN(String gatewayARN)

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

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

Constraints:
Length: 50 - 500

Parameters:

gatewayARN - The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Returns:

A reference to this updated object so that method calls can be chained together.

getVolumeSizeInBytes

public Long getVolumeSizeInBytes()

The size of the cached volume.

Returns:

The size of the cached volume.

setVolumeSizeInBytes

public void setVolumeSizeInBytes(Long volumeSizeInBytes)

The size of the cached volume.

Parameters:

volumeSizeInBytes - The size of the cached volume.

withVolumeSizeInBytes

public CreateCachediSCSIVolumeRequest withVolumeSizeInBytes(Long volumeSizeInBytes)

The size of the cached volume.

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

Parameters:

volumeSizeInBytes - The size of the cached volume.

Returns:

A reference to this updated object so that method calls can be chained together.

getSnapshotId

public String getSnapshotId()

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 cached volume from a snapshot; otherwise, do not include this field. To list snapshots for your account, use DescribeSnapshots in Amazon Elastic Compute Cloud API Reference.

Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z

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 cached volume from a snapshot; otherwise, do not include this field. To list snapshots for your account, use DescribeSnapshots in Amazon Elastic Compute Cloud API Reference.

setSnapshotId

public void setSnapshotId(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 cached volume from a snapshot; otherwise, do not include this field. To list snapshots for your account, use DescribeSnapshots in Amazon Elastic Compute Cloud API Reference.

Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z

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 cached volume from a snapshot; otherwise, do not include this field. To list snapshots for your account, use DescribeSnapshots in 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 stored volume. Specify this field if you want to create the iSCSI cached volume from a snapshot; otherwise, do not include this field. To list snapshots for your account, use DescribeSnapshots in Amazon Elastic Compute Cloud API Reference.

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

Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z

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 cached volume from a snapshot; otherwise, do not include this field. To list snapshots for your account, use DescribeSnapshots in Amazon Elastic Compute Cloud API Reference.

Returns:

A reference to this updated object so that method calls can be chained together.

getTargetName

public String getTargetName()

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-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.

Constraints:
Length: 1 - 200
Pattern: ^[-\.;a-z0-9]+$

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-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.

setTargetName

public void setTargetName(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-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.

Constraints:
Length: 1 - 200
Pattern: ^[-\.;a-z0-9]+$

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-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.

withTargetName

public CreateCachediSCSIVolumeRequest withTargetName(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-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.

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

Constraints:
Length: 1 - 200
Pattern: ^[-\.;a-z0-9]+$

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-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.

Returns:

A reference to this updated object so that method calls can be chained together.

getNetworkInterfaceId

public String getNetworkInterfaceId()

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use the DescribeGatewayInformation operation to get a list of the network interfaces available on the gateway.

Constraints:
Pattern: \A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z

Returns:

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use the DescribeGatewayInformation operation to get a list of the network interfaces available on the gateway.

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 the DescribeGatewayInformation operation to get a list of the network interfaces available on the gateway.

Constraints:
Pattern: \A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z

Parameters:

networkInterfaceId - The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use the DescribeGatewayInformation operation to get a list of the network interfaces available on the gateway.

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 the DescribeGatewayInformation operation to get a list of the network interfaces available on the gateway.

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

Constraints:
Pattern: \A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z

Parameters:

networkInterfaceId - The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use the DescribeGatewayInformation operation to get a list of the network interfaces available on the gateway.

Returns:

A reference to this updated object so that method calls can be chained together.

getClientToken

public String getClientToken()

A unique identifying string for the cached volume.

Constraints:
Length: 5 - 100

Returns:

A unique identifying string for the cached volume.

setClientToken

public void setClientToken(String clientToken)

A unique identifying string for the cached volume.

Constraints:
Length: 5 - 100

Parameters:

clientToken - A unique identifying string for the cached volume.

withClientToken

public CreateCachediSCSIVolumeRequest withClientToken(String clientToken)

A unique identifying string for the cached volume.

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

Constraints:
Length: 5 - 100

Parameters:

clientToken - A unique identifying string for the cached volume.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object