Package software.amazon.awscdk.services.ec2

Class CfnIPAMScope

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.CfnIPAMScope
All Implemented Interfaces:
IInspectable, IIPAMScopeRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:08.758Z") @Stability(Stable) public class CfnIPAMScope extends CfnResource implements IInspectable, IIPAMScopeRef, ITaggable
In IPAM, a scope is the highest-level container within IPAM.

An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

For more information, see How IPAM works 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.*;
 CfnIPAMScope cfnIPAMScope = CfnIPAMScope.Builder.create(this, "MyCfnIPAMScope")
         .ipamId("ipamId")
         // the properties below are optional
         .description("description")
         .externalAuthorityConfiguration(IpamScopeExternalAuthorityConfigurationProperty.builder()
                 .externalResourceIdentifier("externalResourceIdentifier")
                 .ipamScopeExternalAuthorityType("ipamScopeExternalAuthorityType")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • 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

    • CfnIPAMScope

      protected CfnIPAMScope(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnIPAMScope

      protected CfnIPAMScope(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnIPAMScope

      @Stability(Stable) public CfnIPAMScope(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIPAMScopeProps props)
      Create a new AWS::EC2::IPAMScope.

      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

    • arnForIPAMScope

      @Stability(Stable) @NotNull public static String arnForIPAMScope(@NotNull IIPAMScopeRef resource)
      Parameters:
      resource - This parameter is required.

    • fromIPAMScopeArn

      @Stability(Stable) @NotNull public static IIPAMScopeRef fromIPAMScopeArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IIPAMScopeRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromIpamScopeId

      @Stability(Stable) @NotNull public static IIPAMScopeRef fromIpamScopeId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String ipamScopeId)
      Creates a new IIPAMScopeRef from a ipamScopeId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      ipamScopeId - This parameter is required.

    • isCfnIPAMScope

      @Stability(Stable) @NotNull public static Boolean isCfnIPAMScope(@NotNull Object x)
      Checks whether the given object is a CfnIPAMScope.

      Parameters:
      x - This parameter is required.

    • 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 scope.

    • getAttrIpamArn

      @Stability(Stable) @NotNull public String getAttrIpamArn()
      The ARN of an IPAM.

    • getAttrIpamScopeId

      @Stability(Stable) @NotNull public String getAttrIpamScopeId()
      The ID of an IPAM scope.

    • getAttrIpamScopeType

      @Stability(Stable) @NotNull public String getAttrIpamScopeType()
      The type of the scope.

    • getAttrIsDefault

      @Stability(Stable) @NotNull public IResolvable getAttrIsDefault()
      Defines if the scope is the default scope or not.

    • getAttrPoolCount

      @Stability(Stable) @NotNull public Number getAttrPoolCount()
      The number of pools in a scope.

    • getCfnProperties

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

    • getIpamScopeRef

      @Stability(Stable) @NotNull public IPAMScopeReference getIpamScopeRef()
      A reference to a IPAMScope resource.
      Specified by:
      getIpamScopeRef in interface IIPAMScopeRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getIpamId

      @Stability(Stable) @NotNull public String getIpamId()
      The ID of the IPAM for which you're creating this scope.

    • setIpamId

      @Stability(Stable) public void setIpamId(@NotNull String value)
      The ID of the IPAM for which you're creating this scope.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the scope.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the scope.

    • getExternalAuthorityConfiguration

      @Stability(Stable) @Nullable public Object getExternalAuthorityConfiguration()
      The configuration that links an Amazon VPC IPAM scope to an external authority system.

      Returns union: either IResolvable or CfnIPAMScope.IpamScopeExternalAuthorityConfigurationProperty

    • setExternalAuthorityConfiguration

      @Stability(Stable) public void setExternalAuthorityConfiguration(@Nullable IResolvable value)
      The configuration that links an Amazon VPC IPAM scope to an external authority system.

    • setExternalAuthorityConfiguration

      @Stability(Stable) public void setExternalAuthorityConfiguration(@Nullable CfnIPAMScope.IpamScopeExternalAuthorityConfigurationProperty value)
      The configuration that links an Amazon VPC IPAM scope to an external authority system.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The key/value combination of a tag assigned to the resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The key/value combination of a tag assigned to the resource.