CfnIPAMPrefixListResolverPropsMixin

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

Bases: Mixin

Resource Type definition for AWS::EC2::IPAMPrefixListResolver.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamprefixlistresolver.html
CloudformationResource:: AWS::EC2::IPAMPrefixListResolver
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

from aws_cdk import CfnTag, CfnTag
# 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_iPAMPrefix_list_resolver_props_mixin = ec2_mixins.CfnIPAMPrefixListResolverPropsMixin(ec2_mixins.CfnIPAMPrefixListResolverMixinProps(
    address_family="addressFamily",
    description="description",
    ipam_id="ipamId",
    rules=[ec2_mixins.CfnIPAMPrefixListResolverPropsMixin.IpamPrefixListResolverRuleProperty(
        conditions=[ec2_mixins.CfnIPAMPrefixListResolverPropsMixin.IpamPrefixListResolverRuleConditionProperty(
            cidr="cidr",
            ipam_pool_id="ipamPoolId",
            operation="operation",
            resource_id="resourceId",
            resource_owner="resourceOwner",
            resource_region="resourceRegion",
            resource_tag=CfnTag(
                key="key",
                value="value"
            )
        )],
        ipam_scope_id="ipamScopeId",
        resource_type="resourceType",
        rule_type="ruleType",
        static_cidr="staticCidr"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnIPAMPrefixListResolverMixinProps, 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:: None

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['addressFamily', 'description', 'ipamId', 'rules', 'tags']

Static Methods

classmethod is_mixin(x)

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.

IpamPrefixListResolverRuleConditionProperty

class CfnIPAMPrefixListResolverPropsMixin.IpamPrefixListResolverRuleConditionProperty(*, cidr=None, ipam_pool_id=None, operation=None, resource_id=None, resource_owner=None, resource_region=None, resource_tag=None)

Bases: object

Two of the rule types allow you to add conditions to the rules.

For IPAM Pool CIDR rules, you can specify an ipamPoolId; if not specified, the rule will apply to all IPAM Pool CIDRs in the scope. (2) For IPAM Resource CIDR rules, you can specify resourceId, resourceOwner, resourceRegion, cidr, or resourceTag.

Parameters:

cidr (Optional[str]) – Condition for the IPAM Resource CIDR rule type. CIDR (like 10.24.34.0/23).
ipam_pool_id (Optional[str]) – Condition for the IPAM Pool CIDR rule type. If not chosen, the resolver applies to all IPAM Pool CIDRs in the scope.
operation (Optional[str]) – Equals, Not equals, or Subnet Of. The subnet-of operation only applies to cidr conditions.
resource_id (Optional[str]) – Condition for the IPAM Resource CIDR rule type. The unique ID of a resource (like vpc-1234567890abcdef0).
resource_owner (Optional[str]) – Condition for the IPAM Resource CIDR rule type. Resource owner (like 111122223333).
resource_region (Optional[str]) – Condition for the IPAM Resource CIDR rule type. Resource region (like us-east-1).
resource_tag (Union[IResolvable, CfnTag, Dict[str, Any], None]) – A key-value pair to associate with a resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamprefixlistresolver-ipamprefixlistresolverrulecondition.html

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# 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

ipam_prefix_list_resolver_rule_condition_property = ec2_mixins.CfnIPAMPrefixListResolverPropsMixin.IpamPrefixListResolverRuleConditionProperty(
    cidr="cidr",
    ipam_pool_id="ipamPoolId",
    operation="operation",
    resource_id="resourceId",
    resource_owner="resourceOwner",
    resource_region="resourceRegion",
    resource_tag=CfnTag(
        key="key",
        value="value"
    )
)

Attributes

cidr

Condition for the IPAM Resource CIDR rule type.

CIDR (like 10.24.34.0/23).

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

ipam_pool_id

Condition for the IPAM Pool CIDR rule type.

If not chosen, the resolver applies to all IPAM Pool CIDRs in the scope.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamprefixlistresolver-ipamprefixlistresolverrulecondition.html#cfn-ec2-ipamprefixlistresolver-ipamprefixlistresolverrulecondition-ipampoolid

operation

Equals, Not equals, or Subnet Of.

The subnet-of operation only applies to cidr conditions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamprefixlistresolver-ipamprefixlistresolverrulecondition.html#cfn-ec2-ipamprefixlistresolver-ipamprefixlistresolverrulecondition-operation

resource_id

Condition for the IPAM Resource CIDR rule type.

The unique ID of a resource (like vpc-1234567890abcdef0).

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

resource_owner

Condition for the IPAM Resource CIDR rule type.

Resource owner (like 111122223333).

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

resource_region

Condition for the IPAM Resource CIDR rule type.

Resource region (like us-east-1).

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

resource_tag

A key-value pair to associate with a resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamprefixlistresolver-ipamprefixlistresolverrulecondition.html#cfn-ec2-ipamprefixlistresolver-ipamprefixlistresolverrulecondition-resourcetag

IpamPrefixListResolverRuleProperty

class CfnIPAMPrefixListResolverPropsMixin.IpamPrefixListResolverRuleProperty(*, conditions=None, ipam_scope_id=None, resource_type=None, rule_type=None, static_cidr=None)

Bases: object

CIDR selection rules define the business logic for selecting CIDRs from IPAM.

If a CIDR matches any of the rules, it will be included. If a rule has multiple conditions, the CIDR has to match every condition of that rule. You can create a prefix list resolver without rules, but you’ll need to add at least one rule before it can actually automate your prefix list updates.

Parameters:

conditions (Union[IResolvable, Sequence[Union[IResolvable, IpamPrefixListResolverRuleConditionProperty, Dict[str, Any]]], None]) – Two of the rule types allow you to add conditions to the rules. (1) For IPAM Pool CIDR rules, you can specify an ipamPoolId; if not specified, the rule will apply to all IPAM Pool CIDRs in the scope. (2) For IPAM Resource CIDR rules, you can specify resourceId, resourceOwner, resourceRegion, cidr, or resourceTag.
ipam_scope_id (Optional[str]) – This rule will only match resources that are in this IPAM Scope.
resource_type (Optional[str]) – The resourceType property only applies to ipam-resource-cidr rules; this property specifies what type of resources this rule will apply to, such as VPCs or Subnets.
rule_type (Optional[str]) – There are three rule types: (1) Static CIDR: A fixed list of CIDRs that don’t change (like a manual list replicated across Regions). (2) IPAM pool CIDR: CIDRs from specific IPAM pools (like all CIDRs from your IPAM production pool). (3) IPAM resource CIDR: CIDRs for AWS resources like VPCs, subnets, and EIPs within a specific IPAM scope.
static_cidr (Optional[str]) – A fixed CIDR that doesn’t change.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamprefixlistresolver-ipamprefixlistresolverrule.html

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# 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

ipam_prefix_list_resolver_rule_property = ec2_mixins.CfnIPAMPrefixListResolverPropsMixin.IpamPrefixListResolverRuleProperty(
    conditions=[ec2_mixins.CfnIPAMPrefixListResolverPropsMixin.IpamPrefixListResolverRuleConditionProperty(
        cidr="cidr",
        ipam_pool_id="ipamPoolId",
        operation="operation",
        resource_id="resourceId",
        resource_owner="resourceOwner",
        resource_region="resourceRegion",
        resource_tag=CfnTag(
            key="key",
            value="value"
        )
    )],
    ipam_scope_id="ipamScopeId",
    resource_type="resourceType",
    rule_type="ruleType",
    static_cidr="staticCidr"
)

Attributes

conditions

Two of the rule types allow you to add conditions to the rules.

For IPAM Pool CIDR rules, you can specify an ipamPoolId; if not specified, the rule will apply to all IPAM Pool CIDRs in the scope. (2) For IPAM Resource CIDR rules, you can specify resourceId, resourceOwner, resourceRegion, cidr, or resourceTag.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamprefixlistresolver-ipamprefixlistresolverrule.html#cfn-ec2-ipamprefixlistresolver-ipamprefixlistresolverrule-conditions

ipam_scope_id

This rule will only match resources that are in this IPAM Scope.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamprefixlistresolver-ipamprefixlistresolverrule.html#cfn-ec2-ipamprefixlistresolver-ipamprefixlistresolverrule-ipamscopeid

resource_type

The resourceType property only applies to ipam-resource-cidr rules;

this property specifies what type of resources this rule will apply to, such as VPCs or Subnets.

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

rule_type

A fixed list of CIDRs that don’t change (like a manual list replicated across Regions).

IPAM pool CIDR: CIDRs from specific IPAM pools (like all CIDRs from your IPAM production pool). (3) IPAM resource CIDR: CIDRs for AWS resources like VPCs, subnets, and EIPs within a specific IPAM scope.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamprefixlistresolver-ipamprefixlistresolverrule.html#cfn-ec2-ipamprefixlistresolver-ipamprefixlistresolverrule-ruletype

Type:

There are three rule types

Type:

Static CIDR

static_cidr

A fixed CIDR that doesn’t change.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamprefixlistresolver-ipamprefixlistresolverrule.html#cfn-ec2-ipamprefixlistresolver-ipamprefixlistresolverrule-staticcidr