com.amazonaws.services.storagegateway.model
Class CreateStorediSCSIVolumeRequest

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

public class CreateStorediSCSIVolumeRequest
extends AmazonWebServiceRequest

Container for the parameters to the CreateStorediSCSIVolume operation.

This operation creates a volume on a specified gateway. The size of the volume is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased.

In the request you must specify the gateway and the disk information on which you are creating the volume. In response, AWS Storage Gateway creates the volume and returns volume information such as the volume ARN, size and the iSCSI target ARN that initiators can use to connect to the volume target.

See Also:

AWSStorageGateway.createStorediSCSIVolume(CreateStorediSCSIVolumeRequest)

Constructor Summary

CreateStorediSCSIVolumeRequest()

Method Summary

boolean	equals(Object obj)
String	getDiskId() The unique identifier for the gateway local disk that is configured as a stored 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.
Boolean	getPreserveExistingData() Specify this field as true if you want to preserve the data on the local disk.
String	getSnapshotId() The snapshot ID (e.g.
String	getTargetName() The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN.
int	hashCode()
Boolean	isPreserveExistingData() Specify this field as true if you want to preserve the data on the local disk.
void	setDiskId(String diskId) The unique identifier for the gateway local disk that is configured as a stored 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	setPreserveExistingData(Boolean preserveExistingData) Specify this field as true if you want to preserve the data on the local disk.
void	setSnapshotId(String snapshotId) The snapshot ID (e.g.
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.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateStorediSCSIVolumeRequest	withDiskId(String diskId) The unique identifier for the gateway local disk that is configured as a stored volume.
CreateStorediSCSIVolumeRequest	withGatewayARN(String gatewayARN) The Amazon Resource Name (ARN) of the gateway.
CreateStorediSCSIVolumeRequest	withNetworkInterfaceId(String networkInterfaceId) The network interface of the gateway on which to expose the iSCSI target.
CreateStorediSCSIVolumeRequest	withPreserveExistingData(Boolean preserveExistingData) Specify this field as true if you want to preserve the data on the local disk.
CreateStorediSCSIVolumeRequest	withSnapshotId(String snapshotId) The snapshot ID (e.g.
CreateStorediSCSIVolumeRequest	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.

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

CreateStorediSCSIVolumeRequest

public CreateStorediSCSIVolumeRequest()

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

getDiskId

public String getDiskId()

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

Constraints:
Length: 1 - 300

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.

setDiskId

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

Constraints:
Length: 1 - 300

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.

withDiskId

public CreateStorediSCSIVolumeRequest withDiskId(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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 300

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:

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

Length: 13

Valid Values: Must be a valid snapshot ID, "snap-" followed by eight hexadecimal characters.

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

Length: 13

Valid Values: Must be a valid snapshot ID, "snap-" followed by eight hexadecimal characters.

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

Length: 13

Valid Values: Must be a valid snapshot ID, "snap-" followed by eight hexadecimal characters.

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

Length: 13

Valid Values: Must be a valid snapshot ID, "snap-" followed by eight hexadecimal characters.

withSnapshotId

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

Length: 13

Valid Values: Must be a valid snapshot ID, "snap-" followed by eight hexadecimal characters.

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

Length: 13

Valid Values: Must be a valid snapshot ID, "snap-" followed by eight hexadecimal characters.

Returns:

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

isPreserveExistingData

public Boolean isPreserveExistingData()

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

setPreserveExistingData

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

withPreserveExistingData

public CreateStorediSCSIVolumeRequest withPreserveExistingData(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 a reference to this object so that method calls can be chained together.

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:

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

getPreserveExistingData

public Boolean getPreserveExistingData()

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

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

Length: Minimum length of 1. Maximum length of 200.

Constraints: The name can contain lower case letters, numbers, periods (.), and hyphens (-).

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

Length: Minimum length of 1. Maximum length of 200.

Constraints: The name can contain lower case letters, numbers, periods (.), and hyphens (-).

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

Length: Minimum length of 1. Maximum length of 200.

Constraints: The name can contain lower case letters, numbers, periods (.), and hyphens (-).

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

Length: Minimum length of 1. Maximum length of 200.

Constraints: The name can contain lower case letters, numbers, periods (.), and hyphens (-).

withTargetName

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

Length: Minimum length of 1. Maximum length of 200.

Constraints: The name can contain lower case letters, numbers, periods (.), and hyphens (-).

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

Length: Minimum length of 1. Maximum length of 200.

Constraints: The name can contain lower case letters, numbers, periods (.), and hyphens (-).

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

Valid Values: A valid IP address.

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

Valid Values: A valid IP address.

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.

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

Valid Values: A valid IP address.

withNetworkInterfaceId

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

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

Valid Values: A valid IP address.

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