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

Class CfnIPAMPropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIPAMPropsMixin>

Enclosing class:

CfnIPAMPropsMixin

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

A fluent builder for CfnIPAMPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnIPAMPropsMixin	build()
static CfnIPAMPropsMixin.Builder	create()
static CfnIPAMPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnIPAMPropsMixin.Builder	defaultResourceDiscoveryOrganizationalUnitExclusions(List<? extends Object> defaultResourceDiscoveryOrganizationalUnitExclusions)	If your IPAM is integrated with AWS Organizations, you can exclude an organizational unit (OU) from being managed by IPAM.
CfnIPAMPropsMixin.Builder	defaultResourceDiscoveryOrganizationalUnitExclusions(IResolvable defaultResourceDiscoveryOrganizationalUnitExclusions)	If your IPAM is integrated with AWS Organizations, you can exclude an organizational unit (OU) from being managed by IPAM.
CfnIPAMPropsMixin.Builder	description(String description)	The description for the IPAM.
CfnIPAMPropsMixin.Builder	enablePrivateGua(Boolean enablePrivateGua)	Enable this option to use your own GUA ranges as private IPv6 addresses.
CfnIPAMPropsMixin.Builder	enablePrivateGua(IResolvable enablePrivateGua)	Enable this option to use your own GUA ranges as private IPv6 addresses.
CfnIPAMPropsMixin.Builder	meteredAccount(String meteredAccount)	A metered account is an AWS account that is charged for active IP addresses managed in IPAM.
CfnIPAMPropsMixin.Builder	operatingRegions(List<? extends Object> operatingRegions)	The operating Regions for an IPAM.
CfnIPAMPropsMixin.Builder	operatingRegions(IResolvable operatingRegions)	The operating Regions for an IPAM.
CfnIPAMPropsMixin.Builder	tags(List<? extends CfnTag> tags)	The key/value combination of a tag assigned to the resource.
CfnIPAMPropsMixin.Builder	tier(String tier)	IPAM is offered in a Free Tier and an Advanced Tier.

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

Parameters:

options - Mixin options.

Returns:

a new instance of CfnIPAMPropsMixin.Builder.

create

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

Returns:

a new instance of CfnIPAMPropsMixin.Builder.

defaultResourceDiscoveryOrganizationalUnitExclusions

@Stability(Stable)
public CfnIPAMPropsMixin.Builder defaultResourceDiscoveryOrganizationalUnitExclusions(IResolvable defaultResourceDiscoveryOrganizationalUnitExclusions)

If your IPAM is integrated with AWS Organizations, you can exclude an organizational unit (OU) from being managed by IPAM. When you exclude an OU, IPAM will not manage the IP addresses in accounts in that OU. For more information, see Exclude organizational units from IPAM in the Amazon Virtual Private Cloud IP Address Manager User Guide .

Parameters:

defaultResourceDiscoveryOrganizationalUnitExclusions - If your IPAM is integrated with AWS Organizations, you can exclude an organizational unit (OU) from being managed by IPAM. When you exclude an OU, IPAM will not manage the IP addresses in accounts in that OU. For more information, see Exclude organizational units from IPAM in the Amazon Virtual Private Cloud IP Address Manager User Guide . This parameter is required.

Returns:

this

See Also:

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

defaultResourceDiscoveryOrganizationalUnitExclusions

@Stability(Stable)
public CfnIPAMPropsMixin.Builder defaultResourceDiscoveryOrganizationalUnitExclusions(List<? extends Object> defaultResourceDiscoveryOrganizationalUnitExclusions)

If your IPAM is integrated with AWS Organizations, you can exclude an organizational unit (OU) from being managed by IPAM. When you exclude an OU, IPAM will not manage the IP addresses in accounts in that OU. For more information, see Exclude organizational units from IPAM in the Amazon Virtual Private Cloud IP Address Manager User Guide .

Parameters:

defaultResourceDiscoveryOrganizationalUnitExclusions - If your IPAM is integrated with AWS Organizations, you can exclude an organizational unit (OU) from being managed by IPAM. When you exclude an OU, IPAM will not manage the IP addresses in accounts in that OU. For more information, see Exclude organizational units from IPAM in the Amazon Virtual Private Cloud IP Address Manager User Guide . This parameter is required.

Returns:

this

See Also:

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

description

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

The description for the IPAM.

Parameters:

description - The description for the IPAM. This parameter is required.

Returns:

this

See Also:

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

enablePrivateGua

@Stability(Stable)
public CfnIPAMPropsMixin.Builder enablePrivateGua(Boolean enablePrivateGua)

Enable this option to use your own GUA ranges as private IPv6 addresses.

This option is disabled by default.

Parameters:

enablePrivateGua - Enable this option to use your own GUA ranges as private IPv6 addresses. This parameter is required.

Returns:

this

See Also:

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

enablePrivateGua

@Stability(Stable)
public CfnIPAMPropsMixin.Builder enablePrivateGua(IResolvable enablePrivateGua)

Enable this option to use your own GUA ranges as private IPv6 addresses.

This option is disabled by default.

Parameters:

enablePrivateGua - Enable this option to use your own GUA ranges as private IPv6 addresses. This parameter is required.

Returns:

this

See Also:

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

meteredAccount

@Stability(Stable)
public CfnIPAMPropsMixin.Builder meteredAccount(String meteredAccount)

A metered account is an AWS account that is charged for active IP addresses managed in IPAM.

For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide .

Possible values:

• ipam-owner (default): The AWS account which owns the IPAM is charged for all active IP addresses managed in IPAM.
• resource-owner : The AWS account that owns the IP address is charged for the active IP address.

Parameters:

meteredAccount - A metered account is an AWS account that is charged for active IP addresses managed in IPAM. This parameter is required.

Returns:

this

See Also:

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

operatingRegions

@Stability(Stable)
public CfnIPAMPropsMixin.Builder operatingRegions(IResolvable operatingRegions)

The operating Regions for an IPAM.

Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide .

Parameters:

operatingRegions - The operating Regions for an IPAM. This parameter is required.

Returns:

this

See Also:

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

operatingRegions

@Stability(Stable)
public CfnIPAMPropsMixin.Builder operatingRegions(List<? extends Object> operatingRegions)

The operating Regions for an IPAM.

Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide .

Parameters:

operatingRegions - The operating Regions for an IPAM. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnIPAMPropsMixin.Builder tags(List<? extends CfnTag> tags)

The key/value combination of a tag assigned to the resource.

Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA , specify tag:Owner for the filter name and TeamA for the filter value.

Parameters:

tags - The key/value combination of a tag assigned to the resource. This parameter is required.

Returns:

this

See Also:

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

tier

@Stability(Stable)
public CfnIPAMPropsMixin.Builder tier(String tier)

IPAM is offered in a Free Tier and an Advanced Tier.

For more information about the features available in each tier and the costs associated with the tiers, see the VPC IPAM product pricing page .

Parameters:

tier - IPAM is offered in a Free Tier and an Advanced Tier. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnIPAMPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnIPAMPropsMixin.