ipam_scopes

Creates, updates, deletes, gets or lists an ipam_scopes resource.

Overview

Name	ipam_scopes
Type	Resource
Id	aws.ec2.ipam_scopes

Fields

The following fields are returned by SELECT queries:

describe_ipam_scopes

Name	Datatype	Description
description	string	The description of the scope.
external_authority_configuration	string	The external authority configuration for this IPAM scope, if configured. 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. In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.
ipam_arn	string	The ARN of the IPAM.
ipam_region	string	The Amazon Web Services Region of the IPAM scope.
ipam_scope_arn	string	The Amazon Resource Name (ARN) of the scope.
ipam_scope_id	string	The ID of the scope.
ipam_scope_type	string	The type of the scope.
is_default	boolean	Defines if the scope is the default scope or not.
owner_id	string	The Amazon Web Services account ID of the owner of the scope.
pool_count	integer	The number of pools in the scope.
state	string	The state of the IPAM scope.
tags	string	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_ipam_scopes	select	region	DryRun, Filter, MaxResults, NextToken, IpamScopeId	Get information about your IPAM scopes.
create_ipam_scope	insert	IpamId, region	DryRun, Description, TagSpecification, ClientToken, ExternalAuthorityConfiguration	Create an IPAM scope. 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 Add a scope in the Amazon VPC IPAM User Guide.
modify_ipam_scope	update	IpamScopeId, region	DryRun, Description, ExternalAuthorityConfiguration, RemoveExternalAuthorityConfiguration	Modify an IPAM scope.
delete_ipam_scope	delete	IpamScopeId, region	DryRun	Delete the scope for an IPAM. You cannot delete the default scopes. For more information, see Delete a scope in the Amazon VPC IPAM User Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
IpamId	string	The ID of the IPAM for which you're creating this scope.
IpamScopeId	string	The ID of the scope to delete.
region	string	AWS region (default: us-east-1)
ClientToken	string	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
Description	string	The description of the scope you want to modify.
DryRun	boolean	A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
ExternalAuthorityConfiguration	object	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. In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.
Filter	array	One or more filters for the request. For more information about filtering, see Filtering CLI output.
IpamScopeId	array	The IDs of the scopes you want information on.
MaxResults	integer	The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
NextToken	string	The token for the next page of results.
RemoveExternalAuthorityConfiguration	boolean	Remove the external authority configuration. true to remove.
TagSpecification	array	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.

SELECT examples

describe_ipam_scopes

Get information about your IPAM scopes.

SELECT
description,
external_authority_configuration,
ipam_arn,
ipam_region,
ipam_scope_arn,
ipam_scope_id,
ipam_scope_type,
is_default,
owner_id,
pool_count,
state,
tags
FROM aws.ec2.ipam_scopes
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND IpamScopeId = '{{ IpamScopeId }}'
;

INSERT examples

create_ipam_scope

Create an IPAM scope. 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 Add a scope in the Amazon VPC IPAM User Guide.

INSERT INTO aws.ec2.ipam_scopes (
IpamId,
region,
DryRun,
Description,
TagSpecification,
ClientToken,
ExternalAuthorityConfiguration
)
SELECT 
'{{ IpamId }}',
'{{ region }}',
'{{ DryRun }}',
'{{ Description }}',
'{{ TagSpecification }}',
'{{ ClientToken }}',
'{{ ExternalAuthorityConfiguration }}'
RETURNING
description,
external_authority_configuration,
ipam_arn,
ipam_region,
ipam_scope_arn,
ipam_scope_id,
ipam_scope_type,
is_default,
owner_id,
pool_count,
state,
tags
;

Manifest

# Description fields are for documentation purposes
- name: ipam_scopes
props:
  - name: IpamId
    value: "{{ IpamId }}"
    description: Required parameter for the ipam_scopes resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the ipam_scopes resource.
  - name: DryRun
    value: {{ DryRun }}
    description: A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    description: A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
  - name: Description
    value: "{{ Description }}"
    description: A description for the scope you're creating.
    description: A description for the scope you're creating.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: 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.
    description: 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.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
    description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
  - name: ExternalAuthorityConfiguration
    value: "{{ ExternalAuthorityConfiguration }}"
    description: 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. In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.
    description: 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. In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.

UPDATE examples

modify_ipam_scope

Modify an IPAM scope.

UPDATE aws.ec2.ipam_scopes
SET 
-- No updatable properties
WHERE 
IpamScopeId = '{{ IpamScopeId }}' --required
AND region = '{{ region }}' --required
AND DryRun = {{ DryRun}}
AND Description = '{{ Description}}'
AND ExternalAuthorityConfiguration = '{{ ExternalAuthorityConfiguration}}'
AND RemoveExternalAuthorityConfiguration = {{ RemoveExternalAuthorityConfiguration}}
RETURNING
description,
external_authority_configuration,
ipam_arn,
ipam_region,
ipam_scope_arn,
ipam_scope_id,
ipam_scope_type,
is_default,
owner_id,
pool_count,
state,
tags;

DELETE examples

delete_ipam_scope

Delete the scope for an IPAM. You cannot delete the default scopes. For more information, see Delete a scope in the Amazon VPC IPAM User Guide.

DELETE FROM aws.ec2.ipam_scopes
WHERE IpamScopeId = '{{ IpamScopeId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;