com.amazonaws.services.storagegateway.model

## クラス CreateStorediSCSIVolumeRequest

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

- すべての実装されたインタフェース:
    java.io.Serializable

      public class CreateStorediSCSIVolumeRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `CreateStorediSCSIVolume operation`.

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

  The size of the volume to create 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 Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

  関連項目:
    `AWSStorageGateway.createStorediSCSIVolume(CreateStorediSCSIVolumeRequest)`, 直列化された形式

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `CreateStorediSCSIVolumeRequest()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getDiskId()` The unique identifier for the gateway local disk that is configured as a stored volume.
    `java.lang.String` | `getGatewayARN()` The Amazon Resource Name (ARN) of the gateway.
    `java.lang.String` | `getNetworkInterfaceId()` The network interface of the gateway on which to expose the iSCSI target.
    `java.lang.Boolean` | `getPreserveExistingData()` Specify this field as true if you want to preserve the data on the local disk.
    `java.lang.String` | `getSnapshotId()` The snapshot ID (e.g.
    `java.lang.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()`
    `java.lang.Boolean` | `isPreserveExistingData()` Specify this field as true if you want to preserve the data on the local disk.
    `void` | `setDiskId(java.lang.String diskId)` The unique identifier for the gateway local disk that is configured as a stored volume.
    `void` | `setGatewayARN(java.lang.String gatewayARN)` The Amazon Resource Name (ARN) of the gateway.
    `void` | `setNetworkInterfaceId(java.lang.String networkInterfaceId)` The network interface of the gateway on which to expose the iSCSI target.
    `void` | `setPreserveExistingData(java.lang.Boolean preserveExistingData)` Specify this field as true if you want to preserve the data on the local disk.
    `void` | `setSnapshotId(java.lang.String snapshotId)` The snapshot ID (e.g.
    `void` | `setTargetName(java.lang.String targetName)` The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `CreateStorediSCSIVolumeRequest` | `withDiskId(java.lang.String diskId)` The unique identifier for the gateway local disk that is configured as a stored volume.
    `CreateStorediSCSIVolumeRequest` | `withGatewayARN(java.lang.String gatewayARN)` The Amazon Resource Name (ARN) of the gateway.
    `CreateStorediSCSIVolumeRequest` | `withNetworkInterfaceId(java.lang.String networkInterfaceId)` The network interface of the gateway on which to expose the iSCSI target.
    `CreateStorediSCSIVolumeRequest` | `withPreserveExistingData(java.lang.Boolean preserveExistingData)` Specify this field as true if you want to preserve the data on the local disk.
    `CreateStorediSCSIVolumeRequest` | `withSnapshotId(java.lang.String snapshotId)` The snapshot ID (e.g.
    `CreateStorediSCSIVolumeRequest` | `withTargetName(java.lang.String targetName)` The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

    - ### クラスから継承されたメソッド java.lang.Object

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

- - ### コンストラクタの詳細

    - #### CreateStorediSCSIVolumeRequest

          public CreateStorediSCSIVolumeRequest()

  - ### メソッドの詳細

    - #### getGatewayARN

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

      戻り値:
        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(java.lang.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

      パラメータ:
        `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(java.lang.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

      パラメータ:
        `gatewayARN` - The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

    - #### getDiskId

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

      戻り値:
        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(java.lang.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

      パラメータ:
        `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(java.lang.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

      パラメータ:
        `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.

    - #### getSnapshotId

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

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

      戻り値:
        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.

    - #### setSnapshotId

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

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

      パラメータ:
        `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.

    - #### withSnapshotId

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

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

      パラメータ:
        `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.

    - #### isPreserveExistingData

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

      戻り値:
        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(java.lang.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

      パラメータ:
        `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(java.lang.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.

      パラメータ:
        `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

    - #### getPreserveExistingData

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

      戻り値:
        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 java.lang.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]+$

      戻り値:
        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(java.lang.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]+$

      パラメータ:
        `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 CreateStorediSCSIVolumeRequest withTargetName(java.lang.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]+$

      パラメータ:
        `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.

    - #### getNetworkInterfaceId

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

      戻り値:
        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(java.lang.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

      パラメータ:
        `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(java.lang.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

      パラメータ:
        `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.

    - #### toString

          public java.lang.String toString()

      Returns a string representation of this object; useful for testing and debugging.
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        A string representation of this object.
      関連項目:
        `Object.toString()`

    - #### hashCode

          public int hashCode()

      オーバーライド:
        `hashCode` クラス内 `java.lang.Object`

    - #### equals

          public boolean equals(java.lang.Object obj)

      オーバーライド:
        `equals` クラス内 `java.lang.Object`