CfnIPAMPool (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.177Z")
 @Stability(value=Stable)
public class CfnIPAMPool
extends CfnResource
implements IInspectable

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

In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.

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)
         .awsService("awsService")
         .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` The CIDR provisioned to the IPAM pool.

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.

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAddressFamily()` The address family of the pool.
`Number`	`getAllocationDefaultNetmaskLength()` The default netmask length for allocations added to this pool.
`Number`	`getAllocationMaxNetmaskLength()` The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.
`Number`	`getAllocationMinNetmaskLength()` The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.
`Object`	`getAllocationResourceTags()` Tags that are required for resources that use CIDRs from this IPAM pool.
`String`	`getAttrArn()` The ARN of the IPAM pool.
`String`	`getAttrIpamArn()` The ARN of the IPAM.
`String`	`getAttrIpamPoolId()` The ID of the IPAM pool.
`String`	`getAttrIpamScopeArn()` The ARN of the scope of the IPAM pool.
`String`	`getAttrIpamScopeType()` The scope of the IPAM.
`Number`	`getAttrPoolDepth()` The depth of pools in your IPAM pool.
`String`	`getAttrState()` The state of the IPAM pool.
`String`	`getAttrStateMessage()` A message related to the failed creation of an IPAM pool.
`Object`	`getAutoImport()` If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.
`String`	`getAwsService()` `AWS::EC2::IPAMPool.AwsService`.
`protected Map<String,Object>`	`getCfnProperties()`
`String`	`getDescription()` The description of the IPAM pool.
`String`	`getIpamScopeId()` The ID of the scope in which you would like to create the IPAM pool.
`String`	`getLocale()` The locale of the IPAM pool.
`Object`	`getProvisionedCidrs()` Information about the CIDRs provisioned to an IPAM pool.
`Object`	`getPubliclyAdvertisable()` Determines if a pool is publicly advertisable.
`String`	`getSourceIpamPoolId()` The ID of the source IPAM pool.
`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`	`setAddressFamily(String value)` The address family of the pool.
`void`	`setAllocationDefaultNetmaskLength(Number value)` The default netmask length for allocations added to this pool.
`void`	`setAllocationMaxNetmaskLength(Number value)` The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.
`void`	`setAllocationMinNetmaskLength(Number value)` The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.
`void`	`setAllocationResourceTags(IResolvable value)` Tags that are required for resources that use CIDRs from this IPAM pool.
`void`	`setAllocationResourceTags(List<Object> value)` Tags that are required for resources that use CIDRs from this IPAM pool.
`void`	`setAutoImport(Boolean value)` If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.
`void`	`setAutoImport(IResolvable value)` If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.
`void`	`setAwsService(String value)` `AWS::EC2::IPAMPool.AwsService`.
`void`	`setDescription(String value)` The description of the IPAM pool.
`void`	`setIpamScopeId(String value)` The ID of the scope in which you would like to create the IPAM pool.
`void`	`setLocale(String value)` The locale of the IPAM pool.
`void`	`setProvisionedCidrs(IResolvable value)` Information about the CIDRs provisioned to an IPAM pool.
`void`	`setProvisionedCidrs(List<Object> value)` Information about the CIDRs provisioned to an IPAM pool.
`void`	`setPubliclyAdvertisable(Boolean value)` Determines if a pool is publicly advertisable.
`void`	`setPubliclyAdvertisable(IResolvable value)` Determines if a pool is publicly advertisable.
`void`	`setSourceIpamPoolId(String value)` The ID of the source IPAM pool.

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
  - 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.
  - getAttrArn
```
@Stability(value=Stable)
 @NotNull
public String getAttrArn()
```
    The ARN of the IPAM pool.
  - getAttrIpamArn
```
@Stability(value=Stable)
 @NotNull
public String getAttrIpamArn()
```
    The ARN of the IPAM.
  - getAttrIpamPoolId
```
@Stability(value=Stable)
 @NotNull
public String getAttrIpamPoolId()
```
    The ID of the IPAM pool.
  - getAttrIpamScopeArn
