software.amazon.awscdk.services.ec2

Class CfnIPAMScope

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

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.191Z")
 @Stability(value=Stable)
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 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
	CfnIPAMScope(software.constructs.Construct scope, 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
String	getAttrArn() The ARN of the scope.
String	getAttrIpamArn() The ARN of an IPAM.
String	getAttrIpamScopeId() The ID of an IPAM scope.
String	getAttrIpamScopeType() The type of the scope.
IResolvable	getAttrIsDefault() Defines if the scope is the default scope or not.
Number	getAttrPoolCount() The number of pools in a scope.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the scope.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) The description of the scope.
void	setIpamId(String value) The ID of the IPAM for which you're creating this scope.

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

CfnIPAMScope

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

CfnIPAMScope

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

CfnIPAMScope

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

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

getAttrIpamArn

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

The ARN of an IPAM.

getAttrIpamScopeId

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

The ID of an IPAM scope.

getAttrIpamScopeType

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

The type of the scope.

getAttrIsDefault

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrIsDefault()

Defines if the scope is the default scope or not.

getAttrPoolCount

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

The number of pools in a scope.

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.

getIpamId

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

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

setIpamId

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

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

getDescription

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

The description of the scope.

setDescription

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

The description of the scope.