anycast_ip_lists

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

Overview

Name	anycast_ip_lists
Type	Resource
Id	aws.cloudfront.anycast_ip_lists

Fields

The following fields are returned by SELECT queries:

get_anycast_ip_list

Name	Datatype	Description
anycast_ips	string	The static IP addresses that are allocated to the Anycast static IP list.
arn	string	The Amazon Resource Name (ARN) of the Anycast static IP list.
id	string	The ID of the Anycast static IP list.
ip_address_type	string	The IP address type for the Anycast static IP list.
ip_count	integer	The number of IP addresses in the Anycast static IP list.
ipam_config	string	The IPAM configuration for the Anycast static IP list, that contains the quantity and list of IPAM CIDR configurations.
last_modified_time	string	The last time the Anycast static IP list was modified.
name	string	The name of the Anycast static IP list.
status	string	The status of the Anycast static IP list. Valid values: Deployed, Deploying, or Failed.

list_anycast_ip_lists

Name	Datatype	Description
is_truncated	boolean	If there are more items in the list collection than are in this response, this value is true.
items	string	Items in the Anycast static IP list collection. Each item is of the AnycastIpListSummary structure type.
marker	string	Use this field when paginating results to indicate where to begin in your list. The response includes items in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
max_items	integer	The maximum number of Anycast static IP list collections that you want returned in the response.
next_marker	string	Indicates the next page of the Anycast static IP list collection. To get the next page of the list, use this value in the Marker field of your request.
quantity	integer	The quantity of Anycast static IP lists in the collection.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_anycast_ip_list	select	id, region		Gets an Anycast static IP list.
list_anycast_ip_lists	select	region	Marker, MaxItems	Lists your Anycast static IP lists.
create_anycast_ip_list	insert	region, IpCount		Creates an Anycast static IP list.
update_anycast_ip_list	update	id, If-Match, region		Updates an Anycast static IP list.
delete_anycast_ip_list	delete	id, If-Match, region		Deletes an Anycast static IP list.

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
If-Match	string	The current version (ETag value) of the Anycast static IP list that you are deleting.
id	string	The ID of the Anycast static IP list.
region	string	AWS region (default: us-east-1)
Marker	string	Use this field when paginating results to indicate where to begin in your list. The response includes items in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
MaxItems	integer	The maximum number of Anycast static IP lists that you want returned in the response.

SELECT examples

get_anycast_ip_list

Gets an Anycast static IP list.

SELECT
anycast_ips,
arn,
id,
ip_address_type,
ip_count,
ipam_config,
last_modified_time,
name,
status
FROM aws.cloudfront.anycast_ip_lists
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_anycast_ip_lists

Lists your Anycast static IP lists.

SELECT
is_truncated,
items,
marker,
max_items,
next_marker,
quantity
FROM aws.cloudfront.anycast_ip_lists
WHERE region = '{{ region }}' -- required
AND Marker = '{{ Marker }}'
AND MaxItems = '{{ MaxItems }}'
;

INSERT examples

create_anycast_ip_list

Creates an Anycast static IP list.

INSERT INTO aws.cloudfront.anycast_ip_lists (
Name,
IpCount,
Tags,
IpAddressType,
IpamCidrConfigs,
region
)
SELECT 
'{{ Name }}',
{{ IpCount }} /* required */,
'{{ Tags }}',
'{{ IpAddressType }}',
'{{ IpamCidrConfigs }}',
'{{ region }}'
RETURNING
anycast_ips,
arn,
id,
ip_address_type,
ip_count,
ipam_config,
last_modified_time,
name,
status
;

Manifest

# Description fields are for documentation purposes
- name: anycast_ip_lists
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the anycast_ip_lists resource.
  - name: Name
    value: "{{ Name }}"
  - name: IpCount
    value: {{ IpCount }}
  - name: Tags
    description: |
      A complex type that contains zero or more Tag elements.
    value:
      Items:
        - Key: "{{ Key }}"
          Value: "{{ Value }}"
  - name: IpAddressType
    value: "{{ IpAddressType }}"
    valid_values: ['ipv4', 'ipv6', 'dualstack']
  - name: IpamCidrConfigs
    value:
      - Cidr: "{{ Cidr }}"
        IpamPoolArn: "{{ IpamPoolArn }}"
        AnycastIp: "{{ AnycastIp }}"
        Status: "{{ Status }}"

UPDATE examples

update_anycast_ip_list

Updates an Anycast static IP list.

UPDATE aws.cloudfront.anycast_ip_lists
SET 
IpAddressType = '{{ IpAddressType }}',
IpamCidrConfigs = '{{ IpamCidrConfigs }}'
WHERE 
id = '{{ id }}' --required
AND `If-Match` = '{{ If-Match }}' --required
AND region = '{{ region }}' --required
RETURNING
anycast_ips,
arn,
id,
ip_address_type,
ip_count,
ipam_config,
last_modified_time,
name,
status;

DELETE examples

delete_anycast_ip_list

Deletes an Anycast static IP list.

DELETE FROM aws.cloudfront.anycast_ip_lists
WHERE id = '{{ id }}' --required
AND `If-Match` = '{{ If-Match }}' --required
AND region = '{{ region }}' --required
;