efs

class pulumi_aws.efs.FileSystem(resource_name, opts=None, creation_token=None, encrypted=None, kms_key_id=None, performance_mode=None, provisioned_throughput_in_mibps=None, reference_name=None, tags=None, throughput_mode=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 Terraform. 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.
  • 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.
  • reference_name (pulumi.Input[str]) – 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.
  • 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.
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 Terraform. 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.

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.

reference_name = None

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.

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.

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, 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, __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.

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)

Provides information about an Elastic File System (EFS).

pulumi_aws.efs.get_mount_target(mount_target_id=None)

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