connection_groups

Creates, updates, deletes, gets or lists a connection_groups resource.

Overview

Name	connection_groups
Type	Resource
Id	aws.cloudfront.connection_groups

Fields

The following fields are returned by SELECT queries:

get_connection_group

Name	Datatype	Description
anycast_ip_list_id	string	The ID of the Anycast static IP list.
arn	string	The Amazon Resource Name (ARN) of the connection group.
created_time	string	The date and time when the connection group was created.
enabled	boolean	Whether the connection group is enabled.
id	string	The ID of the connection group.
ipv_6_enabled	boolean	IPv6 is enabled for the connection group.
is_default	boolean	Whether the connection group is the default connection group for the distribution tenants.
last_modified_time	string	The date and time when the connection group was updated.
name	string	The name of the connection group.
routing_endpoint	string	The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net.
status	string	The status of the connection group.
tags	string	A complex type that contains zero or more Tag elements.

list_connection_groups

Name	Datatype	Description
anycast_ip_list_id	string	The ID of the Anycast static IP list.
arn	string	The Amazon Resource Name (ARN) of the connection group.
created_time	string	The date and time when the connection group was created.
e_tag	string	The current version of the connection group.
enabled	boolean	Whether the connection group is enabled
id	string	The ID of the connection group.
is_default	boolean	Whether the connection group is the default connection group for the distribution tenants.
last_modified_time	string	The date and time when the connection group was updated.
name	string	The name of the connection group.
routing_endpoint	string	The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net.
status	string	The status of the connection group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_connection_group	select	identifier, region		Gets information about a connection group.
list_connection_groups	select	region		Lists the connection groups in your Amazon Web Services account.
create_connection_group	insert	region		Creates a connection group.
update_connection_group	update	id, If-Match, region		Updates a connection group.
delete_connection_group	delete	id, If-Match, region		Deletes a connection group.

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 value of the ETag header that you received when retrieving the connection group to delete.
id	string	The ID of the connection group to delete.
identifier	string	The ID, name, or Amazon Resource Name (ARN) of the connection group.
region	string	AWS region (default: us-east-1)

SELECT examples

get_connection_group

Gets information about a connection group.

SELECT
anycast_ip_list_id,
arn,
created_time,
enabled,
id,
ipv_6_enabled,
is_default,
last_modified_time,
name,
routing_endpoint,
status,
tags
FROM aws.cloudfront.connection_groups
WHERE identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_connection_groups

Lists the connection groups in your Amazon Web Services account.

SELECT
anycast_ip_list_id,
arn,
created_time,
e_tag,
enabled,
id,
is_default,
last_modified_time,
name,
routing_endpoint,
status
FROM aws.cloudfront.connection_groups
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_connection_group

Creates a connection group.

INSERT INTO aws.cloudfront.connection_groups (
Name,
Ipv6Enabled,
Tags,
AnycastIpListId,
Enabled,
region
)
SELECT 
'{{ Name }}',
{{ Ipv6Enabled }},
'{{ Tags }}',
'{{ AnycastIpListId }}',
{{ Enabled }},
'{{ region }}'
RETURNING
anycast_ip_list_id,
arn,
created_time,
enabled,
id,
ipv_6_enabled,
is_default,
last_modified_time,
name,
routing_endpoint,
status,
tags
;

Manifest

# Description fields are for documentation purposes
- name: connection_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the connection_groups resource.
  - name: Name
    value: "{{ Name }}"
  - name: Ipv6Enabled
    value: {{ Ipv6Enabled }}
  - name: Tags
    description: |
      A complex type that contains zero or more Tag elements.
    value:
      Items:
        - Key: "{{ Key }}"
          Value: "{{ Value }}"
  - name: AnycastIpListId
    value: "{{ AnycastIpListId }}"
  - name: Enabled
    value: {{ Enabled }}

UPDATE examples

update_connection_group

Updates a connection group.

UPDATE aws.cloudfront.connection_groups
SET 
Ipv6Enabled = {{ Ipv6Enabled }},
AnycastIpListId = '{{ AnycastIpListId }}',
Enabled = {{ Enabled }}
WHERE 
id = '{{ id }}' --required
AND `If-Match` = '{{ If-Match }}' --required
AND region = '{{ region }}' --required
RETURNING
anycast_ip_list_id,
arn,
created_time,
enabled,
id,
ipv_6_enabled,
is_default,
last_modified_time,
name,
routing_endpoint,
status,
tags;

DELETE examples

delete_connection_group

Deletes a connection group.

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