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
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-12-17T21:37:29.627Z")
@Stability(Stable)
public class CfnIPAMPool
extends CfnResource
implements IInspectable, ITaggable
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())) .publicIpSource("publicIpSource") .publiclyAdvertisable(false) .sourceIpamPoolId("sourceIpamPoolId") .sourceResource(SourceResourceProperty.builder() .resourceId("resourceId") .resourceOwner("resourceOwner") .resourceRegion("resourceRegion") .resourceType("resourceType") .build()) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnIPAMPool
.static interface
The CIDR provisioned to the IPAM pool.static interface
The resource used to provision CIDRs to a resource planning pool.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnIPAMPool
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnIPAMPool
(software.amazon.jsii.JsiiObjectRef objRef) CfnIPAMPool
(software.constructs.Construct scope, String id, CfnIPAMPoolProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe address family of the pool.The default netmask length for allocations added to this pool.The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.Tags that are required for resources that use CIDRs from this IPAM pool.The ARN of the IPAM pool.The ARN of the IPAM.The ID of the IPAM pool.The ARN of the scope of the IPAM pool.The scope of the IPAM.The depth of pools in your IPAM pool.The state of the IPAM pool.A message related to the failed creation of an IPAM pool.If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.Limits which service in AWS that the pool can be used in.The description of the IPAM pool.The ID of the scope in which you would like to create the IPAM pool.The locale of the IPAM pool.Information about the CIDRs provisioned to an IPAM pool.The IP address source for pools in the public scope.Determines if a pool is publicly advertisable.The ID of the source IPAM pool.The resource used to provision CIDRs to a resource planning pool.getTags()
Tag Manager which manages the tags for this resource.The key/value combination of a tag assigned to the resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAddressFamily
(String value) The address family of the pool.void
The default netmask length for allocations added to this pool.void
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.void
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.void
setAllocationResourceTags
(List<Object> value) Tags that are required for resources that use CIDRs from this IPAM pool.void
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) Limits which service in AWS that the pool can be used in.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
The locale of the IPAM pool.void
setProvisionedCidrs
(List<Object> value) Information about the CIDRs provisioned to an IPAM pool.void
setProvisionedCidrs
(IResolvable value) Information about the CIDRs provisioned to an IPAM pool.void
setPublicIpSource
(String value) The IP address source for pools in the public scope.void
setPubliclyAdvertisable
(Boolean value) Determines if a pool is publicly advertisable.void
Determines if a pool is publicly advertisable.void
setSourceIpamPoolId
(String value) The ID of the source IPAM pool.void
setSourceResource
(IResolvable value) The resource used to provision CIDRs to a resource planning pool.void
The resource used to provision CIDRs to a resource planning pool.void
setTagsRaw
(List<CfnTag> value) The key/value combination of a tag assigned to the resource.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnIPAMPool
protected CfnIPAMPool(software.amazon.jsii.JsiiObjectRef objRef) -
CfnIPAMPool
protected CfnIPAMPool(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnIPAMPool
@Stability(Stable) public CfnIPAMPool(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIPAMPoolProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The ARN of the IPAM pool. -
getAttrIpamArn
The ARN of the IPAM. -
getAttrIpamPoolId
The ID of the IPAM pool. -
getAttrIpamScopeArn
The ARN of the scope of the IPAM pool. -
getAttrIpamScopeType
The scope of the IPAM. -
getAttrPoolDepth
The depth of pools in your IPAM pool.The pool depth quota is 10.
-
getAttrState
The state of the IPAM pool. -
getAttrStateMessage
A message related to the failed creation of an IPAM pool. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getAddressFamily
The address family of the pool. -
setAddressFamily
The address family of the pool. -
getIpamScopeId
The ID of the scope in which you would like to create the IPAM pool. -
setIpamScopeId
The ID of the scope in which you would like to create the IPAM pool. -
getAllocationDefaultNetmaskLength
The default netmask length for allocations added to this pool. -
setAllocationDefaultNetmaskLength
The default netmask length for allocations added to this pool. -
getAllocationMaxNetmaskLength
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. -
setAllocationMaxNetmaskLength
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. -
getAllocationMinNetmaskLength
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. -
setAllocationMinNetmaskLength
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. -
getAllocationResourceTags
Tags that are required for resources that use CIDRs from this IPAM pool. -
setAllocationResourceTags
Tags that are required for resources that use CIDRs from this IPAM pool. -
setAllocationResourceTags
Tags that are required for resources that use CIDRs from this IPAM pool. -
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. -
setAutoImport
If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. -
setAutoImport
If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. -
getAwsService
Limits which service in AWS that the pool can be used in. -
setAwsService
Limits which service in AWS that the pool can be used in. -
getDescription
The description of the IPAM pool. -
setDescription
The description of the IPAM pool. -
getLocale
The locale of the IPAM pool. -
setLocale
The locale of the IPAM pool. -
getProvisionedCidrs
Information about the CIDRs provisioned to an IPAM pool. -
setProvisionedCidrs
Information about the CIDRs provisioned to an IPAM pool. -
setProvisionedCidrs
Information about the CIDRs provisioned to an IPAM pool. -
getPublicIpSource
The IP address source for pools in the public scope. -
setPublicIpSource
The IP address source for pools in the public scope. -
getPubliclyAdvertisable
Determines if a pool is publicly advertisable. -
setPubliclyAdvertisable
Determines if a pool is publicly advertisable. -
setPubliclyAdvertisable
Determines if a pool is publicly advertisable. -
getSourceIpamPoolId
The ID of the source IPAM pool. -
setSourceIpamPoolId
The ID of the source IPAM pool. -
getSourceResource
The resource used to provision CIDRs to a resource planning pool. -
setSourceResource
The resource used to provision CIDRs to a resource planning pool. -
setSourceResource
@Stability(Stable) public void setSourceResource(@Nullable CfnIPAMPool.SourceResourceProperty value) The resource used to provision CIDRs to a resource planning pool. -
getTagsRaw
The key/value combination of a tag assigned to the resource. -
setTagsRaw
The key/value combination of a tag assigned to the resource.
-