Package software.amazon.awscdk.services.ec2

Class CfnIPAMPoolProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ec2.CfnIPAMPoolProps.Jsii$Proxy

All Implemented Interfaces:

CfnIPAMPoolProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnIPAMPoolProps

@Stability(Stable)
@Internal
public static final class CfnIPAMPoolProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnIPAMPoolProps

An implementation for CfnIPAMPoolProps

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.CfnIPAMPoolProps

CfnIPAMPoolProps.Builder, CfnIPAMPoolProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnIPAMPoolProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnIPAMPoolProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getAddressFamily()	The address family of the pool.
final Number	getAllocationDefaultNetmaskLength()	The default netmask length for allocations added to this pool.
final Number	getAllocationMaxNetmaskLength()	The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.
final Number	getAllocationMinNetmaskLength()	The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.
final Object	getAllocationResourceTags()	Tags that are required for resources that use CIDRs from this IPAM pool.
final Object	getAutoImport()	If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.
final String	getAwsService()	Limits which service in AWS that the pool can be used in.
final String	getDescription()	The description of the IPAM pool.
final String	getIpamScopeId()	The ID of the scope in which you would like to create the IPAM pool.
final String	getLocale()	The locale of the IPAM pool.
final Object	getProvisionedCidrs()	Information about the CIDRs provisioned to an IPAM pool.
final String	getPublicIpSource()	The IP address source for pools in the public scope.
final Object	getPubliclyAdvertisable()	Determines if a pool is publicly advertisable.
final String	getSourceIpamPoolId()	The ID of the source IPAM pool.
final Object	getSourceResource()	The resource used to provision CIDRs to a resource planning pool.
final List<CfnTag>	getTags()	The key/value combination of a tag assigned to the resource.
final int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnIPAMPoolProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnIPAMPoolProps.Builder.

Method Details

getAddressFamily

public final String getAddressFamily()

Description copied from interface: CfnIPAMPoolProps

The address family of the pool.

Specified by:

getAddressFamily in interface CfnIPAMPoolProps

See Also:

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

getIpamScopeId

public final String getIpamScopeId()

Description copied from interface: CfnIPAMPoolProps

The ID of the scope in which you would like to create the IPAM pool.

Specified by:

getIpamScopeId in interface CfnIPAMPoolProps

See Also:

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

getAllocationDefaultNetmaskLength

public final Number getAllocationDefaultNetmaskLength()

Description copied from interface: CfnIPAMPoolProps

The default netmask length for allocations added to this pool.

If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

Specified by:

getAllocationDefaultNetmaskLength in interface CfnIPAMPoolProps

See Also:

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

getAllocationMaxNetmaskLength

public final Number getAllocationMaxNetmaskLength()

Description copied from interface: CfnIPAMPoolProps

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.

The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

Specified by:

getAllocationMaxNetmaskLength in interface CfnIPAMPoolProps

See Also:

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

getAllocationMinNetmaskLength

public final Number getAllocationMinNetmaskLength()

Description copied from interface: CfnIPAMPoolProps

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.

The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

Specified by:

getAllocationMinNetmaskLength in interface CfnIPAMPoolProps

See Also:

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

getAllocationResourceTags

public final Object getAllocationResourceTags()

Description copied from interface: CfnIPAMPoolProps

Tags that are required for resources that use CIDRs from this IPAM pool.

Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTag>

Specified by:

getAllocationResourceTags in interface CfnIPAMPoolProps

See Also:

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

getAutoImport

public final Object getAutoImport()

Description copied from interface: CfnIPAMPoolProps

If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.

The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

Returns union: either Boolean or IResolvable

Specified by:

getAutoImport in interface CfnIPAMPoolProps

See Also:

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

getAwsService

public final String getAwsService()

Description copied from interface: CfnIPAMPoolProps

Limits which service in AWS that the pool can be used in.

"ec2", for example, allows users to use space for Elastic IP addresses and VPCs.

Specified by:

getAwsService in interface CfnIPAMPoolProps

See Also:

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

getDescription

public final String getDescription()

Description copied from interface: CfnIPAMPoolProps

The description of the IPAM pool.

Specified by:

getDescription in interface CfnIPAMPoolProps

See Also:

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

getLocale

public final String getLocale()

Description copied from interface: CfnIPAMPoolProps

The locale of the IPAM pool.

The locale for the pool should be one of the following:

• An AWS Region where you want this IPAM pool to be available for allocations.
• The network border group for an AWS Local Zone where you want this IPAM pool to be available for allocations ( supported Local Zones ). This option is only available for IPAM IPv4 pools in the public scope.

If you choose an AWS Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.

Specified by:

getLocale in interface CfnIPAMPoolProps

See Also:

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

getProvisionedCidrs

public final Object getProvisionedCidrs()

Description copied from interface: CfnIPAMPoolProps

Information about the CIDRs provisioned to an IPAM pool.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnIPAMPool.ProvisionedCidrProperty>

Specified by:

getProvisionedCidrs in interface CfnIPAMPoolProps

See Also:

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

getPublicIpSource

public final String getPublicIpSource()

Description copied from interface: CfnIPAMPoolProps

The IP address source for pools in the public scope.

Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP . For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide . By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide .

Specified by:

getPublicIpSource in interface CfnIPAMPoolProps

See Also:

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

getPubliclyAdvertisable

public final Object getPubliclyAdvertisable()

Description copied from interface: CfnIPAMPoolProps

Determines if a pool is publicly advertisable.

This option is not available for pools with AddressFamily set to ipv4 .

Returns union: either Boolean or IResolvable

Specified by:

getPubliclyAdvertisable in interface CfnIPAMPoolProps

See Also:

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

getSourceIpamPoolId

public final String getSourceIpamPoolId()

Description copied from interface: CfnIPAMPoolProps

The ID of the source IPAM pool.

You can use this option to create an IPAM pool within an existing source pool.

Specified by:

getSourceIpamPoolId in interface CfnIPAMPoolProps

See Also:

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

getSourceResource

public final Object getSourceResource()

Description copied from interface: CfnIPAMPoolProps

The resource used to provision CIDRs to a resource planning pool.

Returns union: either IResolvable or CfnIPAMPool.SourceResourceProperty

Specified by:

getSourceResource in interface CfnIPAMPoolProps

See Also:

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

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnIPAMPoolProps

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.

Specified by:

getTags in interface CfnIPAMPoolProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object