software.amazon.awscdk.services.ec2

Class CfnIPAMPool

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:16.921Z")
 @Stability(value=Stable)
public class CfnIPAMPool
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::IPAMPool`.

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.*;
 CfnIPAMPool cfnIPAMPool = CfnIPAMPool.Builder.create(this, "MyCfnIPAMPool")
         .addressFamily("addressFamily")
         .ipamScopeId("ipamScopeId")
         // the properties below are optional
         .allocationDefaultNetmaskLength(123)
         .allocationMaxNetmaskLength(123)
         .allocationMinNetmaskLength(123)
         .allocationResourceTags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .autoImport(false)
         .description("description")
         .locale("locale")
         .provisionedCidrs(List.of(ProvisionedCidrProperty.builder()
                 .cidr("cidr")
                 .build()))
         .publiclyAdvertisable(false)
         .sourceIpamPoolId("sourceIpamPoolId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnIPAMPool.Builder A fluent builder for CfnIPAMPool.
static interface	CfnIPAMPool.ProvisionedCidrProperty Example:

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
	CfnIPAMPool(software.constructs.Construct scope, String id, CfnIPAMPoolProps props) Create a new `AWS::EC2::IPAMPool`.
protected	CfnIPAMPool(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnIPAMPool(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAddressFamily() `AWS::EC2::IPAMPool.AddressFamily`.
Number	getAllocationDefaultNetmaskLength() `AWS::EC2::IPAMPool.AllocationDefaultNetmaskLength`.
Number	getAllocationMaxNetmaskLength() `AWS::EC2::IPAMPool.AllocationMaxNetmaskLength`.
Number	getAllocationMinNetmaskLength() `AWS::EC2::IPAMPool.AllocationMinNetmaskLength`.
Object	getAllocationResourceTags() `AWS::EC2::IPAMPool.AllocationResourceTags`.
String	getAttrArn()
String	getAttrIpamArn()
String	getAttrIpamPoolId()
String	getAttrIpamScopeArn()
String	getAttrIpamScopeType()
Number	getAttrPoolDepth()
String	getAttrState()
String	getAttrStateMessage()
Object	getAutoImport() `AWS::EC2::IPAMPool.AutoImport`.
protected Map<String,Object>	getCfnProperties()
String	getDescription() `AWS::EC2::IPAMPool.Description`.
String	getIpamScopeId() `AWS::EC2::IPAMPool.IpamScopeId`.
String	getLocale() `AWS::EC2::IPAMPool.Locale`.
Object	getProvisionedCidrs() `AWS::EC2::IPAMPool.ProvisionedCidrs`.
Object	getPubliclyAdvertisable() `AWS::EC2::IPAMPool.PubliclyAdvertisable`.
String	getSourceIpamPoolId() `AWS::EC2::IPAMPool.SourceIpamPoolId`.
TagManager	getTags() `AWS::EC2::IPAMPool.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAddressFamily(String value) `AWS::EC2::IPAMPool.AddressFamily`.
void	setAllocationDefaultNetmaskLength(Number value) `AWS::EC2::IPAMPool.AllocationDefaultNetmaskLength`.
void	setAllocationMaxNetmaskLength(Number value) `AWS::EC2::IPAMPool.AllocationMaxNetmaskLength`.
void	setAllocationMinNetmaskLength(Number value) `AWS::EC2::IPAMPool.AllocationMinNetmaskLength`.
void	setAllocationResourceTags(IResolvable value) `AWS::EC2::IPAMPool.AllocationResourceTags`.
void	setAllocationResourceTags(List<Object> value) `AWS::EC2::IPAMPool.AllocationResourceTags`.
void	setAutoImport(Boolean value) `AWS::EC2::IPAMPool.AutoImport`.
void	setAutoImport(IResolvable value) `AWS::EC2::IPAMPool.AutoImport`.
void	setDescription(String value) `AWS::EC2::IPAMPool.Description`.
void	setIpamScopeId(String value) `AWS::EC2::IPAMPool.IpamScopeId`.
void	setLocale(String value) `AWS::EC2::IPAMPool.Locale`.
void	setProvisionedCidrs(IResolvable value) `AWS::EC2::IPAMPool.ProvisionedCidrs`.
void	setProvisionedCidrs(List<Object> value) `AWS::EC2::IPAMPool.ProvisionedCidrs`.
void	setPubliclyAdvertisable(Boolean value) `AWS::EC2::IPAMPool.PubliclyAdvertisable`.
void	setPubliclyAdvertisable(IResolvable value) `AWS::EC2::IPAMPool.PubliclyAdvertisable`.
void	setSourceIpamPoolId(String value) `AWS::EC2::IPAMPool.SourceIpamPoolId`.

Methods inherited from class software.amazon.awscdk.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.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

CfnIPAMPool

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

CfnIPAMPool

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

CfnIPAMPool

@Stability(value=Stable)
public CfnIPAMPool(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CfnIPAMPoolProps props)

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

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.

