efs

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.

class pulumi_aws.efs.AwaitableGetFileSystemResult(arn=None, creation_token=None, dns_name=None, encrypted=None, file_system_id=None, kms_key_id=None, performance_mode=None, tags=None, id=None)
class pulumi_aws.efs.AwaitableGetMountTargetResult(dns_name=None, file_system_arn=None, file_system_id=None, ip_address=None, mount_target_id=None, network_interface_id=None, security_groups=None, subnet_id=None, id=None)
class pulumi_aws.efs.FileSystem(resource_name, opts=None, creation_token=None, encrypted=None, kms_key_id=None, lifecycle_policy=None, performance_mode=None, provisioned_throughput_in_mibps=None, tags=None, throughput_mode=None, __props__=None, __name__=None, __opts__=None)

Provides an Elastic File System (EFS) resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • creation_token (pulumi.Input[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] (http://docs.aws.amazon.com/efs/latest/ug/) user guide for more information.

  • encrypted (pulumi.Input[bool]) – If true, the disk will be encrypted.

  • kms_key_id (pulumi.Input[str]) – The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.

  • lifecycle_policy (pulumi.Input[dict]) – A file system lifecycle policy object (documented below).

  • performance_mode (pulumi.Input[str]) – The file system performance mode. Can be either "generalPurpose" or "maxIO" (Default: "generalPurpose").

  • provisioned_throughput_in_mibps (pulumi.Input[float]) – The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with throughput_mode set to provisioned.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the file system.

  • throughput_mode (pulumi.Input[str]) – Throughput mode for the file system. Defaults to bursting. Valid values: bursting, provisioned. When using provisioned, also set provisioned_throughput_in_mibps.

The lifecycle_policy object supports the following:

  • transitionToIa (pulumi.Input[str]) - Indicates how long it takes to transition files to the IA storage class. Valid values: AFTER_14_DAYS, AFTER_30_DAYS, AFTER_60_DAYS, or AFTER_90_DAYS.

arn = None

Amazon Resource Name of the file system.

creation_token = None

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

dns_name = None

The DNS name for the filesystem per documented convention.

encrypted = None

If true, the disk will be encrypted.

kms_key_id = None

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

lifecycle_policy = None

A file system lifecycle policy object (documented below).

  • transitionToIa (str) - Indicates how long it takes to transition files to the IA storage class. Valid values: AFTER_14_DAYS, AFTER_30_DAYS, AFTER_60_DAYS, or AFTER_90_DAYS.

performance_mode = None

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

provisioned_throughput_in_mibps = None

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

tags = None

A mapping of tags to assign to the file system.

throughput_mode = None

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

static get(resource_name, id, opts=None, arn=None, creation_token=None, dns_name=None, encrypted=None, kms_key_id=None, lifecycle_policy=None, performance_mode=None, provisioned_throughput_in_mibps=None, tags=None, throughput_mode=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • arn (pulumi.Input[str]) – Amazon Resource Name of the file system.

  • creation_token (pulumi.Input[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] (http://docs.aws.amazon.com/efs/latest/ug/) user guide for more information.

  • dns_name (pulumi.Input[str]) –

    The DNS name for the filesystem per documented convention.

  • encrypted (pulumi.Input[bool]) – If true, the disk will be encrypted.

  • kms_key_id (pulumi.Input[str]) – The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.

  • lifecycle_policy (pulumi.Input[dict]) –

    A file system lifecycle policy object (documented below).

  • performance_mode (pulumi.Input[str]) – The file system performance mode. Can be either "generalPurpose" or "maxIO" (Default: "generalPurpose").

  • provisioned_throughput_in_mibps (pulumi.Input[float]) – The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with throughput_mode set to provisioned.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the file system.

  • throughput_mode (pulumi.Input[str]) – Throughput mode for the file system. Defaults to bursting. Valid values: bursting, provisioned. When using provisioned, also set provisioned_throughput_in_mibps.

The lifecycle_policy object supports the following:

  • transitionToIa (pulumi.Input[str]) - Indicates how long it takes to transition files to the IA storage class. Valid values: AFTER_14_DAYS, AFTER_30_DAYS, AFTER_60_DAYS, or AFTER_90_DAYS.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.efs.GetFileSystemResult(arn=None, creation_token=None, dns_name=None, encrypted=None, file_system_id=None, kms_key_id=None, performance_mode=None, tags=None, id=None)

A collection of values returned by getFileSystem.

arn = None

Amazon Resource Name of the file system.

dns_name = None

The DNS name for the filesystem per documented convention.

encrypted = None

Whether EFS is encrypted.

kms_key_id = None

The ARN for the KMS encryption key.

performance_mode = None

The PerformanceMode of the file system.

tags = None

The list of tags assigned to the file system.

id = None

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

class pulumi_aws.efs.GetMountTargetResult(dns_name=None, file_system_arn=None, file_system_id=None, ip_address=None, mount_target_id=None, network_interface_id=None, security_groups=None, subnet_id=None, id=None)

A collection of values returned by getMountTarget.

dns_name = None

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

file_system_arn = None

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

file_system_id = None

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

ip_address = None

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

network_interface_id = None

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

security_groups = None

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

subnet_id = None

ID of the mount target’s subnet.

id = None

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

class pulumi_aws.efs.MountTarget(resource_name, opts=None, file_system_id=None, ip_address=None, security_groups=None, subnet_id=None, __props__=None, __name__=None, __opts__=None)

Provides an Elastic File System (EFS) mount target.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • file_system_id (pulumi.Input[str]) – The ID of the file system for which the mount target is intended.

  • ip_address (pulumi.Input[str]) – The address (within the address range of the specified subnet) at which the file system may be mounted via the mount target.

  • security_groups (pulumi.Input[list]) – 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.

  • subnet_id (pulumi.Input[str]) – The ID of the subnet to add the mount target in.

dns_name = None

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

file_system_arn = None

Amazon Resource Name of the file system.

file_system_id = None

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

ip_address = None

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

network_interface_id = None

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

security_groups = None

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.

subnet_id = None

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

static get(resource_name, id, opts=None, dns_name=None, file_system_arn=None, file_system_id=None, ip_address=None, network_interface_id=None, security_groups=None, subnet_id=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • dns_name (pulumi.Input[str]) –

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

  • file_system_arn (pulumi.Input[str]) – Amazon Resource Name of the file system.

  • file_system_id (pulumi.Input[str]) – The ID of the file system for which the mount target is intended.

  • ip_address (pulumi.Input[str]) – The address (within the address range of the specified subnet) at which the file system may be mounted via the mount target.

  • network_interface_id (pulumi.Input[str]) – The ID of the network interface that Amazon EFS created when it created the mount target.

  • security_groups (pulumi.Input[list]) – 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.

  • subnet_id (pulumi.Input[str]) – The ID of the subnet to add the mount target in.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_aws.efs.get_file_system(creation_token=None, file_system_id=None, tags=None, opts=None)

Provides information about an Elastic File System (EFS).

Parameters
  • creation_token (str) – Restricts the list to the file system with this creation token.

  • file_system_id (str) – The ID that identifies the file system (e.g. fs-ccfc0d65).

pulumi_aws.efs.get_mount_target(mount_target_id=None, opts=None)

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

Parameters

mount_target_id (str) – ID of the mount target that you want to have described