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 = '{{ region }}' 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 = '{{ region }}';

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.connect.approved_origins (
  Origin,
  InstanceId,
  region
)
SELECT
  '{{ origin }}',
  '{{ instance_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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 = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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