software.amazon.awscdk.services.efs

Class CfnMountTarget

java.lang.Object

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

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:41.548Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnMountTarget(Construct scope, java.lang.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
java.lang.String	getAttrId() The ID of the Amazon EFS file system that the mount target provides access to.
java.lang.String	getAttrIpAddress() The IPv4 address of the mount target.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getFileSystemId() The ID of the file system for which to create the mount target.
java.lang.String	getIpAddress() Valid IPv4 address within the address range of the specified subnet.
java.util.List<java.lang.String>	getSecurityGroups() Up to five VPC security group IDs, of the form `sg-xxxxxxxx` .
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setFileSystemId(java.lang.String value) The ID of the file system for which to create the mount target.
void	setIpAddress(java.lang.String value) Valid IPv4 address within the address range of the specified subnet.
void	setSecurityGroups(java.util.List<java.lang.String> value) Up to five VPC security group IDs, of the form `sg-xxxxxxxx` .
void	setSubnetId(java.lang.String value) The ID of the subnet to add the mount target in.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnMountTarget(Construct scope,
                      java.lang.String id,
                      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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

public java.lang.String getAttrId()

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

Example: fs-0123456789111222a

getAttrIpAddress

public java.lang.String getAttrIpAddress()

The IPv4 address of the mount target.

Example: 192.0.2.0

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFileSystemId

public java.lang.String getFileSystemId()

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

setFileSystemId

public void setFileSystemId(java.lang.String value)

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

getSecurityGroups

public java.util.List<java.lang.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

public void setSecurityGroups(java.util.List<java.lang.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

public java.lang.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

public void setSubnetId(java.lang.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

public java.lang.String getIpAddress()

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

setIpAddress

public void setIpAddress(java.lang.String value)

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