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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.858Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnMountTarget.Builder A fluent builder for CfnMountTarget.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnMountTarget(software.constructs.Construct scope, String id, CfnMountTargetProps props) Create a new `AWS::EFS::MountTarget`.
protected	CfnMountTarget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMountTarget(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrId() The ID of the Amazon EFS file system that the mount target provides access to.
String	getAttrIpAddress() The IPv4 address of the mount target.
protected Map<String,Object>	getCfnProperties()
String	getFileSystemId() The ID of the file system for which to create the mount target.
String	getIpAddress() Valid IPv4 address within the address range of the specified subnet.
List<String>	getSecurityGroups() Up to five VPC security group IDs, of the form `sg-xxxxxxxx` .
String	getSubnetId() The ID of the subnet to add the mount target in.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setFileSystemId(String value) The ID of the file system for which to create the mount target.
void	setIpAddress(String value) Valid IPv4 address within the address range of the specified subnet.
void	setSecurityGroups(List<String> value) Up to five VPC security group IDs, of the form `sg-xxxxxxxx` .
void	setSubnetId(String value) The ID of the subnet to add the mount target in.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnMountTarget

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

CfnMountTarget

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

CfnMountTarget

@Stability(value=Stable)
public CfnMountTarget(@NotNull
                                               software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=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(value=Stable)
 @NotNull
public String getAttrIpAddress()

The IPv4 address of the mount target.

Example: 192.0.2.0

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFileSystemId

@Stability(value=Stable)
 @NotNull
public String getFileSystemId()

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

setFileSystemId

@Stability(value=Stable)
public void setFileSystemId(@NotNull
                                                     String value)

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

getSecurityGroups

@Stability(value=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(value=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(value=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(value=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(value=Stable)
 @Nullable
public String getIpAddress()

Valid IPv4 address within the address range of the specified subnet.

setIpAddress

@Stability(value=Stable)
public void setIpAddress(@Nullable
                                                  String value)

Valid IPv4 address within the address range of the specified subnet.