NAME

Paws::StorageGateway::CreateCachediSCSIVolume - Arguments for method CreateCachediSCSIVolume on Paws::StorageGateway

DESCRIPTION

This class represents the parameters used for calling the method CreateCachediSCSIVolume on the AWS Storage Gateway service. Use the attributes of this class as arguments to method CreateCachediSCSIVolume.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateCachediSCSIVolume.

SYNOPSIS

    my $storagegateway = Paws->service('StorageGateway');
    # To create a cached iSCSI volume
    # Creates a cached volume on a specified cached gateway.
    my $CreateCachediSCSIVolumeOutput =
      $storagegateway->CreateCachediSCSIVolume(
      'ClientToken' => 'cachedvol112233',
      'GatewayARN'  =>
        'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
      'NetworkInterfaceId' => '10.1.1.1',
      'SnapshotId'         => 'snap-f47b7b94',
      'TargetName'         => 'my-volume',
      'VolumeSizeInBytes'  => 536870912000
      );
    # Results:
    my $TargetARN = $CreateCachediSCSIVolumeOutput->TargetARN;
    my $VolumeARN = $CreateCachediSCSIVolumeOutput->VolumeARN;
    # Returns a L<Paws::StorageGateway::CreateCachediSCSIVolumeOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/storagegateway/CreateCachediSCSIVolume>

ATTRIBUTES

REQUIRED ClientToken => Str

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.

REQUIRED GatewayARN => Str

KMSEncrypted => Bool

Set to "true" to use Amazon S3 server-side encryption with your own AWS KMS key, or "false" to use a key managed by Amazon S3. Optional.

Valid Values: "true" | "false"

KMSKey => Str

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.

REQUIRED NetworkInterfaceId => Str

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.

SnapshotId => Str

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 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html) in the Amazon Elastic Compute Cloud API Reference.

SourceVolumeARN => Str

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.

Tags => ArrayRef[Paws::StorageGateway::Tag]

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.

REQUIRED TargetName => Str

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.

REQUIRED VolumeSizeInBytes => Int

The size of the volume in bytes.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>