Try AWS Native preview for resources not in the classic version.
aws.efs.FileSystem
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Provides an Elastic File System (EFS) File System resource.
Example Usage
EFS File System w/ tags
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var foo = new Aws.Efs.FileSystem("foo", new()
{
Tags =
{
{ "Name", "MyProduct" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/efs"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := efs.NewFileSystem(ctx, "foo", &efs.FileSystemArgs{
Tags: pulumi.StringMap{
"Name": pulumi.String("MyProduct"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.efs.FileSystem;
import com.pulumi.aws.efs.FileSystemArgs;
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 foo = new FileSystem("foo", FileSystemArgs.builder()
.tags(Map.of("Name", "MyProduct"))
.build());
}
}
import pulumi
import pulumi_aws as aws
foo = aws.efs.FileSystem("foo", tags={
"Name": "MyProduct",
})
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const foo = new aws.efs.FileSystem("foo", {tags: {
Name: "MyProduct",
}});
resources:
foo:
type: aws:efs:FileSystem
properties:
tags:
Name: MyProduct
Using lifecycle policy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var fooWithLifecylePolicy = new Aws.Efs.FileSystem("fooWithLifecylePolicy", new()
{
LifecyclePolicies = new[]
{
new Aws.Efs.Inputs.FileSystemLifecyclePolicyArgs
{
TransitionToIa = "AFTER_30_DAYS",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/efs"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := efs.NewFileSystem(ctx, "fooWithLifecylePolicy", &efs.FileSystemArgs{
LifecyclePolicies: efs.FileSystemLifecyclePolicyArray{
&efs.FileSystemLifecyclePolicyArgs{
TransitionToIa: pulumi.String("AFTER_30_DAYS"),
},
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.efs.FileSystem;
import com.pulumi.aws.efs.FileSystemArgs;
import com.pulumi.aws.efs.inputs.FileSystemLifecyclePolicyArgs;
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 fooWithLifecylePolicy = new FileSystem("fooWithLifecylePolicy", FileSystemArgs.builder()
.lifecyclePolicies(FileSystemLifecyclePolicyArgs.builder()
.transitionToIa("AFTER_30_DAYS")
.build())
.build());
}
}
import pulumi
import pulumi_aws as aws
foo_with_lifecyle_policy = aws.efs.FileSystem("fooWithLifecylePolicy", lifecycle_policies=[aws.efs.FileSystemLifecyclePolicyArgs(
transition_to_ia="AFTER_30_DAYS",
)])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const fooWithLifecylePolicy = new aws.efs.FileSystem("fooWithLifecylePolicy", {lifecyclePolicies: [{
transitionToIa: "AFTER_30_DAYS",
}]});
resources:
fooWithLifecylePolicy:
type: aws:efs:FileSystem
properties:
lifecyclePolicies:
- transitionToIa: AFTER_30_DAYS
Create FileSystem Resource
new FileSystem(name: string, args?: FileSystemArgs, opts?: CustomResourceOptions);
@overload
def FileSystem(resource_name: str,
opts: Optional[ResourceOptions] = None,
availability_zone_name: Optional[str] = None,
creation_token: Optional[str] = None,
encrypted: Optional[bool] = None,
kms_key_id: Optional[str] = None,
lifecycle_policies: Optional[Sequence[FileSystemLifecyclePolicyArgs]] = None,
performance_mode: Optional[str] = None,
provisioned_throughput_in_mibps: Optional[float] = None,
tags: Optional[Mapping[str, str]] = None,
throughput_mode: Optional[str] = None)
@overload
def FileSystem(resource_name: str,
args: Optional[FileSystemArgs] = None,
opts: Optional[ResourceOptions] = None)
func NewFileSystem(ctx *Context, name string, args *FileSystemArgs, opts ...ResourceOption) (*FileSystem, error)
public FileSystem(string name, FileSystemArgs? args = null, CustomResourceOptions? opts = null)
public FileSystem(String name, FileSystemArgs args)
public FileSystem(String name, FileSystemArgs args, CustomResourceOptions options)
type: aws:efs:FileSystem
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FileSystemArgs
- 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 FileSystemArgs
- 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 FileSystemArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FileSystemArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FileSystemArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
FileSystem 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 FileSystem resource accepts the following input properties:
- Availability
Zone stringName the AWS Availability Zone in which to create the file system. Used to create a file system that uses One Zone storage classes. See user guide for more information.
- Creation
Token string A unique name (a maximum of 64 characters are allowed) used as reference when creating the Elastic File System to ensure idempotent file system creation. By default generated by this provider. See [Elastic File System] user guide for more information.
- Encrypted bool
If true, the disk will be encrypted.
- Kms
Key stringId The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
- Lifecycle
Policies List<FileSystem Lifecycle Policy> A file system lifecycle policy object (documented below).
- Performance
Mode string The file system performance mode. Can be either
"generalPurpose"
or"maxIO"
(Default:"generalPurpose"
).- Provisioned
Throughput doubleIn Mibps The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with
throughput_mode
set toprovisioned
.- Dictionary<string, string>
A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Throughput
Mode string Throughput mode for the file system. Defaults to
bursting
. Valid values:bursting
,provisioned
, orelastic
. When usingprovisioned
, also setprovisioned_throughput_in_mibps
.
- Availability
Zone stringName the AWS Availability Zone in which to create the file system. Used to create a file system that uses One Zone storage classes. See user guide for more information.
- Creation
Token string A unique name (a maximum of 64 characters are allowed) used as reference when creating the Elastic File System to ensure idempotent file system creation. By default generated by this provider. See [Elastic File System] user guide for more information.
- Encrypted bool
If true, the disk will be encrypted.
- Kms
Key stringId The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
- Lifecycle
Policies []FileSystem Lifecycle Policy Args A file system lifecycle policy object (documented below).
- Performance
Mode string The file system performance mode. Can be either
"generalPurpose"
or"maxIO"
(Default:"generalPurpose"
).- Provisioned
Throughput float64In Mibps The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with
throughput_mode
set toprovisioned
.- map[string]string
A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Throughput
Mode string Throughput mode for the file system. Defaults to
bursting
. Valid values:bursting
,provisioned
, orelastic
. When usingprovisioned
, also setprovisioned_throughput_in_mibps
.
- availability
Zone StringName the AWS Availability Zone in which to create the file system. Used to create a file system that uses One Zone storage classes. See user guide for more information.
- creation
Token String A unique name (a maximum of 64 characters are allowed) used as reference when creating the Elastic File System to ensure idempotent file system creation. By default generated by this provider. See [Elastic File System] user guide for more information.
- encrypted Boolean
If true, the disk will be encrypted.
- kms
Key StringId The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
- lifecycle
Policies List<FileSystem Lifecycle Policy> A file system lifecycle policy object (documented below).
- performance
Mode String The file system performance mode. Can be either
"generalPurpose"
or"maxIO"
(Default:"generalPurpose"
).- provisioned
Throughput DoubleIn Mibps The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with
throughput_mode
set toprovisioned
.- Map<String,String>
A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- throughput
Mode String Throughput mode for the file system. Defaults to
bursting
. Valid values:bursting
,provisioned
, orelastic
. When usingprovisioned
, also setprovisioned_throughput_in_mibps
.
- availability
Zone stringName the AWS Availability Zone in which to create the file system. Used to create a file system that uses One Zone storage classes. See user guide for more information.
- creation
Token string A unique name (a maximum of 64 characters are allowed) used as reference when creating the Elastic File System to ensure idempotent file system creation. By default generated by this provider. See [Elastic File System] user guide for more information.
- encrypted boolean
If true, the disk will be encrypted.
- kms
Key stringId The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
- lifecycle
Policies FileSystem Lifecycle Policy[] A file system lifecycle policy object (documented below).
- performance
Mode string The file system performance mode. Can be either
"generalPurpose"
or"maxIO"
(Default:"generalPurpose"
).- provisioned
Throughput numberIn Mibps The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with
throughput_mode
set toprovisioned
.- {[key: string]: string}
A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- throughput
Mode string Throughput mode for the file system. Defaults to
bursting
. Valid values:bursting
,provisioned
, orelastic
. When usingprovisioned
, also setprovisioned_throughput_in_mibps
.
- availability_
zone_ strname the AWS Availability Zone in which to create the file system. Used to create a file system that uses One Zone storage classes. See user guide for more information.
- creation_
token str A unique name (a maximum of 64 characters are allowed) used as reference when creating the Elastic File System to ensure idempotent file system creation. By default generated by this provider. See [Elastic File System] user guide for more information.
- encrypted bool
If true, the disk will be encrypted.
- kms_
key_ strid The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
- lifecycle_
policies Sequence[FileSystem Lifecycle Policy Args] A file system lifecycle policy object (documented below).
- performance_
mode str The file system performance mode. Can be either
"generalPurpose"
or"maxIO"
(Default:"generalPurpose"
).- provisioned_
throughput_ floatin_ mibps The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with
throughput_mode
set toprovisioned
.- Mapping[str, str]
A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- throughput_
mode str Throughput mode for the file system. Defaults to
bursting
. Valid values:bursting
,provisioned
, orelastic
. When usingprovisioned
, also setprovisioned_throughput_in_mibps
.
- availability
Zone StringName the AWS Availability Zone in which to create the file system. Used to create a file system that uses One Zone storage classes. See user guide for more information.
- creation
Token String A unique name (a maximum of 64 characters are allowed) used as reference when creating the Elastic File System to ensure idempotent file system creation. By default generated by this provider. See [Elastic File System] user guide for more information.
- encrypted Boolean
If true, the disk will be encrypted.
- kms
Key StringId The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
- lifecycle
Policies List<Property Map> A file system lifecycle policy object (documented below).
- performance
Mode String The file system performance mode. Can be either
"generalPurpose"
or"maxIO"
(Default:"generalPurpose"
).- provisioned
Throughput NumberIn Mibps The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with
throughput_mode
set toprovisioned
.- Map<String>
A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- throughput
Mode String Throughput mode for the file system. Defaults to
bursting
. Valid values:bursting
,provisioned
, orelastic
. When usingprovisioned
, also setprovisioned_throughput_in_mibps
.
Outputs
All input properties are implicitly available as output properties. Additionally, the FileSystem resource produces the following output properties:
- Arn string
Amazon Resource Name of the file system.
- Availability
Zone stringId The identifier of the Availability Zone in which the file system's One Zone storage classes exist.
- Dns
Name string The DNS name for the filesystem per documented convention.
- Id string
The provider-assigned unique ID for this managed resource.
- Name string
The value of the file system's
Name
tag.- Number
Of intMount Targets The current number of mount targets that the file system has.
- Owner
Id string The AWS account that created the file system. If the file system was createdby an IAM user, the parent account to which the user belongs is the owner.
- Size
In List<FileBytes System Size In Byte> The latest known metered size (in bytes) of data stored in the file system, the value is not the exact size that the file system was at any point in time. See Size In Bytes.
- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- Arn string
Amazon Resource Name of the file system.
- Availability
Zone stringId The identifier of the Availability Zone in which the file system's One Zone storage classes exist.
- Dns
Name string The DNS name for the filesystem per documented convention.
- Id string
The provider-assigned unique ID for this managed resource.
- Name string
The value of the file system's
Name
tag.- Number
Of intMount Targets The current number of mount targets that the file system has.
- Owner
Id string The AWS account that created the file system. If the file system was createdby an IAM user, the parent account to which the user belongs is the owner.
- Size
In []FileBytes System Size In Byte The latest known metered size (in bytes) of data stored in the file system, the value is not the exact size that the file system was at any point in time. See Size In Bytes.
- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- arn String
Amazon Resource Name of the file system.
- availability
Zone StringId The identifier of the Availability Zone in which the file system's One Zone storage classes exist.
- dns
Name String The DNS name for the filesystem per documented convention.
- id String
The provider-assigned unique ID for this managed resource.
- name String
The value of the file system's
Name
tag.- number
Of IntegerMount Targets The current number of mount targets that the file system has.
- owner
Id String The AWS account that created the file system. If the file system was createdby an IAM user, the parent account to which the user belongs is the owner.
- size
In List<FileBytes System Size In Byte> The latest known metered size (in bytes) of data stored in the file system, the value is not the exact size that the file system was at any point in time. See Size In Bytes.
- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- arn string
Amazon Resource Name of the file system.
- availability
Zone stringId The identifier of the Availability Zone in which the file system's One Zone storage classes exist.
- dns
Name string The DNS name for the filesystem per documented convention.
- id string
The provider-assigned unique ID for this managed resource.
- name string
The value of the file system's
Name
tag.- number
Of numberMount Targets The current number of mount targets that the file system has.
- owner
Id string The AWS account that created the file system. If the file system was createdby an IAM user, the parent account to which the user belongs is the owner.
- size
In FileBytes System Size In Byte[] The latest known metered size (in bytes) of data stored in the file system, the value is not the exact size that the file system was at any point in time. See Size In Bytes.
- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- arn str
Amazon Resource Name of the file system.
- availability_
zone_ strid The identifier of the Availability Zone in which the file system's One Zone storage classes exist.
- dns_
name str The DNS name for the filesystem per documented convention.
- id str
The provider-assigned unique ID for this managed resource.
- name str
The value of the file system's
Name
tag.- number_
of_ intmount_ targets The current number of mount targets that the file system has.
- owner_
id str The AWS account that created the file system. If the file system was createdby an IAM user, the parent account to which the user belongs is the owner.
- size_
in_ Sequence[Filebytes System Size In Byte] The latest known metered size (in bytes) of data stored in the file system, the value is not the exact size that the file system was at any point in time. See Size In Bytes.
- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- arn String
Amazon Resource Name of the file system.
- availability
Zone StringId The identifier of the Availability Zone in which the file system's One Zone storage classes exist.
- dns
Name String The DNS name for the filesystem per documented convention.
- id String
The provider-assigned unique ID for this managed resource.
- name String
The value of the file system's
Name
tag.- number
Of NumberMount Targets The current number of mount targets that the file system has.
- owner
Id String The AWS account that created the file system. If the file system was createdby an IAM user, the parent account to which the user belongs is the owner.
- size
In List<Property Map>Bytes The latest known metered size (in bytes) of data stored in the file system, the value is not the exact size that the file system was at any point in time. See Size In Bytes.
- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
Look up Existing FileSystem Resource
Get an existing FileSystem 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?: FileSystemState, opts?: CustomResourceOptions): FileSystem
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
availability_zone_id: Optional[str] = None,
availability_zone_name: Optional[str] = None,
creation_token: Optional[str] = None,
dns_name: Optional[str] = None,
encrypted: Optional[bool] = None,
kms_key_id: Optional[str] = None,
lifecycle_policies: Optional[Sequence[FileSystemLifecyclePolicyArgs]] = None,
name: Optional[str] = None,
number_of_mount_targets: Optional[int] = None,
owner_id: Optional[str] = None,
performance_mode: Optional[str] = None,
provisioned_throughput_in_mibps: Optional[float] = None,
size_in_bytes: Optional[Sequence[FileSystemSizeInByteArgs]] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
throughput_mode: Optional[str] = None) -> FileSystem
func GetFileSystem(ctx *Context, name string, id IDInput, state *FileSystemState, opts ...ResourceOption) (*FileSystem, error)
public static FileSystem Get(string name, Input<string> id, FileSystemState? state, CustomResourceOptions? opts = null)
public static FileSystem get(String name, Output<String> id, FileSystemState 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.
- Arn string
Amazon Resource Name of the file system.
- Availability
Zone stringId The identifier of the Availability Zone in which the file system's One Zone storage classes exist.
- Availability
Zone stringName the AWS Availability Zone in which to create the file system. Used to create a file system that uses One Zone storage classes. See user guide for more information.
- Creation
Token string A unique name (a maximum of 64 characters are allowed) used as reference when creating the Elastic File System to ensure idempotent file system creation. By default generated by this provider. See [Elastic File System] user guide for more information.
- Dns
Name string The DNS name for the filesystem per documented convention.
- Encrypted bool
If true, the disk will be encrypted.
- Kms
Key stringId The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
- Lifecycle
Policies List<FileSystem Lifecycle Policy> A file system lifecycle policy object (documented below).
- Name string
The value of the file system's
Name
tag.- Number
Of intMount Targets The current number of mount targets that the file system has.
- Owner
Id string The AWS account that created the file system. If the file system was createdby an IAM user, the parent account to which the user belongs is the owner.
- Performance
Mode string The file system performance mode. Can be either
"generalPurpose"
or"maxIO"
(Default:"generalPurpose"
).- Provisioned
Throughput doubleIn Mibps The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with
throughput_mode
set toprovisioned
.- Size
In List<FileBytes System Size In Byte> The latest known metered size (in bytes) of data stored in the file system, the value is not the exact size that the file system was at any point in time. See Size In Bytes.
- Dictionary<string, string>
A map of tags to assign to the file system. 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>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Throughput
Mode string Throughput mode for the file system. Defaults to
bursting
. Valid values:bursting
,provisioned
, orelastic
. When usingprovisioned
, also setprovisioned_throughput_in_mibps
.
- Arn string
Amazon Resource Name of the file system.
- Availability
Zone stringId The identifier of the Availability Zone in which the file system's One Zone storage classes exist.
- Availability
Zone stringName the AWS Availability Zone in which to create the file system. Used to create a file system that uses One Zone storage classes. See user guide for more information.
- Creation
Token string A unique name (a maximum of 64 characters are allowed) used as reference when creating the Elastic File System to ensure idempotent file system creation. By default generated by this provider. See [Elastic File System] user guide for more information.
- Dns
Name string The DNS name for the filesystem per documented convention.
- Encrypted bool
If true, the disk will be encrypted.
- Kms
Key stringId The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
- Lifecycle
Policies []FileSystem Lifecycle Policy Args A file system lifecycle policy object (documented below).
- Name string
The value of the file system's
Name
tag.- Number
Of intMount Targets The current number of mount targets that the file system has.
- Owner
Id string The AWS account that created the file system. If the file system was createdby an IAM user, the parent account to which the user belongs is the owner.
- Performance
Mode string The file system performance mode. Can be either
"generalPurpose"
or"maxIO"
(Default:"generalPurpose"
).- Provisioned
Throughput float64In Mibps The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with
throughput_mode
set toprovisioned
.- Size
In []FileBytes System Size In Byte Args The latest known metered size (in bytes) of data stored in the file system, the value is not the exact size that the file system was at any point in time. See Size In Bytes.
- map[string]string
A map of tags to assign to the file system. 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
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Throughput
Mode string Throughput mode for the file system. Defaults to
bursting
. Valid values:bursting
,provisioned
, orelastic
. When usingprovisioned
, also setprovisioned_throughput_in_mibps
.
- arn String
Amazon Resource Name of the file system.
- availability
Zone StringId The identifier of the Availability Zone in which the file system's One Zone storage classes exist.
- availability
Zone StringName the AWS Availability Zone in which to create the file system. Used to create a file system that uses One Zone storage classes. See user guide for more information.
- creation
Token String A unique name (a maximum of 64 characters are allowed) used as reference when creating the Elastic File System to ensure idempotent file system creation. By default generated by this provider. See [Elastic File System] user guide for more information.
- dns
Name String The DNS name for the filesystem per documented convention.
- encrypted Boolean
If true, the disk will be encrypted.
- kms
Key StringId The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
- lifecycle
Policies List<FileSystem Lifecycle Policy> A file system lifecycle policy object (documented below).
- name String
The value of the file system's
Name
tag.- number
Of IntegerMount Targets The current number of mount targets that the file system has.
- owner
Id String The AWS account that created the file system. If the file system was createdby an IAM user, the parent account to which the user belongs is the owner.
- performance
Mode String The file system performance mode. Can be either
"generalPurpose"
or"maxIO"
(Default:"generalPurpose"
).- provisioned
Throughput DoubleIn Mibps The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with
throughput_mode
set toprovisioned
.- size
In List<FileBytes System Size In Byte> The latest known metered size (in bytes) of data stored in the file system, the value is not the exact size that the file system was at any point in time. See Size In Bytes.
- Map<String,String>
A map of tags to assign to the file system. 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>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- throughput
Mode String Throughput mode for the file system. Defaults to
bursting
. Valid values:bursting
,provisioned
, orelastic
. When usingprovisioned
, also setprovisioned_throughput_in_mibps
.
- arn string
Amazon Resource Name of the file system.
- availability
Zone stringId The identifier of the Availability Zone in which the file system's One Zone storage classes exist.
- availability
Zone stringName the AWS Availability Zone in which to create the file system. Used to create a file system that uses One Zone storage classes. See user guide for more information.
- creation
Token string A unique name (a maximum of 64 characters are allowed) used as reference when creating the Elastic File System to ensure idempotent file system creation. By default generated by this provider. See [Elastic File System] user guide for more information.
- dns
Name string The DNS name for the filesystem per documented convention.
- encrypted boolean
If true, the disk will be encrypted.
- kms
Key stringId The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
- lifecycle
Policies FileSystem Lifecycle Policy[] A file system lifecycle policy object (documented below).
- name string
The value of the file system's
Name
tag.- number
Of numberMount Targets The current number of mount targets that the file system has.
- owner
Id string The AWS account that created the file system. If the file system was createdby an IAM user, the parent account to which the user belongs is the owner.
- performance
Mode string The file system performance mode. Can be either
"generalPurpose"
or"maxIO"
(Default:"generalPurpose"
).- provisioned
Throughput numberIn Mibps The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with
throughput_mode
set toprovisioned
.- size
In FileBytes System Size In Byte[] The latest known metered size (in bytes) of data stored in the file system, the value is not the exact size that the file system was at any point in time. See Size In Bytes.
- {[key: string]: string}
A map of tags to assign to the file system. 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}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- throughput
Mode string Throughput mode for the file system. Defaults to
bursting
. Valid values:bursting
,provisioned
, orelastic
. When usingprovisioned
, also setprovisioned_throughput_in_mibps
.
- arn str
Amazon Resource Name of the file system.
- availability_
zone_ strid The identifier of the Availability Zone in which the file system's One Zone storage classes exist.
- availability_
zone_ strname the AWS Availability Zone in which to create the file system. Used to create a file system that uses One Zone storage classes. See user guide for more information.
- creation_
token str A unique name (a maximum of 64 characters are allowed) used as reference when creating the Elastic File System to ensure idempotent file system creation. By default generated by this provider. See [Elastic File System] user guide for more information.
- dns_
name str The DNS name for the filesystem per documented convention.
- encrypted bool
If true, the disk will be encrypted.
- kms_
key_ strid The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
- lifecycle_
policies Sequence[FileSystem Lifecycle Policy Args] A file system lifecycle policy object (documented below).
- name str
The value of the file system's
Name
tag.- number_
of_ intmount_ targets The current number of mount targets that the file system has.
- owner_
id str The AWS account that created the file system. If the file system was createdby an IAM user, the parent account to which the user belongs is the owner.
- performance_
mode str The file system performance mode. Can be either
"generalPurpose"
or"maxIO"
(Default:"generalPurpose"
).- provisioned_
throughput_ floatin_ mibps The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with
throughput_mode
set toprovisioned
.- size_
in_ Sequence[Filebytes System Size In Byte Args] The latest known metered size (in bytes) of data stored in the file system, the value is not the exact size that the file system was at any point in time. See Size In Bytes.
- Mapping[str, str]
A map of tags to assign to the file system. 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]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- throughput_
mode str Throughput mode for the file system. Defaults to
bursting
. Valid values:bursting
,provisioned
, orelastic
. When usingprovisioned
, also setprovisioned_throughput_in_mibps
.
- arn String
Amazon Resource Name of the file system.
- availability
Zone StringId The identifier of the Availability Zone in which the file system's One Zone storage classes exist.
- availability
Zone StringName the AWS Availability Zone in which to create the file system. Used to create a file system that uses One Zone storage classes. See user guide for more information.
- creation
Token String A unique name (a maximum of 64 characters are allowed) used as reference when creating the Elastic File System to ensure idempotent file system creation. By default generated by this provider. See [Elastic File System] user guide for more information.
- dns
Name String The DNS name for the filesystem per documented convention.
- encrypted Boolean
If true, the disk will be encrypted.
- kms
Key StringId The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
- lifecycle
Policies List<Property Map> A file system lifecycle policy object (documented below).
- name String
The value of the file system's
Name
tag.- number
Of NumberMount Targets The current number of mount targets that the file system has.
- owner
Id String The AWS account that created the file system. If the file system was createdby an IAM user, the parent account to which the user belongs is the owner.
- performance
Mode String The file system performance mode. Can be either
"generalPurpose"
or"maxIO"
(Default:"generalPurpose"
).- provisioned
Throughput NumberIn Mibps The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with
throughput_mode
set toprovisioned
.- size
In List<Property Map>Bytes The latest known metered size (in bytes) of data stored in the file system, the value is not the exact size that the file system was at any point in time. See Size In Bytes.
- Map<String>
A map of tags to assign to the file system. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- throughput
Mode String Throughput mode for the file system. Defaults to
bursting
. Valid values:bursting
,provisioned
, orelastic
. When usingprovisioned
, also setprovisioned_throughput_in_mibps
.
Supporting Types
FileSystemLifecyclePolicy, FileSystemLifecyclePolicyArgs
- Transition
To stringIa Indicates how long it takes to transition files to the IA storage class. Valid values:
AFTER_1_DAY
,AFTER_7_DAYS
,AFTER_14_DAYS
,AFTER_30_DAYS
,AFTER_60_DAYS
, orAFTER_90_DAYS
.- Transition
To stringPrimary Storage Class Describes the policy used to transition a file from infequent access storage to primary storage. Valid values:
AFTER_1_ACCESS
.
- Transition
To stringIa Indicates how long it takes to transition files to the IA storage class. Valid values:
AFTER_1_DAY
,AFTER_7_DAYS
,AFTER_14_DAYS
,AFTER_30_DAYS
,AFTER_60_DAYS
, orAFTER_90_DAYS
.- Transition
To stringPrimary Storage Class Describes the policy used to transition a file from infequent access storage to primary storage. Valid values:
AFTER_1_ACCESS
.
- transition
To StringIa Indicates how long it takes to transition files to the IA storage class. Valid values:
AFTER_1_DAY
,AFTER_7_DAYS
,AFTER_14_DAYS
,AFTER_30_DAYS
,AFTER_60_DAYS
, orAFTER_90_DAYS
.- transition
To StringPrimary Storage Class Describes the policy used to transition a file from infequent access storage to primary storage. Valid values:
AFTER_1_ACCESS
.
- transition
To stringIa Indicates how long it takes to transition files to the IA storage class. Valid values:
AFTER_1_DAY
,AFTER_7_DAYS
,AFTER_14_DAYS
,AFTER_30_DAYS
,AFTER_60_DAYS
, orAFTER_90_DAYS
.- transition
To stringPrimary Storage Class Describes the policy used to transition a file from infequent access storage to primary storage. Valid values:
AFTER_1_ACCESS
.
- transition_
to_ stria Indicates how long it takes to transition files to the IA storage class. Valid values:
AFTER_1_DAY
,AFTER_7_DAYS
,AFTER_14_DAYS
,AFTER_30_DAYS
,AFTER_60_DAYS
, orAFTER_90_DAYS
.- transition_
to_ strprimary_ storage_ class Describes the policy used to transition a file from infequent access storage to primary storage. Valid values:
AFTER_1_ACCESS
.
- transition
To StringIa Indicates how long it takes to transition files to the IA storage class. Valid values:
AFTER_1_DAY
,AFTER_7_DAYS
,AFTER_14_DAYS
,AFTER_30_DAYS
,AFTER_60_DAYS
, orAFTER_90_DAYS
.- transition
To StringPrimary Storage Class Describes the policy used to transition a file from infequent access storage to primary storage. Valid values:
AFTER_1_ACCESS
.
FileSystemSizeInByte, FileSystemSizeInByteArgs
- Value int
The latest known metered size (in bytes) of data stored in the file system.
- Value
In intIa The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.
- Value
In intStandard The latest known metered size (in bytes) of data stored in the Standard storage class.
- Value int
The latest known metered size (in bytes) of data stored in the file system.
- Value
In intIa The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.
- Value
In intStandard The latest known metered size (in bytes) of data stored in the Standard storage class.
- value Integer
The latest known metered size (in bytes) of data stored in the file system.
- value
In IntegerIa The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.
- value
In IntegerStandard The latest known metered size (in bytes) of data stored in the Standard storage class.
- value number
The latest known metered size (in bytes) of data stored in the file system.
- value
In numberIa The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.
- value
In numberStandard The latest known metered size (in bytes) of data stored in the Standard storage class.
- value int
The latest known metered size (in bytes) of data stored in the file system.
- value_
in_ intia The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.
- value_
in_ intstandard The latest known metered size (in bytes) of data stored in the Standard storage class.
- value Number
The latest known metered size (in bytes) of data stored in the file system.
- value
In NumberIa The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.
- value
In NumberStandard The latest known metered size (in bytes) of data stored in the Standard storage class.
Import
Using pulumi import
, import the EFS file systems using the id
. For example:
$ pulumi import aws:efs/fileSystem:FileSystem foo fs-6fa144c6
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.