software.amazon.awscdk.services.ec2

Class CfnIPAMAllocation

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.ec2.CfnIPAMAllocation

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:20.061Z")
public class CfnIPAMAllocation
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::IPAMAllocation`.

In IPAM, an allocation is a CIDR assignment from an IPAM pool to another resource or IPAM pool.

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.ec2.*;
 CfnIPAMAllocation cfnIPAMAllocation = CfnIPAMAllocation.Builder.create(this, "MyCfnIPAMAllocation")
         .ipamPoolId("ipamPoolId")
         // the properties below are optional
         .cidr("cidr")
         .description("description")
         .netmaskLength(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnIPAMAllocation.Builder A fluent builder for CfnIPAMAllocation.

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
	CfnIPAMAllocation(Construct scope, java.lang.String id, CfnIPAMAllocationProps props) Create a new `AWS::EC2::IPAMAllocation`.
protected	CfnIPAMAllocation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnIPAMAllocation(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrIpamPoolAllocationId() The ID of an allocation.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getCidr() The CIDR you would like to allocate from the IPAM pool.
java.lang.String	getDescription() A description for the allocation.
java.lang.String	getIpamPoolId() The ID of the IPAM pool from which you would like to allocate a CIDR.
java.lang.Number	getNetmaskLength() The netmask length of the CIDR you would like to allocate from the IPAM pool.
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	setCidr(java.lang.String value) The CIDR you would like to allocate from the IPAM pool.
void	setDescription(java.lang.String value) A description for the allocation.
void	setIpamPoolId(java.lang.String value) The ID of the IPAM pool from which you would like to allocate a CIDR.
void	setNetmaskLength(java.lang.Number value) The netmask length of the CIDR you would like to allocate from the IPAM pool.

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

CfnIPAMAllocation

protected CfnIPAMAllocation(software.amazon.jsii.JsiiObjectRef objRef)

CfnIPAMAllocation

protected CfnIPAMAllocation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnIPAMAllocation

public CfnIPAMAllocation(Construct scope,
                         java.lang.String id,
                         CfnIPAMAllocationProps props)

Create a new `AWS::EC2::IPAMAllocation`.

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.

getAttrIpamPoolAllocationId

public java.lang.String getAttrIpamPoolAllocationId()

The ID of an allocation.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getIpamPoolId

public java.lang.String getIpamPoolId()

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

setIpamPoolId

public void setIpamPoolId(java.lang.String value)

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

getCidr

public java.lang.String getCidr()

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.

setCidr

public void setCidr(java.lang.String value)

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.

getDescription

public java.lang.String getDescription()

A description for the allocation.

setDescription

public void setDescription(java.lang.String value)

A description for the allocation.

getNetmaskLength

public java.lang.Number getNetmaskLength()

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.

setNetmaskLength

public void setNetmaskLength(java.lang.Number value)

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.