traffic_distribution_groups

Creates, updates, deletes or gets a traffic_distribution_group resource or lists traffic_distribution_groups in a region

Overview

Name	traffic_distribution_groups
Type	Resource
Description	Resource Type definition for AWS::Connect::TrafficDistributionGroup
Id	awscc.connect.traffic_distribution_groups

Fields

get (all properties)

Name	Datatype	Description
instance_arn	string	The identifier of the Amazon Connect instance that has been replicated.
traffic_distribution_group_arn	string	The identifier of the traffic distribution group.
description	string	A description for the traffic distribution group.
name	string	The name for the traffic distribution group.
status	string	The status of the traffic distribution group.
▶tags	array	One or more tags.
is_default	boolean	If this is the default traffic distribution group.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
traffic_distribution_group_arn	string	The identifier of the traffic distribution group.
region	string	AWS region.

For more information, see AWS::Connect::TrafficDistributionGroup.

Methods

Name	Resource	Accessible by	Required Params
create_resource	traffic_distribution_groups	INSERT	InstanceArn, Name, region
delete_resource	traffic_distribution_groups	DELETE	Identifier, region
update_resource	traffic_distribution_groups	UPDATE	Identifier, PatchDocument, region
list_resources	traffic_distribution_groups_list_only	SELECT	region
get_resource	traffic_distribution_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual traffic_distribution_group.

SELECT
  region,
  instance_arn,
  traffic_distribution_group_arn,
  description,
  name,
  status,
  tags,
  is_default
FROM awscc.connect.traffic_distribution_groups
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ traffic_distribution_group_arn }}';

list (identifiers only)

Lists all traffic_distribution_groups in a region.

SELECT
  region,
  traffic_distribution_group_arn
FROM awscc.connect.traffic_distribution_groups_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.connect.traffic_distribution_groups (
  InstanceArn,
  Name,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.connect.traffic_distribution_groups (
  InstanceArn,
  Description,
  Name,
  Tags,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ description }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

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

UPDATE example

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

/*+ update */
UPDATE awscc.connect.traffic_distribution_groups
SET PatchDocument = string('{{ {
    "InstanceArn": instance_arn,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ traffic_distribution_group_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.connect.traffic_distribution_groups
WHERE
  Identifier = '{{ traffic_distribution_group_arn }}' AND
  region = 'us-east-1';

Permissions

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

Create

connect:CreateTrafficDistributionGroup,
connect:DescribeTrafficDistributionGroup,
connect:TagResource

Read

connect:DescribeTrafficDistributionGroup

Update

connect:TagResource,
connect:UntagResource

Delete

connect:DeleteTrafficDistributionGroup,
connect:DescribeTrafficDistributionGroup,
connect:UntagResource

List

connect:ListTrafficDistributionGroups