connection_groups

Creates, updates, deletes or gets a connection_group resource or lists connection_groups in a region

Overview

Name	connection_groups
Type	Resource
Description	The connection group for your distribution tenants. When you first create a distribution tenant and you don't specify a connection group, CloudFront will automatically create a default connection group for you. When you create a new distribution tenant and don't specify a connection group, the default one will be associated with your distribution tenant.
Id	awscc.cloudfront.connection_groups

Fields

get (all properties)

Name	Datatype	Description
id	string
name	string	The name of the connection group.
arn	string
created_time	string
last_modified_time	string
▶tags	array	A complex type that contains zero or more ``Tag`` elements.
ipv6_enabled	boolean	IPv6 is enabled for the connection group.
routing_endpoint	string
anycast_ip_list_id	string	The ID of the Anycast static IP list.
status	string
enabled	boolean	Whether the connection group is enabled.
is_default	boolean
e_tag	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	connection_groups	INSERT	Name, region
delete_resource	connection_groups	DELETE	Identifier, region
update_resource	connection_groups	UPDATE	Identifier, PatchDocument, region
list_resources	connection_groups_list_only	SELECT	region
get_resource	connection_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual connection_group.

SELECT
  region,
  id,
  name,
  arn,
  created_time,
  last_modified_time,
  tags,
  ipv6_enabled,
  routing_endpoint,
  anycast_ip_list_id,
  status,
  enabled,
  is_default,
  e_tag
FROM awscc.cloudfront.connection_groups
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all connection_groups in a region.

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

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.cloudfront.connection_groups (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.cloudfront.connection_groups (
  Name,
  Tags,
  Ipv6Enabled,
  AnycastIpListId,
  Enabled,
  region
)
SELECT
  '{{ name }}',
  '{{ tags }}',
  '{{ ipv6_enabled }}',
  '{{ anycast_ip_list_id }}',
  '{{ enabled }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: connection_group
    props:
      - name: name
        value: '{{ name }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: ipv6_enabled
        value: '{{ ipv6_enabled }}'
      - name: anycast_ip_list_id
        value: '{{ anycast_ip_list_id }}'
      - name: enabled
        value: '{{ enabled }}'

UPDATE example

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

/*+ update */
UPDATE awscc.cloudfront.connection_groups
SET PatchDocument = string('{{ {
    "Tags": tags,
    "Ipv6Enabled": ipv6_enabled,
    "AnycastIpListId": anycast_ip_list_id,
    "Enabled": enabled
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.cloudfront.connection_groups
WHERE
  Identifier = '{{ id }}' AND
  region = 'us-east-1';

Permissions

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

Create

cloudfront:CreateConnectionGroup,
cloudfront:GetConnectionGroup,
cloudfront:TagResource

Delete

cloudfront:DeleteConnectionGroup,
cloudfront:GetConnectionGroup,
cloudfront:UpdateConnectionGroup

List

cloudfront:ListConnectionGroups,
cloudfront:ListTagsForResource

Read

cloudfront:GetConnectionGroup,
cloudfront:ListTagsForResource

Update

cloudfront:GetConnectionGroup,
cloudfront:UpdateConnectionGroup,
cloudfront:ListTagsForResource,
cloudfront:TagResource,
cloudfront:UntagResource