AWS::EC2::IPAM - AWS CloudFormation

AWS::EC2::IPAM

IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts throughout your AWS Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::EC2::IPAM", "Properties" : { "Description" : String, "OperatingRegions" : [ IpamOperatingRegion, ... ], "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::EC2::IPAM Properties: Description: String OperatingRegions: - IpamOperatingRegion Tags: - Tag

Properties

Description

The description for the IPAM.

Required: No

Type: String

Update requires: No interruption

OperatingRegions

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.

Required: No

Type: List of IpamOperatingRegion

Update requires: No interruption

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.

Required: No

Type: List of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the IPAM ID.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The ARN of the IPAM.

IpamId

The ID of the IPAM.

PrivateDefaultScopeId

The ID of the IPAM's default private scope.

PublicDefaultScopeId

The ID of the IPAM's default public scope.

ScopeCount

The number of scopes in the IPAM. The scope quota is 5.