You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::StorageGateway::Types::CreateCachediSCSIVolumeInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb

Overview

Note:

When making an API call, you may pass CreateCachediSCSIVolumeInput data as a hash:

{
  gateway_arn: "GatewayARN", # required
  volume_size_in_bytes: 1, # required
  snapshot_id: "SnapshotId",
  target_name: "TargetName", # required
  source_volume_arn: "VolumeARN",
  network_interface_id: "NetworkInterfaceId", # required
  client_token: "ClientToken", # required
  kms_encrypted: false,
  kms_key: "KMSKey",
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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.

Returns:

  • (String)


597
598
599
600
601
602
603
604
605
606
607
608
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 597

class CreateCachediSCSIVolumeInput < Struct.new(
  :gateway_arn,
  :volume_size_in_bytes,
  :snapshot_id,
  :target_name,
  :source_volume_arn,
  :network_interface_id,
  :client_token,
  :kms_encrypted,
  :kms_key)
  include Aws::Structure
end

#gateway_arnString

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

Returns:

  • (String)


597
598
599
600
601
602
603
604
605
606
607
608
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 597

class CreateCachediSCSIVolumeInput < Struct.new(
  :gateway_arn,
  :volume_size_in_bytes,
  :snapshot_id,
  :target_name,
  :source_volume_arn,
  :network_interface_id,
  :client_token,
  :kms_encrypted,
  :kms_key)
  include Aws::Structure
end

#kms_encryptedBoolean

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.

Returns:

  • (Boolean)


597
598
599
600
601
602
603
604
605
606
607
608
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 597

class CreateCachediSCSIVolumeInput < Struct.new(
  :gateway_arn,
  :volume_size_in_bytes,
  :snapshot_id,
  :target_name,
  :source_volume_arn,
  :network_interface_id,
  :client_token,
  :kms_encrypted,
  :kms_key)
  include Aws::Structure
end

#kms_keyString

The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

Returns:

  • (String)


597
598
599
600
601
602
603
604
605
606
607
608
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 597

class CreateCachediSCSIVolumeInput < Struct.new(
  :gateway_arn,
  :volume_size_in_bytes,
  :snapshot_id,
  :target_name,
  :source_volume_arn,
  :network_interface_id,
  :client_token,
  :kms_encrypted,
  :kms_key)
  include Aws::Structure
end

#network_interface_idString

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:

  • (String)


597
598
599
600
601
602
603
604
605
606
607
608
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 597

class CreateCachediSCSIVolumeInput < Struct.new(
  :gateway_arn,
  :volume_size_in_bytes,
  :snapshot_id,
  :target_name,
  :source_volume_arn,
  :network_interface_id,
  :client_token,
  :kms_encrypted,
  :kms_key)
  include Aws::Structure
end

#snapshot_idString

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 in the Amazon Elastic Compute Cloud API Reference.

Returns:

  • (String)


597
598
599
600
601
602
603
604
605
606
607
608
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 597

class CreateCachediSCSIVolumeInput < Struct.new(
  :gateway_arn,
  :volume_size_in_bytes,
  :snapshot_id,
  :target_name,
  :source_volume_arn,
  :network_interface_id,
  :client_token,
  :kms_encrypted,
  :kms_key)
  include Aws::Structure
end

#source_volume_arnString

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.

Returns:

  • (String)


597
598
599
600
601
602
603
604
605
606
607
608
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 597

class CreateCachediSCSIVolumeInput < Struct.new(
  :gateway_arn,
  :volume_size_in_bytes,
  :snapshot_id,
  :target_name,
  :source_volume_arn,
  :network_interface_id,
  :client_token,
  :kms_encrypted,
  :kms_key)
  include Aws::Structure
end

#target_nameString

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

Returns:

  • (String)


597
598
599
600
601
602
603
604
605
606
607
608
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 597

class CreateCachediSCSIVolumeInput < Struct.new(
  :gateway_arn,
  :volume_size_in_bytes,
  :snapshot_id,
  :target_name,
  :source_volume_arn,
  :network_interface_id,
  :client_token,
  :kms_encrypted,
  :kms_key)
  include Aws::Structure
end

#volume_size_in_bytesInteger

The size of the volume in bytes.

Returns:

  • (Integer)


597
598
599
600
601
602
603
604
605
606
607
608
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 597

class CreateCachediSCSIVolumeInput < Struct.new(
  :gateway_arn,
  :volume_size_in_bytes,
  :snapshot_id,
  :target_name,
  :source_volume_arn,
  :network_interface_id,
  :client_token,
  :kms_encrypted,
  :kms_key)
  include Aws::Structure
end