Struct aws_sdk_storagegateway::input::CreateStorediScsiVolumeInput

#[non_exhaustive]
pub struct CreateStorediScsiVolumeInput {
    pub gateway_arn: Option<String>,
    pub disk_id: Option<String>,
    pub snapshot_id: Option<String>,
    pub preserve_existing_data: bool,
    pub target_name: Option<String>,
    pub network_interface_id: Option<String>,
    pub kms_encrypted: Option<bool>,
    pub kms_key: Option<String>,
    pub tags: Option<Vec<Tag>>,
}

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

• CreateStorediSCSIVolumeInput$DiskId

• CreateStorediSCSIVolumeInput$NetworkInterfaceId

• CreateStorediSCSIVolumeInput$PreserveExistingData

• CreateStorediSCSIVolumeInput$SnapshotId

• CreateStorediSCSIVolumeInput$TargetName

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

gateway_arn: Option<String>

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

disk_id: Option<String>

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

snapshot_id: Option<String>

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.

preserve_existing_data: 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

target_name: Option<String>

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.

network_interface_id: Option<String>

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.

kms_encrypted: Option<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

kms_key: Option<String>

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.

tags: Option<Vec<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.

Implementations

impl CreateStorediScsiVolumeInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<CreateStorediSCSIVolume, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<CreateStorediSCSIVolume>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateStorediScsiVolumeInput

impl CreateStorediScsiVolumeInput

pub fn gateway_arn(&self) -> Option<&str>

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

pub fn disk_id(&self) -> Option<&str>

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

pub fn snapshot_id(&self) -> Option<&str>

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.

pub fn preserve_existing_data(&self) -> 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

pub fn target_name(&self) -> Option<&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.

pub fn network_interface_id(&self) -> Option<&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.

pub fn kms_encrypted(&self) -> Option<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

pub fn kms_key(&self) -> Option<&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.

pub fn tags(&self) -> Option<&[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.

Trait Implementations

impl Clone for CreateStorediScsiVolumeInput

fn clone(&self) -> CreateStorediScsiVolumeInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateStorediScsiVolumeInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<CreateStorediScsiVolumeInput> for CreateStorediScsiVolumeInput

fn eq(&self, other: &CreateStorediScsiVolumeInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CreateStorediScsiVolumeInput) -> bool

This method tests for !=.

impl StructuralPartialEq for CreateStorediScsiVolumeInput