Package software.amazon.awscdk.services.efs

Class CfnMountTarget

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.efs.CfnMountTarget
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-05-31T18:44:11.791Z") @Stability(Stable) public class CfnMountTarget extends CfnResource implements IInspectable
A CloudFormation `AWS::EFS::MountTarget`.

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")
         .build();

  • 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 Construct scope, @NotNull String id, @NotNull CfnMountTargetProps props)
      Create a new `AWS::EFS::MountTarget`.

      Parameters:
      scope - - scope in which this resource is defined. This parameter is required.
      id - - scoped id of the resource. 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

    • 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()
      Up to five VPC security group IDs, of the form `sg-xxxxxxxx` .

      These must be for the same VPC as subnet specified.

    • setSecurityGroups

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

      These must be for the same VPC as subnet specified.

    • getSubnetId

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

      For file systems that use One Zone storage classes, use the subnet that is associated with the file system's Availability Zone.

    • setSubnetId

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

      For file systems that use One Zone storage classes, use the subnet that is associated with the file system's Availability Zone.

    • getIpAddress

      @Stability(Stable) @Nullable public String getIpAddress()
      Valid IPv4 address within the address range of the specified subnet.

    • setIpAddress

      @Stability(Stable) public void setIpAddress(@Nullable String value)
      Valid IPv4 address within the address range of the specified subnet.