Package software.amazon.awscdk.services.ec2

Class CfnIPAMScope

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.CfnIPAMScope
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.612Z") @Stability(Stable) public class CfnIPAMScope extends CfnResource implements IInspectable
A CloudFormation AWS::EC2::IPAMScope.

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")
         .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

    • CfnIPAMScope

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

    • CfnIPAMScope

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

    • CfnIPAMScope

      @Stability(Stable) public CfnIPAMScope(@NotNull 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      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 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

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

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