AWS::EC2::IPAM - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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 Amazon Regions and accounts throughout your Amazon Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

Syntax

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

JSON

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

Properties

DefaultResourceDiscoveryAssociationId

The IPAM's default resource discovery association ID.

Required: No

Type: String

Update requires: No interruption

DefaultResourceDiscoveryId

The IPAM's default resource discovery ID.

Required: No

Type: String

Update requires: No interruption

Description

The description for the IPAM.

Required: No

Type: String

Update requires: No interruption

OperatingRegions

The operating Regions for an IPAM. Operating Regions are Amazon Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon 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

ResourceDiscoveryAssociationCount

The IPAM's resource discovery association count.

Required: No

Type: Integer

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 Reffunction, Refreturns the IPAM ID.

For more information about using the Reffunction, see Ref.

Fn::GetAtt

The Fn::GetAttintrinsic 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::GetAttintrinsic 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.