CfnIPAMPoolProps

class aws_cdk.aws_ec2.CfnIPAMPoolProps(*, address_family, ipam_scope_id, allocation_default_netmask_length=None, allocation_max_netmask_length=None, allocation_min_netmask_length=None, allocation_resource_tags=None, auto_import=None, aws_service=None, description=None, locale=None, provisioned_cidrs=None, public_ip_source=None, publicly_advertisable=None, source_ipam_pool_id=None, source_resource=None, tags=None)

Bases: object

Properties for defining a CfnIPAMPool.

Parameters:

  • address_family (str) – The address family of the pool.

  • ipam_scope_id (str) – The ID of the scope in which you would like to create the IPAM pool.

  • allocation_default_netmask_length (Union[int, float, None]) – The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

  • allocation_max_netmask_length (Union[int, float, None]) – The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

  • allocation_min_netmask_length (Union[int, float, None]) – The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

  • allocation_resource_tags (Union[IResolvable, Sequence[Union[IResolvable, CfnTag, Dict[str, Any]]], None]) – Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

  • auto_import (Union[bool, IResolvable, None]) – If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool’s allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only. A locale must be set on the pool for this feature to work.

  • aws_service (Optional[str]) – Limits which service in AWS that the pool can be used in. “ec2”, for example, allows users to use space for Elastic IP addresses and VPCs.

  • description (Optional[str]) – The description of the IPAM pool.

  • locale (Optional[str]) – The locale of the IPAM pool. The locale for the pool should be one of the following: - An AWS Region where you want this IPAM pool to be available for allocations. - The network border group for an AWS Local Zone where you want this IPAM pool to be available for allocations ( supported Local Zones ). This option is only available for IPAM IPv4 pools in the public scope. If you choose an AWS Region for locale that has not been configured as an operating Region for the IPAM, you’ll get an error.

  • provisioned_cidrs (Union[IResolvable, Sequence[Union[IResolvable, ProvisionedCidrProperty, Dict[str, Any]]], None]) – Information about the CIDRs provisioned to an IPAM pool.

  • public_ip_source (Optional[str]) – The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP . For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide . By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide .

  • publicly_advertisable (Union[bool, IResolvable, None]) – Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4 .

  • source_ipam_pool_id (Optional[str]) – The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.

  • source_resource (Union[IResolvable, SourceResourceProperty, Dict[str, Any], None]) – The resource used to provision CIDRs to a resource planning pool.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

cfn_iPAMPool_props = ec2.CfnIPAMPoolProps(
    address_family="addressFamily",
    ipam_scope_id="ipamScopeId",

    # the properties below are optional
    allocation_default_netmask_length=123,
    allocation_max_netmask_length=123,
    allocation_min_netmask_length=123,
    allocation_resource_tags=[CfnTag(
        key="key",
        value="value"
    )],
    auto_import=False,
    aws_service="awsService",
    description="description",
    locale="locale",
    provisioned_cidrs=[ec2.CfnIPAMPool.ProvisionedCidrProperty(
        cidr="cidr"
    )],
    public_ip_source="publicIpSource",
    publicly_advertisable=False,
    source_ipam_pool_id="sourceIpamPoolId",
    source_resource=ec2.CfnIPAMPool.SourceResourceProperty(
        resource_id="resourceId",
        resource_owner="resourceOwner",
        resource_region="resourceRegion",
        resource_type="resourceType"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

address_family

The address family of the pool.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-addressfamily

allocation_default_netmask_length

The default netmask length for allocations added to this pool.

If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationdefaultnetmasklength

allocation_max_netmask_length

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.

The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationmaxnetmasklength

allocation_min_netmask_length

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.

The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationminnetmasklength

allocation_resource_tags

Tags that are required for resources that use CIDRs from this IPAM pool.

Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-allocationresourcetags

auto_import

If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.

The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool’s allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-autoimport

aws_service

Limits which service in AWS that the pool can be used in.

“ec2”, for example, allows users to use space for Elastic IP addresses and VPCs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-awsservice

description

The description of the IPAM pool.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-description

ipam_scope_id

The ID of the scope in which you would like to create the IPAM pool.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-ipamscopeid

locale

The locale of the IPAM pool.

The locale for the pool should be one of the following:

  • An AWS Region where you want this IPAM pool to be available for allocations.

  • The network border group for an AWS Local Zone where you want this IPAM pool to be available for allocations ( supported Local Zones ). This option is only available for IPAM IPv4 pools in the public scope.

If you choose an AWS Region for locale that has not been configured as an operating Region for the IPAM, you’ll get an error.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-locale

provisioned_cidrs

Information about the CIDRs provisioned to an IPAM pool.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-provisionedcidrs

public_ip_source

The IP address source for pools in the public scope.

Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP . For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide . By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-publicipsource

publicly_advertisable

Determines if a pool is publicly advertisable.

This option is not available for pools with AddressFamily set to ipv4 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-publiclyadvertisable

source_ipam_pool_id

The ID of the source IPAM pool.

You can use this option to create an IPAM pool within an existing source pool.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-sourceipampoolid

source_resource

The resource used to provision CIDRs to a resource planning pool.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-sourceresource

tags

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html#cfn-ec2-ipampool-tags