CfnIPAMProps

class aws_cdk.aws_ec2.CfnIPAMProps(*, description=None, operating_regions=None, tags=None)

Bases: object

Properties for defining a CfnIPAM.

Parameters
  • description (Optional[str]) – The description for the IPAM.

  • operating_regions (Union[IResolvable, Sequence[Union[IpamOperatingRegionProperty, Dict[str, Any], IResolvable]], None]) – 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 .

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA , specify tag:Owner for the filter name and TeamA for the filter value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.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 import aws_ec2 as ec2

cfn_iPAMProps = ec2.CfnIPAMProps(
    description="description",
    operating_regions=[ec2.CfnIPAM.IpamOperatingRegionProperty(
        region_name="regionName"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

The description for the IPAM.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-description

Return type

Optional[str]

operating_regions

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-operatingregions

Return type

Union[IResolvable, List[Union[IpamOperatingRegionProperty, IResolvable]], None]

tags

The key/value combination of a tag assigned to the resource.

Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA , specify tag:Owner for the filter name and TeamA for the filter value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-ipam.html#cfn-ec2-ipam-tags

Return type

Optional[List[CfnTag]]