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	aws.connect.traffic_distribution_groups

Fields

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.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	InstanceArn, Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all traffic_distribution_groups in a region.

SELECT
region,
instance_arn,
traffic_distribution_group_arn,
description,
name,
status,
tags,
is_default
FROM aws.connect.traffic_distribution_groups
WHERE region = 'us-east-1';

Gets all properties from an individual traffic_distribution_group.

SELECT
region,
instance_arn,
traffic_distribution_group_arn,
description,
name,
status,
tags,
is_default
FROM aws.connect.traffic_distribution_groups
WHERE region = 'us-east-1' AND data__Identifier = '<TrafficDistributionGroupArn>';

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 aws.connect.traffic_distribution_groups (
 InstanceArn,
 Name,
 region
)
SELECT 
'{{ InstanceArn }}',
 '{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.connect.traffic_distribution_groups (
 InstanceArn,
 Description,
 Name,
 Tags,
 region
)
SELECT 
 '{{ InstanceArn }}',
 '{{ 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: InstanceArn
        value: '{{ InstanceArn }}'
      - name: Description
        value: '{{ Description }}'
      - name: Name
        value: '{{ Name }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.connect.traffic_distribution_groups
WHERE data__Identifier = '<TrafficDistributionGroupArn>'
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