Package software.amazon.awscdk.services.efs

Interface CfnMountTargetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMountTargetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-06-20T13:49:16.350Z")
@Stability(Stable)
public interface CfnMountTargetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnMountTarget.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.efs.*;
 CfnMountTargetProps cfnMountTargetProps = CfnMountTargetProps.builder()
         .fileSystemId("fileSystemId")
         .securityGroups(List.of("securityGroups"))
         .subnetId("subnetId")
         // the properties below are optional
         .ipAddress("ipAddress")
         .ipAddressType("ipAddressType")
         .ipv6Address("ipv6Address")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMountTargetProps.Builder	A builder for CfnMountTargetProps
static final class	CfnMountTargetProps.Jsii$Proxy	An implementation for CfnMountTargetProps

Method Summary

Modifier and Type	Method	Description
static CfnMountTargetProps.Builder	builder()
String	getFileSystemId()	The ID of the file system for which to create the mount target.
default String	getIpAddress()	If the IpAddressType for the mount target is IPv4 ( IPV4_ONLY or DUAL_STACK ), then specify the IPv4 address to use.
default String	getIpAddressType()	The IP address type for the mount target.
default String	getIpv6Address()	If the IPAddressType for the mount target is IPv6 ( IPV6_ONLY or DUAL_STACK ), then specify the IPv6 address to use.
List<String>	getSecurityGroups()	VPC security group IDs, of the form sg-xxxxxxxx .
String	getSubnetId()	The ID of the subnet to add the mount target in.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFileSystemId

@Stability(Stable)
@NotNull
String getFileSystemId()

The ID of the file system for which to create the mount target.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-filesystemid

getSecurityGroups

@Stability(Stable)
@NotNull
List<String> getSecurityGroups()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-securitygroups

getSubnetId

@Stability(Stable)
@NotNull
String getSubnetId()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-subnetid

getIpAddress

@Stability(Stable)
@Nullable
default String getIpAddress()

If the IpAddressType for the mount target is IPv4 ( IPV4_ONLY or DUAL_STACK ), then specify the IPv4 address to use.

If you do not specify an IpAddress , then Amazon EFS selects an unused IP address from the subnet specified for SubnetId .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-ipaddress

getIpAddressType

@Stability(Stable)
@Nullable
default String getIpAddressType()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-ipaddresstype

getIpv6Address

@Stability(Stable)
@Nullable
default String getIpv6Address()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html#cfn-efs-mounttarget-ipv6address

builder

@Stability(Stable)
static CfnMountTargetProps.Builder builder()

Returns:

a CfnMountTargetProps.Builder of CfnMountTargetProps