Package software.amazon.awscdk.cfnpropertymixins.services.ec2

Class CfnIPAMAllocationPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.ec2.CfnIPAMAllocationPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIPAMAllocationPropsMixin>

Enclosing class:

CfnIPAMAllocationPropsMixin

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

A fluent builder for CfnIPAMAllocationPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnIPAMAllocationPropsMixin	build()
CfnIPAMAllocationPropsMixin.Builder	cidr(String cidr)	The CIDR you would like to allocate from the IPAM pool.
static CfnIPAMAllocationPropsMixin.Builder	create()
static CfnIPAMAllocationPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnIPAMAllocationPropsMixin.Builder	description(String description)	A description for the allocation.
CfnIPAMAllocationPropsMixin.Builder	ipamPoolId(String ipamPoolId)	The ID of the IPAM pool from which you would like to allocate a CIDR.
CfnIPAMAllocationPropsMixin.Builder	netmaskLength(Number netmaskLength)	The netmask length of the CIDR you would like to allocate from the IPAM pool.

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 CfnIPAMAllocationPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnIPAMAllocationPropsMixin.Builder.

create

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

Returns:

a new instance of CfnIPAMAllocationPropsMixin.Builder.

cidr

@Stability(Stable)
public CfnIPAMAllocationPropsMixin.Builder cidr(String cidr)

The CIDR you would like to allocate from the IPAM pool. Note the following:.

• If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
• If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

Possible values: Any available IPv4 or IPv6 CIDR.

Parameters:

cidr - The CIDR you would like to allocate from the IPAM pool. Note the following:. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html#cfn-ec2-ipamallocation-cidr

description

@Stability(Stable)
public CfnIPAMAllocationPropsMixin.Builder description(String description)

A description for the allocation.

Parameters:

description - A description for the allocation. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html#cfn-ec2-ipamallocation-description

ipamPoolId

@Stability(Stable)
public CfnIPAMAllocationPropsMixin.Builder ipamPoolId(String ipamPoolId)

The ID of the IPAM pool from which you would like to allocate a CIDR.

Parameters:

ipamPoolId - The ID of the IPAM pool from which you would like to allocate a CIDR. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html#cfn-ec2-ipamallocation-ipampoolid

netmaskLength

@Stability(Stable)
public CfnIPAMAllocationPropsMixin.Builder netmaskLength(Number netmaskLength)

The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:.

• If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
• If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

Parameters:

netmaskLength - The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamallocation.html#cfn-ec2-ipamallocation-netmasklength

build

@Stability(Stable)
public CfnIPAMAllocationPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnIPAMAllocationPropsMixin.