Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. fsx
  5. FileCache
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.fsx.FileCache

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
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: [{
        dataRepositoryPath: "nfs://filer.domain.com",
        dataRepositorySubdirectories: [
            "test",
            "test2",
        ],
        fileCachePath: "/ns1",
        nfs: [{
            dnsIps: [
                "192.168.0.1",
                "192.168.0.2",
            ],
            version: "NFS3",
        }],
    }],
    fileCacheType: "LUSTRE",
    fileCacheTypeVersion: "2.12",
    lustreConfigurations: [{
        deploymentType: "CACHE_1",
        metadataConfigurations: [{
            storageCapacity: 2400,
        }],
        perUnitStorageThroughput: 1000,
        weeklyMaintenanceStartTime: "2:05:00",
    }],
    subnetIds: [test1.id],
    storageCapacity: 1200,
});

    import pulumi
import pulumi_aws as aws

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

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
					DataRepositoryPath: pulumi.String("nfs://filer.domain.com"),
					DataRepositorySubdirectories: pulumi.StringArray{
						pulumi.String("test"),
						pulumi.String("test2"),
					},
					FileCachePath: pulumi.String("/ns1"),
					Nfs: fsx.FileCacheDataRepositoryAssociationNfArray{
						&fsx.FileCacheDataRepositoryAssociationNfArgs{
							DnsIps: pulumi.StringArray{
								pulumi.String("192.168.0.1"),
								pulumi.String("192.168.0.2"),
							},
							Version: pulumi.String("NFS3"),
						},
					},
				},
			},
			FileCacheType:        pulumi.String("LUSTRE"),
			FileCacheTypeVersion: pulumi.String("2.12"),
			LustreConfigurations: fsx.FileCacheLustreConfigurationArray{
				&fsx.FileCacheLustreConfigurationArgs{
					DeploymentType: pulumi.String("CACHE_1"),
					MetadataConfigurations: fsx.FileCacheLustreConfigurationMetadataConfigurationArray{
						&fsx.FileCacheLustreConfigurationMetadataConfigurationArgs{
							StorageCapacity: pulumi.Int(2400),
						},
					},
					PerUnitStorageThroughput:   pulumi.Int(1000),
					WeeklyMaintenanceStartTime: pulumi.String("2:05:00"),
				},
			},
			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
            {
                DataRepositoryPath = "nfs://filer.domain.com",
                DataRepositorySubdirectories = new[]
                {
                    "test",
                    "test2",
                },
                FileCachePath = "/ns1",
                Nfs = new[]
                {
                    new Aws.Fsx.Inputs.FileCacheDataRepositoryAssociationNfArgs
                    {
                        DnsIps = new[]
                        {
                            "192.168.0.1",
                            "192.168.0.2",
                        },
                        Version = "NFS3",
                    },
                },
            },
        },
        FileCacheType = "LUSTRE",
        FileCacheTypeVersion = "2.12",
        LustreConfigurations = new[]
        {
            new Aws.Fsx.Inputs.FileCacheLustreConfigurationArgs
            {
                DeploymentType = "CACHE_1",
                MetadataConfigurations = new[]
                {
                    new Aws.Fsx.Inputs.FileCacheLustreConfigurationMetadataConfigurationArgs
                    {
                        StorageCapacity = 2400,
                    },
                },
                PerUnitStorageThroughput = 1000,
                WeeklyMaintenanceStartTime = "2:05:00",
            },
        },
        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.FileCacheLustreConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
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()
                .dataRepositoryPath("nfs://filer.domain.com")
                .dataRepositorySubdirectories(                
                    "test",
                    "test2")
                .fileCachePath("/ns1")
                .nfs(FileCacheDataRepositoryAssociationNfArgs.builder()
                    .dnsIps(                    
                        "192.168.0.1",
                        "192.168.0.2")
                    .version("NFS3")
                    .build())
                .build())
            .fileCacheType("LUSTRE")
            .fileCacheTypeVersion("2.12")
            .lustreConfigurations(FileCacheLustreConfigurationArgs.builder()
                .deploymentType("CACHE_1")
                .metadataConfigurations(FileCacheLustreConfigurationMetadataConfigurationArgs.builder()
                    .storageCapacity(2400)
                    .build())
                .perUnitStorageThroughput(1000)
                .weeklyMaintenanceStartTime("2:05:00")
                .build())
            .subnetIds(test1.id())
            .storageCapacity(1200)
            .build());

    }
}

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

    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",
        },
    },
    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"),
		},
	},
	SecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.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())
    .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=[{
        "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",
        },
    }],
    kms_key_id="string",
    lustre_configurations=[{
        "deploymentType": "string",
        "metadataConfigurations": [{
            "storageCapacity": 0,
        }],
        "perUnitStorageThroughput": 0,
        "logConfigurations": [{
            "destination": "string",
            "level": "string",
        }],
        "mountName": "string",
        "weeklyMaintenanceStartTime": "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",
    }],
    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
    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

    The FileCache resource accepts the following input properties:

    FileCacheType string
    The type of cache that you're creating. The only supported value is LUSTRE.
    FileCacheTypeVersion string
    The version for the type of cache that you're creating. The only supported value is 2.12.
    StorageCapacity int
    The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    SubnetIds List<string>

    A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.

    The following arguments are optional:

    CopyTagsToDataRepositoryAssociations bool
    A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
    DataRepositoryAssociations List<Pulumi.Aws.Fsx.Inputs.FileCacheDataRepositoryAssociation>
    See the data_repository_association configuration block. Max of 8. A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol. The DRA configurations must meet the following requirements: 1) All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time. 2) An NFS DRA must link to an NFS file system that supports the NFSv3 protocol. DRA automatic import and automatic export is not supported.
    KmsKeyId string
    Specifies the ID of the AWS Key Management Service (AWS KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed AWS KMS key for your account is used.
    LustreConfigurations List<Pulumi.Aws.Fsx.Inputs.FileCacheLustreConfiguration>
    See the lustre_configuration block. Required when file_cache_type is LUSTRE.
    SecurityGroupIds List<string>
    A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
    Tags Dictionary<string, string>
    A map of tags to assign to the file cache. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    FileCacheType string
    The type of cache that you're creating. The only supported value is LUSTRE.
    FileCacheTypeVersion string
    The version for the type of cache that you're creating. The only supported value is 2.12.
    StorageCapacity int
    The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    SubnetIds []string

    A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.

    The following arguments are optional:

    CopyTagsToDataRepositoryAssociations bool
    A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
    DataRepositoryAssociations []FileCacheDataRepositoryAssociationArgs
    See the data_repository_association configuration block. Max of 8. A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol. The DRA configurations must meet the following requirements: 1) All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time. 2) An NFS DRA must link to an NFS file system that supports the NFSv3 protocol. DRA automatic import and automatic export is not supported.
    KmsKeyId string
    Specifies the ID of the AWS Key Management Service (AWS KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed AWS KMS key for your account is used.
    LustreConfigurations []FileCacheLustreConfigurationArgs
    See the lustre_configuration block. Required when file_cache_type is LUSTRE.
    SecurityGroupIds []string
    A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
    Tags map[string]string
    A map of tags to assign to the file cache. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    fileCacheType String
    The type of cache that you're creating. The only supported value is LUSTRE.
    fileCacheTypeVersion String
    The version for the type of cache that you're creating. The only supported value is 2.12.
    storageCapacity Integer
    The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    subnetIds List<String>

    A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.

    The following arguments are optional:

    copyTagsToDataRepositoryAssociations Boolean
    A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
    dataRepositoryAssociations List<FileCacheDataRepositoryAssociation>
    See the data_repository_association configuration block. Max of 8. A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol. The DRA configurations must meet the following requirements: 1) All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time. 2) An NFS DRA must link to an NFS file system that supports the NFSv3 protocol. DRA automatic import and automatic export is not supported.
    kmsKeyId String
    Specifies the ID of the AWS Key Management Service (AWS KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed AWS KMS key for your account is used.
    lustreConfigurations List<FileCacheLustreConfiguration>
    See the lustre_configuration block. Required when file_cache_type is LUSTRE.
    securityGroupIds List<String>
    A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
    tags Map<String,String>
    A map of tags to assign to the file cache. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    fileCacheType string
    The type of cache that you're creating. The only supported value is LUSTRE.
    fileCacheTypeVersion string
    The version for the type of cache that you're creating. The only supported value is 2.12.
    storageCapacity number
    The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    subnetIds string[]

    A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.

    The following arguments are optional:

    copyTagsToDataRepositoryAssociations boolean
    A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
    dataRepositoryAssociations FileCacheDataRepositoryAssociation[]
    See the data_repository_association configuration block. Max of 8. A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol. The DRA configurations must meet the following requirements: 1) All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time. 2) An NFS DRA must link to an NFS file system that supports the NFSv3 protocol. DRA automatic import and automatic export is not supported.
    kmsKeyId string
    Specifies the ID of the AWS Key Management Service (AWS KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed AWS KMS key for your account is used.
    lustreConfigurations FileCacheLustreConfiguration[]
    See the lustre_configuration block. Required when file_cache_type is LUSTRE.
    securityGroupIds string[]
    A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
    tags {[key: string]: string}
    A map of tags to assign to the file cache. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    file_cache_type str
    The type of cache that you're creating. The only supported value is LUSTRE.
    file_cache_type_version str
    The version for the type of cache that you're creating. The only supported value is 2.12.
    storage_capacity int
    The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    subnet_ids Sequence[str]

    A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.

    The following arguments are optional:

    copy_tags_to_data_repository_associations bool
    A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
    data_repository_associations Sequence[FileCacheDataRepositoryAssociationArgs]
    See the data_repository_association configuration block. Max of 8. A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol. The DRA configurations must meet the following requirements: 1) All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time. 2) An NFS DRA must link to an NFS file system that supports the NFSv3 protocol. DRA automatic import and automatic export is not supported.
    kms_key_id str
    Specifies the ID of the AWS Key Management Service (AWS KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed AWS KMS key for your account is used.
    lustre_configurations Sequence[FileCacheLustreConfigurationArgs]
    See the lustre_configuration block. Required when file_cache_type is LUSTRE.
    security_group_ids Sequence[str]
    A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
    tags Mapping[str, str]
    A map of tags to assign to the file cache. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    fileCacheType String
    The type of cache that you're creating. The only supported value is LUSTRE.
    fileCacheTypeVersion String
    The version for the type of cache that you're creating. The only supported value is 2.12.
    storageCapacity Number
    The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    subnetIds List<String>

    A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.

    The following arguments are optional:

    copyTagsToDataRepositoryAssociations Boolean
    A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
    dataRepositoryAssociations List<Property Map>
    See the data_repository_association configuration block. Max of 8. A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol. The DRA configurations must meet the following requirements: 1) All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time. 2) An NFS DRA must link to an NFS file system that supports the NFSv3 protocol. DRA automatic import and automatic export is not supported.
    kmsKeyId String
    Specifies the ID of the AWS Key Management Service (AWS KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed AWS KMS key for your account is used.
    lustreConfigurations List<Property Map>
    See the lustre_configuration block. Required when file_cache_type is LUSTRE.
    securityGroupIds List<String>
    A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
    tags Map<String>
    A map of tags to assign to the file cache. If configured with a provider default_tags 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
    The Amazon Resource Name (ARN) for the resource.
    DataRepositoryAssociationIds List<string>
    A list of IDs of data repository associations that are associated with this cache.
    DnsName string
    The Domain Name System (DNS) name for the cache.
    FileCacheId string
    The system-generated, unique ID of the cache.
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkInterfaceIds List<string>
    A list of network interface IDs.
    OwnerId string
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    VpcId string
    The ID of your virtual private cloud (VPC).
    Arn string
    The Amazon Resource Name (ARN) for the resource.
    DataRepositoryAssociationIds []string
    A list of IDs of data repository associations that are associated with this cache.
    DnsName string
    The Domain Name System (DNS) name for the cache.
    FileCacheId string
    The system-generated, unique ID of the cache.
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkInterfaceIds []string
    A list of network interface IDs.
    OwnerId string
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    VpcId string
    The ID of your virtual private cloud (VPC).
    arn String
    The Amazon Resource Name (ARN) for the resource.
    dataRepositoryAssociationIds List<String>
    A list of IDs of data repository associations that are associated with this cache.
    dnsName String
    The Domain Name System (DNS) name for the cache.
    fileCacheId String
    The system-generated, unique ID of the cache.
    id String
    The provider-assigned unique ID for this managed resource.
    networkInterfaceIds List<String>
    A list of network interface IDs.
    ownerId String
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    vpcId String
    The ID of your virtual private cloud (VPC).
    arn string
    The Amazon Resource Name (ARN) for the resource.
    dataRepositoryAssociationIds string[]
    A list of IDs of data repository associations that are associated with this cache.
    dnsName string
    The Domain Name System (DNS) name for the cache.
    fileCacheId string
    The system-generated, unique ID of the cache.
    id string
    The provider-assigned unique ID for this managed resource.
    networkInterfaceIds string[]
    A list of network interface IDs.
    ownerId string
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    vpcId string
    The ID of your virtual private cloud (VPC).
    arn str
    The Amazon Resource Name (ARN) for the resource.
    data_repository_association_ids Sequence[str]
    A list of IDs of data repository associations that are associated with this cache.
    dns_name str
    The Domain Name System (DNS) name for the cache.
    file_cache_id str
    The system-generated, unique ID of the cache.
    id str
    The provider-assigned unique ID for this managed resource.
    network_interface_ids Sequence[str]
    A list of network interface IDs.
    owner_id str
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    vpc_id str
    The ID of your virtual private cloud (VPC).
    arn String
    The Amazon Resource Name (ARN) for the resource.
    dataRepositoryAssociationIds List<String>
    A list of IDs of data repository associations that are associated with this cache.
    dnsName String
    The Domain Name System (DNS) name for the cache.
    fileCacheId String
    The system-generated, unique ID of the cache.
    id String
    The provider-assigned unique ID for this managed resource.
    networkInterfaceIds List<String>
    A list of network interface IDs.
    ownerId String
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    vpcId String
    The ID of your virtual private cloud (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,
        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)
    Resource lookup is not supported in YAML
    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
    The Amazon Resource Name (ARN) for the resource.
    CopyTagsToDataRepositoryAssociations bool
    A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
    DataRepositoryAssociationIds List<string>
    A list of IDs of data repository associations that are associated with this cache.
    DataRepositoryAssociations List<Pulumi.Aws.Fsx.Inputs.FileCacheDataRepositoryAssociation>
    See the data_repository_association configuration block. Max of 8. A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol. The DRA configurations must meet the following requirements: 1) All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time. 2) An NFS DRA must link to an NFS file system that supports the NFSv3 protocol. DRA automatic import and automatic export is not supported.
    DnsName string
    The Domain Name System (DNS) name for the cache.
    FileCacheId string
    The system-generated, unique ID of the cache.
    FileCacheType string
    The type of cache that you're creating. The only supported value is LUSTRE.
    FileCacheTypeVersion string
    The version for the type of cache that you're creating. The only supported value is 2.12.
    KmsKeyId string
    Specifies the ID of the AWS Key Management Service (AWS KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed AWS KMS key for your account is used.
    LustreConfigurations List<Pulumi.Aws.Fsx.Inputs.FileCacheLustreConfiguration>
    See the lustre_configuration block. Required when file_cache_type is LUSTRE.
    NetworkInterfaceIds List<string>
    A list of network interface IDs.
    OwnerId string
    SecurityGroupIds List<string>
    A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
    StorageCapacity int
    The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    SubnetIds List<string>

    A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.

    The following arguments are optional:

    Tags Dictionary<string, string>
    A map of tags to assign to the file cache. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    VpcId string
    The ID of your virtual private cloud (VPC).
    Arn string
    The Amazon Resource Name (ARN) for the resource.
    CopyTagsToDataRepositoryAssociations bool
    A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
    DataRepositoryAssociationIds []string
    A list of IDs of data repository associations that are associated with this cache.
    DataRepositoryAssociations []FileCacheDataRepositoryAssociationArgs
    See the data_repository_association configuration block. Max of 8. A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol. The DRA configurations must meet the following requirements: 1) All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time. 2) An NFS DRA must link to an NFS file system that supports the NFSv3 protocol. DRA automatic import and automatic export is not supported.
    DnsName string
    The Domain Name System (DNS) name for the cache.
    FileCacheId string
    The system-generated, unique ID of the cache.
    FileCacheType string
    The type of cache that you're creating. The only supported value is LUSTRE.
    FileCacheTypeVersion string
    The version for the type of cache that you're creating. The only supported value is 2.12.
    KmsKeyId string
    Specifies the ID of the AWS Key Management Service (AWS KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed AWS KMS key for your account is used.
    LustreConfigurations []FileCacheLustreConfigurationArgs
    See the lustre_configuration block. Required when file_cache_type is LUSTRE.
    NetworkInterfaceIds []string
    A list of network interface IDs.
    OwnerId string
    SecurityGroupIds []string
    A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
    StorageCapacity int
    The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    SubnetIds []string

    A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.

    The following arguments are optional:

    Tags map[string]string
    A map of tags to assign to the file cache. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    VpcId string
    The ID of your virtual private cloud (VPC).
    arn String
    The Amazon Resource Name (ARN) for the resource.
    copyTagsToDataRepositoryAssociations Boolean
    A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
    dataRepositoryAssociationIds List<String>
    A list of IDs of data repository associations that are associated with this cache.
    dataRepositoryAssociations List<FileCacheDataRepositoryAssociation>
    See the data_repository_association configuration block. Max of 8. A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol. The DRA configurations must meet the following requirements: 1) All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time. 2) An NFS DRA must link to an NFS file system that supports the NFSv3 protocol. DRA automatic import and automatic export is not supported.
    dnsName String
    The Domain Name System (DNS) name for the cache.
    fileCacheId String
    The system-generated, unique ID of the cache.
    fileCacheType String
    The type of cache that you're creating. The only supported value is LUSTRE.
    fileCacheTypeVersion String
    The version for the type of cache that you're creating. The only supported value is 2.12.
    kmsKeyId String
    Specifies the ID of the AWS Key Management Service (AWS KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed AWS KMS key for your account is used.
    lustreConfigurations List<FileCacheLustreConfiguration>
    See the lustre_configuration block. Required when file_cache_type is LUSTRE.
    networkInterfaceIds List<String>
    A list of network interface IDs.
    ownerId String
    securityGroupIds List<String>
    A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
    storageCapacity Integer
    The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    subnetIds List<String>

    A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.

    The following arguments are optional:

    tags Map<String,String>
    A map of tags to assign to the file cache. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    vpcId String
    The ID of your virtual private cloud (VPC).
    arn string
    The Amazon Resource Name (ARN) for the resource.
    copyTagsToDataRepositoryAssociations boolean
    A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
    dataRepositoryAssociationIds string[]
    A list of IDs of data repository associations that are associated with this cache.
    dataRepositoryAssociations FileCacheDataRepositoryAssociation[]
    See the data_repository_association configuration block. Max of 8. A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol. The DRA configurations must meet the following requirements: 1) All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time. 2) An NFS DRA must link to an NFS file system that supports the NFSv3 protocol. DRA automatic import and automatic export is not supported.
    dnsName string
    The Domain Name System (DNS) name for the cache.
    fileCacheId string
    The system-generated, unique ID of the cache.
    fileCacheType string
    The type of cache that you're creating. The only supported value is LUSTRE.
    fileCacheTypeVersion string
    The version for the type of cache that you're creating. The only supported value is 2.12.
    kmsKeyId string
    Specifies the ID of the AWS Key Management Service (AWS KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed AWS KMS key for your account is used.
    lustreConfigurations FileCacheLustreConfiguration[]
    See the lustre_configuration block. Required when file_cache_type is LUSTRE.
    networkInterfaceIds string[]
    A list of network interface IDs.
    ownerId string
    securityGroupIds string[]
    A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
    storageCapacity number
    The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    subnetIds string[]

    A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.

    The following arguments are optional:

    tags {[key: string]: string}
    A map of tags to assign to the file cache. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    vpcId string
    The ID of your virtual private cloud (VPC).
    arn str
    The Amazon Resource Name (ARN) for the resource.
    copy_tags_to_data_repository_associations bool
    A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
    data_repository_association_ids Sequence[str]
    A list of IDs of data repository associations that are associated with this cache.
    data_repository_associations Sequence[FileCacheDataRepositoryAssociationArgs]
    See the data_repository_association configuration block. Max of 8. A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol. The DRA configurations must meet the following requirements: 1) All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time. 2) An NFS DRA must link to an NFS file system that supports the NFSv3 protocol. DRA automatic import and automatic export is not supported.
    dns_name str
    The Domain Name System (DNS) name for the cache.
    file_cache_id str
    The system-generated, unique ID of the cache.
    file_cache_type str
    The type of cache that you're creating. The only supported value is LUSTRE.
    file_cache_type_version str
    The version for the type of cache that you're creating. The only supported value is 2.12.
    kms_key_id str
    Specifies the ID of the AWS Key Management Service (AWS KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed AWS KMS key for your account is used.
    lustre_configurations Sequence[FileCacheLustreConfigurationArgs]
    See the lustre_configuration block. Required when file_cache_type is LUSTRE.
    network_interface_ids Sequence[str]
    A list of network interface IDs.
    owner_id str
    security_group_ids Sequence[str]
    A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
    storage_capacity int
    The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    subnet_ids Sequence[str]

    A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.

    The following arguments are optional:

    tags Mapping[str, str]
    A map of tags to assign to the file cache. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    vpc_id str
    The ID of your virtual private cloud (VPC).
    arn String
    The Amazon Resource Name (ARN) for the resource.
    copyTagsToDataRepositoryAssociations Boolean
    A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
    dataRepositoryAssociationIds List<String>
    A list of IDs of data repository associations that are associated with this cache.
    dataRepositoryAssociations List<Property Map>
    See the data_repository_association configuration block. Max of 8. A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol. The DRA configurations must meet the following requirements: 1) All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time. 2) An NFS DRA must link to an NFS file system that supports the NFSv3 protocol. DRA automatic import and automatic export is not supported.
    dnsName String
    The Domain Name System (DNS) name for the cache.
    fileCacheId String
    The system-generated, unique ID of the cache.
    fileCacheType String
    The type of cache that you're creating. The only supported value is LUSTRE.
    fileCacheTypeVersion String
    The version for the type of cache that you're creating. The only supported value is 2.12.
    kmsKeyId String
    Specifies the ID of the AWS Key Management Service (AWS KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed AWS KMS key for your account is used.
    lustreConfigurations List<Property Map>
    See the lustre_configuration block. Required when file_cache_type is LUSTRE.
    networkInterfaceIds List<String>
    A list of network interface IDs.
    ownerId String
    securityGroupIds List<String>
    A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
    storageCapacity Number
    The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
    subnetIds List<String>

    A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.

    The following arguments are optional:

    tags Map<String>
    A map of tags to assign to the file cache. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    vpcId String
    The ID of your virtual private cloud (VPC).

    Supporting Types

    FileCacheDataRepositoryAssociation, FileCacheDataRepositoryAssociationArgs

    DataRepositoryPath string
    The path to the S3 or NFS data repository that links to the cache.
    FileCachePath string
    A path on the cache that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping cache paths. For example, if a data repository is associated with cache path /ns1/, then you cannot link another data repository with cache path /ns1/ns2. This path specifies where in your cache files will be exported from. This cache directory can be linked to only one data repository, and no data repository other can be linked to the directory. Note: The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories is specified. If you specify root (/) as the cache path, you can create only one DRA on the cache. The cache path cannot be set to root (/) for an S3 DRA.
    AssociationId string
    DataRepositorySubdirectories List<string>
    A list of NFS Exports that will be linked with this data repository association. The Export paths are in the format /exportpath1. To use this parameter, you must configure DataRepositoryPath as the domain name of the NFS file system. The NFS file system domain name in effect is the root of the subdirectories. Note that DataRepositorySubdirectories is not supported for S3 data repositories. Max of 500.
    FileCacheId string
    The system-generated, unique ID of the cache.
    FileSystemId string
    FileSystemPath string
    ImportedFileChunkSize int
    Nfs List<Pulumi.Aws.Fsx.Inputs.FileCacheDataRepositoryAssociationNf>
    (Optional) See the nfs configuration block.
    ResourceArn string
    Tags Dictionary<string, string>
    A map of tags to assign to the file cache. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    DataRepositoryPath string
    The path to the S3 or NFS data repository that links to the cache.
    FileCachePath string
    A path on the cache that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping cache paths. For example, if a data repository is associated with cache path /ns1/, then you cannot link another data repository with cache path /ns1/ns2. This path specifies where in your cache files will be exported from. This cache directory can be linked to only one data repository, and no data repository other can be linked to the directory. Note: The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories is specified. If you specify root (/) as the cache path, you can create only one DRA on the cache. The cache path cannot be set to root (/) for an S3 DRA.
    AssociationId string
    DataRepositorySubdirectories []string
    A list of NFS Exports that will be linked with this data repository association. The Export paths are in the format /exportpath1. To use this parameter, you must configure DataRepositoryPath as the domain name of the NFS file system. The NFS file system domain name in effect is the root of the subdirectories. Note that DataRepositorySubdirectories is not supported for S3 data repositories. Max of 500.
    FileCacheId string
    The system-generated, unique ID of the cache.
    FileSystemId string
    FileSystemPath string
    ImportedFileChunkSize int
    Nfs []FileCacheDataRepositoryAssociationNf
    (Optional) See the nfs configuration block.
    ResourceArn string
    Tags map[string]string
    A map of tags to assign to the file cache. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    dataRepositoryPath String
    The path to the S3 or NFS data repository that links to the cache.
    fileCachePath String
    A path on the cache that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping cache paths. For example, if a data repository is associated with cache path /ns1/, then you cannot link another data repository with cache path /ns1/ns2. This path specifies where in your cache files will be exported from. This cache directory can be linked to only one data repository, and no data repository other can be linked to the directory. Note: The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories is specified. If you specify root (/) as the cache path, you can create only one DRA on the cache. The cache path cannot be set to root (/) for an S3 DRA.
    associationId String
    dataRepositorySubdirectories List<String>
    A list of NFS Exports that will be linked with this data repository association. The Export paths are in the format /exportpath1. To use this parameter, you must configure DataRepositoryPath as the domain name of the NFS file system. The NFS file system domain name in effect is the root of the subdirectories. Note that DataRepositorySubdirectories is not supported for S3 data repositories. Max of 500.
    fileCacheId String
    The system-generated, unique ID of the cache.
    fileSystemId String
    fileSystemPath String
    importedFileChunkSize Integer
    nfs List<FileCacheDataRepositoryAssociationNf>
    (Optional) See the nfs configuration block.
    resourceArn String
    tags Map<String,String>
    A map of tags to assign to the file cache. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    dataRepositoryPath string
    The path to the S3 or NFS data repository that links to the cache.
    fileCachePath string
    A path on the cache that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping cache paths. For example, if a data repository is associated with cache path /ns1/, then you cannot link another data repository with cache path /ns1/ns2. This path specifies where in your cache files will be exported from. This cache directory can be linked to only one data repository, and no data repository other can be linked to the directory. Note: The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories is specified. If you specify root (/) as the cache path, you can create only one DRA on the cache. The cache path cannot be set to root (/) for an S3 DRA.
    associationId string
    dataRepositorySubdirectories string[]
    A list of NFS Exports that will be linked with this data repository association. The Export paths are in the format /exportpath1. To use this parameter, you must configure DataRepositoryPath as the domain name of the NFS file system. The NFS file system domain name in effect is the root of the subdirectories. Note that DataRepositorySubdirectories is not supported for S3 data repositories. Max of 500.
    fileCacheId string
    The system-generated, unique ID of the cache.
    fileSystemId string
    fileSystemPath string
    importedFileChunkSize number
    nfs FileCacheDataRepositoryAssociationNf[]
    (Optional) See the nfs configuration block.
    resourceArn string
    tags {[key: string]: string}
    A map of tags to assign to the file cache. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    data_repository_path str
    The path to the S3 or NFS data repository that links to the cache.
    file_cache_path str
    A path on the cache that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping cache paths. For example, if a data repository is associated with cache path /ns1/, then you cannot link another data repository with cache path /ns1/ns2. This path specifies where in your cache files will be exported from. This cache directory can be linked to only one data repository, and no data repository other can be linked to the directory. Note: The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories is specified. If you specify root (/) as the cache path, you can create only one DRA on the cache. The cache path cannot be set to root (/) for an S3 DRA.
    association_id str
    data_repository_subdirectories Sequence[str]
    A list of NFS Exports that will be linked with this data repository association. The Export paths are in the format /exportpath1. To use this parameter, you must configure DataRepositoryPath as the domain name of the NFS file system. The NFS file system domain name in effect is the root of the subdirectories. Note that DataRepositorySubdirectories is not supported for S3 data repositories. Max of 500.
    file_cache_id str
    The system-generated, unique ID of the cache.
    file_system_id str
    file_system_path str
    imported_file_chunk_size int
    nfs Sequence[FileCacheDataRepositoryAssociationNf]
    (Optional) See the nfs configuration block.
    resource_arn str
    tags Mapping[str, str]
    A map of tags to assign to the file cache. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    dataRepositoryPath String
    The path to the S3 or NFS data repository that links to the cache.
    fileCachePath String
    A path on the cache that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping cache paths. For example, if a data repository is associated with cache path /ns1/, then you cannot link another data repository with cache path /ns1/ns2. This path specifies where in your cache files will be exported from. This cache directory can be linked to only one data repository, and no data repository other can be linked to the directory. Note: The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories is specified. If you specify root (/) as the cache path, you can create only one DRA on the cache. The cache path cannot be set to root (/) for an S3 DRA.
    associationId String
    dataRepositorySubdirectories List<String>
    A list of NFS Exports that will be linked with this data repository association. The Export paths are in the format /exportpath1. To use this parameter, you must configure DataRepositoryPath as the domain name of the NFS file system. The NFS file system domain name in effect is the root of the subdirectories. Note that DataRepositorySubdirectories is not supported for S3 data repositories. Max of 500.
    fileCacheId String
    The system-generated, unique ID of the cache.
    fileSystemId String
    fileSystemPath String
    importedFileChunkSize Number
    nfs List<Property Map>
    (Optional) See the nfs configuration block.
    resourceArn String
    tags Map<String>
    A map of tags to assign to the file cache. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    FileCacheDataRepositoryAssociationNf, FileCacheDataRepositoryAssociationNfArgs

    Version string
    The version of the NFS (Network File System) protocol of the NFS data repository. The only supported value is NFS3, which indicates that the data repository must support the NFSv3 protocol. The only supported value is NFS3.
    DnsIps List<string>
    A list of up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name. The provided IP addresses can either be the IP addresses of a DNS forwarder or resolver that the customer manages and runs inside the customer VPC, or the IP addresses of the on-premises DNS servers.
    Version string
    The version of the NFS (Network File System) protocol of the NFS data repository. The only supported value is NFS3, which indicates that the data repository must support the NFSv3 protocol. The only supported value is NFS3.
    DnsIps []string
    A list of up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name. The provided IP addresses can either be the IP addresses of a DNS forwarder or resolver that the customer manages and runs inside the customer VPC, or the IP addresses of the on-premises DNS servers.
    version String
    The version of the NFS (Network File System) protocol of the NFS data repository. The only supported value is NFS3, which indicates that the data repository must support the NFSv3 protocol. The only supported value is NFS3.
    dnsIps List<String>
    A list of up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name. The provided IP addresses can either be the IP addresses of a DNS forwarder or resolver that the customer manages and runs inside the customer VPC, or the IP addresses of the on-premises DNS servers.
    version string
    The version of the NFS (Network File System) protocol of the NFS data repository. The only supported value is NFS3, which indicates that the data repository must support the NFSv3 protocol. The only supported value is NFS3.
    dnsIps string[]
    A list of up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name. The provided IP addresses can either be the IP addresses of a DNS forwarder or resolver that the customer manages and runs inside the customer VPC, or the IP addresses of the on-premises DNS servers.
    version str
    The version of the NFS (Network File System) protocol of the NFS data repository. The only supported value is NFS3, which indicates that the data repository must support the NFSv3 protocol. The only supported value is NFS3.
    dns_ips Sequence[str]
    A list of up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name. The provided IP addresses can either be the IP addresses of a DNS forwarder or resolver that the customer manages and runs inside the customer VPC, or the IP addresses of the on-premises DNS servers.
    version String
    The version of the NFS (Network File System) protocol of the NFS data repository. The only supported value is NFS3, which indicates that the data repository must support the NFSv3 protocol. The only supported value is NFS3.
    dnsIps List<String>
    A list of up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name. The provided IP addresses can either be the IP addresses of a DNS forwarder or resolver that the customer manages and runs inside the customer VPC, or the IP addresses of the on-premises DNS servers.

    FileCacheLustreConfiguration, FileCacheLustreConfigurationArgs

    DeploymentType string
    Specifies the cache deployment type. The only supported value is CACHE_1.
    MetadataConfigurations List<Pulumi.Aws.Fsx.Inputs.FileCacheLustreConfigurationMetadataConfiguration>
    The configuration for a Lustre MDT (Metadata Target) storage volume. See the metadata_configuration block.
    PerUnitStorageThroughput int
    Provisions the amount of read and write throughput for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is 1000.
    LogConfigurations List<Pulumi.Aws.Fsx.Inputs.FileCacheLustreConfigurationLogConfiguration>
    MountName string
    WeeklyMaintenanceStartTime string
    A recurring weekly time, in the format D:HH:MM. D is the day of the week, for which 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. For example, 1:05:00 specifies maintenance at 5 AM Monday. See the ISO week date for more information.
    DeploymentType string
    Specifies the cache deployment type. The only supported value is CACHE_1.
    MetadataConfigurations []FileCacheLustreConfigurationMetadataConfiguration
    The configuration for a Lustre MDT (Metadata Target) storage volume. See the metadata_configuration block.
    PerUnitStorageThroughput int
    Provisions the amount of read and write throughput for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is 1000.
    LogConfigurations []FileCacheLustreConfigurationLogConfiguration
    MountName string
    WeeklyMaintenanceStartTime string
    A recurring weekly time, in the format D:HH:MM. D is the day of the week, for which 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. For example, 1:05:00 specifies maintenance at 5 AM Monday. See the ISO week date for more information.
    deploymentType String
    Specifies the cache deployment type. The only supported value is CACHE_1.
    metadataConfigurations List<FileCacheLustreConfigurationMetadataConfiguration>
    The configuration for a Lustre MDT (Metadata Target) storage volume. See the metadata_configuration block.
    perUnitStorageThroughput Integer
    Provisions the amount of read and write throughput for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is 1000.
    logConfigurations List<FileCacheLustreConfigurationLogConfiguration>
    mountName String
    weeklyMaintenanceStartTime String
    A recurring weekly time, in the format D:HH:MM. D is the day of the week, for which 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. For example, 1:05:00 specifies maintenance at 5 AM Monday. See the ISO week date for more information.
    deploymentType string
    Specifies the cache deployment type. The only supported value is CACHE_1.
    metadataConfigurations FileCacheLustreConfigurationMetadataConfiguration[]
    The configuration for a Lustre MDT (Metadata Target) storage volume. See the metadata_configuration block.
    perUnitStorageThroughput number
    Provisions the amount of read and write throughput for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is 1000.
    logConfigurations FileCacheLustreConfigurationLogConfiguration[]
    mountName string
    weeklyMaintenanceStartTime string
    A recurring weekly time, in the format D:HH:MM. D is the day of the week, for which 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. For example, 1:05:00 specifies maintenance at 5 AM Monday. See the ISO week date for more information.
    deployment_type str
    Specifies the cache deployment type. The only supported value is CACHE_1.
    metadata_configurations Sequence[FileCacheLustreConfigurationMetadataConfiguration]
    The configuration for a Lustre MDT (Metadata Target) storage volume. See the metadata_configuration block.
    per_unit_storage_throughput int
    Provisions the amount of read and write throughput for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is 1000.
    log_configurations Sequence[FileCacheLustreConfigurationLogConfiguration]
    mount_name str
    weekly_maintenance_start_time str
    A recurring weekly time, in the format D:HH:MM. D is the day of the week, for which 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. For example, 1:05:00 specifies maintenance at 5 AM Monday. See the ISO week date for more information.
    deploymentType String
    Specifies the cache deployment type. The only supported value is CACHE_1.
    metadataConfigurations List<Property Map>
    The configuration for a Lustre MDT (Metadata Target) storage volume. See the metadata_configuration block.
    perUnitStorageThroughput Number
    Provisions the amount of read and write throughput for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is 1000.
    logConfigurations List<Property Map>
    mountName String
    weeklyMaintenanceStartTime String
    A recurring weekly time, in the format D:HH:MM. D is the day of the week, for which 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. For example, 1:05:00 specifies maintenance at 5 AM Monday. See the ISO week date for more information.

    FileCacheLustreConfigurationLogConfiguration, FileCacheLustreConfigurationLogConfigurationArgs

    Destination string
    Level string
    Destination string
    Level string
    destination String
    level String
    destination string
    level string
    destination String
    level String

    FileCacheLustreConfigurationMetadataConfiguration, FileCacheLustreConfigurationMetadataConfigurationArgs

    StorageCapacity int
    The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is 2400 GiB.
    StorageCapacity int
    The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is 2400 GiB.
    storageCapacity Integer
    The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is 2400 GiB.
    storageCapacity number
    The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is 2400 GiB.
    storage_capacity int
    The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is 2400 GiB.
    storageCapacity Number
    The 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 v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws