ipam_scopes

Creates, updates, deletes or gets an ipam_scope resource or lists ipam_scopes in a region

Overview

Name	ipam_scopes
Type	Resource
Description	Resource Schema of AWS::EC2::IPAMScope Type
Id	awscc.ec2.ipam_scopes

Fields

get (all properties)

Name	Datatype	Description
ipam_scope_id	string	Id of the IPAM scope.
arn	string	The Amazon Resource Name (ARN) of the IPAM scope.
ipam_id	string	The Id of the IPAM this scope is a part of.
ipam_arn	string	The Amazon Resource Name (ARN) of the IPAM this scope is a part of.
ipam_scope_type	string	Determines whether this scope contains publicly routable space or space for a private network
is_default	boolean	Is this one of the default scopes created with the IPAM.
description	string
pool_count	integer	The number of pools that currently exist in this scope.
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
ipam_scope_id	string	Id of the IPAM scope.
region	string	AWS region.

For more information, see AWS::EC2::IPAMScope.

Methods

Name	Resource	Accessible by	Required Params
create_resource	ipam_scopes	INSERT	IpamId, region
delete_resource	ipam_scopes	DELETE	Identifier, region
update_resource	ipam_scopes	UPDATE	Identifier, PatchDocument, region
list_resources	ipam_scopes_list_only	SELECT	region
get_resource	ipam_scopes	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual ipam_scope.

SELECT
  region,
  ipam_scope_id,
  arn,
  ipam_id,
  ipam_arn,
  ipam_scope_type,
  is_default,
  description,
  pool_count,
  tags
FROM awscc.ec2.ipam_scopes
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ ipam_scope_id }}';

list (identifiers only)

Lists all ipam_scopes in a region.

SELECT
  region,
  ipam_scope_id
FROM awscc.ec2.ipam_scopes_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new ipam_scope resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.ec2.ipam_scopes (
  IpamId,
  region
)
SELECT
  '{{ ipam_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.ipam_scopes (
  IpamId,
  Description,
  Tags,
  region
)
SELECT
  '{{ ipam_id }}',
  '{{ description }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: ipam_scope
  props:
    - name: ipam_id
      value: '{{ ipam_id }}'
    - name: description
      value: '{{ description }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a ipam_scope resource, using stack-deploy.

/*+ update */
UPDATE awscc.ec2.ipam_scopes
SET PatchDocument = string('{{ {
    "Description": description,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ ipam_scope_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.ipam_scopes
WHERE
  Identifier = '{{ ipam_scope_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the ipam_scopes resource, the following permissions are required:

Create

ec2:CreateIpamScope,
ec2:DescribeIpamScopes,
ec2:CreateTags

Read

ec2:DescribeIpamScopes

Update

ec2:ModifyIpamScope,
ec2:DescribeIpamScopes,
ec2:CreateTags,
ec2:DeleteTags

Delete

ec2:DeleteIpamScope,
ec2:DescribeIpamScopes,
ec2:DeleteTags

List

ec2:DescribeIpamScopes