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.
Contents
- description
-
The description of the scope.
Type: String
Required: No
- ipamArn
-
The ARN of the IPAM.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1283.
Required: No
- ipamRegion
-
The AWS Region of the IPAM scope.
Type: String
Required: No
- ipamScopeArn
-
The Amazon Resource Name (ARN) of the scope.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1283.
Required: No
- ipamScopeId
-
The ID of the scope.
Type: String
Required: No
- ipamScopeType
-
The type of the scope.
Type: String
Valid Values:
public | privateRequired: No
- isDefault
-
Defines if the scope is the default scope or not.
Type: Boolean
Required: No
- ownerId
-
The AWS account ID of the owner of the scope.
Type: String
Required: No
- poolCount
-
The number of pools in the scope.
Type: Integer
Required: No
- state
-
The state of the IPAM scope.
Type: String
Valid Values:
create-in-progress | create-complete | create-failed | modify-in-progress | modify-complete | modify-failed | delete-in-progress | delete-complete | delete-failed | isolate-in-progress | isolate-complete | restore-in-progressRequired: No
- tagSet
-
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.Type: Array of Tag objects
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
