anycast_ip_lists

Creates, updates, deletes or gets an anycast_ip_list resource or lists anycast_ip_lists in a region

Overview

Name	anycast_ip_lists
Type	Resource
Description	An Anycast static IP list. For more information, see Request Anycast static IPs to use for allowlisting in the Amazon CloudFront Developer Guide.
Id	awscc.cloudfront.anycast_ip_lists

Fields

get (all properties)

Name	Datatype	Description
▶anycast_ip_list	object	An Anycast static IP list. For more information, see Request Anycast static IPs to use for allowlisting in the Amazon CloudFront Developer Guide.
e_tag	string
id	string
ip_count	integer	The number of IP addresses in the Anycast static IP list.
name	string	The name of the Anycast static IP list.
▶tags	object	A complex type that contains zero or more Tag elements.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string
region	string	AWS region.

For more information, see AWS::CloudFront::AnycastIpList.

Methods

Name	Resource	Accessible by	Required Params
create_resource	anycast_ip_lists	INSERT	IpCount, Name, region
delete_resource	anycast_ip_lists	DELETE	Identifier, region
list_resources	anycast_ip_lists_list_only	SELECT	region
get_resource	anycast_ip_lists	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual anycast_ip_list.

SELECT
  region,
  anycast_ip_list,
  e_tag,
  id,
  ip_count,
  name,
  tags
FROM awscc.cloudfront.anycast_ip_lists
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all anycast_ip_lists in a region.

SELECT
  region,
  id
FROM awscc.cloudfront.anycast_ip_lists_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.cloudfront.anycast_ip_lists (
  IpCount,
  Name,
  region
)
SELECT
  '{{ ip_count }}',
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.cloudfront.anycast_ip_lists (
  IpCount,
  Name,
  Tags,
  region
)
SELECT
  '{{ ip_count }}',
  '{{ name }}',
  '{{ 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: anycast_ip_list
  props:
    - name: ip_count
      value: '{{ ip_count }}'
    - name: name
      value: '{{ name }}'
    - name: tags
      value:
        items:
          - key: '{{ key }}'
            value: '{{ value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.cloudfront.anycast_ip_lists
WHERE
  Identifier = '{{ id }}' AND
  region = 'us-east-1'
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 anycast_ip_lists resource, the following permissions are required:

Create

cloudfront:CreateAnycastIpList,
cloudfront:TagResource

Delete

cloudfront:DeleteAnycastIpList,
cloudfront:GetAnycastIpList

List

cloudfront:ListAnycastIpLists

Read

cloudfront:GetAnycastIpList,
cloudfront:ListTagsForResource