CfnIPAMResourceDiscoveryPropsMixin

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

Bases: Mixin

A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipamresourcediscovery.html
CloudformationResource:: AWS::EC2::IPAMResourceDiscovery
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_iPAMResource_discovery_props_mixin = ec2_mixins.CfnIPAMResourceDiscoveryPropsMixin(ec2_mixins.CfnIPAMResourceDiscoveryMixinProps(
    description="description",
    operating_regions=[ec2_mixins.CfnIPAMResourceDiscoveryPropsMixin.IpamOperatingRegionProperty(
        region_name="regionName"
    )],
    organizational_unit_exclusions=[ec2_mixins.CfnIPAMResourceDiscoveryPropsMixin.IpamResourceDiscoveryOrganizationalUnitExclusionProperty(
        organizations_entity_path="organizationsEntityPath"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnIPAMResourceDiscoveryMixinProps, 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', 'operatingRegions', 'organizationalUnitExclusions', '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

IpamOperatingRegionProperty

class CfnIPAMResourceDiscoveryPropsMixin.IpamOperatingRegionProperty(*, region_name=None)

Bases: object

The operating Regions for an IPAM.

Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide .

Parameters:: region_name (Optional[str]) – The name of the operating Region.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamresourcediscovery-ipamoperatingregion.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_operating_region_property = ec2_mixins.CfnIPAMResourceDiscoveryPropsMixin.IpamOperatingRegionProperty(
    region_name="regionName"
)

Attributes

region_name

The name of the operating Region.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamresourcediscovery-ipamoperatingregion.html#cfn-ec2-ipamresourcediscovery-ipamoperatingregion-regionname

IpamResourceDiscoveryOrganizationalUnitExclusionProperty

class CfnIPAMResourceDiscoveryPropsMixin.IpamResourceDiscoveryOrganizationalUnitExclusionProperty(*, organizations_entity_path=None)

Bases: object

If your IPAM is integrated with AWS Organizations, you can exclude an organizational unit (OU) from being managed by IPAM. When you exclude an OU, IPAM will not manage the IP addresses in accounts in that OU. For more information, see Exclude organizational units from IPAM in the Amazon Virtual Private Cloud IP Address Manager User Guide .

Parameters:: organizations_entity_path (Optional[str]) – An AWS Organizations entity path. For more information on the entity path, see Understand the AWS Organizations entity path in the AWS Identity and Access Management User Guide .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamresourcediscovery-ipamresourcediscoveryorganizationalunitexclusion.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_resource_discovery_organizational_unit_exclusion_property = ec2_mixins.CfnIPAMResourceDiscoveryPropsMixin.IpamResourceDiscoveryOrganizationalUnitExclusionProperty(
    organizations_entity_path="organizationsEntityPath"
)

Attributes

organizations_entity_path

An AWS Organizations entity path.

For more information on the entity path, see Understand the AWS Organizations entity path in the AWS Identity and Access Management User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamresourcediscovery-ipamresourcediscoveryorganizationalunitexclusion.html#cfn-ec2-ipamresourcediscovery-ipamresourcediscoveryorganizationalunitexclusion-organizationsentitypath