Class CfnIPAM
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.CfnIPAM
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
date="2024-05-17T05:10:09.600Z")
@Stability(Stable)
public class CfnIPAM
extends CfnResource
implements IInspectable, ITaggable
IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts throughout your AWS Organization.
For more information, see What is IPAM? in the Amazon VPC IPAM User Guide .
There are AWS Identity and Access Management (IAM) permissions required to fully manage an IPAM in CloudFormation. For more information, see Example policy 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.*; CfnIPAM cfnIPAM = CfnIPAM.Builder.create(this, "MyCfnIPAM") .description("description") .operatingRegions(List.of(IpamOperatingRegionProperty.builder() .regionName("regionName") .build())) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .tier("tier") .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnIPAM
.static interface
The operating Regions for an IPAM.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
CfnIPAM
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnIPAM
(software.amazon.jsii.JsiiObjectRef objRef) CfnIPAM
(software.constructs.Construct scope, String id, CfnIPAMProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the IPAM.The ID of the default resource discovery association.The ID of the default resource discovery.The ID of the IPAM.The ID of the default private scope.The ID of the default public scope.The number of resource discovery associations.The number of scopes.The description for the IPAM.The operating Regions for an IPAM.getTags()
Tag Manager which manages the tags for this resource.The key/value combination of a tag assigned to the resource.getTier()
IPAM is offered in a Free Tier and an Advanced Tier.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDescription
(String value) The description for the IPAM.void
setOperatingRegions
(List<Object> value) The operating Regions for an IPAM.void
setOperatingRegions
(IResolvable value) The operating Regions for an IPAM.void
setTagsRaw
(List<CfnTag> value) The key/value combination of a tag assigned to the resource.void
IPAM is offered in a Free Tier and an Advanced Tier.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
-
CfnIPAM
protected CfnIPAM(software.amazon.jsii.JsiiObjectRef objRef) -
CfnIPAM
protected CfnIPAM(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnIPAM
@Stability(Stable) public CfnIPAM(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnIPAMProps 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.
-
CfnIPAM
- 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.
-
-
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. -
getAttrDefaultResourceDiscoveryAssociationId
The ID of the default resource discovery association. -
getAttrDefaultResourceDiscoveryId
The ID of the default resource discovery. -
getAttrIpamId
The ID of the IPAM. -
getAttrPrivateDefaultScopeId
The ID of the default private scope. -
getAttrPublicDefaultScopeId
The ID of the default public scope. -
getAttrResourceDiscoveryAssociationCount
The number of resource discovery associations. -
getAttrScopeCount
The number of scopes. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getDescription
The description for the IPAM. -
setDescription
The description for the IPAM. -
getOperatingRegions
The operating Regions for an IPAM. -
setOperatingRegions
The operating Regions for an IPAM. -
setOperatingRegions
The operating Regions for an IPAM. -
getTagsRaw
The key/value combination of a tag assigned to the resource. -
setTagsRaw
The key/value combination of a tag assigned to the resource. -
getTier
IPAM is offered in a Free Tier and an Advanced Tier. -
setTier
IPAM is offered in a Free Tier and an Advanced Tier.
-