Module efs

@pulumi/aws > efs

Index

efs/fileSystem.ts efs/getFileSystem.ts efs/getMountTarget.ts efs/mountTarget.ts

class FileSystem

Provides an Elastic File System (EFS) resource.

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): 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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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 Terraform. See [Elastic File System] (http://docs.aws.amazon.com/efs/latest/ug/) 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 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 throughput_mode set to provisioned.

property referenceName

public referenceName: pulumi.Output<string>;

DEPRECATED (Optional) A reference name used when creating the Creation Token which Amazon EFS uses to ensure idempotent file system creation. By default generated by Terraform.

property tags

public tags: pulumi.Output<Tags | undefined>;

A mapping 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 provisioned_throughput_in_mibps.

property urn

urn: Output<URN>;

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

class MountTarget

Provides an Elastic File System (EFS) mount target.

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): 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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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.

function getFileSystem

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

Provides information about an Elastic File System (EFS).

function getMountTarget

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

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

interface FileSystemArgs

The set of arguments for constructing a FileSystem resource.

property creationToken

creationToken?: pulumi.Input<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 Terraform. See [Elastic File System] (http://docs.aws.amazon.com/efs/latest/ug/) user guide for more information.

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 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 throughput_mode set to provisioned.

property referenceName

referenceName?: pulumi.Input<string>;

DEPRECATED (Optional) A reference name used when creating the Creation Token which Amazon EFS uses to ensure idempotent file system creation. By default generated by Terraform.

property tags

tags?: pulumi.Input<Tags>;

A mapping 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 provisioned_throughput_in_mibps.

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>;

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 Terraform. See [Elastic File System] (http://docs.aws.amazon.com/efs/latest/ug/) user guide for more information.

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 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 throughput_mode set to provisioned.

property referenceName

referenceName?: pulumi.Input<string>;

DEPRECATED (Optional) A reference name used when creating the Creation Token which Amazon EFS uses to ensure idempotent file system creation. By default generated by Terraform.

property tags

tags?: pulumi.Input<Tags>;

A mapping 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 provisioned_throughput_in_mibps.

interface GetFileSystemArgs

A collection of arguments for invoking getFileSystem.

property creationToken

creationToken?: string;

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

property fileSystemId

fileSystemId?: string;

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

property tags

tags?: { ... };

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;

id is the provider-assigned unique ID for this managed resource.

property kmsKeyId

kmsKeyId: string;

The ARN for the KMS encryption key.

property performanceMode

performanceMode: string;

The PerformanceMode of the file system.

property tags

tags: { ... };

The list of tags assigned to the file system.

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

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;

id is 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 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

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

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.