getAddressFamily

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

`AWS::EC2::IPAMPool.AddressFamily`.

setAddressFamily

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

`AWS::EC2::IPAMPool.AddressFamily`.

getAllocationDefaultNetmaskLength

@Stability(value=Stable)
 @Nullable
public Number getAllocationDefaultNetmaskLength()

`AWS::EC2::IPAMPool.AllocationDefaultNetmaskLength`.

setAllocationDefaultNetmaskLength

@Stability(value=Stable)
public void setAllocationDefaultNetmaskLength(@Nullable
                                                                       Number value)

`AWS::EC2::IPAMPool.AllocationDefaultNetmaskLength`.

getAllocationMaxNetmaskLength

@Stability(value=Stable)
 @Nullable
public Number getAllocationMaxNetmaskLength()

`AWS::EC2::IPAMPool.AllocationMaxNetmaskLength`.

setAllocationMaxNetmaskLength

@Stability(value=Stable)
public void setAllocationMaxNetmaskLength(@Nullable
                                                                   Number value)

`AWS::EC2::IPAMPool.AllocationMaxNetmaskLength`.

getAllocationMinNetmaskLength

@Stability(value=Stable)
 @Nullable
public Number getAllocationMinNetmaskLength()

`AWS::EC2::IPAMPool.AllocationMinNetmaskLength`.

setAllocationMinNetmaskLength

@Stability(value=Stable)
public void setAllocationMinNetmaskLength(@Nullable
                                                                   Number value)

`AWS::EC2::IPAMPool.AllocationMinNetmaskLength`.

getAllocationResourceTags

@Stability(value=Stable)
 @Nullable
public Object getAllocationResourceTags()

`AWS::EC2::IPAMPool.AllocationResourceTags`.

setAllocationResourceTags

@Stability(value=Stable)
public void setAllocationResourceTags(@Nullable
                                                               IResolvable value)

`AWS::EC2::IPAMPool.AllocationResourceTags`.

setAllocationResourceTags

@Stability(value=Stable)
public void setAllocationResourceTags(@Nullable
                                                               List<Object> value)

`AWS::EC2::IPAMPool.AllocationResourceTags`.

getAttrArn

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

getAttrIpamArn

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

getAttrIpamPoolId

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

getAttrIpamScopeArn

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

getAttrIpamScopeType

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

getAttrPoolDepth

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

getAttrState

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

getAttrStateMessage

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

getAutoImport

@Stability(value=Stable)
 @Nullable
public Object getAutoImport()

`AWS::EC2::IPAMPool.AutoImport`.

setAutoImport

@Stability(value=Stable)
public void setAutoImport(@Nullable
                                                   Boolean value)

`AWS::EC2::IPAMPool.AutoImport`.

setAutoImport

@Stability(value=Stable)
public void setAutoImport(@Nullable
                                                   IResolvable value)

`AWS::EC2::IPAMPool.AutoImport`.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getDescription

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

`AWS::EC2::IPAMPool.Description`.

setDescription

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

`AWS::EC2::IPAMPool.Description`.

getIpamScopeId

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

`AWS::EC2::IPAMPool.IpamScopeId`.

setIpamScopeId

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

`AWS::EC2::IPAMPool.IpamScopeId`.

getLocale

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

`AWS::EC2::IPAMPool.Locale`.

setLocale

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

`AWS::EC2::IPAMPool.Locale`.

getProvisionedCidrs

@Stability(value=Stable)
 @Nullable
public Object getProvisionedCidrs()

`AWS::EC2::IPAMPool.ProvisionedCidrs`.

setProvisionedCidrs

@Stability(value=Stable)
public void setProvisionedCidrs(@Nullable
                                                         IResolvable value)

`AWS::EC2::IPAMPool.ProvisionedCidrs`.

setProvisionedCidrs

@Stability(value=Stable)
public void setProvisionedCidrs(@Nullable
                                                         List<Object> value)

`AWS::EC2::IPAMPool.ProvisionedCidrs`.

getPubliclyAdvertisable

@Stability(value=Stable)
 @Nullable
public Object getPubliclyAdvertisable()

`AWS::EC2::IPAMPool.PubliclyAdvertisable`.

setPubliclyAdvertisable

@Stability(value=Stable)
public void setPubliclyAdvertisable(@Nullable
                                                             Boolean value)

`AWS::EC2::IPAMPool.PubliclyAdvertisable`.

setPubliclyAdvertisable

@Stability(value=Stable)
public void setPubliclyAdvertisable(@Nullable
                                                             IResolvable value)

`AWS::EC2::IPAMPool.PubliclyAdvertisable`.

getSourceIpamPoolId

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

`AWS::EC2::IPAMPool.SourceIpamPoolId`.

setSourceIpamPoolId

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

`AWS::EC2::IPAMPool.SourceIpamPoolId`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::EC2::IPAMPool.Tags`.