Skip to content

Create File Cache

fsx_create_file_cache R Documentation

Creates a new Amazon File Cache resource

Description

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, create_file_cache 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, create_file_cache 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 create_file_cache call returns while the cache's lifecycle state is still CREATING. You can check the cache creation status by calling the describe_file_caches operation, which returns the cache state along with other information.

Usage

fsx_create_file_cache(ClientRequestToken, FileCacheType,
  FileCacheTypeVersion, StorageCapacity, SubnetIds, SecurityGroupIds,
  Tags, CopyTagsToDataRepositoryAssociations, KmsKeyId,
  LustreConfiguration, DataRepositoryAssociations)

Arguments

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 create_file_cache 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.
FileCacheType

[required] The type of cache that you're creating, which must be LUSTRE.
FileCacheTypeVersion

[required] Sets the Lustre version for the cache that you're creating, which must be 2.12.
StorageCapacity

[required] The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
SubnetIds

[required]
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.
Tags
CopyTagsToDataRepositoryAssociations

A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
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.
LustreConfiguration

The configuration for the Amazon File Cache resource being created.
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.

Value

A list with the following syntax:

list(
  FileCache = list(
    OwnerId = "string",
    CreationTime = as.POSIXct(
      "2015-01-01"
    ),
    FileCacheId = "string",
    FileCacheType = "LUSTRE",
    FileCacheTypeVersion = "string",
    Lifecycle = "AVAILABLE"|"CREATING"|"DELETING"|"UPDATING"|"FAILED",
    FailureDetails = list(
      Message = "string"
    ),
    StorageCapacity = 123,
    VpcId = "string",
    SubnetIds = list(
      "string"
    ),
    NetworkInterfaceIds = list(
      "string"
    ),
    DNSName = "string",
    KmsKeyId = "string",
    ResourceARN = "string",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    CopyTagsToDataRepositoryAssociations = TRUE|FALSE,
    LustreConfiguration = list(
      PerUnitStorageThroughput = 123,
      DeploymentType = "CACHE_1",
      MountName = "string",
      WeeklyMaintenanceStartTime = "string",
      MetadataConfiguration = list(
        StorageCapacity = 123
      ),
      LogConfiguration = list(
        Level = "DISABLED"|"WARN_ONLY"|"ERROR_ONLY"|"WARN_ERROR",
        Destination = "string"
      )
    ),
    DataRepositoryAssociationIds = list(
      "string"
    )
  )
)

Request syntax

svc$create_file_cache(
  ClientRequestToken = "string",
  FileCacheType = "LUSTRE",
  FileCacheTypeVersion = "string",
  StorageCapacity = 123,
  SubnetIds = list(
    "string"
  ),
  SecurityGroupIds = list(
    "string"
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  CopyTagsToDataRepositoryAssociations = TRUE|FALSE,
  KmsKeyId = "string",
  LustreConfiguration = list(
    PerUnitStorageThroughput = 123,
    DeploymentType = "CACHE_1",
    WeeklyMaintenanceStartTime = "string",
    MetadataConfiguration = list(
      StorageCapacity = 123
    )
  ),
  DataRepositoryAssociations = list(
    list(
      FileCachePath = "string",
      DataRepositoryPath = "string",
      DataRepositorySubdirectories = list(
        "string"
      ),
      NFS = list(
        Version = "NFS3",
        DnsIps = list(
          "string"
        )
      )
    )
  )
)