Package software.amazon.awscdk.services.ec2

Class CfnIPAM

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.ec2.CfnIPAM
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:38.573Z") @Stability(Stable) public class CfnIPAM extends CfnResource implements IInspectable
A CloudFormation 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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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 new AWS::EC2::IPAM.

      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.

    • CfnIPAM

      @Stability(Stable) public CfnIPAM(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::EC2::IPAM.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The ARN of the IPAM.

    • getAttrIpamId

      @Stability(Stable) @NotNull public String getAttrIpamId()
      The ID of the IPAM.

    • getAttrPrivateDefaultScopeId

      @Stability(Stable) @NotNull public String getAttrPrivateDefaultScopeId()
      The ID of the default private scope.

    • getAttrPublicDefaultScopeId

      @Stability(Stable) @NotNull public String getAttrPublicDefaultScopeId()
      The ID of the default public scope.

    • getAttrResourceDiscoveryAssociationCount

      @Stability(Stable) @NotNull public Number getAttrResourceDiscoveryAssociationCount()
      The number of resource discovery associations.

    • getAttrScopeCount

      @Stability(Stable) @NotNull public Number getAttrScopeCount()
      The number of scopes.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(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.

    • getDefaultResourceDiscoveryAssociationId

      @Stability(Stable) @Nullable public String getDefaultResourceDiscoveryAssociationId()
      The IPAM's default resource discovery association ID.

    • setDefaultResourceDiscoveryAssociationId

      @Stability(Stable) public void setDefaultResourceDiscoveryAssociationId(@Nullable String value)
      The IPAM's default resource discovery association ID.

    • getDefaultResourceDiscoveryId

      @Stability(Stable) @Nullable public String getDefaultResourceDiscoveryId()
      The IPAM's default resource discovery ID.

    • setDefaultResourceDiscoveryId

      @Stability(Stable) public void setDefaultResourceDiscoveryId(@Nullable String value)
      The IPAM's default resource discovery ID.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description for the IPAM.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description for the IPAM.

    • getOperatingRegions

      @Stability(Stable) @Nullable public Object 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

      @Stability(Stable) public void setOperatingRegions(@Nullable IResolvable value)
      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

      @Stability(Stable) public void setOperatingRegions(@Nullable List<Object> value)
      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 .