We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
The AWS::EFS::MountTarget resource is an Amazon EFS resource that creates a mount target for an EFS file system. You can then mount the file system on Amazon EC2 instances or other resources by using the mount target.
Create MountTarget Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new MountTarget(name: string, args: MountTargetArgs, opts?: CustomResourceOptions);@overload
def MountTarget(resource_name: str,
args: MountTargetArgs,
opts: Optional[ResourceOptions] = None)
@overload
def MountTarget(resource_name: str,
opts: Optional[ResourceOptions] = None,
file_system_id: Optional[str] = None,
security_groups: Optional[Sequence[str]] = None,
subnet_id: Optional[str] = None,
ip_address: Optional[str] = None,
ip_address_type: Optional[MountTargetIpAddressType] = None,
ipv6_address: Optional[str] = None)func NewMountTarget(ctx *Context, name string, args MountTargetArgs, opts ...ResourceOption) (*MountTarget, error)public MountTarget(string name, MountTargetArgs args, CustomResourceOptions? opts = null)
public MountTarget(String name, MountTargetArgs args)
public MountTarget(String name, MountTargetArgs args, CustomResourceOptions options)
type: aws-native:efs:MountTarget
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_efs_mount_target" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args MountTargetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args MountTargetArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args MountTargetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args MountTargetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args MountTargetArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
MountTarget Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The MountTarget resource accepts the following input properties:
- File
System stringId - The ID of the file system for which to create the mount target.
- Security
Groups List<string> - VPC security group IDs, of the form
sg-xxxxxxxx. These must be for the same VPC as the subnet specified. The maximum number of security groups depends on account quota. For more information, see Amazon VPC Quotas in the Amazon VPC User Guide (see the Security Groups table). If you don't specify a security group, then Amazon EFS uses the default security group for the subnet's VPC. - Subnet
Id string - The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone. The subnet type must be the same type as the
IpAddressType. - Ip
Address string - If the
IpAddressTypefor the mount target is IPv4 (IPV4_ONLYorDUAL_STACK), then specify the IPv4 address to use. If you do not specify anIpAddress, then Amazon EFS selects an unused IP address from the subnet specified forSubnetId. - Ip
Address Pulumi.Type Aws Native. Efs. Mount Target Ip Address Type - The IP address type for the mount target. The possible values are
IPV4_ONLY(only IPv4 addresses),IPV6_ONLY(only IPv6 addresses), andDUAL_STACK(dual-stack, both IPv4 and IPv6 addresses). If you don’t specify anIpAddressType, thenIPV4_ONLYis used. TheIPAddressTypemust match the IP type of the subnet. Additionally, theIPAddressTypeparameter overrides the value set as the default IP address for the subnet in the VPC. For example, if theIPAddressTypeisIPV4_ONLYandAssignIpv6AddressOnCreationistrue, then IPv4 is used for the mount target. For more information, see Modify the IP addressing attributes of your subnet. - Ipv6Address string
- If the
IPAddressTypefor the mount target is IPv6 (IPV6_ONLYorDUAL_STACK), then specify the IPv6 address to use. If you do not specify anIpv6Address, then Amazon EFS selects an unused IP address from the subnet specified forSubnetId.
- File
System stringId - The ID of the file system for which to create the mount target.
- Security
Groups []string - VPC security group IDs, of the form
sg-xxxxxxxx. These must be for the same VPC as the subnet specified. The maximum number of security groups depends on account quota. For more information, see Amazon VPC Quotas in the Amazon VPC User Guide (see the Security Groups table). If you don't specify a security group, then Amazon EFS uses the default security group for the subnet's VPC. - Subnet
Id string - The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone. The subnet type must be the same type as the
IpAddressType. - Ip
Address string - If the
IpAddressTypefor the mount target is IPv4 (IPV4_ONLYorDUAL_STACK), then specify the IPv4 address to use. If you do not specify anIpAddress, then Amazon EFS selects an unused IP address from the subnet specified forSubnetId. - Ip
Address MountType Target Ip Address Type - The IP address type for the mount target. The possible values are
IPV4_ONLY(only IPv4 addresses),IPV6_ONLY(only IPv6 addresses), andDUAL_STACK(dual-stack, both IPv4 and IPv6 addresses). If you don’t specify anIpAddressType, thenIPV4_ONLYis used. TheIPAddressTypemust match the IP type of the subnet. Additionally, theIPAddressTypeparameter overrides the value set as the default IP address for the subnet in the VPC. For example, if theIPAddressTypeisIPV4_ONLYandAssignIpv6AddressOnCreationistrue, then IPv4 is used for the mount target. For more information, see Modify the IP addressing attributes of your subnet. - Ipv6Address string
- If the
IPAddressTypefor the mount target is IPv6 (IPV6_ONLYorDUAL_STACK), then specify the IPv6 address to use. If you do not specify anIpv6Address, then Amazon EFS selects an unused IP address from the subnet specified forSubnetId.
- file_
system_ stringid - The ID of the file system for which to create the mount target.
- security_
groups list(string) - VPC security group IDs, of the form
sg-xxxxxxxx. These must be for the same VPC as the subnet specified. The maximum number of security groups depends on account quota. For more information, see Amazon VPC Quotas in the Amazon VPC User Guide (see the Security Groups table). If you don't specify a security group, then Amazon EFS uses the default security group for the subnet's VPC. - subnet_
id string - The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone. The subnet type must be the same type as the
IpAddressType. - ip_
address string - If the
IpAddressTypefor the mount target is IPv4 (IPV4_ONLYorDUAL_STACK), then specify the IPv4 address to use. If you do not specify anIpAddress, then Amazon EFS selects an unused IP address from the subnet specified forSubnetId. - ip_
address_ "IPV4_ONLY" | "IPV6_ONLY" | "DUAL_STACK"type - The IP address type for the mount target. The possible values are
IPV4_ONLY(only IPv4 addresses),IPV6_ONLY(only IPv6 addresses), andDUAL_STACK(dual-stack, both IPv4 and IPv6 addresses). If you don’t specify anIpAddressType, thenIPV4_ONLYis used. TheIPAddressTypemust match the IP type of the subnet. Additionally, theIPAddressTypeparameter overrides the value set as the default IP address for the subnet in the VPC. For example, if theIPAddressTypeisIPV4_ONLYandAssignIpv6AddressOnCreationistrue, then IPv4 is used for the mount target. For more information, see Modify the IP addressing attributes of your subnet. - ipv6_
address string - If the
IPAddressTypefor the mount target is IPv6 (IPV6_ONLYorDUAL_STACK), then specify the IPv6 address to use. If you do not specify anIpv6Address, then Amazon EFS selects an unused IP address from the subnet specified forSubnetId.
- file
System StringId - The ID of the file system for which to create the mount target.
- security
Groups List<String> - VPC security group IDs, of the form
sg-xxxxxxxx. These must be for the same VPC as the subnet specified. The maximum number of security groups depends on account quota. For more information, see Amazon VPC Quotas in the Amazon VPC User Guide (see the Security Groups table). If you don't specify a security group, then Amazon EFS uses the default security group for the subnet's VPC. - subnet
Id String - The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone. The subnet type must be the same type as the
IpAddressType. - ip
Address String - If the
IpAddressTypefor the mount target is IPv4 (IPV4_ONLYorDUAL_STACK), then specify the IPv4 address to use. If you do not specify anIpAddress, then Amazon EFS selects an unused IP address from the subnet specified forSubnetId. - ip
Address MountType Target Ip Address Type - The IP address type for the mount target. The possible values are
IPV4_ONLY(only IPv4 addresses),IPV6_ONLY(only IPv6 addresses), andDUAL_STACK(dual-stack, both IPv4 and IPv6 addresses). If you don’t specify anIpAddressType, thenIPV4_ONLYis used. TheIPAddressTypemust match the IP type of the subnet. Additionally, theIPAddressTypeparameter overrides the value set as the default IP address for the subnet in the VPC. For example, if theIPAddressTypeisIPV4_ONLYandAssignIpv6AddressOnCreationistrue, then IPv4 is used for the mount target. For more information, see Modify the IP addressing attributes of your subnet. - ipv6Address String
- If the
IPAddressTypefor the mount target is IPv6 (IPV6_ONLYorDUAL_STACK), then specify the IPv6 address to use. If you do not specify anIpv6Address, then Amazon EFS selects an unused IP address from the subnet specified forSubnetId.
- file
System stringId - The ID of the file system for which to create the mount target.
- security
Groups string[] - VPC security group IDs, of the form
sg-xxxxxxxx. These must be for the same VPC as the subnet specified. The maximum number of security groups depends on account quota. For more information, see Amazon VPC Quotas in the Amazon VPC User Guide (see the Security Groups table). If you don't specify a security group, then Amazon EFS uses the default security group for the subnet's VPC. - subnet
Id string - The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone. The subnet type must be the same type as the
IpAddressType. - ip
Address string - If the
IpAddressTypefor the mount target is IPv4 (IPV4_ONLYorDUAL_STACK), then specify the IPv4 address to use. If you do not specify anIpAddress, then Amazon EFS selects an unused IP address from the subnet specified forSubnetId. - ip
Address MountType Target Ip Address Type - The IP address type for the mount target. The possible values are
IPV4_ONLY(only IPv4 addresses),IPV6_ONLY(only IPv6 addresses), andDUAL_STACK(dual-stack, both IPv4 and IPv6 addresses). If you don’t specify anIpAddressType, thenIPV4_ONLYis used. TheIPAddressTypemust match the IP type of the subnet. Additionally, theIPAddressTypeparameter overrides the value set as the default IP address for the subnet in the VPC. For example, if theIPAddressTypeisIPV4_ONLYandAssignIpv6AddressOnCreationistrue, then IPv4 is used for the mount target. For more information, see Modify the IP addressing attributes of your subnet. - ipv6Address string
- If the
IPAddressTypefor the mount target is IPv6 (IPV6_ONLYorDUAL_STACK), then specify the IPv6 address to use. If you do not specify anIpv6Address, then Amazon EFS selects an unused IP address from the subnet specified forSubnetId.
- file_
system_ strid - The ID of the file system for which to create the mount target.
- security_
groups Sequence[str] - VPC security group IDs, of the form
sg-xxxxxxxx. These must be for the same VPC as the subnet specified. The maximum number of security groups depends on account quota. For more information, see Amazon VPC Quotas in the Amazon VPC User Guide (see the Security Groups table). If you don't specify a security group, then Amazon EFS uses the default security group for the subnet's VPC. - subnet_
id str - The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone. The subnet type must be the same type as the
IpAddressType. - ip_
address str - If the
IpAddressTypefor the mount target is IPv4 (IPV4_ONLYorDUAL_STACK), then specify the IPv4 address to use. If you do not specify anIpAddress, then Amazon EFS selects an unused IP address from the subnet specified forSubnetId. - ip_
address_ Mounttype Target Ip Address Type - The IP address type for the mount target. The possible values are
IPV4_ONLY(only IPv4 addresses),IPV6_ONLY(only IPv6 addresses), andDUAL_STACK(dual-stack, both IPv4 and IPv6 addresses). If you don’t specify anIpAddressType, thenIPV4_ONLYis used. TheIPAddressTypemust match the IP type of the subnet. Additionally, theIPAddressTypeparameter overrides the value set as the default IP address for the subnet in the VPC. For example, if theIPAddressTypeisIPV4_ONLYandAssignIpv6AddressOnCreationistrue, then IPv4 is used for the mount target. For more information, see Modify the IP addressing attributes of your subnet. - ipv6_
address str - If the
IPAddressTypefor the mount target is IPv6 (IPV6_ONLYorDUAL_STACK), then specify the IPv6 address to use. If you do not specify anIpv6Address, then Amazon EFS selects an unused IP address from the subnet specified forSubnetId.
- file
System StringId - The ID of the file system for which to create the mount target.
- security
Groups List<String> - VPC security group IDs, of the form
sg-xxxxxxxx. These must be for the same VPC as the subnet specified. The maximum number of security groups depends on account quota. For more information, see Amazon VPC Quotas in the Amazon VPC User Guide (see the Security Groups table). If you don't specify a security group, then Amazon EFS uses the default security group for the subnet's VPC. - subnet
Id String - The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone. The subnet type must be the same type as the
IpAddressType. - ip
Address String - If the
IpAddressTypefor the mount target is IPv4 (IPV4_ONLYorDUAL_STACK), then specify the IPv4 address to use. If you do not specify anIpAddress, then Amazon EFS selects an unused IP address from the subnet specified forSubnetId. - ip
Address "IPV4_ONLY" | "IPV6_ONLY" | "DUAL_STACK"Type - The IP address type for the mount target. The possible values are
IPV4_ONLY(only IPv4 addresses),IPV6_ONLY(only IPv6 addresses), andDUAL_STACK(dual-stack, both IPv4 and IPv6 addresses). If you don’t specify anIpAddressType, thenIPV4_ONLYis used. TheIPAddressTypemust match the IP type of the subnet. Additionally, theIPAddressTypeparameter overrides the value set as the default IP address for the subnet in the VPC. For example, if theIPAddressTypeisIPV4_ONLYandAssignIpv6AddressOnCreationistrue, then IPv4 is used for the mount target. For more information, see Modify the IP addressing attributes of your subnet. - ipv6Address String
- If the
IPAddressTypefor the mount target is IPv6 (IPV6_ONLYorDUAL_STACK), then specify the IPv6 address to use. If you do not specify anIpv6Address, then Amazon EFS selects an unused IP address from the subnet specified forSubnetId.
Outputs
All input properties are implicitly available as output properties. Additionally, the MountTarget resource produces the following output properties:
Look up Existing MountTarget Resource
Get an existing MountTarget resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): MountTarget@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> MountTargetfunc GetMountTarget(ctx *Context, name string, id IDInput, state *MountTargetState, opts ...ResourceOption) (*MountTarget, error)public static MountTarget Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static MountTarget get(String name, Output<String> id, CustomResourceOptions options)resources: existingMountTarget: type: aws-native:efs:MountTarget get: id: ${id}import {
to = aws-native_efs_mount_target.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state MountTargetState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
MountTargetIpAddressType
The IP address type for the mount target. The possible values are IPV4_ONLY (only IPv4 addresses), IPV6_ONLY (only IPv6 addresses), and DUAL_STACK (dual-stack, both IPv4 and IPv6 addresses). If you don’t specify an IpAddressType, then IPV4_ONLY is used.
The IPAddressType must match the IP type of the subnet. Additionally, the IPAddressType parameter overrides the value set as the default IP address for the subnet in the VPC. For example, if the IPAddressType is IPV4_ONLY and AssignIpv6AddressOnCreation is true, then IPv4 is used for the mount target. For more information, see Modify the IP addressing attributes of your subnet.
| Name | Value |
|---|---|
| Ipv4Only | IPV4_ONLY |
| Ipv6Only | IPV6_ONLY |
| Dual | DUAL_STACK |
| Name | Value |
|---|---|
| Mount | IPV4_ONLY |
| Mount | IPV6_ONLY |
| Mount | DUAL_STACK |
| Value |
|---|
IPV4_ONLY |
IPV6_ONLY |
DUAL_STACK |
| Name | Value |
|---|---|
| Ipv4Only | IPV4_ONLY |
| Ipv6Only | IPV6_ONLY |
| Dual | DUAL_STACK |
| Name | Value |
|---|---|
| Ipv4Only | IPV4_ONLY |
| Ipv6Only | IPV6_ONLY |
| Dual | DUAL_STACK |
| Name | Value |
|---|---|
| IPV4_ONLY | IPV4_ONLY |
| IPV6_ONLY | IPV6_ONLY |
| DUAL_STACK | DUAL_STACK |
| Value |
|---|
IPV4_ONLY |
IPV6_ONLY |
DUAL_STACK |
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi