Class CreateFileCacheRequest
Container for the parameters to the CreateFileCache operation. 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.
note
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.
public class CreateFileCacheRequest : AmazonFSxRequest- Inheritance
-
CreateFileCacheRequest
Constructors
CreateFileCacheRequest()
public CreateFileCacheRequest()Properties
ClientRequestToken
Gets and sets the property ClientRequestToken.
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.
public string ClientRequestToken { get; set; }Property Value
CopyTagsToDataRepositoryAssociations
Gets and sets the property CopyTagsToDataRepositoryAssociations.
A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
public bool CopyTagsToDataRepositoryAssociations { get; set; }Property Value
DataRepositoryAssociations
Gets and sets the property DataRepositoryAssociations.
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.
public List<FileCacheDataRepositoryAssociation> DataRepositoryAssociations { get; set; }Property Value
FileCacheType
Gets and sets the property FileCacheType.
The type of cache that you're creating, which must be LUSTRE.
public FileCacheType FileCacheType { get; set; }Property Value
FileCacheTypeVersion
Gets and sets the property FileCacheTypeVersion.
Sets the Lustre version for the cache that you're creating, which must be 2.12.
public string FileCacheTypeVersion { get; set; }Property Value
KmsKeyId
Gets and sets the property KmsKeyId.
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.
public string KmsKeyId { get; set; }Property Value
LustreConfiguration
Gets and sets the property LustreConfiguration.
The configuration for the Amazon File Cache resource being created.
public CreateFileCacheLustreConfiguration LustreConfiguration { get; set; }Property Value
SecurityGroupIds
Gets and sets the property SecurityGroupIds.
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.
public List<string> SecurityGroupIds { get; set; }Property Value
StorageCapacity
Gets and sets the property StorageCapacity.
The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
public int StorageCapacity { get; set; }Property Value
SubnetIds
Gets and sets the property SubnetIds.
public List<string> SubnetIds { get; set; }Property Value
Tags
Gets and sets the property Tags.
public List<Tag> Tags { get; set; }