CfnIPAMScopePropsMixin

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

Bases: Mixin

In IPAM, a scope is the highest-level container within IPAM.

An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

For more information, see How IPAM works in the Amazon VPC IPAM User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamscope.html
CloudformationResource:: AWS::EC2::IPAMScope
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_iPAMScope_props_mixin = ec2_mixins.CfnIPAMScopePropsMixin(ec2_mixins.CfnIPAMScopeMixinProps(
    description="description",
    external_authority_configuration=ec2_mixins.CfnIPAMScopePropsMixin.IpamScopeExternalAuthorityConfigurationProperty(
        external_resource_identifier="externalResourceIdentifier",
        ipam_scope_external_authority_type="ipamScopeExternalAuthorityType"
    ),
    ipam_id="ipamId",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnIPAMScopeMixinProps, 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 = ['description', 'externalAuthorityConfiguration', 'ipamId', '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

IpamScopeExternalAuthorityConfigurationProperty

class CfnIPAMScopePropsMixin.IpamScopeExternalAuthorityConfigurationProperty(*, external_resource_identifier=None, ipam_scope_external_authority_type=None)

Bases: object

The configuration that links an Amazon VPC IPAM scope to an external authority system.

It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.

In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to AWS while using Amazon VPC IPAM to manage subnets within those ranges.

Parameters:

external_resource_identifier (Optional[str]) – The identifier for the external resource managing this scope. For Infoblox integrations, this is the Infoblox resource identifier in the format <version>.identity.account.<entity_realm>.<entity_id> .
ipam_scope_external_authority_type (Optional[str]) – The type of external authority managing this scope. Currently supports Infoblox for integration with Infoblox Universal DDI.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamscope-ipamscopeexternalauthorityconfiguration.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

ipam_scope_external_authority_configuration_property = ec2_mixins.CfnIPAMScopePropsMixin.IpamScopeExternalAuthorityConfigurationProperty(
    external_resource_identifier="externalResourceIdentifier",
    ipam_scope_external_authority_type="ipamScopeExternalAuthorityType"
)

Attributes

external_resource_identifier

The identifier for the external resource managing this scope.

For Infoblox integrations, this is the Infoblox resource identifier in the format <version>.identity.account.<entity_realm>.<entity_id> .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamscope-ipamscopeexternalauthorityconfiguration.html#cfn-ec2-ipamscope-ipamscopeexternalauthorityconfiguration-externalresourceidentifier

ipam_scope_external_authority_type

The type of external authority managing this scope.

Currently supports Infoblox for integration with Infoblox Universal DDI.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamscope-ipamscopeexternalauthorityconfiguration.html#cfn-ec2-ipamscope-ipamscopeexternalauthorityconfiguration-ipamscopeexternalauthoritytype