Package software.amazon.awscdk.services.ec2

Class CfnIPAMPoolCidr

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.CfnIPAMPoolCidr

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-24T02:42:36.717Z")
@Stability(Stable)
public class CfnIPAMPoolCidr
extends CfnResource
implements IInspectable

A CIDR provisioned to an 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.*;
 CfnIPAMPoolCidr cfnIPAMPoolCidr = CfnIPAMPoolCidr.Builder.create(this, "MyCfnIPAMPoolCidr")
         .ipamPoolId("ipamPoolId")
         // the properties below are optional
         .cidr("cidr")
         .netmaskLength(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnIPAMPoolCidr(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnIPAMPoolCidr(software.amazon.jsii.JsiiObjectRef objRef)
	CfnIPAMPoolCidr(software.constructs.Construct scope, String id, CfnIPAMPoolCidrProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrIpamPoolCidrId()	The IPAM pool CIDR ID.
String	getAttrState()	The state of the CIDR.
protected Map<String,Object>	getCfnProperties()
String	getCidr()	The CIDR provisioned to the IPAM pool.
String	getIpamPoolId()	The ID of the IPAM pool.
Number	getNetmaskLength()	The netmask length of the CIDR you'd like to provision to a 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 provisioned to the IPAM pool.
void	setIpamPoolId(String value)	The ID of the IPAM pool.
void	setNetmaskLength(Number value)	The netmask length of the CIDR you'd like to provision to a pool.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnIPAMPoolCidr

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

CfnIPAMPoolCidr

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

CfnIPAMPoolCidr

@Stability(Stable)
public CfnIPAMPoolCidr(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnIPAMPoolCidrProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(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(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrIpamPoolCidrId

@Stability(Stable)
@NotNull
public String getAttrIpamPoolCidrId()

The IPAM pool CIDR ID.

getAttrState

@Stability(Stable)
@NotNull
public String getAttrState()

The state of the CIDR.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getIpamPoolId

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

The ID of the IPAM pool.

setIpamPoolId

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

The ID of the IPAM pool.

getCidr

@Stability(Stable)
@Nullable
public String getCidr()

The CIDR provisioned to the IPAM pool.

setCidr

@Stability(Stable)
public void setCidr(@Nullable
 String value)

The CIDR provisioned to the IPAM pool.

getNetmaskLength

@Stability(Stable)
@Nullable
public Number getNetmaskLength()

The netmask length of the CIDR you'd like to provision to a pool.

setNetmaskLength

@Stability(Stable)
public void setNetmaskLength(@Nullable
 Number value)

The netmask length of the CIDR you'd like to provision to a pool.