Amazonka.StorageGateway.CreateStorediSCSIVolume

Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type.

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

Creating a Request

data CreateStorediSCSIVolume

A JSON object containing one or more of the following fields:

• CreateStorediSCSIVolumeInput$DiskId
• CreateStorediSCSIVolumeInput$NetworkInterfaceId
• CreateStorediSCSIVolumeInput$PreserveExistingData
• CreateStorediSCSIVolumeInput$SnapshotId
• CreateStorediSCSIVolumeInput$TargetName

See: newCreateStorediSCSIVolume smart constructor.

Constructors

CreateStorediSCSIVolume'

Fields

• kmsEncrypted :: Maybe Bool

  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

• kmsKey :: Maybe Text

  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.

• snapshotId :: Maybe Text

  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.

• tags :: Maybe [Tag]

  A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair.

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

• gatewayARN :: Text
• diskId :: Text

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

• preserveExistingData :: Bool

  Set to true if you want to preserve the data on the local disk. Otherwise, set to false to create an empty volume.

  Valid Values: true | false

• targetName :: Text

  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.

• networkInterfaceId :: Text

  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.

Instances

ToJSON CreateStorediSCSIVolume

Defined in Amazonka.StorageGateway.CreateStorediSCSIVolume

Methods

toJSON :: CreateStorediSCSIVolume -> Value

toEncoding :: CreateStorediSCSIVolume -> Encoding

toJSONList :: [CreateStorediSCSIVolume] -> Value

toEncodingList :: [CreateStorediSCSIVolume] -> Encoding

ToHeaders CreateStorediSCSIVolume

Defined in Amazonka.StorageGateway.CreateStorediSCSIVolume

Methods

toHeaders :: CreateStorediSCSIVolume -> [Header]

ToPath CreateStorediSCSIVolume

Defined in Amazonka.StorageGateway.CreateStorediSCSIVolume

Methods

toPath :: CreateStorediSCSIVolume -> ByteString

ToQuery CreateStorediSCSIVolume

Defined in Amazonka.StorageGateway.CreateStorediSCSIVolume

Methods

toQuery :: CreateStorediSCSIVolume -> QueryString

AWSRequest CreateStorediSCSIVolume

Defined in Amazonka.StorageGateway.CreateStorediSCSIVolume

Associated Types

type AWSResponse CreateStorediSCSIVolume

Methods

request :: (Service -> Service) -> CreateStorediSCSIVolume -> Request CreateStorediSCSIVolume

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateStorediSCSIVolume -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateStorediSCSIVolume)))

Generic CreateStorediSCSIVolume

Defined in Amazonka.StorageGateway.CreateStorediSCSIVolume

Associated Types

type Rep CreateStorediSCSIVolume :: Type -> Type

Methods

from :: CreateStorediSCSIVolume -> Rep CreateStorediSCSIVolume x

to :: Rep CreateStorediSCSIVolume x -> CreateStorediSCSIVolume

Read CreateStorediSCSIVolume

Defined in Amazonka.StorageGateway.CreateStorediSCSIVolume

Methods

readsPrec :: Int -> ReadS CreateStorediSCSIVolume

readList :: ReadS [CreateStorediSCSIVolume]

readPrec :: ReadPrec CreateStorediSCSIVolume

readListPrec :: ReadPrec [CreateStorediSCSIVolume]

Show CreateStorediSCSIVolume

Defined in Amazonka.StorageGateway.CreateStorediSCSIVolume

Methods

showsPrec :: Int -> CreateStorediSCSIVolume -> ShowS

show :: CreateStorediSCSIVolume -> String

showList :: [CreateStorediSCSIVolume] -> ShowS

NFData CreateStorediSCSIVolume

Defined in Amazonka.StorageGateway.CreateStorediSCSIVolume

Methods

rnf :: CreateStorediSCSIVolume -> ()

Eq CreateStorediSCSIVolume

Defined in Amazonka.StorageGateway.CreateStorediSCSIVolume

