CfnIPAMPoolPropsMixin

class aws_cdk.mixins_preview.aws_ec2.mixins.CfnIPAMPoolPropsMixin(props, *, strategy=None)

Bases: Mixin

In IPAM, a pool is a collection of contiguous IP addresses CIDRs.

Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampool.html
CloudformationResource:: AWS::EC2::IPAMPool
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_ec2 import mixins as ec2_mixins

cfn_iPAMPool_props_mixin = ec2_mixins.CfnIPAMPoolPropsMixin(ec2_mixins.CfnIPAMPoolMixinProps(
    address_family="addressFamily",
    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",
    ipam_scope_id="ipamScopeId",
    locale="locale",
    provisioned_cidrs=[ec2_mixins.CfnIPAMPoolPropsMixin.ProvisionedCidrProperty(
        cidr="cidr"
    )],
    public_ip_source="publicIpSource",
    publicly_advertisable=False,
    source_ipam_pool_id="sourceIpamPoolId",
    source_resource=ec2_mixins.CfnIPAMPoolPropsMixin.SourceResourceProperty(
        resource_id="resourceId",
        resource_owner="resourceOwner",
        resource_region="resourceRegion",
        resource_type="resourceType"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::EC2::IPAMPool.

Parameters:

props (Union[CfnIPAMPoolMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['addressFamily', 'allocationDefaultNetmaskLength', 'allocationMaxNetmaskLength', 'allocationMinNetmaskLength', 'allocationResourceTags', 'autoImport', 'awsService', 'description', 'ipamScopeId', 'locale', 'provisionedCidrs', 'publicIpSource', 'publiclyAdvertisable', 'sourceIpamPoolId', 'sourceResource', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ProvisionedCidrProperty

class CfnIPAMPoolPropsMixin.ProvisionedCidrProperty(*, cidr=None)

Bases: object

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 . .. epigraph:

This resource type does not allow you to provision a CIDR using the netmask length. To provision a CIDR using netmask length, use `AWS::EC2::IPAMPoolCidr <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipampoolcidr.html>`_ .

Parameters:: cidr (Optional[str]) – 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 .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipampool-provisionedcidr.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.mixins_preview.aws_ec2 import mixins as ec2_mixins

provisioned_cidr_property = ec2_mixins.CfnIPAMPoolPropsMixin.ProvisionedCidrProperty(
    cidr="cidr"
)

Attributes

cidr

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipampool-provisionedcidr.html#cfn-ec2-ipampool-provisionedcidr-cidr

SourceResourceProperty

class CfnIPAMPoolPropsMixin.SourceResourceProperty(*, resource_id=None, resource_owner=None, resource_region=None, resource_type=None)

Bases: object

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

Parameters:

resource_id (Optional[str]) – The source resource ID.
resource_owner (Optional[str]) – The source resource owner.
resource_region (Optional[str]) – The source resource Region.
resource_type (Optional[str]) – The source resource type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipampool-sourceresource.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.mixins_preview.aws_ec2 import mixins as ec2_mixins

source_resource_property = ec2_mixins.CfnIPAMPoolPropsMixin.SourceResourceProperty(
    resource_id="resourceId",
    resource_owner="resourceOwner",
    resource_region="resourceRegion",
    resource_type="resourceType"
)

Attributes

resource_id

The source resource ID.

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

resource_owner

The source resource owner.

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

resource_region

The source resource Region.

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

resource_type

The source resource type.

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