software.amazon.awscdk.services.ec2

Class CfnIPAMScope

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:42.450Z")
public class CfnIPAMScope
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::IPAMScope`.

In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

For more information, see How IPAM works 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.*;
 CfnIPAMScope cfnIPAMScope = CfnIPAMScope.Builder.create(this, "MyCfnIPAMScope")
         .ipamId("ipamId")
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The ARN of the scope.
java.lang.String	getAttrIpamArn() The ARN of an IPAM.
java.lang.String	getAttrIpamScopeId() The ID of an IPAM scope.
java.lang.String	getAttrIpamScopeType() The type of the scope.
IResolvable	getAttrIsDefault() Defines if the scope is the default scope or not.
java.lang.Number	getAttrPoolCount() The number of pools in a scope.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() The description of the scope.
java.lang.String	getIpamId() The ID of the IPAM for which you're creating this scope.
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	setDescription(java.lang.String value) The description of the scope.
void	setIpamId(java.lang.String value) The ID of the IPAM for which you're creating this scope.

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

CfnIPAMScope

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

CfnIPAMScope

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

CfnIPAMScope

public CfnIPAMScope(Construct scope,
                    java.lang.String id,
                    CfnIPAMScopeProps props)

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

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.

getAttrArn

public java.lang.String getAttrArn()

The ARN of the scope.

getAttrIpamArn

public java.lang.String getAttrIpamArn()

The ARN of an IPAM.

getAttrIpamScopeId

public java.lang.String getAttrIpamScopeId()

The ID of an IPAM scope.

getAttrIpamScopeType

public java.lang.String getAttrIpamScopeType()

The type of the scope.

getAttrIsDefault

public IResolvable getAttrIsDefault()

Defines if the scope is the default scope or not.

getAttrPoolCount

public java.lang.Number getAttrPoolCount()

The number of pools in a scope.

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.

getIpamId

public java.lang.String getIpamId()

The ID of the IPAM for which you're creating this scope.

setIpamId

public void setIpamId(java.lang.String value)

The ID of the IPAM for which you're creating this scope.

getDescription

public java.lang.String getDescription()

The description of the scope.

setDescription

public void setDescription(java.lang.String value)

The description of the scope.