Methods

(==) :: CreateStorediSCSIVolume -> CreateStorediSCSIVolume -> Bool

(/=) :: CreateStorediSCSIVolume -> CreateStorediSCSIVolume -> Bool

Hashable CreateStorediSCSIVolume

Defined in Amazonka.StorageGateway.CreateStorediSCSIVolume

Methods

hashWithSalt :: Int -> CreateStorediSCSIVolume -> Int

hash :: CreateStorediSCSIVolume -> Int

type AWSResponse CreateStorediSCSIVolume

Defined in Amazonka.StorageGateway.CreateStorediSCSIVolume

type AWSResponse CreateStorediSCSIVolume = CreateStorediSCSIVolumeResponse

type Rep CreateStorediSCSIVolume

Defined in Amazonka.StorageGateway.CreateStorediSCSIVolume

type Rep CreateStorediSCSIVolume = D1 ('MetaData "CreateStorediSCSIVolume" "Amazonka.StorageGateway.CreateStorediSCSIVolume" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "CreateStorediSCSIVolume'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "kmsEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "kmsKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "snapshotId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :*: ((S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "diskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "preserveExistingData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "targetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "networkInterfaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateStorediSCSIVolume

Arguments

:: Text

CreateStorediSCSIVolume

-> Text

CreateStorediSCSIVolume

-> Bool

$sel:preserveExistingData:CreateStorediSCSIVolume'

-> Text

CreateStorediSCSIVolume

-> Text

CreateStorediSCSIVolume

-> CreateStorediSCSIVolume

Create a value of CreateStorediSCSIVolume with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateStorediSCSIVolume, createStorediSCSIVolume_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

CreateStorediSCSIVolume, createStorediSCSIVolume_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.

$sel:snapshotId:CreateStorediSCSIVolume', createStorediSCSIVolume_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.

CreateStorediSCSIVolume, createStorediSCSIVolume_tags - A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair.

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

CreateStorediSCSIVolume, createStorediSCSIVolume_gatewayARN - Undocumented member.

CreateStorediSCSIVolume, createStorediSCSIVolume_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.

$sel:preserveExistingData:CreateStorediSCSIVolume', createStorediSCSIVolume_preserveExistingData - Set to true if you want to preserve the data on the local disk. Otherwise, set to false to create an empty volume.

Valid Values: true | false

CreateStorediSCSIVolume, createStorediSCSIVolume_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.

CreateStorediSCSIVolume, createStorediSCSIVolume_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.

Request Lenses

createStorediSCSIVolume_kmsEncrypted :: Lens' CreateStorediSCSIVolume (Maybe Bool)

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

createStorediSCSIVolume_kmsKey :: Lens' CreateStorediSCSIVolume (Maybe Text)

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.

createStorediSCSIVolume_snapshotId :: Lens' CreateStorediSCSIVolume (Maybe Text)

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.

createStorediSCSIVolume_tags :: Lens' CreateStorediSCSIVolume (Maybe [Tag])

A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair.

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

createStorediSCSIVolume_gatewayARN :: Lens' CreateStorediSCSIVolume Text

Undocumented member.

createStorediSCSIVolume_diskId :: Lens' CreateStorediSCSIVolume Text

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

createStorediSCSIVolume_preserveExistingData :: Lens' CreateStorediSCSIVolume Bool

Set to true if you want to preserve the data on the local disk. Otherwise, set to false to create an empty volume.

Valid Values: true | false

createStorediSCSIVolume_targetName :: Lens' CreateStorediSCSIVolume Text

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.

createStorediSCSIVolume_networkInterfaceId :: Lens' CreateStorediSCSIVolume Text

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.

Destructuring the Response

data CreateStorediSCSIVolumeResponse

A JSON object containing the following fields:

See: newCreateStorediSCSIVolumeResponse smart constructor.

Constructors

CreateStorediSCSIVolumeResponse'

Fields

• targetARN :: Maybe Text

  The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.

• volumeARN :: Maybe Text

  The Amazon Resource Name (ARN) of the configured volume.

• volumeSizeInBytes :: Maybe Integer

  The size of the volume in bytes.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateStorediSCSIVolumeResponse

Defined in Amazonka.StorageGateway.CreateStorediSCSIVolume

Associated Types

type Rep CreateStorediSCSIVolumeResponse :: Type -> Type

Methods

from :: CreateStorediSCSIVolumeResponse -> Rep CreateStorediSCSIVolumeResponse x

to :: Rep CreateStorediSCSIVolumeResponse x -> CreateStorediSCSIVolumeResponse

Read CreateStorediSCSIVolumeResponse

Defined in Amazonka.StorageGateway.CreateStorediSCSIVolume

Methods

readsPrec :: Int -> ReadS CreateStorediSCSIVolumeResponse

readList :: ReadS [CreateStorediSCSIVolumeResponse]

readPrec :: ReadPrec CreateStorediSCSIVolumeResponse

readListPrec :: ReadPrec [CreateStorediSCSIVolumeResponse]

Show CreateStorediSCSIVolumeResponse

Defined in Amazonka.StorageGateway.CreateStorediSCSIVolume

Methods

showsPrec :: Int -> CreateStorediSCSIVolumeResponse -> ShowS

show :: CreateStorediSCSIVolumeResponse -> String

showList :: [CreateStorediSCSIVolumeResponse] -> ShowS

NFData CreateStorediSCSIVolumeResponse

Defined in Amazonka.StorageGateway.CreateStorediSCSIVolume

Methods

rnf :: CreateStorediSCSIVolumeResponse -> ()

Eq CreateStorediSCSIVolumeResponse

Defined in Amazonka.StorageGateway.CreateStorediSCSIVolume

Methods

(==) :: CreateStorediSCSIVolumeResponse -> CreateStorediSCSIVolumeResponse -> Bool

(/=) :: CreateStorediSCSIVolumeResponse -> CreateStorediSCSIVolumeResponse -> Bool

type Rep CreateStorediSCSIVolumeResponse

Defined in Amazonka.StorageGateway.CreateStorediSCSIVolume

type Rep CreateStorediSCSIVolumeResponse = D1 ('MetaData "CreateStorediSCSIVolumeResponse" "Amazonka.StorageGateway.CreateStorediSCSIVolume" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "CreateStorediSCSIVolumeResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "targetARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "volumeARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "volumeSizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateStorediSCSIVolumeResponse

Arguments

:: Int

$sel:httpStatus:CreateStorediSCSIVolumeResponse'

-> CreateStorediSCSIVolumeResponse

Create a value of CreateStorediSCSIVolumeResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateStorediSCSIVolumeResponse, createStorediSCSIVolumeResponse_targetARN - The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.

CreateStorediSCSIVolumeResponse, createStorediSCSIVolumeResponse_volumeARN - The Amazon Resource Name (ARN) of the configured volume.

CreateStorediSCSIVolumeResponse, createStorediSCSIVolumeResponse_volumeSizeInBytes - The size of the volume in bytes.

$sel:httpStatus:CreateStorediSCSIVolumeResponse', createStorediSCSIVolumeResponse_httpStatus - The response's http status code.

Response Lenses

createStorediSCSIVolumeResponse_targetARN :: Lens' CreateStorediSCSIVolumeResponse (Maybe Text)

The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.

createStorediSCSIVolumeResponse_volumeARN :: Lens' CreateStorediSCSIVolumeResponse (Maybe Text)

The Amazon Resource Name (ARN) of the configured volume.

createStorediSCSIVolumeResponse_volumeSizeInBytes :: Lens' CreateStorediSCSIVolumeResponse (Maybe Integer)

The size of the volume in bytes.

createStorediSCSIVolumeResponse_httpStatus :: Lens' CreateStorediSCSIVolumeResponse Int

The response's http status code.