Class CfnIPAM
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
AWS::EC2::IPAM
.
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 .
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") .defaultResourceDiscoveryAssociationId("defaultResourceDiscoveryAssociationId") .defaultResourceDiscoveryId("defaultResourceDiscoveryId") .description("description") .operatingRegions(List.of(IpamOperatingRegionProperty.builder() .regionName("regionName") .build())) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
-
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.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the IPAM.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 IPAM's default resource discovery association ID.The IPAM's default resource discovery ID.The description for the IPAM.The operating Regions for an IPAM.getTags()
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
The IPAM's default resource discovery association ID.void
The IPAM's default resource discovery ID.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.Methods inherited from class software.amazon.awscdk.core.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.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
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 Construct scope, @NotNull String id, @Nullable CfnIPAMProps props) Create a newAWS::EC2::IPAM
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
CfnIPAM
Create a newAWS::EC2::IPAM
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
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. -
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
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 valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value. -
getDefaultResourceDiscoveryAssociationId
The IPAM's default resource discovery association ID. -
setDefaultResourceDiscoveryAssociationId
The IPAM's default resource discovery association ID. -
getDefaultResourceDiscoveryId
The IPAM's default resource discovery ID. -
setDefaultResourceDiscoveryId
The IPAM's default resource discovery ID. -
getDescription
The description for the IPAM. -
setDescription
The description for the IPAM. -
getOperatingRegions
The operating Regions for an IPAM.Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide .
-
setOperatingRegions
The operating Regions for an IPAM.Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide .
-
setOperatingRegions
The operating Regions for an IPAM.Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide .
-