pub struct CreateStorediSCSIVolume { /* private fields */ }Expand description
Fluent builder constructing a request to 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.
Implementations
sourceimpl CreateStorediSCSIVolume
impl CreateStorediSCSIVolume
sourcepub async fn send(
self
) -> Result<CreateStorediScsiVolumeOutput, SdkError<CreateStorediSCSIVolumeError>>
pub async fn send(
self
) -> Result<CreateStorediScsiVolumeOutput, SdkError<CreateStorediSCSIVolumeError>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn gateway_arn(self, input: impl Into<String>) -> Self
pub fn gateway_arn(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_gateway_arn(self, input: Option<String>) -> Self
pub fn set_gateway_arn(self, input: Option<String>) -> Self
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.
sourcepub fn disk_id(self, input: impl Into<String>) -> Self
pub fn disk_id(self, input: impl Into<String>) -> Self
The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.
sourcepub fn set_disk_id(self, input: Option<String>) -> Self
pub fn set_disk_id(self, input: Option<String>) -> Self
The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.
sourcepub fn snapshot_id(self, input: impl Into<String>) -> Self
pub fn snapshot_id(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_snapshot_id(self, input: Option<String>) -> Self
pub fn set_snapshot_id(self, input: Option<String>) -> Self
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.
sourcepub fn preserve_existing_data(self, input: bool) -> Self
pub fn preserve_existing_data(self, input: bool) -> Self
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
sourcepub fn set_preserve_existing_data(self, input: Option<bool>) -> Self
pub fn set_preserve_existing_data(self, input: Option<bool>) -> Self
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
sourcepub fn target_name(self, input: impl Into<String>) -> Self
pub fn target_name(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_target_name(self, input: Option<String>) -> Self
pub fn set_target_name(self, input: Option<String>) -> Self
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.
sourcepub fn network_interface_id(self, input: impl Into<String>) -> Self
pub fn network_interface_id(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_network_interface_id(self, input: Option<String>) -> Self
pub fn set_network_interface_id(self, input: Option<String>) -> Self
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.
sourcepub fn kms_encrypted(self, input: bool) -> Self
pub fn kms_encrypted(self, input: bool) -> Self
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
sourcepub fn set_kms_encrypted(self, input: Option<bool>) -> Self
pub fn set_kms_encrypted(self, input: Option<bool>) -> Self
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
sourcepub fn kms_key(self, input: impl Into<String>) -> Self
pub fn kms_key(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_kms_key(self, input: Option<String>) -> Self
pub fn set_kms_key(self, input: Option<String>) -> Self
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.
Appends an item to Tags.
To override the contents of this collection use set_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.
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
sourceimpl Clone for CreateStorediSCSIVolume
impl Clone for CreateStorediSCSIVolume
sourcefn clone(&self) -> CreateStorediSCSIVolume
fn clone(&self) -> CreateStorediSCSIVolume
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
Auto Trait Implementations
impl !RefUnwindSafe for CreateStorediSCSIVolume
impl Send for CreateStorediSCSIVolume
impl Sync for CreateStorediSCSIVolume
impl Unpin for CreateStorediSCSIVolume
impl !UnwindSafe for CreateStorediSCSIVolume
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more