This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::EC2::IPAMScope
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.
Syntax
To declare this entity in your CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::EC2::IPAMScope", "Properties" : { "Description" :String, "ExternalAuthorityConfiguration" :IpamScopeExternalAuthorityConfiguration, "IpamId" :String, "Tags" :[ Tag, ... ]} }
YAML
Type: AWS::EC2::IPAMScope Properties: Description:StringExternalAuthorityConfiguration:IpamScopeExternalAuthorityConfigurationIpamId:StringTags:- Tag
Properties
Description-
The description of the scope.
Required: No
Type: String
Update requires: No interruption
-
The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.
For more information, see Integrate VPC IPAM with Infoblox infrastructure in the Amazon VPC IPAM User Guide.
Required: No
Type: IpamScopeExternalAuthorityConfiguration
Update requires: No interruption
IpamId-
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
Ownerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value.Required: No
Type: Array 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 scope 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 scope.
IpamArn-
The ARN of an IPAM.
IpamScopeId-
The ID of an IPAM scope.
IpamScopeType-
The type of the scope.
IsDefault-
Defines if the scope is the default scope or not.
PoolCount-
The number of pools in a scope.
Warning Javascript is disabled or is unavailable in your browser.
To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.