aws.fsx.FileCache
Explore with Pulumi AI
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
This property is required. string - The unique name of the resource.
- args
This property is required. FileCacheArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. FileCacheArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. FileCacheArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. 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=[{
"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",
}],
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
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:
- File
Cache Type This property is required. Changes to this property will trigger replacement.
- The type of cache that you're creating. The only supported value is
LUSTRE
. - File
Cache Type Version This property is required. Changes to this property will trigger replacement.
- The version for the type of cache that you're creating. The only supported value is
2.12
. - Storage
Capacity This property is required. Changes to this property will trigger replacement.
- The storage capacity of the cache in gibibytes (GiB). Valid values are
1200
GiB,2400
GiB, and increments of2400
GiB. - Subnet
Ids This property is required. Changes to this property will trigger replacement.
A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.
The following arguments are optional:
- 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 Changes to this property will trigger replacement.
Cache Data Repository Association> - 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 Changes to this property will trigger replacement.
- 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 List<FileCache Lustre Configuration> - See the
lustre_configuration
block. Required whenfile_cache_type
isLUSTRE
. - Security
Group Ids Changes to this property will trigger replacement.
- A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
- 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.
- File
Cache Type This property is required. Changes to this property will trigger replacement.
- The type of cache that you're creating. The only supported value is
LUSTRE
. - File
Cache Type Version This property is required. Changes to this property will trigger replacement.
- The version for the type of cache that you're creating. The only supported value is
2.12
. - Storage
Capacity This property is required. Changes to this property will trigger replacement.
- The storage capacity of the cache in gibibytes (GiB). Valid values are
1200
GiB,2400
GiB, and increments of2400
GiB. - Subnet
Ids This property is required. Changes to this property will trigger replacement.
A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.
The following arguments are optional:
- 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 Changes to this property will trigger replacement.
Cache Data Repository Association Args - 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 Changes to this property will trigger replacement.
- 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 []FileCache Lustre Configuration Args - See the
lustre_configuration
block. Required whenfile_cache_type
isLUSTRE
. - Security
Group Ids Changes to this property will trigger replacement.
- A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
- 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.
- file
Cache Type This property is required. Changes to this property will trigger replacement.
- The type of cache that you're creating. The only supported value is
LUSTRE
. - file
Cache Type Version This property is required. Changes to this property will trigger replacement.
- The version for the type of cache that you're creating. The only supported value is
2.12
. - storage
Capacity This property is required. Changes to this property will trigger replacement.
- The storage capacity of the cache in gibibytes (GiB). Valid values are
1200
GiB,2400
GiB, and increments of2400
GiB. - subnet
Ids This property is required. Changes to this property will trigger replacement.
A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.
The following arguments are optional:
- Boolean
- A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
- data
Repository Associations Changes to this property will trigger replacement.
Cache Data Repository Association> - 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 Changes to this property will trigger replacement.
- 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 List<FileCache Lustre Configuration> - See the
lustre_configuration
block. Required whenfile_cache_type
isLUSTRE
. - security
Group Ids Changes to this property will trigger replacement.
- A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
- 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.
- file
Cache Type This property is required. Changes to this property will trigger replacement.
- The type of cache that you're creating. The only supported value is
LUSTRE
. - file
Cache Type Version This property is required. Changes to this property will trigger replacement.
- The version for the type of cache that you're creating. The only supported value is
2.12
. - storage
Capacity This property is required. Changes to this property will trigger replacement.
- The storage capacity of the cache in gibibytes (GiB). Valid values are
1200
GiB,2400
GiB, and increments of2400
GiB. - subnet
Ids This property is required. Changes to this property will trigger replacement.
A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.
The following arguments are optional:
- boolean
- A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
- data
Repository Associations Changes to this property will trigger replacement.
Cache Data Repository Association[] - 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 Changes to this property will trigger replacement.
- 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 FileCache Lustre Configuration[] - See the
lustre_configuration
block. Required whenfile_cache_type
isLUSTRE
. - security
Group Ids Changes to this property will trigger replacement.
- A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
- {[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 This property is required. Changes to this property will trigger replacement.
- The type of cache that you're creating. The only supported value is
LUSTRE
. - file_
cache_ type_ version This property is required. Changes to this property will trigger replacement.
- The version for the type of cache that you're creating. The only supported value is
2.12
. - storage_
capacity This property is required. Changes to this property will trigger replacement.
- The storage capacity of the cache in gibibytes (GiB). Valid values are
1200
GiB,2400
GiB, and increments of2400
GiB. - subnet_
ids This property is required. Changes to this property will trigger replacement.
A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.
The following arguments are optional:
- 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 Changes to this property will trigger replacement.
Cache Data Repository Association Args] - 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 Changes to this property will trigger replacement.
- 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[FileCache Lustre Configuration Args] - See the
lustre_configuration
block. Required whenfile_cache_type
isLUSTRE
. - security_
group_ ids Changes to this property will trigger replacement.
- A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
- 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.
- file
Cache Type This property is required. Changes to this property will trigger replacement.
- The type of cache that you're creating. The only supported value is
LUSTRE
. - file
Cache Type Version This property is required. Changes to this property will trigger replacement.
- The version for the type of cache that you're creating. The only supported value is
2.12
. - storage
Capacity This property is required. Changes to this property will trigger replacement.
- The storage capacity of the cache in gibibytes (GiB). Valid values are
1200
GiB,2400
GiB, and increments of2400
GiB. - subnet
Ids This property is required. Changes to this property will trigger replacement.
A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.
The following arguments are optional:
- Boolean
- A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
- data
Repository Associations Changes to this property will trigger replacement.
- 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 Changes to this property will trigger replacement.
- 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 List<Property Map> - See the
lustre_configuration
block. Required whenfile_cache_type
isLUSTRE
. - security
Group Ids Changes to this property will trigger replacement.
- A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
- 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.
- Data
Repository List<string>Association Ids - A list of IDs of data repository associations that are associated with this cache.
- Dns
Name string - The Domain Name System (DNS) name for the cache.
- File
Cache stringId - The system-generated, unique ID of the cache.
- Id string
- The provider-assigned unique ID for this managed resource.
- Network
Interface List<string>Ids - A list of network interface IDs.
- Owner
Id string - Dictionary<string, string>
- Vpc
Id string - The ID of your virtual private cloud (VPC).
- Arn string
- The Amazon Resource Name (ARN) for the resource.
- Data
Repository []stringAssociation Ids - A list of IDs of data repository associations that are associated with this cache.
- Dns
Name string - The Domain Name System (DNS) name for the cache.
- File
Cache stringId - The system-generated, unique ID of the cache.
- Id string
- The provider-assigned unique ID for this managed resource.
- Network
Interface []stringIds - A list of network interface IDs.
- Owner
Id string - map[string]string
- Vpc
Id string - The ID of your virtual private cloud (VPC).
- arn String
- The Amazon Resource Name (ARN) for the resource.
- data
Repository List<String>Association Ids - A list of IDs of data repository associations that are associated with this cache.
- dns
Name String - The Domain Name System (DNS) name for the cache.
- file
Cache StringId - The system-generated, unique ID of the cache.
- id String
- The provider-assigned unique ID for this managed resource.
- network
Interface List<String>Ids - A list of network interface IDs.
- owner
Id String - Map<String,String>
- vpc
Id String - The ID of your virtual private cloud (VPC).
- arn string
- The Amazon Resource Name (ARN) for the resource.
- data
Repository string[]Association Ids - A list of IDs of data repository associations that are associated with this cache.
- dns
Name string - The Domain Name System (DNS) name for the cache.
- file
Cache stringId - The system-generated, unique ID of the cache.
- id string
- The provider-assigned unique ID for this managed resource.
- network
Interface string[]Ids - A list of network interface IDs.
- owner
Id string - {[key: string]: string}
- vpc
Id string - The ID of your virtual private cloud (VPC).
- arn str
- The Amazon Resource Name (ARN) for the resource.
- data_
repository_ Sequence[str]association_ ids - 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_ strid - The system-generated, unique ID of the cache.
- id str
- The provider-assigned unique ID for this managed resource.
- network_
interface_ Sequence[str]ids - A list of network interface IDs.
- owner_
id str - Mapping[str, str]
- vpc_
id str - The ID of your virtual private cloud (VPC).
- arn String
- The Amazon Resource Name (ARN) for the resource.
- data
Repository List<String>Association Ids - A list of IDs of data repository associations that are associated with this cache.
- dns
Name String - The Domain Name System (DNS) name for the cache.
- file
Cache StringId - The system-generated, unique ID of the cache.
- id String
- The provider-assigned unique ID for this managed resource.
- network
Interface List<String>Ids - A list of network interface IDs.
- owner
Id String - Map<String>
- vpc
Id 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)
resources: _: type: aws:fsx:FileCache get: id: ${id}
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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.
- Arn string
- The Amazon Resource Name (ARN) for the resource.
- bool
- A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
- Data
Repository List<string>Association Ids - A list of IDs of data repository associations that are associated with this cache.
- Data
Repository Associations Changes to this property will trigger replacement.
Cache Data Repository Association> - 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 string - The Domain Name System (DNS) name for the cache.
- File
Cache stringId - The system-generated, unique ID of the cache.
- File
Cache Type Changes to this property will trigger replacement.
- The type of cache that you're creating. The only supported value is
LUSTRE
. - File
Cache Type Version Changes to this property will trigger replacement.
- The version for the type of cache that you're creating. The only supported value is
2.12
. - Kms
Key Id Changes to this property will trigger replacement.
- 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 List<FileCache Lustre Configuration> - See the
lustre_configuration
block. Required whenfile_cache_type
isLUSTRE
. - Network
Interface List<string>Ids - A list of network interface IDs.
- Owner
Id string - Security
Group Ids Changes to this property will trigger replacement.
- A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
- Storage
Capacity Changes to this property will trigger replacement.
- The storage capacity of the cache in gibibytes (GiB). Valid values are
1200
GiB,2400
GiB, and increments of2400
GiB. - Subnet
Ids Changes to this property will trigger replacement.
A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.
The following arguments are optional:
- 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. - Dictionary<string, string>
- Vpc
Id string - The ID of your virtual private cloud (VPC).
- Arn string
- The Amazon Resource Name (ARN) for the resource.
- bool
- A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
- Data
Repository []stringAssociation Ids - A list of IDs of data repository associations that are associated with this cache.
- Data
Repository Associations Changes to this property will trigger replacement.
Cache Data Repository Association Args - 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 string - The Domain Name System (DNS) name for the cache.
- File
Cache stringId - The system-generated, unique ID of the cache.
- File
Cache Type Changes to this property will trigger replacement.
- The type of cache that you're creating. The only supported value is
LUSTRE
. - File
Cache Type Version Changes to this property will trigger replacement.
- The version for the type of cache that you're creating. The only supported value is
2.12
. - Kms
Key Id Changes to this property will trigger replacement.
- 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 []FileCache Lustre Configuration Args - See the
lustre_configuration
block. Required whenfile_cache_type
isLUSTRE
. - Network
Interface []stringIds - A list of network interface IDs.
- Owner
Id string - Security
Group Ids Changes to this property will trigger replacement.
- A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
- Storage
Capacity Changes to this property will trigger replacement.
- The storage capacity of the cache in gibibytes (GiB). Valid values are
1200
GiB,2400
GiB, and increments of2400
GiB. - Subnet
Ids Changes to this property will trigger replacement.
A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.
The following arguments are optional:
- 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. - map[string]string
- Vpc
Id string - The ID of your virtual private cloud (VPC).
- arn String
- The Amazon Resource Name (ARN) for the resource.
- Boolean
- A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
- data
Repository List<String>Association Ids - A list of IDs of data repository associations that are associated with this cache.
- data
Repository Associations Changes to this property will trigger replacement.
Cache Data Repository Association> - 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 String - The Domain Name System (DNS) name for the cache.
- file
Cache StringId - The system-generated, unique ID of the cache.
- file
Cache Type Changes to this property will trigger replacement.
- The type of cache that you're creating. The only supported value is
LUSTRE
. - file
Cache Type Version Changes to this property will trigger replacement.
- The version for the type of cache that you're creating. The only supported value is
2.12
. - kms
Key Id Changes to this property will trigger replacement.
- 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 List<FileCache Lustre Configuration> - See the
lustre_configuration
block. Required whenfile_cache_type
isLUSTRE
. - network
Interface List<String>Ids - A list of network interface IDs.
- owner
Id String - security
Group Ids Changes to this property will trigger replacement.
- A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
- storage
Capacity Changes to this property will trigger replacement.
- The storage capacity of the cache in gibibytes (GiB). Valid values are
1200
GiB,2400
GiB, and increments of2400
GiB. - subnet
Ids Changes to this property will trigger replacement.
A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.
The following arguments are optional:
- 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. - Map<String,String>
- vpc
Id String - The ID of your virtual private cloud (VPC).
- arn string
- The Amazon Resource Name (ARN) for the resource.
- boolean
- A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
- data
Repository string[]Association Ids - A list of IDs of data repository associations that are associated with this cache.
- data
Repository Associations Changes to this property will trigger replacement.
Cache Data Repository Association[] - 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 string - The Domain Name System (DNS) name for the cache.
- file
Cache stringId - The system-generated, unique ID of the cache.
- file
Cache Type Changes to this property will trigger replacement.
- The type of cache that you're creating. The only supported value is
LUSTRE
. - file
Cache Type Version Changes to this property will trigger replacement.
- The version for the type of cache that you're creating. The only supported value is
2.12
. - kms
Key Id Changes to this property will trigger replacement.
- 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 FileCache Lustre Configuration[] - See the
lustre_configuration
block. Required whenfile_cache_type
isLUSTRE
. - network
Interface string[]Ids - A list of network interface IDs.
- owner
Id string - security
Group Ids Changes to this property will trigger replacement.
- A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
- storage
Capacity Changes to this property will trigger replacement.
- The storage capacity of the cache in gibibytes (GiB). Valid values are
1200
GiB,2400
GiB, and increments of2400
GiB. - subnet
Ids Changes to this property will trigger replacement.
A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.
The following arguments are optional:
- {[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. - {[key: string]: string}
- vpc
Id string - The ID of your virtual private cloud (VPC).
- arn str
- The Amazon Resource Name (ARN) for the resource.
- bool
- A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
- data_
repository_ Sequence[str]association_ ids - A list of IDs of data repository associations that are associated with this cache.
- data_
repository_ associations Changes to this property will trigger replacement.
Cache Data Repository Association Args] - 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_ strid - The system-generated, unique ID of the cache.
- file_
cache_ type Changes to this property will trigger replacement.
- The type of cache that you're creating. The only supported value is
LUSTRE
. - file_
cache_ type_ version Changes to this property will trigger replacement.
- The version for the type of cache that you're creating. The only supported value is
2.12
. - kms_
key_ id Changes to this property will trigger replacement.
- 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[FileCache Lustre Configuration Args] - See the
lustre_configuration
block. Required whenfile_cache_type
isLUSTRE
. - network_
interface_ Sequence[str]ids - A list of network interface IDs.
- owner_
id str - security_
group_ ids Changes to this property will trigger replacement.
- A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
- storage_
capacity Changes to this property will trigger replacement.
- The storage capacity of the cache in gibibytes (GiB). Valid values are
1200
GiB,2400
GiB, and increments of2400
GiB. - subnet_
ids Changes to this property will trigger replacement.
A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.
The following arguments are optional:
- 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. - Mapping[str, str]
- vpc_
id str - The ID of your virtual private cloud (VPC).
- arn String
- The Amazon Resource Name (ARN) for the resource.
- Boolean
- A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
- data
Repository List<String>Association Ids - A list of IDs of data repository associations that are associated with this cache.
- data
Repository Associations Changes to this property will trigger replacement.
- 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 String - The Domain Name System (DNS) name for the cache.
- file
Cache StringId - The system-generated, unique ID of the cache.
- file
Cache Type Changes to this property will trigger replacement.
- The type of cache that you're creating. The only supported value is
LUSTRE
. - file
Cache Type Version Changes to this property will trigger replacement.
- The version for the type of cache that you're creating. The only supported value is
2.12
. - kms
Key Id Changes to this property will trigger replacement.
- 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 List<Property Map> - See the
lustre_configuration
block. Required whenfile_cache_type
isLUSTRE
. - network
Interface List<String>Ids - A list of network interface IDs.
- owner
Id String - security
Group Ids Changes to this property will trigger replacement.
- A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.
- storage
Capacity Changes to this property will trigger replacement.
- The storage capacity of the cache in gibibytes (GiB). Valid values are
1200
GiB,2400
GiB, and increments of2400
GiB. - subnet
Ids Changes to this property will trigger replacement.
A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID.
The following arguments are optional:
- 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. - Map<String>
- vpc
Id String - The ID of your virtual private cloud (VPC).
Supporting Types
FileCacheDataRepositoryAssociation, FileCacheDataRepositoryAssociationArgs
- Data
Repository Path This property is required. string - The path to the S3 or NFS data repository that links to the cache.
- File
Cache Path This property is required. 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.
- Association
Id string - Data
Repository List<string>Subdirectories - 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 stringId - The system-generated, unique ID of the cache.
- File
System stringId - File
System stringPath - Imported
File intChunk Size - Nfs
List<File
Cache Data Repository Association Nf> - (Optional) See the
nfs
configuration block. - Resource
Arn string - 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.
- Data
Repository Path This property is required. string - The path to the S3 or NFS data repository that links to the cache.
- File
Cache Path This property is required. 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.
- Association
Id string - Data
Repository []stringSubdirectories - 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 stringId - The system-generated, unique ID of the cache.
- File
System stringId - File
System stringPath - Imported
File intChunk Size - Nfs
[]File
Cache Data Repository Association Nf - (Optional) See the
nfs
configuration block. - Resource
Arn string - 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.
- data
Repository Path This property is required. String - The path to the S3 or NFS data repository that links to the cache.
- file
Cache Path This property is required. 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.
- association
Id String - data
Repository List<String>Subdirectories - 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 StringId - The system-generated, unique ID of the cache.
- file
System StringId - file
System StringPath - imported
File IntegerChunk Size - nfs
List<File
Cache Data Repository Association Nf> - (Optional) See the
nfs
configuration block. - resource
Arn String - 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.
- data
Repository Path This property is required. string - The path to the S3 or NFS data repository that links to the cache.
- file
Cache Path This property is required. 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.
- association
Id string - data
Repository string[]Subdirectories - 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 stringId - The system-generated, unique ID of the cache.
- file
System stringId - file
System stringPath - imported
File numberChunk Size - nfs
File
Cache Data Repository Association Nf[] - (Optional) See the
nfs
configuration block. - resource
Arn string - {[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 This property is required. str - The path to the S3 or NFS data repository that links to the cache.
- file_
cache_ path This property is required. 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_ Sequence[str]subdirectories - 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_ strid - The system-generated, unique ID of the cache.
- file_
system_ strid - file_
system_ strpath - imported_
file_ intchunk_ size - nfs
Sequence[File
Cache Data Repository Association Nf] - (Optional) See the
nfs
configuration block. - resource_
arn str - 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.
- data
Repository Path This property is required. String - The path to the S3 or NFS data repository that links to the cache.
- file
Cache Path This property is required. 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.
- association
Id String - data
Repository List<String>Subdirectories - 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 StringId - The system-generated, unique ID of the cache.
- file
System StringId - file
System StringPath - imported
File NumberChunk Size - nfs List<Property Map>
- (Optional) See the
nfs
configuration block. - resource
Arn String - 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
This property is required. 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
. - Dns
Ips 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
This property is required. 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
. - Dns
Ips []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
This property is required. 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
. - dns
Ips 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
This property is required. 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
. - dns
Ips 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
This property is required. 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
This property is required. 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
. - dns
Ips 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
- Deployment
Type This property is required. Changes to this property will trigger replacement.
- Specifies the cache deployment type. The only supported value is
CACHE_1
. - Metadata
Configurations This property is required. Changes to this property will trigger replacement.
Cache Lustre Configuration Metadata Configuration> - The configuration for a Lustre MDT (Metadata Target) storage volume. See the
metadata_configuration
block. - Per
Unit Storage Throughput This property is required. Changes to this property will trigger replacement.
- 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 List<FileCache Lustre Configuration Log Configuration> - Mount
Name string - Weekly
Maintenance stringStart Time - A recurring weekly time, in the format
D:HH:MM
.D
is the day of the week, for which1
represents Monday and7
represents Sunday.HH
is the zero-padded hour of the day (0-23), andMM
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 This property is required. Changes to this property will trigger replacement.
- Specifies the cache deployment type. The only supported value is
CACHE_1
. - Metadata
Configurations This property is required. Changes to this property will trigger replacement.
Cache Lustre Configuration Metadata Configuration - The configuration for a Lustre MDT (Metadata Target) storage volume. See the
metadata_configuration
block. - Per
Unit Storage Throughput This property is required. Changes to this property will trigger replacement.
- 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 []FileCache Lustre Configuration Log Configuration - Mount
Name string - Weekly
Maintenance stringStart Time - A recurring weekly time, in the format
D:HH:MM
.D
is the day of the week, for which1
represents Monday and7
represents Sunday.HH
is the zero-padded hour of the day (0-23), andMM
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 This property is required. Changes to this property will trigger replacement.
- Specifies the cache deployment type. The only supported value is
CACHE_1
. - metadata
Configurations This property is required. Changes to this property will trigger replacement.
Cache Lustre Configuration Metadata Configuration> - The configuration for a Lustre MDT (Metadata Target) storage volume. See the
metadata_configuration
block. - per
Unit Storage Throughput This property is required. Changes to this property will trigger replacement.
- 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 List<FileCache Lustre Configuration Log Configuration> - mount
Name String - weekly
Maintenance StringStart Time - A recurring weekly time, in the format
D:HH:MM
.D
is the day of the week, for which1
represents Monday and7
represents Sunday.HH
is the zero-padded hour of the day (0-23), andMM
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 This property is required. Changes to this property will trigger replacement.
- Specifies the cache deployment type. The only supported value is
CACHE_1
. - metadata
Configurations This property is required. Changes to this property will trigger replacement.
Cache Lustre Configuration Metadata Configuration[] - The configuration for a Lustre MDT (Metadata Target) storage volume. See the
metadata_configuration
block. - per
Unit Storage Throughput This property is required. Changes to this property will trigger replacement.
- 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 FileCache Lustre Configuration Log Configuration[] - mount
Name string - weekly
Maintenance stringStart Time - A recurring weekly time, in the format
D:HH:MM
.D
is the day of the week, for which1
represents Monday and7
represents Sunday.HH
is the zero-padded hour of the day (0-23), andMM
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 This property is required. Changes to this property will trigger replacement.
- Specifies the cache deployment type. The only supported value is
CACHE_1
. - metadata_
configurations This property is required. Changes to this property will trigger replacement.
Cache Lustre Configuration Metadata Configuration] - The configuration for a Lustre MDT (Metadata Target) storage volume. See the
metadata_configuration
block. - per_
unit_ storage_ throughput This property is required. Changes to this property will trigger replacement.
- 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[FileCache Lustre Configuration Log Configuration] - mount_
name str - weekly_
maintenance_ strstart_ time - A recurring weekly time, in the format
D:HH:MM
.D
is the day of the week, for which1
represents Monday and7
represents Sunday.HH
is the zero-padded hour of the day (0-23), andMM
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 This property is required. Changes to this property will trigger replacement.
- Specifies the cache deployment type. The only supported value is
CACHE_1
. - metadata
Configurations This property is required. Changes to this property will trigger replacement.
- The configuration for a Lustre MDT (Metadata Target) storage volume. See the
metadata_configuration
block. - per
Unit Storage Throughput This property is required. Changes to this property will trigger replacement.
- 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 List<Property Map> - mount
Name String - weekly
Maintenance StringStart Time - A recurring weekly time, in the format
D:HH:MM
.D
is the day of the week, for which1
represents Monday and7
represents Sunday.HH
is the zero-padded hour of the day (0-23), andMM
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 str
- level str
- destination String
- level String
FileCacheLustreConfigurationMetadataConfiguration, FileCacheLustreConfigurationMetadataConfigurationArgs
- Storage
Capacity This property is required. Changes to this property will trigger replacement.
- The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is
2400
GiB.
- Storage
Capacity This property is required. Changes to this property will trigger replacement.
- The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is
2400
GiB.
- storage
Capacity This property is required. Changes to this property will trigger replacement.
- The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is
2400
GiB.
- storage
Capacity This property is required. Changes to this property will trigger replacement.
- The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is
2400
GiB.
- storage_
capacity This property is required. Changes to this property will trigger replacement.
- The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is
2400
GiB.
- storage
Capacity This property is required. Changes to this property will trigger replacement.
- 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.