```
@Stability(value=Stable)
 @NotNull
public String getAttrIpamScopeArn()
```
    The ARN of the scope of the IPAM pool.
  - getAttrIpamScopeType
```
@Stability(value=Stable)
 @NotNull
public String getAttrIpamScopeType()
```
    The scope of the IPAM.
  - getAttrPoolDepth
```
@Stability(value=Stable)
 @NotNull
public Number getAttrPoolDepth()
```
    The depth of pools in your IPAM pool.
    The pool depth quota is 10.
  - getAttrState
```
@Stability(value=Stable)
 @NotNull
public String getAttrState()
```
    The state of the IPAM pool.
  - getAttrStateMessage
```
@Stability(value=Stable)
 @NotNull
public String getAttrStateMessage()
```
    A message related to the failed creation of an IPAM pool.
  - 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.
  - getAddressFamily
```
@Stability(value=Stable)
 @NotNull
public String getAddressFamily()
```
    The address family of the pool.
  - setAddressFamily
```
@Stability(value=Stable)
public void setAddressFamily(@NotNull
                                                      String value)
```
    The address family of the pool.
  - getIpamScopeId
```
@Stability(value=Stable)
 @NotNull
public String getIpamScopeId()
```
    The ID of the scope in which you would like to create the IPAM pool.
  - setIpamScopeId
```
@Stability(value=Stable)
public void setIpamScopeId(@NotNull
                                                    String value)
```
    The ID of the scope in which you would like to create the IPAM pool.
  - getAllocationDefaultNetmaskLength
```
@Stability(value=Stable)
 @Nullable
public Number getAllocationDefaultNetmaskLength()
```
    The default netmask length for allocations added to this pool.
    If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
  - setAllocationDefaultNetmaskLength
```
@Stability(value=Stable)
public void setAllocationDefaultNetmaskLength(@Nullable
                                                                       Number value)
```
    The default netmask length for allocations added to this pool.
    If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
  - getAllocationMaxNetmaskLength
```
@Stability(value=Stable)
 @Nullable
public Number getAllocationMaxNetmaskLength()
```
    The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.
    The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
  - setAllocationMaxNetmaskLength
```
@Stability(value=Stable)
public void setAllocationMaxNetmaskLength(@Nullable
                                                                   Number value)
```
    The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.
    The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
  - getAllocationMinNetmaskLength
```
@Stability(value=Stable)
 @Nullable
public Number getAllocationMinNetmaskLength()
```
    The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.
    The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
  - setAllocationMinNetmaskLength
```
@Stability(value=Stable)
public void setAllocationMinNetmaskLength(@Nullable
                                                                   Number value)
```
    The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.
    The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
  - getAllocationResourceTags
```
@Stability(value=Stable)
 @Nullable
public Object getAllocationResourceTags()
```
    Tags that are required for resources that use CIDRs from this IPAM pool.
    Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
  - setAllocationResourceTags
```
@Stability(value=Stable)
public void setAllocationResourceTags(@Nullable
                                                               IResolvable value)
```
    Tags that are required for resources that use CIDRs from this IPAM pool.
    Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
  - setAllocationResourceTags
```
@Stability(value=Stable)
public void setAllocationResourceTags(@Nullable
                                                               List<Object> value)
```
    Tags that are required for resources that use CIDRs from this IPAM pool.
    Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.
  - getAutoImport
```
@Stability(value=Stable)
 @Nullable
public Object getAutoImport()
```
    If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.
    The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
    A locale must be set on the pool for this feature to work.
  - setAutoImport
```
@Stability(value=Stable)
public void setAutoImport(@Nullable
                                                   Boolean value)
```
    If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.
    The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
    A locale must be set on the pool for this feature to work.
  - setAutoImport
```
@Stability(value=Stable)
public void setAutoImport(@Nullable
                                                   IResolvable value)
```
    If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.
    The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
    A locale must be set on the pool for this feature to work.
  - getAwsService
```
@Stability(value=Stable)
 @Nullable
public String getAwsService()
```
    `AWS::EC2::IPAMPool.AwsService`.
  - setAwsService
