CfnIPAMPrefixListResolver

class aws_cdk.aws_ec2.CfnIPAMPrefixListResolver(scope, id, *, address_family, description=None, ipam_id=None, rules=None, tags=None)

Bases: CfnResource

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
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 import aws_ec2 as ec2

cfn_iPAMPrefix_list_resolver = ec2.CfnIPAMPrefixListResolver(self, "MyCfnIPAMPrefixListResolver",
    address_family="addressFamily",

    # the properties below are optional
    description="description",
    ipam_id="ipamId",
    rules=[ec2.CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleProperty(
        rule_type="ruleType",

        # the properties below are optional
        conditions=[ec2.CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleConditionProperty(
            operation="operation",

            # the properties below are optional
            cidr="cidr",
            ipam_pool_id="ipamPoolId",
            resource_id="resourceId",
            resource_owner="resourceOwner",
            resource_region="resourceRegion",
            resource_tag=CfnTag(
                key="key",
                value="value"
            )
        )],
        ipam_scope_id="ipamScopeId",
        resource_type="resourceType",
        static_cidr="staticCidr"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::EC2::IPAMPrefixListResolver.

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
address_family (str) – The address family of the address space in this Prefix List Resolver. Either IPv4 or IPv6.
description (Optional[str])
ipam_id (Optional[str]) – The Id of the IPAM this Prefix List Resolver is a part of.
rules (Union[IResolvable, Sequence[Union[IResolvable, IpamPrefixListResolverRuleProperty, Dict[str, Any]]], None]) – Rules define the business logic for selecting CIDRs from IPAM.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:: target (CfnResource)
Deprecated:: use addDependency
Stability:: deprecated
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

with_(*mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:: mixins (IMixin)
Return type:: IConstruct

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::EC2::IPAMPrefixListResolver'

address_family: The address family of the address space in this Prefix List Resolver.

attr_ipam_arn

The Amazon Resource Name (ARN) of the IPAM this Prefix List Resolver is a part of.

CloudformationAttribute:: IpamArn

attr_ipam_prefix_list_resolver_arn

The Amazon Resource Name (ARN) of the IPAM Prefix List Resolver.

CloudformationAttribute:: IpamPrefixListResolverArn

attr_ipam_prefix_list_resolver_id

Id of the IPAM Prefix List Resolver.

CloudformationAttribute:: IpamPrefixListResolverId

cdk_tag_manager: Tag Manager which manages the tags for this resource.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description

env

ipam_id: The Id of the IPAM this Prefix List Resolver is a part of.

ipam_prefix_list_resolver_ref: A reference to a IPAMPrefixListResolver resource.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

rules: Rules define the business logic for selecting CIDRs from IPAM.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: An array of key-value pairs to apply to this resource.

Static Methods

classmethod arn_for_ipam_prefix_list_resolver(resource)

Parameters:: resource (IIPAMPrefixListResolverRef)
Return type:: str

classmethod from_ipam_prefix_list_resolver_arn(scope, id, arn)

Creates a new IIPAMPrefixListResolverRef from an ARN.

Parameters:

scope (Construct)
id (str)
arn (str)

Return type:

IIPAMPrefixListResolverRef

classmethod from_ipam_prefix_list_resolver_id(scope, id, ipam_prefix_list_resolver_id)

Creates a new IIPAMPrefixListResolverRef from a ipamPrefixListResolverId.

Parameters:

scope (Construct)
id (str)
ipam_prefix_list_resolver_id (str)

Return type:

IIPAMPrefixListResolverRef

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_ipam_prefix_list_resolver(x)

Checks whether the given object is a CfnIPAMPrefixListResolver.

Parameters:: x (Any)
Return type:: bool

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

IpamPrefixListResolverRuleConditionProperty

class CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleConditionProperty(*, operation, cidr=None, ipam_pool_id=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:

operation (str) – Equals, Not equals, or Subnet Of. The subnet-of operation only applies to cidr conditions.
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.
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 import aws_ec2 as ec2

ipam_prefix_list_resolver_rule_condition_property = ec2.CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleConditionProperty(
    operation="operation",

    # the properties below are optional
    cidr="cidr",
    ipam_pool_id="ipamPoolId",
    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 CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleProperty(*, rule_type, conditions=None, ipam_scope_id=None, resource_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:

rule_type (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.
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.
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 import aws_ec2 as ec2

ipam_prefix_list_resolver_rule_property = ec2.CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleProperty(
    rule_type="ruleType",

    # the properties below are optional
    conditions=[ec2.CfnIPAMPrefixListResolver.IpamPrefixListResolverRuleConditionProperty(
        operation="operation",

        # the properties below are optional
        cidr="cidr",
        ipam_pool_id="ipamPoolId",
        resource_id="resourceId",
        resource_owner="resourceOwner",
        resource_region="resourceRegion",
        resource_tag=CfnTag(
            key="key",
            value="value"
        )
    )],
    ipam_scope_id="ipamScopeId",
    resource_type="resourceType",
    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