Module efs

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Resources

Resource AccessPoint

class AccessPoint extends CustomResource

Provides an Elastic File System (EFS) access point.

Example Usage

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

const test = new aws.efs.AccessPoint("test", {
    fileSystemId: aws_efs_file_system_foo.id,
});

constructor

new AccessPoint(name: string, args: AccessPointArgs, opts?: pulumi.CustomResourceOptions)

Create a AccessPoint resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AccessPointState, opts?: pulumi.CustomResourceOptions): AccessPoint

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AccessPoint

Returns true if the given object is an instance of AccessPoint. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name of the access point.

property fileSystemArn

public fileSystemArn: pulumi.Output<string>;

Amazon Resource Name of the file system.

property fileSystemId

public fileSystemId: pulumi.Output<string>;

The ID of the file system for which the access point is intended.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ownerId

public ownerId: pulumi.Output<string>;

property posixUser

public posixUser: pulumi.Output<AccessPointPosixUser | undefined>;

The operating system user and group applied to all file system requests made using the access point. See Posix User below.

property rootDirectory

public rootDirectory: pulumi.Output<AccessPointRootDirectory>;

Specifies the directory on the Amazon EFS file system that the access point provides access to. See Root Directory below.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value mapping of resource tags.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource FileSystem

class FileSystem extends CustomResource

Provides an Elastic File System (EFS) File System resource.

Example Usage

EFS File System w/ tags

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

const foo = new aws.efs.FileSystem("foo", {
    tags: {
        Name: "MyProduct",
    },
});

Using lifecycle policy

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

const fooWithLifecylePolicy = new aws.efs.FileSystem("foo_with_lifecyle_policy", {
    lifecyclePolicy: {
        transitionToIa: "AFTER_30_DAYS",
    },
});

constructor

new FileSystem(name: string, args?: FileSystemArgs, opts?: pulumi.CustomResourceOptions)

Create a FileSystem resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FileSystemState, opts?: pulumi.CustomResourceOptions): FileSystem

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is FileSystem

Returns true if the given object is an instance of FileSystem. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name of the file system.

property creationToken

public creationToken: pulumi.Output<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.

property dnsName

public dnsName: pulumi.Output<string>;

The DNS name for the filesystem per documented convention.

property encrypted

public encrypted: pulumi.Output<boolean>;

If true, the disk will be encrypted.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kmsKeyId

public kmsKeyId: pulumi.Output<string>;

The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.

property lifecyclePolicy

public lifecyclePolicy: pulumi.Output<FileSystemLifecyclePolicy | undefined>;

A file system lifecycle policy object (documented below).

property performanceMode

public performanceMode: pulumi.Output<string>;

The file system performance mode. Can be either "generalPurpose" or "maxIO" (Default: "generalPurpose").

property provisionedThroughputInMibps

public provisionedThroughputInMibps: pulumi.Output<number | undefined>;

The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with throughputMode set to provisioned.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the file system.

property throughputMode

public throughputMode: pulumi.Output<string | undefined>;

Throughput mode for the file system. Defaults to bursting. Valid values: bursting, provisioned. When using provisioned, also set provisionedThroughputInMibps.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource FileSystemPolicy

class FileSystemPolicy extends CustomResource

Provides an Elastic File System (EFS) File System Policy resource.

Example Usage

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

const fs = new aws.efs.FileSystem("fs", {});
const policy = new aws.efs.FileSystemPolicy("policy", {
    fileSystemId: fs.id,
    policy: pulumi.interpolate`{
    "Version": "2012-10-17",
    "Id": "ExamplePolicy01",
    "Statement": [
        {
            "Sid": "ExampleSatement01",
            "Effect": "Allow",
            "Principal": {
                "AWS": "*"
            },
            "Resource": "${aws_efs_file_system_test.arn}",
            "Action": [
                "elasticfilesystem:ClientMount",
                "elasticfilesystem:ClientWrite"
            ],
            "Condition": {
                "Bool": {
                    "aws:SecureTransport": "true"
                }
            }
        }
    ]
}
`,
});

constructor

new FileSystemPolicy(name: string, args: FileSystemPolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a FileSystemPolicy resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FileSystemPolicyState, opts?: pulumi.CustomResourceOptions): FileSystemPolicy

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is FileSystemPolicy

