pub struct CreateFileCacheFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateFileCache
.
Creates a new Amazon File Cache resource.
You can use this operation with a client request token in the request that Amazon File Cache uses to ensure idempotent creation. If a cache with the specified client request token exists and the parameters match, CreateFileCache
returns the description of the existing cache. If a cache with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError
. If a file cache with the specified client request token doesn't exist, CreateFileCache
does the following:
-
Creates a new, empty Amazon File Cache resource with an assigned ID, and an initial lifecycle state of
CREATING
. -
Returns the description of the cache in JSON format.
The CreateFileCache
call returns while the cache's lifecycle state is still CREATING
. You can check the cache creation status by calling the DescribeFileCaches operation, which returns the cache state along with other information.
Implementations§
Source§impl CreateFileCacheFluentBuilder
impl CreateFileCacheFluentBuilder
Sourcepub fn as_input(&self) -> &CreateFileCacheInputBuilder
pub fn as_input(&self) -> &CreateFileCacheInputBuilder
Access the CreateFileCache as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateFileCacheOutput, SdkError<CreateFileCacheError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateFileCacheOutput, SdkError<CreateFileCacheError, HttpResponse>>
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 customize(
self,
) -> CustomizableOperation<CreateFileCacheOutput, CreateFileCacheError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateFileCacheOutput, CreateFileCacheError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn client_request_token(self, input: impl Into<String>) -> Self
pub fn client_request_token(self, input: impl Into<String>) -> Self
An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
By using the idempotent operation, you can retry a CreateFileCache
operation without the risk of creating an extra cache. This approach can be useful when an initial call fails in a way that makes it unclear whether a cache was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a cache, the client receives success as long as the parameters are the same.
Sourcepub fn set_client_request_token(self, input: Option<String>) -> Self
pub fn set_client_request_token(self, input: Option<String>) -> Self
An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
By using the idempotent operation, you can retry a CreateFileCache
operation without the risk of creating an extra cache. This approach can be useful when an initial call fails in a way that makes it unclear whether a cache was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a cache, the client receives success as long as the parameters are the same.
Sourcepub fn get_client_request_token(&self) -> &Option<String>
pub fn get_client_request_token(&self) -> &Option<String>
An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
By using the idempotent operation, you can retry a CreateFileCache
operation without the risk of creating an extra cache. This approach can be useful when an initial call fails in a way that makes it unclear whether a cache was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a cache, the client receives success as long as the parameters are the same.
Sourcepub fn file_cache_type(self, input: FileCacheType) -> Self
pub fn file_cache_type(self, input: FileCacheType) -> Self
The type of cache that you're creating, which must be LUSTRE
.
Sourcepub fn set_file_cache_type(self, input: Option<FileCacheType>) -> Self
pub fn set_file_cache_type(self, input: Option<FileCacheType>) -> Self
The type of cache that you're creating, which must be LUSTRE
.
Sourcepub fn get_file_cache_type(&self) -> &Option<FileCacheType>
pub fn get_file_cache_type(&self) -> &Option<FileCacheType>
The type of cache that you're creating, which must be LUSTRE
.
Sourcepub fn file_cache_type_version(self, input: impl Into<String>) -> Self
pub fn file_cache_type_version(self, input: impl Into<String>) -> Self
Sets the Lustre version for the cache that you're creating, which must be 2.12
.
Sourcepub fn set_file_cache_type_version(self, input: Option<String>) -> Self
pub fn set_file_cache_type_version(self, input: Option<String>) -> Self
Sets the Lustre version for the cache that you're creating, which must be 2.12
.
Sourcepub fn get_file_cache_type_version(&self) -> &Option<String>
pub fn get_file_cache_type_version(&self) -> &Option<String>
Sets the Lustre version for the cache that you're creating, which must be 2.12
.
Sourcepub fn storage_capacity(self, input: i32) -> Self
pub fn storage_capacity(self, input: i32) -> Self
The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
Sourcepub fn set_storage_capacity(self, input: Option<i32>) -> Self
pub fn set_storage_capacity(self, input: Option<i32>) -> Self
The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
Sourcepub fn get_storage_capacity(&self) -> &Option<i32>
pub fn get_storage_capacity(&self) -> &Option<i32>
The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
Sourcepub fn subnet_ids(self, input: impl Into<String>) -> Self
pub fn subnet_ids(self, input: impl Into<String>) -> Self
Appends an item to SubnetIds
.
To override the contents of this collection use set_subnet_ids
.
A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID in a call to the CreateFileCache
operation.
Sourcepub fn set_subnet_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_subnet_ids(self, input: Option<Vec<String>>) -> Self
A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID in a call to the CreateFileCache
operation.
Sourcepub fn get_subnet_ids(&self) -> &Option<Vec<String>>
pub fn get_subnet_ids(&self) -> &Option<Vec<String>>
A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID in a call to the CreateFileCache
operation.
Sourcepub fn security_group_ids(self, input: impl Into<String>) -> Self
pub fn security_group_ids(self, input: impl Into<String>) -> Self
Appends an item to SecurityGroupIds
.
To override the contents of this collection use set_security_group_ids
.
A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache.
Sourcepub fn set_security_group_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_security_group_ids(self, input: Option<Vec<String>>) -> Self
A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache.
Sourcepub fn get_security_group_ids(&self) -> &Option<Vec<String>>
pub fn get_security_group_ids(&self) -> &Option<Vec<String>>
A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache.
Appends an item to Tags
.
To override the contents of this collection use set_tags
.
A list of Tag
values, with a maximum of 50 elements.
A list of Tag
values, with a maximum of 50 elements.
A list of Tag
values, with a maximum of 50 elements.
A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
Sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId
isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.
Sourcepub fn set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId
isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.
Sourcepub fn get_kms_key_id(&self) -> &Option<String>
pub fn get_kms_key_id(&self) -> &Option<String>
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId
isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.
Sourcepub fn lustre_configuration(
self,
input: CreateFileCacheLustreConfiguration,
) -> Self
pub fn lustre_configuration( self, input: CreateFileCacheLustreConfiguration, ) -> Self
The configuration for the Amazon File Cache resource being created.
Sourcepub fn set_lustre_configuration(
self,
input: Option<CreateFileCacheLustreConfiguration>,
) -> Self
pub fn set_lustre_configuration( self, input: Option<CreateFileCacheLustreConfiguration>, ) -> Self
The configuration for the Amazon File Cache resource being created.
Sourcepub fn get_lustre_configuration(
&self,
) -> &Option<CreateFileCacheLustreConfiguration>
pub fn get_lustre_configuration( &self, ) -> &Option<CreateFileCacheLustreConfiguration>
The configuration for the Amazon File Cache resource being created.
Sourcepub fn data_repository_associations(
self,
input: FileCacheDataRepositoryAssociation,
) -> Self
pub fn data_repository_associations( self, input: FileCacheDataRepositoryAssociation, ) -> Self
Appends an item to DataRepositoryAssociations
.
To override the contents of this collection use set_data_repository_associations
.
A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.
The DRA configurations must meet the following requirements:
-
All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time.
-
An NFS DRA must link to an NFS file system that supports the NFSv3 protocol.
DRA automatic import and automatic export is not supported.
Sourcepub fn set_data_repository_associations(
self,
input: Option<Vec<FileCacheDataRepositoryAssociation>>,
) -> Self
pub fn set_data_repository_associations( self, input: Option<Vec<FileCacheDataRepositoryAssociation>>, ) -> Self
A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.
The DRA configurations must meet the following requirements:
-
All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time.
-
An NFS DRA must link to an NFS file system that supports the NFSv3 protocol.
DRA automatic import and automatic export is not supported.
Sourcepub fn get_data_repository_associations(
&self,
) -> &Option<Vec<FileCacheDataRepositoryAssociation>>
pub fn get_data_repository_associations( &self, ) -> &Option<Vec<FileCacheDataRepositoryAssociation>>
A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.
The DRA configurations must meet the following requirements:
-
All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time.
-
An NFS DRA must link to an NFS file system that supports the NFSv3 protocol.
DRA automatic import and automatic export is not supported.
Trait Implementations§
Source§impl Clone for CreateFileCacheFluentBuilder
impl Clone for CreateFileCacheFluentBuilder
Source§fn clone(&self) -> CreateFileCacheFluentBuilder
fn clone(&self) -> CreateFileCacheFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateFileCacheFluentBuilder
impl !RefUnwindSafe for CreateFileCacheFluentBuilder
impl Send for CreateFileCacheFluentBuilder
impl Sync for CreateFileCacheFluentBuilder
impl Unpin for CreateFileCacheFluentBuilder
impl !UnwindSafe for CreateFileCacheFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);