Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. efs
  5. MountTarget

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.efs.MountTarget

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws-native

    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.

    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:

    FileSystemId string
    The ID of the file system for which to create the mount target.
    SecurityGroups 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).
    SubnetId 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.
    IpAddress string
    Valid IPv4 address within the address range of the specified subnet.
    IpAddressType Pulumi.AwsNative.Efs.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 .

    Ipv6Address string
    If the IPAddressType for the mount target is IPv6 ( IPV6_ONLY or DUAL_STACK ), then specify the IPv6 address to use. If you do not specify an Ipv6Address , then Amazon EFS selects an unused IP address from the subnet specified for SubnetId .
    FileSystemId string
    The ID of the file system for which to create the mount target.
    SecurityGroups []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).
    SubnetId 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.
    IpAddress string
    Valid IPv4 address within the address range of the specified subnet.
    IpAddressType 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 .

    Ipv6Address string
    If the IPAddressType for the mount target is IPv6 ( IPV6_ONLY or DUAL_STACK ), then specify the IPv6 address to use. If you do not specify an Ipv6Address , then Amazon EFS selects an unused IP address from the subnet specified for SubnetId .
    fileSystemId String
    The ID of the file system for which to create the mount target.
    securityGroups 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).
    subnetId 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.
    ipAddress String
    Valid IPv4 address within the address range of the specified subnet.
    ipAddressType 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 .

    ipv6Address String
    If the IPAddressType for the mount target is IPv6 ( IPV6_ONLY or DUAL_STACK ), then specify the IPv6 address to use. If you do not specify an Ipv6Address , then Amazon EFS selects an unused IP address from the subnet specified for SubnetId .
    fileSystemId string
    The ID of the file system for which to create the mount target.
    securityGroups 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).
    subnetId 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.
    ipAddress string
    Valid IPv4 address within the address range of the specified subnet.
    ipAddressType 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 .

    ipv6Address string
    If the IPAddressType for the mount target is IPv6 ( IPV6_ONLY or DUAL_STACK ), then specify the IPv6 address to use. If you do not specify an Ipv6Address , then Amazon EFS selects an unused IP address from the subnet specified for SubnetId .
    file_system_id str
    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).
    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.
    ip_address str
    Valid IPv4 address within the address range of the specified subnet.
    ip_address_type 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 .

    ipv6_address str
    If the IPAddressType for the mount target is IPv6 ( IPV6_ONLY or DUAL_STACK ), then specify the IPv6 address to use. If you do not specify an Ipv6Address , then Amazon EFS selects an unused IP address from the subnet specified for SubnetId .
    fileSystemId String
    The ID of the file system for which to create the mount target.
    securityGroups 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).
    subnetId 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.
    ipAddress String
    Valid IPv4 address within the address range of the specified subnet.
    ipAddressType "IPV4_ONLY" | "IPV6_ONLY" | "DUAL_STACK"

    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 .

    ipv6Address String
    If the IPAddressType for the mount target is IPv6 ( IPV6_ONLY or DUAL_STACK ), then specify the IPv6 address to use. If you do not specify an Ipv6Address , then Amazon EFS selects an unused IP address from the subnet specified for SubnetId .

    Outputs

    All input properties are implicitly available as output properties. Additionally, the MountTarget resource produces the following output properties:

    AwsId string

    The ID of the Amazon EFS file system that the mount target provides access to.

    Example: fs-0123456789111222a

    Id string
    The provider-assigned unique ID for this managed resource.
    AwsId string

    The ID of the Amazon EFS file system that the mount target provides access to.

    Example: fs-0123456789111222a

    Id string
    The provider-assigned unique ID for this managed resource.
    awsId String

    The ID of the Amazon EFS file system that the mount target provides access to.

    Example: fs-0123456789111222a

    id String
    The provider-assigned unique ID for this managed resource.
    awsId string

    The ID of the Amazon EFS file system that the mount target provides access to.

    Example: fs-0123456789111222a

    id string
    The provider-assigned unique ID for this managed resource.
    aws_id str

    The ID of the Amazon EFS file system that the mount target provides access to.

    Example: fs-0123456789111222a

    id str
    The provider-assigned unique ID for this managed resource.
    awsId String

    The ID of the Amazon EFS file system that the mount target provides access to.

    Example: fs-0123456789111222a

    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    MountTargetIpAddressType, MountTargetIpAddressTypeArgs

    Ipv4Only
    IPV4_ONLY
    Ipv6Only
    IPV6_ONLY
    DualStack
    DUAL_STACK
    MountTargetIpAddressTypeIpv4Only
    IPV4_ONLY
    MountTargetIpAddressTypeIpv6Only
    IPV6_ONLY
    MountTargetIpAddressTypeDualStack
    DUAL_STACK
    Ipv4Only
    IPV4_ONLY
    Ipv6Only
    IPV6_ONLY
    DualStack
    DUAL_STACK
    Ipv4Only
    IPV4_ONLY
    Ipv6Only
    IPV6_ONLY
    DualStack
    DUAL_STACK
    IPV4_ONLY
    IPV4_ONLY
    IPV6_ONLY
    IPV6_ONLY
    DUAL_STACK
    DUAL_STACK
    "IPV4_ONLY"
    IPV4_ONLY
    "IPV6_ONLY"
    IPV6_ONLY
    "DUAL_STACK"
    DUAL_STACK

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
    pulumi/pulumi-aws-native