Package software.amazon.awscdk.cfnpropertymixins.services.efs

Class CfnMountTargetPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.efs.CfnMountTargetPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnMountTargetPropsMixin>

Enclosing class:

CfnMountTargetPropsMixin

@Stability(Stable)
public static final class CfnMountTargetPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnMountTargetPropsMixin>

A fluent builder for CfnMountTargetPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnMountTargetPropsMixin	build()
static CfnMountTargetPropsMixin.Builder	create()
static CfnMountTargetPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnMountTargetPropsMixin.Builder	fileSystemId(String fileSystemId)	The ID of the file system for which to create the mount target.
CfnMountTargetPropsMixin.Builder	fileSystemId(IFileSystemRef fileSystemId)	The ID of the file system for which to create the mount target.
CfnMountTargetPropsMixin.Builder	ipAddress(String ipAddress)	If the IpAddressType for the mount target is IPv4 ( IPV4_ONLY or DUAL_STACK ), then specify the IPv4 address to use.
CfnMountTargetPropsMixin.Builder	ipAddressType(String ipAddressType)	The IP address type for the mount target.
CfnMountTargetPropsMixin.Builder	ipv6Address(String ipv6Address)	If the IPAddressType for the mount target is IPv6 ( IPV6_ONLY or DUAL_STACK ), then specify the IPv6 address to use.
CfnMountTargetPropsMixin.Builder	securityGroups(List<? extends Object> securityGroups)	VPC security group IDs, of the form sg-xxxxxxxx .
CfnMountTargetPropsMixin.Builder	subnetId(String subnetId)	The ID of the subnet to add the mount target in.
CfnMountTargetPropsMixin.Builder	subnetId(ISubnetRef subnetId)	The ID of the subnet to add the mount target in.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnMountTargetPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnMountTargetPropsMixin.Builder.

create

@Stability(Stable)
public static CfnMountTargetPropsMixin.Builder create()

Returns:

a new instance of CfnMountTargetPropsMixin.Builder.

fileSystemId

@Stability(Stable)
public CfnMountTargetPropsMixin.Builder fileSystemId(String fileSystemId)

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

Parameters:

fileSystemId - The ID of the file system for which to create the mount target. This parameter is required.

Returns:

this

See Also:

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

fileSystemId

@Stability(Stable)
public CfnMountTargetPropsMixin.Builder fileSystemId(IFileSystemRef fileSystemId)

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

Parameters:

fileSystemId - The ID of the file system for which to create the mount target. This parameter is required.

Returns:

this

See Also:

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

ipAddress

@Stability(Stable)
public CfnMountTargetPropsMixin.Builder ipAddress(String ipAddress)

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 .

Parameters:

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

Returns:

this

See Also:

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

ipAddressType

@Stability(Stable)
public CfnMountTargetPropsMixin.Builder ipAddressType(String ipAddressType)

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 .

Parameters:

ipAddressType - The IP address type for the mount target. This parameter is required.

Returns:

this

See Also:

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

ipv6Address

@Stability(Stable)
public CfnMountTargetPropsMixin.Builder ipv6Address(String ipv6Address)

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 .

Parameters:

ipv6Address - If the IPAddressType for the mount target is IPv6 ( IPV6_ONLY or DUAL_STACK ), then specify the IPv6 address to use. This parameter is required.

Returns:

this

See Also:

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

securityGroups

@Stability(Stable)
public CfnMountTargetPropsMixin.Builder securityGroups(List<? extends Object> securityGroups)

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.

Parameters:

securityGroups - VPC security group IDs, of the form sg-xxxxxxxx . This parameter is required.

Returns:

this

See Also:

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

subnetId

@Stability(Stable)
public CfnMountTargetPropsMixin.Builder subnetId(String subnetId)

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 .

Parameters:

subnetId - The ID of the subnet to add the mount target in. This parameter is required.

Returns:

this

See Also:

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

subnetId

@Stability(Stable)
public CfnMountTargetPropsMixin.Builder subnetId(ISubnetRef subnetId)

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 .

Parameters:

subnetId - The ID of the subnet to add the mount target in. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnMountTargetPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnMountTargetPropsMixin>

Returns:

a newly built instance of CfnMountTargetPropsMixin.