approved_origins

Creates, updates, deletes or gets an approved_origin resource or lists approved_origins in a region

Overview

Name	approved_origins
Type	Resource
Description	Resource Type definition for AWS::Connect::ApprovedOrigin
Id	awscc.connect.approved_origins

Fields

get (all properties)

Name	Datatype	Description
origin	string	Domain name to be added to the allowlist of instance
instance_id	string	Amazon Connect instance identifier
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
origin	string	Domain name to be added to the allowlist of instance
instance_id	string	Amazon Connect instance identifier
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	approved_origins	INSERT	Origin, InstanceId, region
delete_resource	approved_origins	DELETE	Identifier, region
list_resources	approved_origins_list_only	SELECT	region
get_resource	approved_origins	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual approved_origin.

SELECT
  region,
  origin,
  instance_id
FROM awscc.connect.approved_origins
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ instance_id }}|{{ origin }}';

list (identifiers only)

Lists all approved_origins in a region.

SELECT
  region,
  instance_id,
  origin
FROM awscc.connect.approved_origins_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.connect.approved_origins (
  Origin,
  InstanceId,
  region
)
SELECT
  '{{ origin }}',
  '{{ instance_id }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.connect.approved_origins (
  Origin,
  InstanceId,
  region
)
SELECT
  '{{ origin }}',
  '{{ instance_id }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: approved_origin
    props:
      - name: origin
        value: '{{ origin }}'
      - name: instance_id
        value: '{{ instance_id }}'

DELETE example

/*+ delete */
DELETE FROM awscc.connect.approved_origins
WHERE
  Identifier = '{{ instance_id }}|{{ origin }}' AND
  region = 'us-east-1';

Permissions

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

Create

connect:AssociateApprovedOrigin,
connect:ListApprovedOrigins

Read

connect:ListApprovedOrigins

Delete

connect:DisassociateApprovedOrigin,
connect:ListApprovedOrigins

List

connect:ListApprovedOrigins