Package software.amazon.awscdk.services.efs

Class CfnMountTarget

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.efs.CfnMountTarget
All Implemented Interfaces:
IInspectable, IMountTargetRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:39.438Z") @Stability(Stable) public class CfnMountTarget extends CfnResource implements IInspectable, IMountTargetRef
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.

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.*;
 CfnMountTarget cfnMountTarget = CfnMountTarget.Builder.create(this, "MyCfnMountTarget")
         .fileSystemId("fileSystemId")
         .securityGroups(List.of("securityGroups"))
         .subnetId("subnetId")
         // the properties below are optional
         .ipAddress("ipAddress")
         .ipAddressType("ipAddressType")
         .ipv6Address("ipv6Address")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnMountTarget

      protected CfnMountTarget(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnMountTarget

      protected CfnMountTarget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnMountTarget

      @Stability(Stable) public CfnMountTarget(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMountTargetProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the Amazon EFS file system that the mount target provides access to.

      Example: fs-0123456789111222a

    • getAttrIpAddress

      @Stability(Stable) @NotNull public String getAttrIpAddress()
      The IPv4 address of the mount target.

      Example: 192.0.2.0

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getMountTargetRef

      @Stability(Stable) @NotNull public MountTargetReference getMountTargetRef()
      A reference to a MountTarget resource.
      Specified by:
      getMountTargetRef in interface IMountTargetRef

    • getFileSystemId

      @Stability(Stable) @NotNull public String getFileSystemId()
      The ID of the file system for which to create the mount target.

    • setFileSystemId

      @Stability(Stable) public void setFileSystemId(@NotNull String value)
      The ID of the file system for which to create the mount target.

    • getSecurityGroups

      @Stability(Stable) @NotNull public List<String> getSecurityGroups()
      VPC security group IDs, of the form sg-xxxxxxxx .

    • setSecurityGroups

      @Stability(Stable) public void setSecurityGroups(@NotNull List<String> value)
      VPC security group IDs, of the form sg-xxxxxxxx .

    • getSubnetId

      @Stability(Stable) @NotNull public String getSubnetId()
      The ID of the subnet to add the mount target in.

    • setSubnetId

      @Stability(Stable) public void setSubnetId(@NotNull String value)
      The ID of the subnet to add the mount target in.

    • getIpAddress

      @Stability(Stable) @Nullable public String getIpAddress()
      If the IpAddressType for the mount target is IPv4 ( IPV4_ONLY or DUAL_STACK ), then specify the IPv4 address to use.

    • setIpAddress

      @Stability(Stable) public void setIpAddress(@Nullable String value)
      If the IpAddressType for the mount target is IPv4 ( IPV4_ONLY or DUAL_STACK ), then specify the IPv4 address to use.

    • getIpAddressType

      @Stability(Stable) @Nullable public String getIpAddressType()
      The IP address type for the mount target.

    • setIpAddressType

      @Stability(Stable) public void setIpAddressType(@Nullable String value)
      The IP address type for the mount target.

    • getIpv6Address

      @Stability(Stable) @Nullable public String getIpv6Address()
      If the IPAddressType for the mount target is IPv6 ( IPV6_ONLY or DUAL_STACK ), then specify the IPv6 address to use.

    • setIpv6Address

      @Stability(Stable) public void setIpv6Address(@Nullable String value)
      If the IPAddressType for the mount target is IPv6 ( IPV6_ONLY or DUAL_STACK ), then specify the IPv6 address to use.