Struct aws_sdk_fsx::operation::create_file_cache::builders::CreateFileCacheFluentBuilder

pub struct CreateFileCacheFluentBuilder { /* private fields */ }

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 resourcewith 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

impl CreateFileCacheFluentBuilder

pub fn as_input(&self) -> &CreateFileCacheInputBuilder

Access the CreateFileCache as a reference.

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.

pub fn customize( self ) -> CustomizableOperation<CreateFileCacheOutput, CreateFileCacheError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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.

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.

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.

pub fn file_cache_type(self, input: FileCacheType) -> Self

The type of cache that you're creating, which must be LUSTRE.

pub fn set_file_cache_type(self, input: Option<FileCacheType>) -> Self

The type of cache that you're creating, which must be LUSTRE.

pub fn get_file_cache_type(&self) -> &Option<FileCacheType>

The type of cache that you're creating, which must be LUSTRE.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

pub fn tags(self, input: Tag) -> Self

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.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

A list of Tag values, with a maximum of 50 elements.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

A list of Tag values, with a maximum of 50 elements.

pub fn copy_tags_to_data_repository_associations(self, input: bool) -> Self

A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.

pub fn set_copy_tags_to_data_repository_associations( self, input: Option<bool> ) -> Self

A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.

pub fn get_copy_tags_to_data_repository_associations(&self) -> &Option<bool>

A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.

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.

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.

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.

pub fn lustre_configuration( self, input: CreateFileCacheLustreConfiguration ) -> Self

The configuration for the Amazon File Cache resource being created.

pub fn set_lustre_configuration( self, input: Option<CreateFileCacheLustreConfiguration> ) -> Self

The configuration for the Amazon File Cache resource being created.

pub fn get_lustre_configuration( &self ) -> &Option<CreateFileCacheLustreConfiguration>

The configuration for the Amazon File Cache resource being created.

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.

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.

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

impl Clone for CreateFileCacheFluentBuilder

fn clone(&self) -> CreateFileCacheFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateFileCacheFluentBuilder

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

Formats the value using the given formatter.