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.
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.AccessPoint(resource_name, opts=None, file_system_id=None, posix_user=None, root_directory=None, tags=None, __props__=None, __name__=None, __opts__=None)¶ Provides an Elastic File System (EFS) access point.
import pulumi import pulumi_aws as aws test = aws.efs.AccessPoint("test", file_system_id=aws_efs_file_system["foo"]["id"])
- 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 access point is intended.
posix_user (pulumi.Input[dict]) – The operating system user and group applied to all file system requests made using the access point. See Posix User below.
root_directory (pulumi.Input[dict]) – Specifies the directory on the Amazon EFS file system that the access point provides access to. See Root Directory below.
tags (pulumi.Input[dict]) – Key-value mapping of resource tags.
The posix_user object supports the following:
gid(pulumi.Input[float]) - The POSIX group ID used for all file system operations using this access point.secondaryGids(pulumi.Input[list]) - Secondary POSIX group IDs used for all file system operations using this access point.uid(pulumi.Input[float]) - The POSIX user ID used for all file system operations using this access point.
The root_directory object supports the following:
creationInfo(pulumi.Input[dict]) - Specifies the POSIX IDs and permissions to apply to the access point’s Root Directory. See Creation Info below.ownerGid(pulumi.Input[float]) - Specifies the POSIX group ID to apply to theroot_directory.ownerUid(pulumi.Input[float]) - Specifies the POSIX user ID to apply to theroot_directory.permissions(pulumi.Input[str]) - Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file’s mode bits.
path(pulumi.Input[str]) - Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to providecreation_info.
arn: pulumi.Output[str] = None¶Amazon Resource Name of the access point.
file_system_arn: pulumi.Output[str] = None¶Amazon Resource Name of the file system.
file_system_id: pulumi.Output[str] = None¶The ID of the file system for which the access point is intended.
posix_user: pulumi.Output[dict] = None¶The operating system user and group applied to all file system requests made using the access point. See Posix User below.
gid(float) - The POSIX group ID used for all file system operations using this access point.secondaryGids(list) - Secondary POSIX group IDs used for all file system operations using this access point.uid(float) - The POSIX user ID used for all file system operations using this access point.
root_directory: pulumi.Output[dict] = None¶Specifies the directory on the Amazon EFS file system that the access point provides access to. See Root Directory below.
creationInfo(dict) - Specifies the POSIX IDs and permissions to apply to the access point’s Root Directory. See Creation Info below.ownerGid(float) - Specifies the POSIX group ID to apply to theroot_directory.ownerUid(float) - Specifies the POSIX user ID to apply to theroot_directory.permissions(str) - Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file’s mode bits.
path(str) - Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to providecreation_info.
Key-value mapping of resource tags.
- static
get(resource_name, id, opts=None, arn=None, file_system_arn=None, file_system_id=None, owner_id=None, posix_user=None, root_directory=None, tags=None)¶ Get an existing AccessPoint 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 access point.
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 access point is intended.
posix_user (pulumi.Input[dict]) – The operating system user and group applied to all file system requests made using the access point. See Posix User below.
root_directory (pulumi.Input[dict]) – Specifies the directory on the Amazon EFS file system that the access point provides access to. See Root Directory below.
tags (pulumi.Input[dict]) – Key-value mapping of resource tags.
The posix_user object supports the following:
gid(pulumi.Input[float]) - The POSIX group ID used for all file system operations using this access point.secondaryGids(pulumi.Input[list]) - Secondary POSIX group IDs used for all file system operations using this access point.uid(pulumi.Input[float]) - The POSIX user ID used for all file system operations using this access point.
The root_directory object supports the following:
creationInfo(pulumi.Input[dict]) - Specifies the POSIX IDs and permissions to apply to the access point’s Root Directory. See Creation Info below.ownerGid(pulumi.Input[float]) - Specifies the POSIX group ID to apply to theroot_directory.ownerUid(pulumi.Input[float]) - Specifies the POSIX user ID to apply to theroot_directory.permissions(pulumi.Input[str]) - Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file’s mode bits.
path(pulumi.Input[str]) - Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to providecreation_info.
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.AwaitableGetAccessPointResult(access_point_id=None, arn=None, file_system_arn=None, file_system_id=None, id=None, owner_id=None, posix_users=None, root_directories=None, tags=None)¶
- class
pulumi_aws.efs.AwaitableGetFileSystemResult(arn=None, creation_token=None, dns_name=None, encrypted=None, file_system_id=None, id=None, kms_key_id=None, lifecycle_policy=None, performance_mode=None, provisioned_throughput_in_mibps=None, size_in_bytes=None, tags=None, throughput_mode=None)¶
- class
pulumi_aws.efs.AwaitableGetMountTargetResult(availability_zone_id=None, availability_zone_name=None, dns_name=None, file_system_arn=None, file_system_id=None, id=None, ip_address=None, mount_target_dns_name=None, mount_target_id=None, network_interface_id=None, owner_id=None, security_groups=None, subnet_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) File System resource.
import pulumi import pulumi_aws as aws foo = aws.efs.FileSystem("foo", tags={ "Name": "MyProduct", })
import pulumi import pulumi_aws as aws foo_with_lifecyle_policy = aws.efs.FileSystem("fooWithLifecylePolicy", lifecycle_policy={ "transitionToIa": "AFTER_30_DAYS", })
- 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_modeset toprovisioned.tags (pulumi.Input[dict]) – A map 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 usingprovisioned, also setprovisioned_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_7_DAYS,AFTER_14_DAYS,AFTER_30_DAYS,AFTER_60_DAYS, orAFTER_90_DAYS.
arn: pulumi.Output[str] = None¶Amazon Resource Name of the file system.
creation_token: pulumi.Output[str] = 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: pulumi.Output[str] = None¶The DNS name for the filesystem per documented convention.
encrypted: pulumi.Output[bool] = None¶If true, the disk will be encrypted.
kms_key_id: pulumi.Output[str] = None¶The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
lifecycle_policy: pulumi.Output[dict] = 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_7_DAYS,AFTER_14_DAYS,AFTER_30_DAYS,AFTER_60_DAYS, orAFTER_90_DAYS.
performance_mode: pulumi.Output[str] = None¶The file system performance mode. Can be either
"generalPurpose"or"maxIO"(Default:"generalPurpose").
provisioned_throughput_in_mibps: pulumi.Output[float] = None¶The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with
throughput_modeset toprovisioned.
A map of tags to assign to the file system.
throughput_mode: pulumi.Output[str] = None¶Throughput mode for the file system. Defaults to
bursting. Valid values:bursting,provisioned. When usingprovisioned, also setprovisioned_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_modeset toprovisioned.tags (pulumi.Input[dict]) – A map 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 usingprovisioned, also setprovisioned_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_7_DAYS,AFTER_14_DAYS,AFTER_30_DAYS,AFTER_60_DAYS, orAFTER_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.FileSystemPolicy(resource_name, opts=None, file_system_id=None, policy=None, __props__=None, __name__=None, __opts__=None)¶ Provides an Elastic File System (EFS) File System Policy resource.
import pulumi import pulumi_aws as aws fs = aws.efs.FileSystem("fs") policy = aws.efs.FileSystemPolicy("policy", file_system_id=fs.id, policy=f"""{{ "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" }} }} }} ] }} """)
- 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 EFS file system.
policy (pulumi.Input[str]) – The JSON formatted file system policy for the EFS file system. see Docs for more info.
file_system_id: pulumi.Output[str] = None¶The ID of the EFS file system.
policy: pulumi.Output[str] = None¶The JSON formatted file system policy for the EFS file system. see Docs for more info.
- static
get(resource_name, id, opts=None, file_system_id=None, policy=None)¶ Get an existing FileSystemPolicy 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.
file_system_id (pulumi.Input[str]) – The ID of the EFS file system.
policy (pulumi.Input[str]) –
The JSON formatted file system policy for the EFS file system. see Docs for more info.
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.GetAccessPointResult(access_point_id=None, arn=None, file_system_arn=None, file_system_id=None, id=None, owner_id=None, posix_users=None, root_directories=None, tags=None)¶ A collection of values returned by getAccessPoint.
arn= None¶Amazon Resource Name of the file system.
file_system_arn= None¶Amazon Resource Name of the file system.
file_system_id= None¶The ID of the file system for which the access point is intended.
id= None¶The provider-assigned unique ID for this managed resource.
posix_users= None¶Single element list containing operating system user and group applied to all file system requests made using the access point.
Key-value mapping of resource tags.
- class
pulumi_aws.efs.GetFileSystemResult(arn=None, creation_token=None, dns_name=None, encrypted=None, file_system_id=None, id=None, kms_key_id=None, lifecycle_policy=None, performance_mode=None, provisioned_throughput_in_mibps=None, size_in_bytes=None, tags=None, throughput_mode=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.
id= None¶The provider-assigned unique ID for this managed resource.
kms_key_id= None¶The ARN for the KMS encryption key.
lifecycle_policy= None¶A file system lifecycle policy object.
performance_mode= None¶The file system performance mode.
provisioned_throughput_in_mibps= None¶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.
size_in_bytes= None¶The current byte count used by the file system.
throughput_mode= None¶Throughput mode for the file system.
- class
pulumi_aws.efs.GetMountTargetResult(availability_zone_id=None, availability_zone_name=None, dns_name=None, file_system_arn=None, file_system_id=None, id=None, ip_address=None, mount_target_dns_name=None, mount_target_id=None, network_interface_id=None, owner_id=None, security_groups=None, subnet_id=None)¶ A collection of values returned by getMountTarget.
availability_zone_id= None¶The unique and consistent identifier of the Availability Zone (AZ) that the mount target resides in.
availability_zone_name= None¶The name of the Availability Zone (AZ) that the mount target resides in.
dns_name= None¶The DNS name for the EFS file system.
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.
id= None¶The provider-assigned unique ID for this managed resource.
ip_address= None¶Address at which the file system may be mounted via the mount target.
mount_target_dns_name= None¶The DNS name for the given subnet/AZ per documented convention.
network_interface_id= None¶The ID of the network interface that Amazon EFS created when it created the mount target.
owner_id= None¶AWS account ID that owns the resource.
security_groups= None¶List of VPC security group IDs attached to the mount target.
subnet_id= None¶ID of the mount target’s subnet.
- 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.
import pulumi import pulumi_aws as aws foo = aws.ec2.Vpc("foo", cidr_block="10.0.0.0/16") alpha_subnet = aws.ec2.Subnet("alphaSubnet", availability_zone="us-west-2a", cidr_block="10.0.1.0/24", vpc_id=foo.id) alpha_mount_target = aws.efs.MountTarget("alphaMountTarget", file_system_id=aws_efs_file_system["foo"]["id"], subnet_id=alpha_subnet.id)
- 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.
availability_zone_id: pulumi.Output[str] = None¶The unique and consistent identifier of the Availability Zone (AZ) that the mount target resides in.
availability_zone_name: pulumi.Output[str] = None¶The name of the Availability Zone (AZ) that the mount target resides in.
dns_name: pulumi.Output[str] = None¶The DNS name for the EFS file system.
file_system_arn: pulumi.Output[str] = None¶Amazon Resource Name of the file system.
file_system_id: pulumi.Output[str] = None¶The ID of the file system for which the mount target is intended.
ip_address: pulumi.Output[str] = None¶The address (within the address range of the specified subnet) at which the file system may be mounted via the mount target.
mount_target_dns_name: pulumi.Output[str] = None¶The DNS name for the given subnet/AZ per documented convention.
network_interface_id: pulumi.Output[str] = None¶The ID of the network interface that Amazon EFS created when it created the mount target.
owner_id: pulumi.Output[str] = None¶AWS account ID that owns the resource.
security_groups: pulumi.Output[list] = 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: pulumi.Output[str] = None¶The ID of the subnet to add the mount target in.
- static
get(resource_name, id, opts=None, availability_zone_id=None, availability_zone_name=None, dns_name=None, file_system_arn=None, file_system_id=None, ip_address=None, mount_target_dns_name=None, network_interface_id=None, owner_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.
availability_zone_id (pulumi.Input[str]) – The unique and consistent identifier of the Availability Zone (AZ) that the mount target resides in.
availability_zone_name (pulumi.Input[str]) – The name of the Availability Zone (AZ) that the mount target resides in.
dns_name (pulumi.Input[str]) – The DNS name for the EFS file system.
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.
mount_target_dns_name (pulumi.Input[str]) –
The DNS name for the given subnet/AZ per documented convention.
network_interface_id (pulumi.Input[str]) – The ID of the network interface that Amazon EFS created when it created the mount target.
owner_id (pulumi.Input[str]) – AWS account ID that owns the resource.
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_access_point(access_point_id=None, tags=None, opts=None)¶Provides information about an Elastic File System (EFS) Access Point.
import pulumi import pulumi_aws as aws test = aws.efs.get_access_point(access_point_id="fsap-12345678")
- Parameters
access_point_id (str) – The ID that identifies the file system.
tags (dict) – Key-value mapping of resource tags.
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) File System.
import pulumi import pulumi_aws as aws config = pulumi.Config() file_system_id = config.get("fileSystemId") if file_system_id is None: file_system_id = "" by_id = aws.efs.get_file_system(file_system_id=file_system_id)
- 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).
import pulumi import pulumi_aws as aws config = pulumi.Config() mount_target_id = config.get("mountTargetId") if mount_target_id is None: mount_target_id = "" by_id = aws.efs.get_mount_target(mount_target_id=mount_target_id)
- Parameters
mount_target_id (str) – ID of the mount target that you want to have described