Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. fsx
  6. FileCache
Viewing docs for AWS v7.46.0
published on Thursday, Sep 10, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.fsx.FileCache

aws logo aws logo
Viewing docs for AWS v7.46.0
published on Thursday, Sep 10, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Resource for managing an Amazon File Cache cache. See the Create File Cache for more information.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.fsx.FileCache("example", {
    dataRepositoryAssociations: [{
        nfs: [{
            dnsIps: [
                "192.168.0.1",
                "192.168.0.2",
            ],
            version: "NFS3",
        }],
        dataRepositoryPath: "nfs://filer.domain.com",
        dataRepositorySubdirectories: [
            "test",
            "test2",
        ],
        fileCachePath: "/ns1",
    }],
    lustreConfigurations: [{
        metadataConfigurations: [{
            storageCapacity: 2400,
        }],
        deploymentType: "CACHE_1",
        perUnitStorageThroughput: 1000,
        weeklyMaintenanceStartTime: "2:05:00",
    }],
    fileCacheType: "LUSTRE",
    fileCacheTypeVersion: "2.12",
    subnetIds: [test1.id],
    storageCapacity: 1200,
});

    import pulumi
import pulumi_aws as aws

example = aws.fsx.FileCache("example",
    data_repository_associations=[{
        "nfs": [{
            "dns_ips": [
                "192.168.0.1",
                "192.168.0.2",
            ],
            "version": "NFS3",
        }],
        "data_repository_path": "nfs://filer.domain.com",
        "data_repository_subdirectories": [
            "test",
            "test2",
        ],
        "file_cache_path": "/ns1",
    }],
    lustre_configurations=[{
        "metadata_configurations": [{
            "storage_capacity": 2400,
        }],
        "deployment_type": "CACHE_1",
        "per_unit_storage_throughput": 1000,
        "weekly_maintenance_start_time": "2:05:00",
    }],
    file_cache_type="LUSTRE",
    file_cache_type_version="2.12",
    subnet_ids=[test1["id"]],
    storage_capacity=1200)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/fsx"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fsx.NewFileCache(ctx, "example", &fsx.FileCacheArgs{
			DataRepositoryAssociations: fsx.FileCacheDataRepositoryAssociationArray{
				&fsx.FileCacheDataRepositoryAssociationArgs{
					Nfs: fsx.FileCacheDataRepositoryAssociationNfArray{
						&fsx.FileCacheDataRepositoryAssociationNfArgs{
							DnsIps: pulumi.StringArray{
								pulumi.String("192.168.0.1"),
								pulumi.String("192.168.0.2"),
							},
							Version: pulumi.String("NFS3"),
						},
					},
					DataRepositoryPath: pulumi.String("nfs://filer.domain.com"),
					DataRepositorySubdirectories: pulumi.StringArray{
						pulumi.String("test"),
						pulumi.String("test2"),
					},
					FileCachePath: pulumi.String("/ns1"),
				},
			},
			LustreConfigurations: fsx.FileCacheLustreConfigurationArray{
				&fsx.FileCacheLustreConfigurationArgs{
					MetadataConfigurations: fsx.FileCacheLustreConfigurationMetadataConfigurationArray{
						&fsx.FileCacheLustreConfigurationMetadataConfigurationArgs{
							StorageCapacity: pulumi.Int(2400),
						},
					},
					DeploymentType:             pulumi.String("CACHE_1"),
					PerUnitStorageThroughput:   pulumi.Int(1000),
					WeeklyMaintenanceStartTime: pulumi.String("2:05:00"),
				},
			},
			FileCacheType:        pulumi.String("LUSTRE"),
			FileCacheTypeVersion: pulumi.String("2.12"),
			SubnetIds: pulumi.StringArray{
				test1.Id,
			},
			StorageCapacity: pulumi.Int(1200),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Fsx.FileCache("example", new()
    {
        DataRepositoryAssociations = new[]
        {
            new Aws.Fsx.Inputs.FileCacheDataRepositoryAssociationArgs
            {
                Nfs = new[]
                {
                    new Aws.Fsx.Inputs.FileCacheDataRepositoryAssociationNfArgs
                    {
                        DnsIps = new[]
                        {
                            "192.168.0.1",
                            "192.168.0.2",
                        },
                        Version = "NFS3",
                    },
                },
                DataRepositoryPath = "nfs://filer.domain.com",
                DataRepositorySubdirectories = new[]
                {
                    "test",
                    "test2",
                },
                FileCachePath = "/ns1",
            },
        },
        LustreConfigurations = new[]
        {
            new Aws.Fsx.Inputs.FileCacheLustreConfigurationArgs
            {
                MetadataConfigurations = new[]
                {
                    new Aws.Fsx.Inputs.FileCacheLustreConfigurationMetadataConfigurationArgs
                    {
                        StorageCapacity = 2400,
                    },
                },
                DeploymentType = "CACHE_1",
                PerUnitStorageThroughput = 1000,
                WeeklyMaintenanceStartTime = "2:05:00",
            },
        },
        FileCacheType = "LUSTRE",
        FileCacheTypeVersion = "2.12",
        SubnetIds = new[]
        {
            test1.Id,
        },
        StorageCapacity = 1200,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.fsx.FileCache;
import com.pulumi.aws.fsx.FileCacheArgs;
import com.pulumi.aws.fsx.inputs.FileCacheDataRepositoryAssociationArgs;
import com.pulumi.aws.fsx.inputs.FileCacheDataRepositoryAssociationNfArgs;
import com.pulumi.aws.fsx.inputs.FileCacheLustreConfigurationArgs;
import com.pulumi.aws.fsx.inputs.FileCacheLustreConfigurationMetadataConfigurationArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new FileCache("example", FileCacheArgs.builder()
            .dataRepositoryAssociations(FileCacheDataRepositoryAssociationArgs.builder()
                .nfs(FileCacheDataRepositoryAssociationNfArgs.builder()
                    .dnsIps(                    
                        "192.168.0.1",
                        "192.168.0.2")
                    .version("NFS3")
                    .build())
                .dataRepositoryPath("nfs://filer.domain.com")
                .dataRepositorySubdirectories(                
                    "test",
                    "test2")
                .fileCachePath("/ns1")
                .build())
            .lustreConfigurations(FileCacheLustreConfigurationArgs.builder()
                .metadataConfigurations(FileCacheLustreConfigurationMetadataConfigurationArgs.builder()
                    .storageCapacity(2400)
                    .build())
                .deploymentType("CACHE_1")
                .perUnitStorageThroughput(1000)
                .weeklyMaintenanceStartTime("2:05:00")
                .build())
            .fileCacheType("LUSTRE")
            .fileCacheTypeVersion("2.12")
            .subnetIds(test1.id())
            .storageCapacity(1200)
            .build());

    }
}

    resources:
  example:
    type: aws:fsx:FileCache
    properties:
      dataRepositoryAssociations:
        - nfs:
            - dnsIps:
                - 192.168.0.1
                - 192.168.0.2
              version: NFS3
          dataRepositoryPath: nfs://filer.domain.com
          dataRepositorySubdirectories:
            - test
            - test2
          fileCachePath: /ns1
      lustreConfigurations:
        - metadataConfigurations:
            - storageCapacity: 2400
          deploymentType: CACHE_1
          perUnitStorageThroughput: 1000
          weeklyMaintenanceStartTime: 2:05:00
      fileCacheType: LUSTRE
      fileCacheTypeVersion: '2.12'
      subnetIds:
        - ${test1.id}
      storageCapacity: 1200

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_fsx_filecache" "example" {
  data_repository_associations {
    nfs {
      dns_ips = ["192.168.0.1", "192.168.0.2"]
      version = "NFS3"
    }
    data_repository_path           = "nfs://filer.domain.com"
    data_repository_subdirectories = ["test", "test2"]
    file_cache_path                = "/ns1"
  }
  lustre_configurations {
    metadata_configurations {
      storage_capacity = 2400
    }
    deployment_type               = "CACHE_1"
    per_unit_storage_throughput   = 1000
    weekly_maintenance_start_time = "2:05:00"
  }
  file_cache_type         = "LUSTRE"
  file_cache_type_version = "2.12"
  subnet_ids              = [test1.id]
  storage_capacity        = 1200
}

    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[str] = 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_configurations: Optional[Sequence[FileCacheLustreConfigurationArgs]] = None,
              region: Optional[str] = None,
              security_group_ids: Optional[Sequence[str]] = None,
              tags: Optional[Mapping[str, str]] = 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:fsx:FileCache
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws_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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var fileCacheResource = new Aws.Fsx.FileCache("fileCacheResource", new()
{
    FileCacheType = "string",
    FileCacheTypeVersion = "string",
    StorageCapacity = 0,
    SubnetIds = new[]
    {
        "string",
    },
    CopyTagsToDataRepositoryAssociations = false,
    DataRepositoryAssociations = new[]
    {
        new Aws.Fsx.Inputs.FileCacheDataRepositoryAssociationArgs
        {
            DataRepositoryPath = "string",
            FileCachePath = "string",
            AssociationId = "string",
            DataRepositorySubdirectories = new[]
            {
                "string",
            },
            FileCacheId = "string",
            FileSystemId = "string",
            FileSystemPath = "string",
            ImportedFileChunkSize = 0,
            Nfs = new[]
            {
                new Aws.Fsx.Inputs.FileCacheDataRepositoryAssociationNfArgs
                {
                    Version = "string",
                    DnsIps = new[]
                    {
                        "string",
                    },
                },
            },
            ResourceArn = "string",
            Tags = 
            {
                { "string", "string" },
            },
        },
    },
    KmsKeyId = "string",
    LustreConfigurations = new[]
    {
        new Aws.Fsx.Inputs.FileCacheLustreConfigurationArgs
        {
            DeploymentType = "string",
            MetadataConfigurations = new[]
            {
                new Aws.Fsx.Inputs.FileCacheLustreConfigurationMetadataConfigurationArgs
                {
                    StorageCapacity = 0,
                },
            },
            PerUnitStorageThroughput = 0,
            LogConfigurations = new[]
            {
                new Aws.Fsx.Inputs.FileCacheLustreConfigurationLogConfigurationArgs
                {
                    Destination = "string",
                    Level = "string",
                },
            },
            MountName = "string",
            WeeklyMaintenanceStartTime = "string",
        },
    },
    Region = "string",
    SecurityGroupIds = new[]
    {
        "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := fsx.NewFileCache(ctx, "fileCacheResource", &fsx.FileCacheArgs{
	FileCacheType:        pulumi.String("string"),
	FileCacheTypeVersion: pulumi.String("string"),
	StorageCapacity:      pulumi.Int(0),
	SubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	CopyTagsToDataRepositoryAssociations: pulumi.Bool(false),
	DataRepositoryAssociations: fsx.FileCacheDataRepositoryAssociationArray{
		&fsx.FileCacheDataRepositoryAssociationArgs{
			DataRepositoryPath: pulumi.String("string"),
			FileCachePath:      pulumi.String("string"),
			AssociationId:      pulumi.String("string"),
			DataRepositorySubdirectories: pulumi.StringArray{
				pulumi.String("string"),
			},
			FileCacheId:           pulumi.String("string"),
			FileSystemId:          pulumi.String("string"),
			FileSystemPath:        pulumi.String("string"),
			ImportedFileChunkSize: pulumi.Int(0),
			Nfs: fsx.FileCacheDataRepositoryAssociationNfArray{
				&fsx.FileCacheDataRepositoryAssociationNfArgs{
					Version: pulumi.String("string"),
					DnsIps: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
			ResourceArn: pulumi.String("string"),
			Tags: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
		},
	},
	KmsKeyId: pulumi.String("string"),
	LustreConfigurations: fsx.FileCacheLustreConfigurationArray{
		&fsx.FileCacheLustreConfigurationArgs{
			DeploymentType: pulumi.String("string"),
			MetadataConfigurations: fsx.FileCacheLustreConfigurationMetadataConfigurationArray{
				&fsx.FileCacheLustreConfigurationMetadataConfigurationArgs{
					StorageCapacity: pulumi.Int(0),
				},
			},
			PerUnitStorageThroughput: pulumi.Int(0),
			LogConfigurations: fsx.FileCacheLustreConfigurationLogConfigurationArray{
				&fsx.FileCacheLustreConfigurationLogConfigurationArgs{
					Destination: pulumi.String("string"),
					Level:       pulumi.String("string"),
				},
			},
			MountName:                  pulumi.String("string"),
			WeeklyMaintenanceStartTime: pulumi.String("string"),
		},
	},
	Region: pulumi.String("string"),
	SecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    resource "aws_fsx_file_cache" "fileCacheResource" {
  lifecycle {
    create_before_destroy = true
  }
  file_cache_type                           = "string"
  file_cache_type_version                   = "string"
  storage_capacity                          = 0
  subnet_ids                                = ["string"]
  copy_tags_to_data_repository_associations = false
  data_repository_associations {
    data_repository_path           = "string"
    file_cache_path                = "string"
    association_id                 = "string"
    data_repository_subdirectories = ["string"]
    file_cache_id                  = "string"
    file_system_id                 = "string"
    file_system_path               = "string"
    imported_file_chunk_size       = 0
    nfs {
      version = "string"
      dns_ips = ["string"]
    }
    resource_arn = "string"
    tags = {
      "string" = "string"
    }
  }
  kms_key_id = "string"
  lustre_configurations {
    deployment_type = "string"
    metadata_configurations {
      storage_capacity = 0
    }
    per_unit_storage_throughput = 0
    log_configurations {
      destination = "string"
      level       = "string"
    }
    mount_name                    = "string"
    weekly_maintenance_start_time = "string"
  }
  region             = "string"
  security_group_ids = ["string"]
  tags = {
    "string" = "string"
  }
}

    var fileCacheResource = new FileCache("fileCacheResource", FileCacheArgs.builder()
    .fileCacheType("string")
    .fileCacheTypeVersion("string")
    .storageCapacity(0)
    .subnetIds("string")
    .copyTagsToDataRepositoryAssociations(false)
    .dataRepositoryAssociations(FileCacheDataRepositoryAssociationArgs.builder()
        .dataRepositoryPath("string")
        .fileCachePath("string")
        .associationId("string")
        .dataRepositorySubdirectories("string")
        .fileCacheId("string")
        .fileSystemId("string")
        .fileSystemPath("string")
        .importedFileChunkSize(0)
        .nfs(FileCacheDataRepositoryAssociationNfArgs.builder()
            .version("string")
            .dnsIps("string")
            .build())
        .resourceArn("string")
        .tags(Map.of("string", "string"))
        .build())
    .kmsKeyId("string")
    .lustreConfigurations(FileCacheLustreConfigurationArgs.builder()
        .deploymentType("string")
        .metadataConfigurations(FileCacheLustreConfigurationMetadataConfigurationArgs.builder()
            .storageCapacity(0)
            .build())
        .perUnitStorageThroughput(0)
        .logConfigurations(FileCacheLustreConfigurationLogConfigurationArgs.builder()
            .destination("string")
            .level("string")
            .build())
        .mountName("string")
        .weeklyMaintenanceStartTime("string")
        .build())
    .region("string")
    .securityGroupIds("string")
    .tags(Map.of("string", "string"))
    .build());

    file_cache_resource = aws.fsx.FileCache("fileCacheResource",
    file_cache_type="string",
    file_cache_type_version="string",
    storage_capacity=0,
    subnet_ids=["string"],
    copy_tags_to_data_repository_associations=False,
    data_repository_associations=[{
        "data_repository_path": "string",
        "file_cache_path": "string",
        "association_id": "string",
        "data_repository_subdirectories": ["string"],
        "file_cache_id": "string",
        "file_system_id": "string",
        "file_system_path": "string",
        "imported_file_chunk_size": 0,
        "nfs": [{
            "version": "string",
            "dns_ips": ["string"],
        }],
        "resource_arn": "string",
        "tags": {
            "string": "string",
        },
    }],
    kms_key_id="string",
    lustre_configurations=[{
        "deployment_type": "string",
        "metadata_configurations": [{
            "storage_capacity": 0,
        }],
        "per_unit_storage_throughput": 0,
        "log_configurations": [{
            "destination": "string",
            "level": "string",
        }],
        "mount_name": "string",
        "weekly_maintenance_start_time": "string",
    }],
    region="string",
    security_group_ids=["string"],
    tags={
        "string": "string",
    })

    const fileCacheResource = new aws.fsx.FileCache("fileCacheResource", {
    fileCacheType: "string",
    fileCacheTypeVersion: "string",
    storageCapacity: 0,
    subnetIds: ["string"],
    copyTagsToDataRepositoryAssociations: false,
    dataRepositoryAssociations: [{
        dataRepositoryPath: "string",
        fileCachePath: "string",
        associationId: "string",
        dataRepositorySubdirectories: ["string"],
        fileCacheId: "string",
        fileSystemId: "string",
        fileSystemPath: "string",
        importedFileChunkSize: 0,
        nfs: [{
            version: "string",
            dnsIps: ["string"],
        }],
        resourceArn: "string",
        tags: {
            string: "string",
        },
    }],
    kmsKeyId: "string",
    lustreConfigurations: [{
        deploymentType: "string",
        metadataConfigurations: [{
            storageCapacity: 0,
        }],
        perUnitStorageThroughput: 0,
        logConfigurations: [{
            destination: "string",
            level: "string",
        }],
        mountName: "string",
        weeklyMaintenanceStartTime: "string",
    }],
    region: "string",
    securityGroupIds: ["string"],
    tags: {
        string: "string",
    },
});

    type: aws:fsx:FileCache
properties:
    copyTagsToDataRepositoryAssociations: false
    dataRepositoryAssociations:
        - associationId: string
          dataRepositoryPath: string
          dataRepositorySubdirectories:
            - string
          fileCacheId: string
          fileCachePath: string
          fileSystemId: string
          fileSystemPath: string
          importedFileChunkSize: 0
          nfs:
            - dnsIps:
                - string
              version: string
          resourceArn: string
          tags:
            string: string
    fileCacheType: string
    fileCacheTypeVersion: string
    kmsKeyId: string
    lustreConfigurations:
        - deploymentType: string
          logConfigurations:
            - destination: string
              level: string
          metadataConfigurations:
            - storageCapacity: 0
          mountName: string
          perUnitStorageThroughput: 0
          weeklyMaintenanceStartTime: string
    region: string
    securityGroupIds:
        - string
    storageCapacity: 0
    subnetIds:
        - string
    tags:
        string: string

    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 string
    Type of cache to create. The only supported value is LUSTRE.
    FileCacheTypeVersion string
    Version for the type of cache to create. The only supported value is 2.12.
    StorageCapacity int
    Storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    SubnetIds List<string>
    Subnet IDs that the cache is accessible from. You can specify only one subnet ID.
    CopyTagsToDataRepositoryAssociations bool
    Whether to copy tags for the cache to data repository associations. Defaults to false.
    DataRepositoryAssociations List<FileCacheDataRepositoryAssociation>
    Configurations for up to 8 data repository associations (DRAs) to create during cache creation. All configurations must be of the same data repository type, either all S3 or all NFS. Maximum of 8. See dataRepositoryAssociation Block below.
    KmsKeyId string
    ID of the KMS key to use for encrypting data on the cache. Defaults to the Amazon FSx-managed KMS key for your account.
    LustreConfigurations List<FileCacheLustreConfiguration>
    Configuration for the Lustre cache. Required when fileCacheType is LUSTRE. See lustreConfiguration Block below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SecurityGroupIds List<string>
    IDs of the security groups to apply to all network interfaces created for cache access.
    Tags Dictionary<string, string>
    Map of tags to assign to the file cache. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    FileCacheType string
    Type of cache to create. The only supported value is LUSTRE.
    FileCacheTypeVersion string
    Version for the type of cache to create. The only supported value is 2.12.
    StorageCapacity int
    Storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    SubnetIds []string
    Subnet IDs that the cache is accessible from. You can specify only one subnet ID.
    CopyTagsToDataRepositoryAssociations bool
    Whether to copy tags for the cache to data repository associations. Defaults to false.
    DataRepositoryAssociations []FileCacheDataRepositoryAssociationArgs
    Configurations for up to 8 data repository associations (DRAs) to create during cache creation. All configurations must be of the same data repository type, either all S3 or all NFS. Maximum of 8. See dataRepositoryAssociation Block below.
    KmsKeyId string
    ID of the KMS key to use for encrypting data on the cache. Defaults to the Amazon FSx-managed KMS key for your account.
    LustreConfigurations []FileCacheLustreConfigurationArgs
    Configuration for the Lustre cache. Required when fileCacheType is LUSTRE. See lustreConfiguration Block below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SecurityGroupIds []string
    IDs of the security groups to apply to all network interfaces created for cache access.
    Tags map[string]string
    Map of tags to assign to the file cache. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    file_cache_type string
    Type of cache to create. The only supported value is LUSTRE.
    file_cache_type_version string
    Version for the type of cache to create. The only supported value is 2.12.
    storage_capacity number
    Storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    subnet_ids list(string)
    Subnet IDs that the cache is accessible from. You can specify only one subnet ID.
    copy_tags_to_data_repository_associations bool
    Whether to copy tags for the cache to data repository associations. Defaults to false.
    data_repository_associations list(object)
    Configurations for up to 8 data repository associations (DRAs) to create during cache creation. All configurations must be of the same data repository type, either all S3 or all NFS. Maximum of 8. See dataRepositoryAssociation Block below.
    kms_key_id string
    ID of the KMS key to use for encrypting data on the cache. Defaults to the Amazon FSx-managed KMS key for your account.
    lustre_configurations list(object)
    Configuration for the Lustre cache. Required when fileCacheType is LUSTRE. See lustreConfiguration Block below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    security_group_ids list(string)
    IDs of the security groups to apply to all network interfaces created for cache access.
    tags map(string)
    Map of tags to assign to the file cache. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    fileCacheType String
    Type of cache to create. The only supported value is LUSTRE.
    fileCacheTypeVersion String
    Version for the type of cache to create. The only supported value is 2.12.
    storageCapacity Integer
    Storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    subnetIds List<String>
    Subnet IDs that the cache is accessible from. You can specify only one subnet ID.
    copyTagsToDataRepositoryAssociations Boolean
    Whether to copy tags for the cache to data repository associations. Defaults to false.
    dataRepositoryAssociations List<FileCacheDataRepositoryAssociation>
    Configurations for up to 8 data repository associations (DRAs) to create during cache creation. All configurations must be of the same data repository type, either all S3 or all NFS. Maximum of 8. See dataRepositoryAssociation Block below.
    kmsKeyId String
    ID of the KMS key to use for encrypting data on the cache. Defaults to the Amazon FSx-managed KMS key for your account.
    lustreConfigurations List<FileCacheLustreConfiguration>
    Configuration for the Lustre cache. Required when fileCacheType is LUSTRE. See lustreConfiguration Block below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    securityGroupIds List<String>
    IDs of the security groups to apply to all network interfaces created for cache access.
    tags Map<String,String>
    Map of tags to assign to the file cache. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    fileCacheType string
    Type of cache to create. The only supported value is LUSTRE.
    fileCacheTypeVersion string
    Version for the type of cache to create. The only supported value is 2.12.
    storageCapacity number
    Storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    subnetIds string[]
    Subnet IDs that the cache is accessible from. You can specify only one subnet ID.
    copyTagsToDataRepositoryAssociations boolean
    Whether to copy tags for the cache to data repository associations. Defaults to false.
    dataRepositoryAssociations FileCacheDataRepositoryAssociation[]
    Configurations for up to 8 data repository associations (DRAs) to create during cache creation. All configurations must be of the same data repository type, either all S3 or all NFS. Maximum of 8. See dataRepositoryAssociation Block below.
    kmsKeyId string
    ID of the KMS key to use for encrypting data on the cache. Defaults to the Amazon FSx-managed KMS key for your account.
    lustreConfigurations FileCacheLustreConfiguration[]
    Configuration for the Lustre cache. Required when fileCacheType is LUSTRE. See lustreConfiguration Block below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    securityGroupIds string[]
    IDs of the security groups to apply to all network interfaces created for cache access.
    tags {[key: string]: string}
    Map of tags to assign to the file cache. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    file_cache_type str
    Type of cache to create. The only supported value is LUSTRE.
    file_cache_type_version str
    Version for the type of cache to create. The only supported value is 2.12.
    storage_capacity int
    Storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    subnet_ids Sequence[str]
    Subnet IDs that the cache is accessible from. You can specify only one subnet ID.
    copy_tags_to_data_repository_associations bool
    Whether to copy tags for the cache to data repository associations. Defaults to false.
    data_repository_associations Sequence[FileCacheDataRepositoryAssociationArgs]
    Configurations for up to 8 data repository associations (DRAs) to create during cache creation. All configurations must be of the same data repository type, either all S3 or all NFS. Maximum of 8. See dataRepositoryAssociation Block below.
    kms_key_id str
    ID of the KMS key to use for encrypting data on the cache. Defaults to the Amazon FSx-managed KMS key for your account.
    lustre_configurations Sequence[FileCacheLustreConfigurationArgs]
    Configuration for the Lustre cache. Required when fileCacheType is LUSTRE. See lustreConfiguration Block below.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    security_group_ids Sequence[str]
    IDs of the security groups to apply to all network interfaces created for cache access.
    tags Mapping[str, str]
    Map of tags to assign to the file cache. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    fileCacheType String
    Type of cache to create. The only supported value is LUSTRE.
    fileCacheTypeVersion String
    Version for the type of cache to create. The only supported value is 2.12.
    storageCapacity Number
    Storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    subnetIds List<String>
    Subnet IDs that the cache is accessible from. You can specify only one subnet ID.
    copyTagsToDataRepositoryAssociations Boolean
    Whether to copy tags for the cache to data repository associations. Defaults to false.
    dataRepositoryAssociations List<Property Map>
    Configurations for up to 8 data repository associations (DRAs) to create during cache creation. All configurations must be of the same data repository type, either all S3 or all NFS. Maximum of 8. See dataRepositoryAssociation Block below.
    kmsKeyId String
    ID of the KMS key to use for encrypting data on the cache. Defaults to the Amazon FSx-managed KMS key for your account.
    lustreConfigurations List<Property Map>
    Configuration for the Lustre cache. Required when fileCacheType is LUSTRE. See lustreConfiguration Block below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    securityGroupIds List<String>
    IDs of the security groups to apply to all network interfaces created for cache access.
    tags Map<String>
    Map of tags to assign to the file cache. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    ARN of the cache.
    DataRepositoryAssociationIds List<string>
    IDs of data repository associations that are associated with the cache.
    DnsName string
    DNS name for the cache.
    FileCacheId string
    System-generated, unique ID of the cache.
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkInterfaceIds List<string>
    IDs of the network interfaces.
    OwnerId string
    AWS account that created the cache.
    TagsAll Dictionary<string, string>
    VpcId string
    ID of your VPC.
    Arn string
    ARN of the cache.
    DataRepositoryAssociationIds []string
    IDs of data repository associations that are associated with the cache.
    DnsName string
    DNS name for the cache.
    FileCacheId string
    System-generated, unique ID of the cache.
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkInterfaceIds []string
    IDs of the network interfaces.
    OwnerId string
    AWS account that created the cache.
    TagsAll map[string]string
    VpcId string
    ID of your VPC.
    arn string
    ARN of the cache.
    data_repository_association_ids list(string)
    IDs of data repository associations that are associated with the cache.
    dns_name string
    DNS name for the cache.
    file_cache_id string
    System-generated, unique ID of the cache.
    id string
    The provider-assigned unique ID for this managed resource.
    network_interface_ids list(string)
    IDs of the network interfaces.
    owner_id string
    AWS account that created the cache.
    tags_all map(string)
    vpc_id string
    ID of your VPC.
    arn String
    ARN of the cache.
    dataRepositoryAssociationIds List<String>
    IDs of data repository associations that are associated with the cache.
    dnsName String
    DNS name for the cache.
    fileCacheId String
    System-generated, unique ID of the cache.
    id String
    The provider-assigned unique ID for this managed resource.
    networkInterfaceIds List<String>
    IDs of the network interfaces.
    ownerId String
    AWS account that created the cache.
    tagsAll Map<String,String>
    vpcId String
    ID of your VPC.
    arn string
    ARN of the cache.
    dataRepositoryAssociationIds string[]
    IDs of data repository associations that are associated with the cache.
    dnsName string
    DNS name for the cache.
    fileCacheId string
    System-generated, unique ID of the cache.
    id string
    The provider-assigned unique ID for this managed resource.
    networkInterfaceIds string[]
    IDs of the network interfaces.
    ownerId string
    AWS account that created the cache.
    tagsAll {[key: string]: string}
    vpcId string
    ID of your VPC.
    arn str
    ARN of the cache.
    data_repository_association_ids Sequence[str]
    IDs of data repository associations that are associated with the cache.
    dns_name str
    DNS name for the cache.
    file_cache_id str
    System-generated, unique ID of the cache.
    id str
    The provider-assigned unique ID for this managed resource.
    network_interface_ids Sequence[str]
    IDs of the network interfaces.
    owner_id str
    AWS account that created the cache.
    tags_all Mapping[str, str]
    vpc_id str
    ID of your VPC.
    arn String
    ARN of the cache.
    dataRepositoryAssociationIds List<String>
    IDs of data repository associations that are associated with the cache.
    dnsName String
    DNS name for the cache.
    fileCacheId String
    System-generated, unique ID of the cache.
    id String
    The provider-assigned unique ID for this managed resource.
    networkInterfaceIds List<String>
    IDs of the network interfaces.
    ownerId String
    AWS account that created the cache.
    tagsAll Map<String>
    vpcId String
    ID of your VPC.

    Look up Existing FileCache Resource

    Get an existing FileCache resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: FileCacheState, opts?: CustomResourceOptions): FileCache
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        copy_tags_to_data_repository_associations: Optional[bool] = None,
        data_repository_association_ids: Optional[Sequence[str]] = None,
        data_repository_associations: Optional[Sequence[FileCacheDataRepositoryAssociationArgs]] = None,
        dns_name: Optional[str] = None,
        file_cache_id: Optional[str] = None,
        file_cache_type: Optional[str] = None,
        file_cache_type_version: Optional[str] = None,
        kms_key_id: Optional[str] = None,
        lustre_configurations: Optional[Sequence[FileCacheLustreConfigurationArgs]] = None,
        network_interface_ids: Optional[Sequence[str]] = None,
        owner_id: Optional[str] = None,
        region: Optional[str] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        storage_capacity: Optional[int] = None,
        subnet_ids: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpc_id: Optional[str] = None) -> FileCache
    func GetFileCache(ctx *Context, name string, id IDInput, state *FileCacheState, opts ...ResourceOption) (*FileCache, error)
    public static FileCache Get(string name, Input<string> id, FileCacheState? state, CustomResourceOptions? opts = null)
    public static FileCache get(String name, Output<String> id, FileCacheState state, CustomResourceOptions options)
    resources:  _:    type: aws:fsx:FileCache    get:      id: ${id}
    import {
  to = aws_fsx_file_cache.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the cache.
    CopyTagsToDataRepositoryAssociations bool
    Whether to copy tags for the cache to data repository associations. Defaults to false.
    DataRepositoryAssociationIds List<string>
    IDs of data repository associations that are associated with the cache.
    DataRepositoryAssociations List<FileCacheDataRepositoryAssociation>
    Configurations for up to 8 data repository associations (DRAs) to create during cache creation. All configurations must be of the same data repository type, either all S3 or all NFS. Maximum of 8. See dataRepositoryAssociation Block below.
    DnsName string
    DNS name for the cache.
    FileCacheId string
    System-generated, unique ID of the cache.
    FileCacheType string
    Type of cache to create. The only supported value is LUSTRE.
    FileCacheTypeVersion string
    Version for the type of cache to create. The only supported value is 2.12.
    KmsKeyId string
    ID of the KMS key to use for encrypting data on the cache. Defaults to the Amazon FSx-managed KMS key for your account.
    LustreConfigurations List<FileCacheLustreConfiguration>
    Configuration for the Lustre cache. Required when fileCacheType is LUSTRE. See lustreConfiguration Block below.
    NetworkInterfaceIds List<string>
    IDs of the network interfaces.
    OwnerId string
    AWS account that created the cache.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SecurityGroupIds List<string>
    IDs of the security groups to apply to all network interfaces created for cache access.
    StorageCapacity int
    Storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    SubnetIds List<string>
    Subnet IDs that the cache is accessible from. You can specify only one subnet ID.
    Tags Dictionary<string, string>
    Map of tags to assign to the file cache. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    VpcId string
    ID of your VPC.
    Arn string
    ARN of the cache.
    CopyTagsToDataRepositoryAssociations bool
    Whether to copy tags for the cache to data repository associations. Defaults to false.
    DataRepositoryAssociationIds []string
    IDs of data repository associations that are associated with the cache.
    DataRepositoryAssociations []FileCacheDataRepositoryAssociationArgs
    Configurations for up to 8 data repository associations (DRAs) to create during cache creation. All configurations must be of the same data repository type, either all S3 or all NFS. Maximum of 8. See dataRepositoryAssociation Block below.
    DnsName string
    DNS name for the cache.
    FileCacheId string
    System-generated, unique ID of the cache.
    FileCacheType string
    Type of cache to create. The only supported value is LUSTRE.
    FileCacheTypeVersion string
    Version for the type of cache to create. The only supported value is 2.12.
    KmsKeyId string
    ID of the KMS key to use for encrypting data on the cache. Defaults to the Amazon FSx-managed KMS key for your account.
    LustreConfigurations []FileCacheLustreConfigurationArgs
    Configuration for the Lustre cache. Required when fileCacheType is LUSTRE. See lustreConfiguration Block below.
    NetworkInterfaceIds []string
    IDs of the network interfaces.
    OwnerId string
    AWS account that created the cache.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SecurityGroupIds []string
    IDs of the security groups to apply to all network interfaces created for cache access.
    StorageCapacity int
    Storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    SubnetIds []string
    Subnet IDs that the cache is accessible from. You can specify only one subnet ID.
    Tags map[string]string
    Map of tags to assign to the file cache. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    VpcId string
    ID of your VPC.
    arn string
    ARN of the cache.
    copy_tags_to_data_repository_associations bool
    Whether to copy tags for the cache to data repository associations. Defaults to false.
    data_repository_association_ids list(string)
    IDs of data repository associations that are associated with the cache.
    data_repository_associations list(object)
    Configurations for up to 8 data repository associations (DRAs) to create during cache creation. All configurations must be of the same data repository type, either all S3 or all NFS. Maximum of 8. See dataRepositoryAssociation Block below.
    dns_name string
    DNS name for the cache.
    file_cache_id string
    System-generated, unique ID of the cache.
    file_cache_type string
    Type of cache to create. The only supported value is LUSTRE.
    file_cache_type_version string
    Version for the type of cache to create. The only supported value is 2.12.
    kms_key_id string
    ID of the KMS key to use for encrypting data on the cache. Defaults to the Amazon FSx-managed KMS key for your account.
    lustre_configurations list(object)
    Configuration for the Lustre cache. Required when fileCacheType is LUSTRE. See lustreConfiguration Block below.
    network_interface_ids list(string)
    IDs of the network interfaces.
    owner_id string
    AWS account that created the cache.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    security_group_ids list(string)
    IDs of the security groups to apply to all network interfaces created for cache access.
    storage_capacity number
    Storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    subnet_ids list(string)
    Subnet IDs that the cache is accessible from. You can specify only one subnet ID.
    tags map(string)
    Map of tags to assign to the file cache. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all map(string)
    vpc_id string
    ID of your VPC.
    arn String
    ARN of the cache.
    copyTagsToDataRepositoryAssociations Boolean
    Whether to copy tags for the cache to data repository associations. Defaults to false.
    dataRepositoryAssociationIds List<String>
    IDs of data repository associations that are associated with the cache.
    dataRepositoryAssociations List<FileCacheDataRepositoryAssociation>
    Configurations for up to 8 data repository associations (DRAs) to create during cache creation. All configurations must be of the same data repository type, either all S3 or all NFS. Maximum of 8. See dataRepositoryAssociation Block below.
    dnsName String
    DNS name for the cache.
    fileCacheId String
    System-generated, unique ID of the cache.
    fileCacheType String
    Type of cache to create. The only supported value is LUSTRE.
    fileCacheTypeVersion String
    Version for the type of cache to create. The only supported value is 2.12.
    kmsKeyId String
    ID of the KMS key to use for encrypting data on the cache. Defaults to the Amazon FSx-managed KMS key for your account.
    lustreConfigurations List<FileCacheLustreConfiguration>
    Configuration for the Lustre cache. Required when fileCacheType is LUSTRE. See lustreConfiguration Block below.
    networkInterfaceIds List<String>
    IDs of the network interfaces.
    ownerId String
    AWS account that created the cache.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    securityGroupIds List<String>
    IDs of the security groups to apply to all network interfaces created for cache access.
    storageCapacity Integer
    Storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    subnetIds List<String>
    Subnet IDs that the cache is accessible from. You can specify only one subnet ID.
    tags Map<String,String>
    Map of tags to assign to the file cache. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    vpcId String
    ID of your VPC.
    arn string
    ARN of the cache.
    copyTagsToDataRepositoryAssociations boolean
    Whether to copy tags for the cache to data repository associations. Defaults to false.
    dataRepositoryAssociationIds string[]
    IDs of data repository associations that are associated with the cache.
    dataRepositoryAssociations FileCacheDataRepositoryAssociation[]
    Configurations for up to 8 data repository associations (DRAs) to create during cache creation. All configurations must be of the same data repository type, either all S3 or all NFS. Maximum of 8. See dataRepositoryAssociation Block below.
    dnsName string
    DNS name for the cache.
    fileCacheId string
    System-generated, unique ID of the cache.
    fileCacheType string
    Type of cache to create. The only supported value is LUSTRE.
    fileCacheTypeVersion string
    Version for the type of cache to create. The only supported value is 2.12.
    kmsKeyId string
    ID of the KMS key to use for encrypting data on the cache. Defaults to the Amazon FSx-managed KMS key for your account.
    lustreConfigurations FileCacheLustreConfiguration[]
    Configuration for the Lustre cache. Required when fileCacheType is LUSTRE. See lustreConfiguration Block below.
    networkInterfaceIds string[]
    IDs of the network interfaces.
    ownerId string
    AWS account that created the cache.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    securityGroupIds string[]
    IDs of the security groups to apply to all network interfaces created for cache access.
    storageCapacity number
    Storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    subnetIds string[]
    Subnet IDs that the cache is accessible from. You can specify only one subnet ID.
    tags {[key: string]: string}
    Map of tags to assign to the file cache. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    vpcId string
    ID of your VPC.
    arn str
    ARN of the cache.
    copy_tags_to_data_repository_associations bool
    Whether to copy tags for the cache to data repository associations. Defaults to false.
    data_repository_association_ids Sequence[str]
    IDs of data repository associations that are associated with the cache.
    data_repository_associations Sequence[FileCacheDataRepositoryAssociationArgs]
    Configurations for up to 8 data repository associations (DRAs) to create during cache creation. All configurations must be of the same data repository type, either all S3 or all NFS. Maximum of 8. See dataRepositoryAssociation Block below.
    dns_name str
    DNS name for the cache.
    file_cache_id str
    System-generated, unique ID of the cache.
    file_cache_type str
    Type of cache to create. The only supported value is LUSTRE.
    file_cache_type_version str
    Version for the type of cache to create. The only supported value is 2.12.
    kms_key_id str
    ID of the KMS key to use for encrypting data on the cache. Defaults to the Amazon FSx-managed KMS key for your account.
    lustre_configurations Sequence[FileCacheLustreConfigurationArgs]
    Configuration for the Lustre cache. Required when fileCacheType is LUSTRE. See lustreConfiguration Block below.
    network_interface_ids Sequence[str]
    IDs of the network interfaces.
    owner_id str
    AWS account that created the cache.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    security_group_ids Sequence[str]
    IDs of the security groups to apply to all network interfaces created for cache access.
    storage_capacity int
    Storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    subnet_ids Sequence[str]
    Subnet IDs that the cache is accessible from. You can specify only one subnet ID.
    tags Mapping[str, str]
    Map of tags to assign to the file cache. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    vpc_id str
    ID of your VPC.
    arn String
    ARN of the cache.
    copyTagsToDataRepositoryAssociations Boolean
    Whether to copy tags for the cache to data repository associations. Defaults to false.
    dataRepositoryAssociationIds List<String>
    IDs of data repository associations that are associated with the cache.
    dataRepositoryAssociations List<Property Map>
    Configurations for up to 8 data repository associations (DRAs) to create during cache creation. All configurations must be of the same data repository type, either all S3 or all NFS. Maximum of 8. See dataRepositoryAssociation Block below.
    dnsName String
    DNS name for the cache.
    fileCacheId String
    System-generated, unique ID of the cache.
    fileCacheType String
    Type of cache to create. The only supported value is LUSTRE.
    fileCacheTypeVersion String
    Version for the type of cache to create. The only supported value is 2.12.
    kmsKeyId String
    ID of the KMS key to use for encrypting data on the cache. Defaults to the Amazon FSx-managed KMS key for your account.
    lustreConfigurations List<Property Map>
    Configuration for the Lustre cache. Required when fileCacheType is LUSTRE. See lustreConfiguration Block below.
    networkInterfaceIds List<String>
    IDs of the network interfaces.
    ownerId String
    AWS account that created the cache.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    securityGroupIds List<String>
    IDs of the security groups to apply to all network interfaces created for cache access.
    storageCapacity Number
    Storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    subnetIds List<String>
    Subnet IDs that the cache is accessible from. You can specify only one subnet ID.
    tags Map<String>
    Map of tags to assign to the file cache. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    vpcId String
    ID of your VPC.

    Supporting Types

    FileCacheDataRepositoryAssociation, FileCacheDataRepositoryAssociationArgs

    DataRepositoryPath string
    Path to the S3 or NFS data repository that links to the cache.
    FileCachePath string
    Path on the cache that maps 1-1 with dataRepositoryPath. Must begin with a forward slash and cannot overlap the cache path of another data repository association.
    AssociationId string
    System-generated, unique ID of the data repository association.
    DataRepositorySubdirectories List<string>
    NFS exports linked with this data repository association, in the format /exportpath1. Configure dataRepositoryPath as the domain name of the NFS file system to use this argument. Not supported for S3 data repositories. Maximum of 500.
    FileCacheId string
    System-generated, unique ID of the cache.
    FileSystemId string
    ID of the file system for an NFS data repository association.
    FileSystemPath string
    Path to the data repository on the file system.
    ImportedFileChunkSize int
    Size, in mebibytes (MiB), of the data blocks used to represent imported files.
    Nfs List<FileCacheDataRepositoryAssociationNf>
    Configuration for a data repository association linked to an NFS file system. See nfs Block below.
    ResourceArn string
    ARN of the data repository association.
    Tags Dictionary<string, string>
    Map of tags to assign to the file cache. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    DataRepositoryPath string
    Path to the S3 or NFS data repository that links to the cache.
    FileCachePath string
    Path on the cache that maps 1-1 with dataRepositoryPath. Must begin with a forward slash and cannot overlap the cache path of another data repository association.
    AssociationId string
    System-generated, unique ID of the data repository association.
    DataRepositorySubdirectories []string
    NFS exports linked with this data repository association, in the format /exportpath1. Configure dataRepositoryPath as the domain name of the NFS file system to use this argument. Not supported for S3 data repositories. Maximum of 500.
    FileCacheId string
    System-generated, unique ID of the cache.
    FileSystemId string
    ID of the file system for an NFS data repository association.
    FileSystemPath string
    Path to the data repository on the file system.
    ImportedFileChunkSize int
    Size, in mebibytes (MiB), of the data blocks used to represent imported files.
    Nfs []FileCacheDataRepositoryAssociationNf
    Configuration for a data repository association linked to an NFS file system. See nfs Block below.
    ResourceArn string
    ARN of the data repository association.
    Tags map[string]string
    Map of tags to assign to the file cache. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    data_repository_path string
    Path to the S3 or NFS data repository that links to the cache.
    file_cache_path string
    Path on the cache that maps 1-1 with dataRepositoryPath. Must begin with a forward slash and cannot overlap the cache path of another data repository association.
    association_id string
    System-generated, unique ID of the data repository association.
    data_repository_subdirectories list(string)
    NFS exports linked with this data repository association, in the format /exportpath1. Configure dataRepositoryPath as the domain name of the NFS file system to use this argument. Not supported for S3 data repositories. Maximum of 500.
    file_cache_id string
    System-generated, unique ID of the cache.
    file_system_id string
    ID of the file system for an NFS data repository association.
    file_system_path string
    Path to the data repository on the file system.
    imported_file_chunk_size number
    Size, in mebibytes (MiB), of the data blocks used to represent imported files.
    nfs list(object)
    Configuration for a data repository association linked to an NFS file system. See nfs Block below.
    resource_arn string
    ARN of the data repository association.
    tags map(string)
    Map of tags to assign to the file cache. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    dataRepositoryPath String
    Path to the S3 or NFS data repository that links to the cache.
    fileCachePath String
    Path on the cache that maps 1-1 with dataRepositoryPath. Must begin with a forward slash and cannot overlap the cache path of another data repository association.
    associationId String
    System-generated, unique ID of the data repository association.
    dataRepositorySubdirectories List<String>
    NFS exports linked with this data repository association, in the format /exportpath1. Configure dataRepositoryPath as the domain name of the NFS file system to use this argument. Not supported for S3 data repositories. Maximum of 500.
    fileCacheId String
    System-generated, unique ID of the cache.
    fileSystemId String
    ID of the file system for an NFS data repository association.
    fileSystemPath String
    Path to the data repository on the file system.
    importedFileChunkSize Integer
    Size, in mebibytes (MiB), of the data blocks used to represent imported files.
    nfs List<FileCacheDataRepositoryAssociationNf>
    Configuration for a data repository association linked to an NFS file system. See nfs Block below.
    resourceArn String
    ARN of the data repository association.
    tags Map<String,String>
    Map of tags to assign to the file cache. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    dataRepositoryPath string
    Path to the S3 or NFS data repository that links to the cache.
    fileCachePath string
    Path on the cache that maps 1-1 with dataRepositoryPath. Must begin with a forward slash and cannot overlap the cache path of another data repository association.
    associationId string
    System-generated, unique ID of the data repository association.
    dataRepositorySubdirectories string[]
    NFS exports linked with this data repository association, in the format /exportpath1. Configure dataRepositoryPath as the domain name of the NFS file system to use this argument. Not supported for S3 data repositories. Maximum of 500.
    fileCacheId string
    System-generated, unique ID of the cache.
    fileSystemId string
    ID of the file system for an NFS data repository association.
    fileSystemPath string
    Path to the data repository on the file system.
    importedFileChunkSize number
    Size, in mebibytes (MiB), of the data blocks used to represent imported files.
    nfs FileCacheDataRepositoryAssociationNf[]
    Configuration for a data repository association linked to an NFS file system. See nfs Block below.
    resourceArn string
    ARN of the data repository association.
    tags {[key: string]: string}
    Map of tags to assign to the file cache. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    data_repository_path str
    Path to the S3 or NFS data repository that links to the cache.
    file_cache_path str
    Path on the cache that maps 1-1 with dataRepositoryPath. Must begin with a forward slash and cannot overlap the cache path of another data repository association.
    association_id str
    System-generated, unique ID of the data repository association.
    data_repository_subdirectories Sequence[str]
    NFS exports linked with this data repository association, in the format /exportpath1. Configure dataRepositoryPath as the domain name of the NFS file system to use this argument. Not supported for S3 data repositories. Maximum of 500.
    file_cache_id str
    System-generated, unique ID of the cache.
    file_system_id str
    ID of the file system for an NFS data repository association.
    file_system_path str
    Path to the data repository on the file system.
    imported_file_chunk_size int
    Size, in mebibytes (MiB), of the data blocks used to represent imported files.
    nfs Sequence[FileCacheDataRepositoryAssociationNf]
    Configuration for a data repository association linked to an NFS file system. See nfs Block below.
    resource_arn str
    ARN of the data repository association.
    tags Mapping[str, str]
    Map of tags to assign to the file cache. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    dataRepositoryPath String
    Path to the S3 or NFS data repository that links to the cache.
    fileCachePath String
    Path on the cache that maps 1-1 with dataRepositoryPath. Must begin with a forward slash and cannot overlap the cache path of another data repository association.
    associationId String
    System-generated, unique ID of the data repository association.
    dataRepositorySubdirectories List<String>
    NFS exports linked with this data repository association, in the format /exportpath1. Configure dataRepositoryPath as the domain name of the NFS file system to use this argument. Not supported for S3 data repositories. Maximum of 500.
    fileCacheId String
    System-generated, unique ID of the cache.
    fileSystemId String
    ID of the file system for an NFS data repository association.
    fileSystemPath String
    Path to the data repository on the file system.
    importedFileChunkSize Number
    Size, in mebibytes (MiB), of the data blocks used to represent imported files.
    nfs List<Property Map>
    Configuration for a data repository association linked to an NFS file system. See nfs Block below.
    resourceArn String
    ARN of the data repository association.
    tags Map<String>
    Map of tags to assign to the file cache. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    FileCacheDataRepositoryAssociationNf, FileCacheDataRepositoryAssociationNfArgs

    Version string
    Version of the NFS protocol of the NFS data repository. The only supported value is NFS3.
    DnsIps List<string>
    Up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name.
    Version string
    Version of the NFS protocol of the NFS data repository. The only supported value is NFS3.
    DnsIps []string
    Up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name.
    version string
    Version of the NFS protocol of the NFS data repository. The only supported value is NFS3.
    dns_ips list(string)
    Up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name.
    version String
    Version of the NFS protocol of the NFS data repository. The only supported value is NFS3.
    dnsIps List<String>
    Up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name.
    version string
    Version of the NFS protocol of the NFS data repository. The only supported value is NFS3.
    dnsIps string[]
    Up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name.
    version str
    Version of the NFS protocol of the NFS data repository. The only supported value is NFS3.
    dns_ips Sequence[str]
    Up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name.
    version String
    Version of the NFS protocol of the NFS data repository. The only supported value is NFS3.
    dnsIps List<String>
    Up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name.

    FileCacheLustreConfiguration, FileCacheLustreConfigurationArgs

    DeploymentType string
    Cache deployment type. The only supported value is CACHE_1.
    MetadataConfigurations List<FileCacheLustreConfigurationMetadataConfiguration>
    Configuration for a Lustre MDT (Metadata Target) storage volume. See metadataConfiguration Block below.
    PerUnitStorageThroughput int
    Throughput provisioned for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is 1000.
    LogConfigurations List<FileCacheLustreConfigurationLogConfiguration>
    Configuration for Lustre logging used to write the enabled logging events for the cache. See logConfiguration Block below.
    MountName string
    Mount name of the cache.
    WeeklyMaintenanceStartTime string
    Recurring weekly time to start maintenance, in the format D:HH:MM. D is the day of the week, where 1 represents Monday and 7 represents Sunday. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. See the ISO week date for more information.
    DeploymentType string
    Cache deployment type. The only supported value is CACHE_1.
    MetadataConfigurations []FileCacheLustreConfigurationMetadataConfiguration
    Configuration for a Lustre MDT (Metadata Target) storage volume. See metadataConfiguration Block below.
    PerUnitStorageThroughput int
    Throughput provisioned for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is 1000.
    LogConfigurations []FileCacheLustreConfigurationLogConfiguration
    Configuration for Lustre logging used to write the enabled logging events for the cache. See logConfiguration Block below.
    MountName string
    Mount name of the cache.
    WeeklyMaintenanceStartTime string
    Recurring weekly time to start maintenance, in the format D:HH:MM. D is the day of the week, where 1 represents Monday and 7 represents Sunday. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. See the ISO week date for more information.
    deployment_type string
    Cache deployment type. The only supported value is CACHE_1.
    metadata_configurations list(object)
    Configuration for a Lustre MDT (Metadata Target) storage volume. See metadataConfiguration Block below.
    per_unit_storage_throughput number
    Throughput provisioned for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is 1000.
    log_configurations list(object)
    Configuration for Lustre logging used to write the enabled logging events for the cache. See logConfiguration Block below.
    mount_name string
    Mount name of the cache.
    weekly_maintenance_start_time string
    Recurring weekly time to start maintenance, in the format D:HH:MM. D is the day of the week, where 1 represents Monday and 7 represents Sunday. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. See the ISO week date for more information.
    deploymentType String
    Cache deployment type. The only supported value is CACHE_1.
    metadataConfigurations List<FileCacheLustreConfigurationMetadataConfiguration>
    Configuration for a Lustre MDT (Metadata Target) storage volume. See metadataConfiguration Block below.
    perUnitStorageThroughput Integer
    Throughput provisioned for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is 1000.
    logConfigurations List<FileCacheLustreConfigurationLogConfiguration>
    Configuration for Lustre logging used to write the enabled logging events for the cache. See logConfiguration Block below.
    mountName String
    Mount name of the cache.
    weeklyMaintenanceStartTime String
    Recurring weekly time to start maintenance, in the format D:HH:MM. D is the day of the week, where 1 represents Monday and 7 represents Sunday. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. See the ISO week date for more information.
    deploymentType string
    Cache deployment type. The only supported value is CACHE_1.
    metadataConfigurations FileCacheLustreConfigurationMetadataConfiguration[]
    Configuration for a Lustre MDT (Metadata Target) storage volume. See metadataConfiguration Block below.
    perUnitStorageThroughput number
    Throughput provisioned for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is 1000.
    logConfigurations FileCacheLustreConfigurationLogConfiguration[]
    Configuration for Lustre logging used to write the enabled logging events for the cache. See logConfiguration Block below.
    mountName string
    Mount name of the cache.
    weeklyMaintenanceStartTime string
    Recurring weekly time to start maintenance, in the format D:HH:MM. D is the day of the week, where 1 represents Monday and 7 represents Sunday. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. See the ISO week date for more information.
    deployment_type str
    Cache deployment type. The only supported value is CACHE_1.
    metadata_configurations Sequence[FileCacheLustreConfigurationMetadataConfiguration]
    Configuration for a Lustre MDT (Metadata Target) storage volume. See metadataConfiguration Block below.
    per_unit_storage_throughput int
    Throughput provisioned for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is 1000.
    log_configurations Sequence[FileCacheLustreConfigurationLogConfiguration]
    Configuration for Lustre logging used to write the enabled logging events for the cache. See logConfiguration Block below.
    mount_name str
    Mount name of the cache.
    weekly_maintenance_start_time str
    Recurring weekly time to start maintenance, in the format D:HH:MM. D is the day of the week, where 1 represents Monday and 7 represents Sunday. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. See the ISO week date for more information.
    deploymentType String
    Cache deployment type. The only supported value is CACHE_1.
    metadataConfigurations List<Property Map>
    Configuration for a Lustre MDT (Metadata Target) storage volume. See metadataConfiguration Block below.
    perUnitStorageThroughput Number
    Throughput provisioned for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is 1000.
    logConfigurations List<Property Map>
    Configuration for Lustre logging used to write the enabled logging events for the cache. See logConfiguration Block below.
    mountName String
    Mount name of the cache.
    weeklyMaintenanceStartTime String
    Recurring weekly time to start maintenance, in the format D:HH:MM. D is the day of the week, where 1 represents Monday and 7 represents Sunday. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. See the ISO week date for more information.

    FileCacheLustreConfigurationLogConfiguration, FileCacheLustreConfigurationLogConfigurationArgs

    Destination string
    ARN of the destination that receives the logs.
    Level string
    Level of logging that Lustre logs write to the destination.
    Destination string
    ARN of the destination that receives the logs.
    Level string
    Level of logging that Lustre logs write to the destination.
    destination string
    ARN of the destination that receives the logs.
    level string
    Level of logging that Lustre logs write to the destination.
    destination String
    ARN of the destination that receives the logs.
    level String
    Level of logging that Lustre logs write to the destination.
    destination string
    ARN of the destination that receives the logs.
    level string
    Level of logging that Lustre logs write to the destination.
    destination str
    ARN of the destination that receives the logs.
    level str
    Level of logging that Lustre logs write to the destination.
    destination String
    ARN of the destination that receives the logs.
    level String
    Level of logging that Lustre logs write to the destination.

    FileCacheLustreConfigurationMetadataConfiguration, FileCacheLustreConfigurationMetadataConfigurationArgs

    StorageCapacity int
    Storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is 2400 GiB.
    StorageCapacity int
    Storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is 2400 GiB.
    storage_capacity number
    Storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is 2400 GiB.
    storageCapacity Integer
    Storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is 2400 GiB.
    storageCapacity number
    Storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is 2400 GiB.
    storage_capacity int
    Storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is 2400 GiB.
    storageCapacity Number
    Storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is 2400 GiB.

    Import

    Using pulumi import, import Amazon File Cache cache using the resource id. For example:

    $ pulumi import aws:fsx/fileCache:FileCache example fc-8012925589

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo aws logo
    Viewing docs for AWS v7.46.0
    published on Thursday, Sep 10, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial