views

Creates, updates, deletes or gets a view resource or lists views in a region

Overview

Name	views
Type	Resource
Description	Resource Type definition for AWS::Connect::View
Id	aws.connect.views

Fields

Name	Datatype	Description
instance_arn	string	The Amazon Resource Name (ARN) of the instance.
view_arn	string	The Amazon Resource Name (ARN) of the view.
view_id	string	The view id of the view.
name	string	The name of the view.
description	string	The description of the view.
template	object	The template of the view as JSON.
actions	array	The actions of the view in an array.
view_content_sha256	string	The view content hash.
tags	array	One or more tags.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	InstanceArn, Template, Actions, 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 views in a region.

SELECT
region,
instance_arn,
view_arn,
view_id,
name,
description,
template,
actions,
view_content_sha256,
tags
FROM aws.connect.views
WHERE region = 'us-east-1';

Gets all properties from an individual view.

SELECT
region,
instance_arn,
view_arn,
view_id,
name,
description,
template,
actions,
view_content_sha256,
tags
FROM aws.connect.views
WHERE region = 'us-east-1' AND data__Identifier = '<ViewArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.connect.views (
 InstanceArn,
 Name,
 Template,
 Actions,
 region
)
SELECT 
'{{ InstanceArn }}',
 '{{ Name }}',
 '{{ Template }}',
 '{{ Actions }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.connect.views (
 InstanceArn,
 Name,
 Description,
 Template,
 Actions,
 Tags,
 region
)
SELECT 
 '{{ InstanceArn }}',
 '{{ Name }}',
 '{{ Description }}',
 '{{ Template }}',
 '{{ Actions }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: view
    props:
      - name: InstanceArn
        value: '{{ InstanceArn }}'
      - name: Name
        value: '{{ Name }}'
      - name: Description
        value: '{{ Description }}'
      - name: Template
        value: {}
      - name: Actions
        value:
          - '{{ Actions[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.connect.views
WHERE data__Identifier = '<ViewArn>'
AND region = 'us-east-1';

Permissions

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

Create

connect:CreateView,
connect:TagResource

Read

connect:DescribeView

Delete

connect:DeleteView,
connect:UntagResource

List

connect:ListViews

Update

connect:UpdateViewMetadata,
connect:UpdateViewContent,
connect:TagResource,
connect:UntagResource