AWS::EC2::IPAMScope - Amazon CloudFormation
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).


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.


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


{ "Type" : "AWS::EC2::IPAMScope", "Properties" : { "Description" : String, "IpamId" : String, "Tags" : [ Tag, ... ] } }


Type: AWS::EC2::IPAMScope Properties: Description: String IpamId: String Tags: - Tag



The description of the scope.

Required: No

Type: String

Update requires: No interruption


The ID of the IPAM for which you're creating this scope.

Required: Yes

Type: String

Update requires: Replacement


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: Array of Tag

Update requires: No interruption

Return values


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

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


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.


The ARN of the scope.


The ARN of an IPAM.


The ID of an IPAM scope.


The type of the scope.


Defines if the scope is the default scope or not.


The number of pools in a scope.