software.amazon.awscdk.services.ec2

Class CfnIPAMAllocation

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ec2.CfnIPAMAllocation

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.57.0 (build f614666)",
           date="2022-04-22T09:30:46.775Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnIPAMAllocation(software.constructs.Construct scope, 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
String	getAttrIpamPoolAllocationId() The ID of an allocation.
protected Map<String,Object>	getCfnProperties()
String	getCidr() The CIDR you would like to allocate from the IPAM pool.
String	getDescription() A description for the allocation.
String	getIpamPoolId() The ID of the IPAM pool from which you would like to allocate a CIDR.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCidr(String value) The CIDR you would like to allocate from the IPAM pool.
void	setDescription(String value) A description for the allocation.
void	setIpamPoolId(String value) The ID of the IPAM pool from which you would like to allocate a CIDR.
void	setNetmaskLength(Number value) The netmask length of the CIDR you would like to allocate from the IPAM pool.

Methods inherited from class software.amazon.awscdk.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.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnIPAMAllocation(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrIpamPoolAllocationId

@Stability(value=Stable)
 @NotNull
public String getAttrIpamPoolAllocationId()

The ID of an allocation.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getIpamPoolId

@Stability(value=Stable)
 @NotNull
public String getIpamPoolId()

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

setIpamPoolId

@Stability(value=Stable)
public void setIpamPoolId(@NotNull
                                                   String value)

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

getCidr

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setCidr(@Nullable
                                             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

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description for the allocation.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description for the allocation.

getNetmaskLength

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setNetmaskLength(@Nullable
                                                      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.