```
@Stability(value=Stable)
public void setAwsService(@Nullable
                                                   String value)
```
    `AWS::EC2::IPAMPool.AwsService`.
  - getDescription
```
@Stability(value=Stable)
 @Nullable
public String getDescription()
```
    The description of the IPAM pool.
  - setDescription
```
@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)
```
    The description of the IPAM pool.
  - getLocale
```
@Stability(value=Stable)
 @Nullable
public String getLocale()
```
    The locale of the IPAM pool.
    In IPAM, the locale is the AWS Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an AWS Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.
  - setLocale
```
@Stability(value=Stable)
public void setLocale(@Nullable
                                               String value)
```
    The locale of the IPAM pool.
    In IPAM, the locale is the AWS Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an AWS Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.
  - getProvisionedCidrs
```
@Stability(value=Stable)
 @Nullable
public Object getProvisionedCidrs()
```
    Information about the CIDRs provisioned to an IPAM pool.
  - setProvisionedCidrs
```
@Stability(value=Stable)
public void setProvisionedCidrs(@Nullable
                                                         IResolvable value)
```
    Information about the CIDRs provisioned to an IPAM pool.
  - setProvisionedCidrs
```
@Stability(value=Stable)
public void setProvisionedCidrs(@Nullable
                                                         List<Object> value)
```
    Information about the CIDRs provisioned to an IPAM pool.
  - getPubliclyAdvertisable
```
@Stability(value=Stable)
 @Nullable
public Object getPubliclyAdvertisable()
```
    Determines if a pool is publicly advertisable.
    This option is not available for pools with AddressFamily set to ipv4 .
  - setPubliclyAdvertisable
```
@Stability(value=Stable)
public void setPubliclyAdvertisable(@Nullable
                                                             Boolean value)
```
    Determines if a pool is publicly advertisable.
    This option is not available for pools with AddressFamily set to ipv4 .
  - setPubliclyAdvertisable
```
@Stability(value=Stable)
public void setPubliclyAdvertisable(@Nullable
                                                             IResolvable value)
```
    Determines if a pool is publicly advertisable.
    This option is not available for pools with AddressFamily set to ipv4 .
  - getSourceIpamPoolId
```
@Stability(value=Stable)
 @Nullable
public String getSourceIpamPoolId()
```
    The ID of the source IPAM pool.
    You can use this option to create an IPAM pool within an existing source pool.
  - setSourceIpamPoolId
```
@Stability(value=Stable)
public void setSourceIpamPoolId(@Nullable
                                                         String value)
```
    The ID of the source IPAM pool.
    You can use this option to create an IPAM pool within an existing source pool.

Class CfnIPAMPool

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

Nested classes/interfaces inherited from interface software.constructs.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.CfnResource

Methods inherited from class software.amazon.awscdk.CfnRefElement

Methods inherited from class software.amazon.awscdk.CfnElement

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnIPAMPool

CfnIPAMPool

CfnIPAMPool

Method Detail

inspect

renderProperties

getAttrArn

getAttrIpamArn

getAttrIpamPoolId

getAttrIpamScopeArn

getAttrIpamScopeType

getAttrPoolDepth

getAttrState

getAttrStateMessage

getCfnProperties

getTags

getAddressFamily

setAddressFamily

getIpamScopeId

setIpamScopeId

getAllocationDefaultNetmaskLength

setAllocationDefaultNetmaskLength

getAllocationMaxNetmaskLength

setAllocationMaxNetmaskLength

getAllocationMinNetmaskLength

setAllocationMinNetmaskLength

getAllocationResourceTags

setAllocationResourceTags

setAllocationResourceTags

getAutoImport

setAutoImport

setAutoImport

getAwsService

setAwsService

getDescription

setDescription

getLocale

setLocale

getProvisionedCidrs

setProvisionedCidrs

setProvisionedCidrs

getPubliclyAdvertisable

setPubliclyAdvertisable

setPubliclyAdvertisable

getSourceIpamPoolId

setSourceIpamPoolId