software.amazon.awscdk.services.ec2

Class CfnIPAM

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.175Z")
 @Stability(value=Stable)
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")
         .description("description")
         .operatingRegions(List.of(IpamOperatingRegionProperty.builder()
                 .regionName("regionName")
                 .build()))
         .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 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
	CfnIPAM(software.constructs.Construct scope, String id) Create a new `AWS::EC2::IPAM`.
	CfnIPAM(software.constructs.Construct scope, 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
String	getAttrArn() The ARN of the IPAM.
String	getAttrIpamId() The ID of the IPAM.
String	getAttrPrivateDefaultScopeId() The ID of the IPAM's default private scope.
String	getAttrPublicDefaultScopeId() The ID of the IPAM's default public scope.
Number	getAttrScopeCount() The number of scopes in the IPAM.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description for the IPAM.
Object	getOperatingRegions() The operating Regions for an IPAM.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) The description for the IPAM.
void	setOperatingRegions(IResolvable value) The operating Regions for an IPAM.
void	setOperatingRegions(List<Object> value) The operating Regions for an IPAM.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, 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

CfnIPAM

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

CfnIPAM

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

CfnIPAM

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

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

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

getAttrArn

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

The ARN of the IPAM.

getAttrIpamId

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

The ID of the IPAM.

getAttrPrivateDefaultScopeId

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

The ID of the IPAM's default private scope.

getAttrPublicDefaultScopeId

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

The ID of the IPAM's default public scope.

getAttrScopeCount

@Stability(value=Stable)
 @NotNull
public Number getAttrScopeCount()

The number of scopes in the IPAM.

The scope quota is 5.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

getDescription

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

The description for the IPAM.

setDescription

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

The description for the IPAM.

getOperatingRegions

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

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

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