Returns true if the given object is an instance of FileSystemPolicy. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property fileSystemId

public fileSystemId: pulumi.Output<string>;

The ID of the EFS file system.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property policy

public policy: pulumi.Output<string>;

The JSON formatted file system policy for the EFS file system. see Docs for more info.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource MountTarget

class MountTarget extends CustomResource

Provides an Elastic File System (EFS) mount target.

Example Usage

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

const foo = new aws.ec2.Vpc("foo", {
    cidrBlock: "10.0.0.0/16",
});
const alphaSubnet = new aws.ec2.Subnet("alpha", {
    availabilityZone: "us-west-2a",
    cidrBlock: "10.0.1.0/24",
    vpcId: foo.id,
});
const alphaMountTarget = new aws.efs.MountTarget("alpha", {
    fileSystemId: aws_efs_file_system_foo.id,
    subnetId: alphaSubnet.id,
});

constructor

new MountTarget(name: string, args: MountTargetArgs, opts?: pulumi.CustomResourceOptions)

Create a MountTarget resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MountTargetState, opts?: pulumi.CustomResourceOptions): MountTarget

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is MountTarget

Returns true if the given object is an instance of MountTarget. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property dnsName

public dnsName: pulumi.Output<string>;

The DNS name for the given subnet/AZ per documented convention.

property fileSystemArn

public fileSystemArn: pulumi.Output<string>;

Amazon Resource Name of the file system.

property fileSystemId

public fileSystemId: pulumi.Output<string>;

The ID of the file system for which the mount target is intended.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipAddress

public ipAddress: pulumi.Output<string>;

The address (within the address range of the specified subnet) at which the file system may be mounted via the mount target.

property networkInterfaceId

public networkInterfaceId: pulumi.Output<string>;

The ID of the network interface that Amazon EFS created when it created the mount target.

property securityGroups

public securityGroups: pulumi.Output<string[]>;

A list of up to 5 VPC security group IDs (that must be for the same VPC as subnet specified) in effect for the mount target.

property subnetId

public subnetId: pulumi.Output<string>;

The ID of the subnet to add the mount target in.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getAccessPoint

getAccessPoint(args: GetAccessPointArgs, opts?: pulumi.InvokeOptions): Promise<GetAccessPointResult>

Provides information about an Elastic File System (EFS) Access Point.

Example Usage

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

const test = pulumi.output(aws.efs.getAccessPoint({
    accessPointId: "fsap-12345678",
}, { async: true }));

Function getFileSystem

getFileSystem(args?: GetFileSystemArgs, opts?: pulumi.InvokeOptions): Promise<GetFileSystemResult>

Provides information about an Elastic File System (EFS) File System.

Example Usage

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

const config = new pulumi.Config();
const fileSystemId = config.get("fileSystemId") || "";

const byId = pulumi.output(aws.efs.getFileSystem({
    fileSystemId: fileSystemId,
}, { async: true }));

Function getMountTarget

getMountTarget(args: GetMountTargetArgs, opts?: pulumi.InvokeOptions): Promise<GetMountTargetResult>

Provides information about an Elastic File System Mount Target (EFS).

Example Usage

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

const config = new pulumi.Config();
const mountTargetId = config.get("mountTargetId") || "";

const byId = pulumi.output(aws.efs.getMountTarget({
    mountTargetId: mountTargetId,
}, { async: true }));

Others

interface AccessPointArgs

interface AccessPointArgs

The set of arguments for constructing a AccessPoint resource.

property fileSystemId

fileSystemId: pulumi.Input<string>;

The ID of the file system for which the access point is intended.

property posixUser

posixUser?: pulumi.Input<AccessPointPosixUser>;

The operating system user and group applied to all file system requests made using the access point. See Posix User below.

property rootDirectory

rootDirectory?: pulumi.Input<AccessPointRootDirectory>;

Specifies the directory on the Amazon EFS file system that the access point provides access to. See Root Directory below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value mapping of resource tags.

interface AccessPointState

interface AccessPointState

Input properties used for looking up and filtering AccessPoint resources.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name of the access point.

property fileSystemArn

fileSystemArn?: pulumi.Input<string>;

Amazon Resource Name of the file system.

property fileSystemId

fileSystemId?: pulumi.Input<string>;

The ID of the file system for which the access point is intended.

