1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. fsx
  6. FileCache

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi

    Resource Type definition for AWS::FSx::FileCache

    Create FileCache Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new FileCache(name: string, args: FileCacheArgs, opts?: CustomResourceOptions);
    @overload
    def FileCache(resource_name: str,
                  args: FileCacheArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def FileCache(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  file_cache_type: Optional[FileCacheType] = None,
                  file_cache_type_version: Optional[str] = None,
                  storage_capacity: Optional[int] = None,
                  subnet_ids: Optional[Sequence[str]] = None,
                  copy_tags_to_data_repository_associations: Optional[bool] = None,
                  data_repository_associations: Optional[Sequence[FileCacheDataRepositoryAssociationArgs]] = None,
                  kms_key_id: Optional[str] = None,
                  lustre_configuration: Optional[FileCacheLustreConfigurationArgs] = None,
                  security_group_ids: Optional[Sequence[str]] = None,
                  tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewFileCache(ctx *Context, name string, args FileCacheArgs, opts ...ResourceOption) (*FileCache, error)
    public FileCache(string name, FileCacheArgs args, CustomResourceOptions? opts = null)
    public FileCache(String name, FileCacheArgs args)
    public FileCache(String name, FileCacheArgs args, CustomResourceOptions options)
    
    type: aws-native:fsx:FileCache
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_fsx_file_cache" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args FileCacheArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FileCacheArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FileCacheArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FileCacheArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FileCacheArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    FileCache Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The FileCache resource accepts the following input properties:

    FileCacheType Pulumi.AwsNative.FSx.FileCacheType
    The type of cache, which must be LUSTRE
    FileCacheTypeVersion string
    The Lustre version of the cache, which must be 2.12
    StorageCapacity int
    The storage capacity of the cache in gibibytes (GiB)
    SubnetIds List<string>
    A list of subnet IDs for the cache
    CopyTagsToDataRepositoryAssociations bool
    Whether tags should be copied to data repository associations
    DataRepositoryAssociations List<Pulumi.AwsNative.FSx.Inputs.FileCacheDataRepositoryAssociation>
    Data repository associations for the cache
    KmsKeyId string
    The KMS key ID for encrypting data
    LustreConfiguration Pulumi.AwsNative.FSx.Inputs.FileCacheLustreConfiguration
    The Lustre configuration for the file cache
    SecurityGroupIds List<string>
    A list of security group IDs for the cache
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Tags to associate with the file cache
    FileCacheType FileCacheType
    The type of cache, which must be LUSTRE
    FileCacheTypeVersion string
    The Lustre version of the cache, which must be 2.12
    StorageCapacity int
    The storage capacity of the cache in gibibytes (GiB)
    SubnetIds []string
    A list of subnet IDs for the cache
    CopyTagsToDataRepositoryAssociations bool
    Whether tags should be copied to data repository associations
    DataRepositoryAssociations []FileCacheDataRepositoryAssociationArgs
    Data repository associations for the cache
    KmsKeyId string
    The KMS key ID for encrypting data
    LustreConfiguration FileCacheLustreConfigurationArgs
    The Lustre configuration for the file cache
    SecurityGroupIds []string
    A list of security group IDs for the cache
    Tags TagArgs
    Tags to associate with the file cache
    file_cache_type "LUSTRE"
    The type of cache, which must be LUSTRE
    file_cache_type_version string
    The Lustre version of the cache, which must be 2.12
    storage_capacity number
    The storage capacity of the cache in gibibytes (GiB)
    subnet_ids list(string)
    A list of subnet IDs for the cache
    copy_tags_to_data_repository_associations bool
    Whether tags should be copied to data repository associations
    data_repository_associations list(object)
    Data repository associations for the cache
    kms_key_id string
    The KMS key ID for encrypting data
    lustre_configuration object
    The Lustre configuration for the file cache
    security_group_ids list(string)
    A list of security group IDs for the cache
    tags list(object)
    Tags to associate with the file cache
    fileCacheType FileCacheType
    The type of cache, which must be LUSTRE
    fileCacheTypeVersion String
    The Lustre version of the cache, which must be 2.12
    storageCapacity Integer
    The storage capacity of the cache in gibibytes (GiB)
    subnetIds List<String>
    A list of subnet IDs for the cache
    copyTagsToDataRepositoryAssociations Boolean
    Whether tags should be copied to data repository associations
    dataRepositoryAssociations List<FileCacheDataRepositoryAssociation>
    Data repository associations for the cache
    kmsKeyId String
    The KMS key ID for encrypting data
    lustreConfiguration FileCacheLustreConfiguration
    The Lustre configuration for the file cache
    securityGroupIds List<String>
    A list of security group IDs for the cache
    tags List<Tag>
    Tags to associate with the file cache
    fileCacheType FileCacheType
    The type of cache, which must be LUSTRE
    fileCacheTypeVersion string
    The Lustre version of the cache, which must be 2.12
    storageCapacity number
    The storage capacity of the cache in gibibytes (GiB)
    subnetIds string[]
    A list of subnet IDs for the cache
    copyTagsToDataRepositoryAssociations boolean
    Whether tags should be copied to data repository associations
    dataRepositoryAssociations FileCacheDataRepositoryAssociation[]
    Data repository associations for the cache
    kmsKeyId string
    The KMS key ID for encrypting data
    lustreConfiguration FileCacheLustreConfiguration
    The Lustre configuration for the file cache
    securityGroupIds string[]
    A list of security group IDs for the cache
    tags Tag[]
    Tags to associate with the file cache
    file_cache_type FileCacheType
    The type of cache, which must be LUSTRE
    file_cache_type_version str
    The Lustre version of the cache, which must be 2.12
    storage_capacity int
    The storage capacity of the cache in gibibytes (GiB)
    subnet_ids Sequence[str]
    A list of subnet IDs for the cache
    copy_tags_to_data_repository_associations bool
    Whether tags should be copied to data repository associations
    data_repository_associations Sequence[FileCacheDataRepositoryAssociationArgs]
    Data repository associations for the cache
    kms_key_id str
    The KMS key ID for encrypting data
    lustre_configuration FileCacheLustreConfigurationArgs
    The Lustre configuration for the file cache
    security_group_ids Sequence[str]
    A list of security group IDs for the cache
    tags Sequence[TagArgs]
    Tags to associate with the file cache
    fileCacheType "LUSTRE"
    The type of cache, which must be LUSTRE
    fileCacheTypeVersion String
    The Lustre version of the cache, which must be 2.12
    storageCapacity Number
    The storage capacity of the cache in gibibytes (GiB)
    subnetIds List<String>
    A list of subnet IDs for the cache
    copyTagsToDataRepositoryAssociations Boolean
    Whether tags should be copied to data repository associations
    dataRepositoryAssociations List<Property Map>
    Data repository associations for the cache
    kmsKeyId String
    The KMS key ID for encrypting data
    lustreConfiguration Property Map
    The Lustre configuration for the file cache
    securityGroupIds List<String>
    A list of security group IDs for the cache
    tags List<Property Map>
    Tags to associate with the file cache

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FileCache resource produces the following output properties:

    CreationTime string
    The time the cache was created
    DataRepositoryAssociationIds List<string>
    A list of IDs of data repository associations that are associated with this cache
    DnsName string
    The DNS name for the cache
    FileCacheId string
    The ID of the file cache
    Id string
    The provider-assigned unique ID for this managed resource.
    Lifecycle Pulumi.AwsNative.FSx.FileCacheLifecycle
    The lifecycle status of the cache
    NetworkInterfaceIds List<string>
    Network interface IDs for the cache
    OwnerId string
    The AWS account ID of the cache owner
    ResourceArn string
    The Amazon Resource Name (ARN) of the file cache
    VpcId string
    The VPC ID of the cache
    CreationTime string
    The time the cache was created
    DataRepositoryAssociationIds []string
    A list of IDs of data repository associations that are associated with this cache
    DnsName string
    The DNS name for the cache
    FileCacheId string
    The ID of the file cache
    Id string
    The provider-assigned unique ID for this managed resource.
    Lifecycle FileCacheLifecycle
    The lifecycle status of the cache
    NetworkInterfaceIds []string
    Network interface IDs for the cache
    OwnerId string
    The AWS account ID of the cache owner
    ResourceArn string
    The Amazon Resource Name (ARN) of the file cache
    VpcId string
    The VPC ID of the cache
    creation_time string
    The time the cache was created
    data_repository_association_ids list(string)
    A list of IDs of data repository associations that are associated with this cache
    dns_name string
    The DNS name for the cache
    file_cache_id string
    The ID of the file cache
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycle "AVAILABLE" | "CREATING" | "DELETING" | "UPDATING" | "FAILED"
    The lifecycle status of the cache
    network_interface_ids list(string)
    Network interface IDs for the cache
    owner_id string
    The AWS account ID of the cache owner
    resource_arn string
    The Amazon Resource Name (ARN) of the file cache
    vpc_id string
    The VPC ID of the cache
    creationTime String
    The time the cache was created
    dataRepositoryAssociationIds List<String>
    A list of IDs of data repository associations that are associated with this cache
    dnsName String
    The DNS name for the cache
    fileCacheId String
    The ID of the file cache
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycle FileCacheLifecycle
    The lifecycle status of the cache
    networkInterfaceIds List<String>
    Network interface IDs for the cache
    ownerId String
    The AWS account ID of the cache owner
    resourceArn String
    The Amazon Resource Name (ARN) of the file cache
    vpcId String
    The VPC ID of the cache
    creationTime string
    The time the cache was created
    dataRepositoryAssociationIds string[]
    A list of IDs of data repository associations that are associated with this cache
    dnsName string
    The DNS name for the cache
    fileCacheId string
    The ID of the file cache
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycle FileCacheLifecycle
    The lifecycle status of the cache
    networkInterfaceIds string[]
    Network interface IDs for the cache
    ownerId string
    The AWS account ID of the cache owner
    resourceArn string
    The Amazon Resource Name (ARN) of the file cache
    vpcId string
    The VPC ID of the cache
    creation_time str
    The time the cache was created
    data_repository_association_ids Sequence[str]
    A list of IDs of data repository associations that are associated with this cache
    dns_name str
    The DNS name for the cache
    file_cache_id str
    The ID of the file cache
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle FileCacheLifecycle
    The lifecycle status of the cache
    network_interface_ids Sequence[str]
    Network interface IDs for the cache
    owner_id str
    The AWS account ID of the cache owner
    resource_arn str
    The Amazon Resource Name (ARN) of the file cache
    vpc_id str
    The VPC ID of the cache
    creationTime String
    The time the cache was created
    dataRepositoryAssociationIds List<String>
    A list of IDs of data repository associations that are associated with this cache
    dnsName String
    The DNS name for the cache
    fileCacheId String
    The ID of the file cache
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycle "AVAILABLE" | "CREATING" | "DELETING" | "UPDATING" | "FAILED"
    The lifecycle status of the cache
    networkInterfaceIds List<String>
    Network interface IDs for the cache
    ownerId String
    The AWS account ID of the cache owner
    resourceArn String
    The Amazon Resource Name (ARN) of the file cache
    vpcId String
    The VPC ID of the cache

    Supporting Types

    FileCacheDataRepositoryAssociation, FileCacheDataRepositoryAssociationArgs

    FileCacheLifecycle, FileCacheLifecycleArgs

    Available
    AVAILABLE
    Creating
    CREATING
    Deleting
    DELETING
    Updating
    UPDATING
    Failed
    FAILED
    FileCacheLifecycleAvailable
    AVAILABLE
    FileCacheLifecycleCreating
    CREATING
    FileCacheLifecycleDeleting
    DELETING
    FileCacheLifecycleUpdating
    UPDATING
    FileCacheLifecycleFailed
    FAILED
    "AVAILABLE"
    AVAILABLE
    "CREATING"
    CREATING
    "DELETING"
    DELETING
    "UPDATING"
    UPDATING
    "FAILED"
    FAILED
    Available
    AVAILABLE
    Creating
    CREATING
    Deleting
    DELETING
    Updating
    UPDATING
    Failed
    FAILED
    Available
    AVAILABLE
    Creating
    CREATING
    Deleting
    DELETING
    Updating
    UPDATING
    Failed
    FAILED
    AVAILABLE
    AVAILABLE
    CREATING
    CREATING
    DELETING
    DELETING
    UPDATING
    UPDATING
    FAILED
    FAILED
    "AVAILABLE"
    AVAILABLE
    "CREATING"
    CREATING
    "DELETING"
    DELETING
    "UPDATING"
    UPDATING
    "FAILED"
    FAILED

    FileCacheLogConfiguration, FileCacheLogConfigurationArgs

    FileCacheLogConfigurationLevel, FileCacheLogConfigurationLevelArgs

    Disabled
    DISABLED
    WarnOnly
    WARN_ONLY
    ErrorOnly
    ERROR_ONLY
    WarnError
    WARN_ERROR
    FileCacheLogConfigurationLevelDisabled
    DISABLED
    FileCacheLogConfigurationLevelWarnOnly
    WARN_ONLY
    FileCacheLogConfigurationLevelErrorOnly
    ERROR_ONLY
    FileCacheLogConfigurationLevelWarnError
    WARN_ERROR
    "DISABLED"
    DISABLED
    "WARN_ONLY"
    WARN_ONLY
    "ERROR_ONLY"
    ERROR_ONLY
    "WARN_ERROR"
    WARN_ERROR
    Disabled
    DISABLED
    WarnOnly
    WARN_ONLY
    ErrorOnly
    ERROR_ONLY
    WarnError
    WARN_ERROR
    Disabled
    DISABLED
    WarnOnly
    WARN_ONLY
    ErrorOnly
    ERROR_ONLY
    WarnError
    WARN_ERROR
    DISABLED
    DISABLED
    WARN_ONLY
    WARN_ONLY
    ERROR_ONLY
    ERROR_ONLY
    WARN_ERROR
    WARN_ERROR
    "DISABLED"
    DISABLED
    "WARN_ONLY"
    WARN_ONLY
    "ERROR_ONLY"
    ERROR_ONLY
    "WARN_ERROR"
    WARN_ERROR

    FileCacheLustreConfiguration, FileCacheLustreConfigurationArgs

    FileCacheLustreConfigurationDeploymentType, FileCacheLustreConfigurationDeploymentTypeArgs

    Cache1
    CACHE_1
    FileCacheLustreConfigurationDeploymentTypeCache1
    CACHE_1
    "CACHE_1"
    CACHE_1
    Cache1
    CACHE_1
    Cache1
    CACHE_1
    CACHE1
    CACHE_1
    "CACHE_1"
    CACHE_1

    FileCacheMetadataConfiguration, FileCacheMetadataConfigurationArgs

    FileCacheType, FileCacheTypeArgs

    Lustre
    LUSTRE
    FileCacheTypeLustre
    LUSTRE
    "LUSTRE"
    LUSTRE
    Lustre
    LUSTRE
    Lustre
    LUSTRE
    LUSTRE
    LUSTRE
    "LUSTRE"
    LUSTRE

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.81.0
    published on Monday, Sep 28, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial