software.amazon.awscdk.services.ec2

Class CfnIPAM

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:21.586Z")
public class CfnIPAM
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::IPAM`.

IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts throughout your AWS Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide .

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.*;
 CfnIPAM cfnIPAM = CfnIPAM.Builder.create(this, "MyCfnIPAM")
         .defaultResourceDiscoveryAssociationId("defaultResourceDiscoveryAssociationId")
         .defaultResourceDiscoveryId("defaultResourceDiscoveryId")
         .description("description")
         .operatingRegions(List.of(IpamOperatingRegionProperty.builder()
                 .regionName("regionName")
                 .build()))
         .resourceDiscoveryAssociationCount(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnIPAM.Builder A fluent builder for CfnIPAM.
static interface	CfnIPAM.IpamOperatingRegionProperty The operating Regions for an IPAM.

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The ARN of the IPAM.
java.lang.String	getAttrIpamId() The ID of the IPAM.
java.lang.String	getAttrPrivateDefaultScopeId() The ID of the IPAM's default private scope.
java.lang.String	getAttrPublicDefaultScopeId() The ID of the IPAM's default public scope.
java.lang.Number	getAttrScopeCount() The number of scopes in the IPAM.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDefaultResourceDiscoveryAssociationId() The IPAM's default resource discovery association ID.
java.lang.String	getDefaultResourceDiscoveryId() The IPAM's default resource discovery ID.
java.lang.String	getDescription() The description for the IPAM.
java.lang.Object	getOperatingRegions() The operating Regions for an IPAM.
java.lang.Number	getResourceDiscoveryAssociationCount() The IPAM's resource discovery association count.
TagManager	getTags() The key/value combination of a tag assigned to the resource.
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	setDefaultResourceDiscoveryAssociationId(java.lang.String value) The IPAM's default resource discovery association ID.
void	setDefaultResourceDiscoveryId(java.lang.String value) The IPAM's default resource discovery ID.
void	setDescription(java.lang.String value) The description for the IPAM.
void	setOperatingRegions(IResolvable value) The operating Regions for an IPAM.
void	setOperatingRegions(java.util.List<java.lang.Object> value) The operating Regions for an IPAM.
void	setResourceDiscoveryAssociationCount(java.lang.Number value) The IPAM's resource discovery association count.

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

CfnIPAM

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

CfnIPAM

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

CfnIPAM

public CfnIPAM(Construct scope,
               java.lang.String id,
               CfnIPAMProps props)

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

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.

CfnIPAM

public CfnIPAM(Construct scope,
               java.lang.String id)

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

Parameters:

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

id - - scoped id of the resource. 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.

getAttrArn

public java.lang.String getAttrArn()

The ARN of the IPAM.

getAttrIpamId

public java.lang.String getAttrIpamId()

The ID of the IPAM.

getAttrPrivateDefaultScopeId

public java.lang.String getAttrPrivateDefaultScopeId()

The ID of the IPAM's default private scope.

getAttrPublicDefaultScopeId

public java.lang.String getAttrPublicDefaultScopeId()

The ID of the IPAM's default public scope.

getAttrScopeCount

public java.lang.Number getAttrScopeCount()

The number of scopes in the IPAM.

The scope quota is 5.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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.

getDefaultResourceDiscoveryAssociationId

public java.lang.String getDefaultResourceDiscoveryAssociationId()

The IPAM's default resource discovery association ID.

setDefaultResourceDiscoveryAssociationId

public void setDefaultResourceDiscoveryAssociationId(java.lang.String value)

The IPAM's default resource discovery association ID.

getDefaultResourceDiscoveryId

public java.lang.String getDefaultResourceDiscoveryId()

The IPAM's default resource discovery ID.

setDefaultResourceDiscoveryId

public void setDefaultResourceDiscoveryId(java.lang.String value)

The IPAM's default resource discovery ID.

getDescription

public java.lang.String getDescription()

The description for the IPAM.

setDescription

public void setDescription(java.lang.String value)

The description for the IPAM.

getOperatingRegions

public java.lang.Object getOperatingRegions()

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 .

setOperatingRegions

public void setOperatingRegions(IResolvable value)

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 .

setOperatingRegions

public void setOperatingRegions(java.util.List<java.lang.Object> value)

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 .

getResourceDiscoveryAssociationCount

public java.lang.Number getResourceDiscoveryAssociationCount()

The IPAM's resource discovery association count.

setResourceDiscoveryAssociationCount

public void setResourceDiscoveryAssociationCount(java.lang.Number value)

The IPAM's resource discovery association count.