property ownerId

ownerId?: pulumi.Input<string>;

property posixUser

posixUser?: pulumi.Input<AccessPointPosixUser>;

The operating system user and group applied to all file system requests made using the access point. See Posix User below.

property rootDirectory

rootDirectory?: pulumi.Input<AccessPointRootDirectory>;

Specifies the directory on the Amazon EFS file system that the access point provides access to. See Root Directory below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value mapping of resource tags.

interface FileSystemArgs

interface FileSystemArgs

The set of arguments for constructing a FileSystem resource.

property creationToken

creationToken?: pulumi.Input<string>;

property encrypted

encrypted?: pulumi.Input<boolean>;

If true, the disk will be encrypted.

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.

property lifecyclePolicy

lifecyclePolicy?: pulumi.Input<FileSystemLifecyclePolicy>;

A file system lifecycle policy object (documented below).

property performanceMode

performanceMode?: pulumi.Input<string>;

The file system performance mode. Can be either "generalPurpose" or "maxIO" (Default: "generalPurpose").

property provisionedThroughputInMibps

provisionedThroughputInMibps?: pulumi.Input<number>;

The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with throughputMode set to provisioned.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the file system.

property throughputMode

throughputMode?: pulumi.Input<string>;

Throughput mode for the file system. Defaults to bursting. Valid values: bursting, provisioned. When using provisioned, also set provisionedThroughputInMibps.

interface FileSystemPolicyArgs

interface FileSystemPolicyArgs

The set of arguments for constructing a FileSystemPolicy resource.

property fileSystemId

fileSystemId: pulumi.Input<string>;

The ID of the EFS file system.

property policy

policy: pulumi.Input<string>;

The JSON formatted file system policy for the EFS file system. see Docs for more info.

interface FileSystemPolicyState

interface FileSystemPolicyState

Input properties used for looking up and filtering FileSystemPolicy resources.

property fileSystemId

fileSystemId?: pulumi.Input<string>;

The ID of the EFS file system.

property policy

policy?: pulumi.Input<string>;

The JSON formatted file system policy for the EFS file system. see Docs for more info.

interface FileSystemState

interface FileSystemState

Input properties used for looking up and filtering FileSystem resources.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name of the file system.

property creationToken

creationToken?: pulumi.Input<string>;

property dnsName

dnsName?: pulumi.Input<string>;

The DNS name for the filesystem per documented convention.

property encrypted

encrypted?: pulumi.Input<boolean>;

If true, the disk will be encrypted.

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.

property lifecyclePolicy

lifecyclePolicy?: pulumi.Input<FileSystemLifecyclePolicy>;

A file system lifecycle policy object (documented below).

property performanceMode

performanceMode?: pulumi.Input<string>;

The file system performance mode. Can be either "generalPurpose" or "maxIO" (Default: "generalPurpose").

property provisionedThroughputInMibps

provisionedThroughputInMibps?: pulumi.Input<number>;

The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with throughputMode set to provisioned.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the file system.

property throughputMode

throughputMode?: pulumi.Input<string>;

Throughput mode for the file system. Defaults to bursting. Valid values: bursting, provisioned. When using provisioned, also set provisionedThroughputInMibps.

interface GetAccessPointArgs

interface GetAccessPointArgs

A collection of arguments for invoking getAccessPoint.

property accessPointId

accessPointId: string;

The ID that identifies the file system.

property tags

tags?: undefined | {[key: string]: any};

Key-value mapping of resource tags.

interface GetAccessPointResult

interface GetAccessPointResult

A collection of values returned by getAccessPoint.

property accessPointId

accessPointId: string;

property arn

arn: string;

Amazon Resource Name of the file system.

property fileSystemArn

fileSystemArn: string;

Amazon Resource Name of the file system.

property fileSystemId

fileSystemId: string;

The ID of the file system for which the access point is intended.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ownerId

ownerId: string;

property posixUsers

posixUsers: GetAccessPointPosixUser[];

Single element list containing operating system user and group applied to all file system requests made using the access point.

property rootDirectories

rootDirectories: GetAccessPointRootDirectory[];

property tags

tags?: undefined | {[key: string]: any};

Key-value mapping of resource tags.

interface GetFileSystemArgs

interface GetFileSystemArgs

