Package software.amazon.awscdk.services.ec2

Class CfnIPAMPoolCidr

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

A CIDR provisioned to an IPAM pool.

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.*;
 CfnIPAMPoolCidr cfnIPAMPoolCidr = CfnIPAMPoolCidr.Builder.create(this, "MyCfnIPAMPoolCidr")
         .ipamPoolId("ipamPoolId")
         // the properties below are optional
         .cidr("cidr")
         .netmaskLength(123)
         .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

    • CfnIPAMPoolCidr

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

    • CfnIPAMPoolCidr

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

    • CfnIPAMPoolCidr

      @Stability(Stable) public CfnIPAMPoolCidr(@NotNull Construct scope, @NotNull String id, @NotNull CfnIPAMPoolCidrProps props)
      Create a new AWS::EC2::IPAMPoolCidr.

      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.

    • getAttrIpamPoolCidrId

      @Stability(Stable) @NotNull public String getAttrIpamPoolCidrId()
      The IPAM pool CIDR ID.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The state of the CIDR.

    • getCfnProperties

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

    • getIpamPoolId

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

    • setIpamPoolId

      @Stability(Stable) public void setIpamPoolId(@NotNull String value)
      The ID of the IPAM pool.

    • getCidr

      @Stability(Stable) @Nullable public String getCidr()
      The CIDR provisioned to the IPAM pool.

      A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23 . An IPv6 CIDR example is 2001:DB8::/32 .

    • setCidr

      @Stability(Stable) public void setCidr(@Nullable String value)
      The CIDR provisioned to the IPAM pool.

      A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23 . An IPv6 CIDR example is 2001:DB8::/32 .

    • getNetmaskLength

      @Stability(Stable) @Nullable public Number getNetmaskLength()
      The netmask length of the CIDR you'd like to provision to a pool.

      Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. "NetmaskLength" or "Cidr" is required.

    • setNetmaskLength

      @Stability(Stable) public void setNetmaskLength(@Nullable Number value)
      The netmask length of the CIDR you'd like to provision to a pool.

      Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. "NetmaskLength" or "Cidr" is required.