A collection of arguments for invoking getFileSystem.

property creationToken

creationToken?: undefined | string;

Restricts the list to the file system with this creation token.

property fileSystemId

fileSystemId?: undefined | string;

The ID that identifies the file system (e.g. fs-ccfc0d65).

property tags

tags?: undefined | {[key: string]: any};

interface GetFileSystemResult

interface GetFileSystemResult

A collection of values returned by getFileSystem.

property arn

arn: string;

Amazon Resource Name of the file system.

property creationToken

creationToken: string;

property dnsName

dnsName: string;

The DNS name for the filesystem per documented convention.

property encrypted

encrypted: boolean;

Whether EFS is encrypted.

property fileSystemId

fileSystemId: string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property kmsKeyId

kmsKeyId: string;

The ARN for the KMS encryption key.

property lifecyclePolicy

lifecyclePolicy: GetFileSystemLifecyclePolicy;

A file system lifecycle policy object.

property performanceMode

performanceMode: string;

The file system performance mode.

property provisionedThroughputInMibps

provisionedThroughputInMibps: number;

The throughput, measured in MiB/s, that you want to provision for the file system. * tags -A map of tags to assign to the file system.

property sizeInBytes

sizeInBytes: number;

The current byte count used by the file system.

property tags

tags: {[key: string]: any};

property throughputMode

throughputMode: string;

Throughput mode for the file system.

interface GetMountTargetArgs

interface GetMountTargetArgs

A collection of arguments for invoking getMountTarget.

property mountTargetId

mountTargetId: string;

ID of the mount target that you want to have described

interface GetMountTargetResult

interface GetMountTargetResult

A collection of values returned by getMountTarget.

property dnsName

dnsName: string;

The DNS name for the given subnet/AZ per documented convention.

property fileSystemArn

fileSystemArn: string;

Amazon Resource Name of the file system for which the mount target is intended.

property fileSystemId

fileSystemId: string;

ID of the file system for which the mount target is intended.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ipAddress

ipAddress: string;

Address at which the file system may be mounted via the mount target.

property mountTargetId

mountTargetId: string;

property networkInterfaceId

networkInterfaceId: string;

The ID of the network interface that Amazon EFS created when it created the mount target.

property securityGroups

securityGroups: string[];

List of VPC security group IDs attached to the mount target.

property subnetId

subnetId: string;

ID of the mount target’s subnet.

interface MountTargetArgs

interface MountTargetArgs

The set of arguments for constructing a MountTarget resource.

property fileSystemId

fileSystemId: pulumi.Input<string>;

The ID of the file system for which the mount target is intended.

property ipAddress

ipAddress?: pulumi.Input<string>;

The address (within the address range of the specified subnet) at which the file system may be mounted via the mount target.

property securityGroups

securityGroups?: pulumi.Input<pulumi.Input<string>[]>;

A list of up to 5 VPC security group IDs (that must be for the same VPC as subnet specified) in effect for the mount target.

property subnetId

subnetId: pulumi.Input<string>;

The ID of the subnet to add the mount target in.

interface MountTargetState

interface MountTargetState

Input properties used for looking up and filtering MountTarget resources.

property dnsName

dnsName?: pulumi.Input<string>;

The DNS name for the given subnet/AZ per documented convention.

property fileSystemArn

fileSystemArn?: pulumi.Input<string>;

Amazon Resource Name of the file system.

property fileSystemId

fileSystemId?: pulumi.Input<string>;

The ID of the file system for which the mount target is intended.

property ipAddress

ipAddress?: pulumi.Input<string>;

The address (within the address range of the specified subnet) at which the file system may be mounted via the mount target.

property networkInterfaceId

networkInterfaceId?: pulumi.Input<string>;

The ID of the network interface that Amazon EFS created when it created the mount target.

property securityGroups

securityGroups?: pulumi.Input<pulumi.Input<string>[]>;

A list of up to 5 VPC security group IDs (that must be for the same VPC as subnet specified) in effect for the mount target.

property subnetId

subnetId?: pulumi.Input<string>;

The ID of the subnet to add the mount target in.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module efs

Resources

Functions

Others

Resources

Example Usage

Example Usage

EFS File System w/ tags

Using lifecycle policy

Example Usage

Example Usage

Functions

Example Usage

Example Usage

Example Usage

Others