predefined_attributes

Creates, updates, deletes or gets a predefined_attribute resource or lists predefined_attributes in a region

Overview

Name	predefined_attributes
Type	Resource
Description	Resource Type definition for AWS::Connect::PredefinedAttribute
Id	aws.connect.predefined_attributes

Fields

Name	Datatype	Description
instance_arn	string	The identifier of the Amazon Connect instance.
name	string	The name of the predefined attribute.
values	object	The values of a predefined attribute.
last_modified_region	string	Last modified region.
last_modified_time	number	Last modified time.
region	string	AWS region.

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

Methods

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

SELECT
region,
instance_arn,
name,
values,
last_modified_region,
last_modified_time
FROM aws.connect.predefined_attributes
WHERE region = 'us-east-1';

Gets all properties from an individual predefined_attribute.

SELECT
region,
instance_arn,
name,
values,
last_modified_region,
last_modified_time
FROM aws.connect.predefined_attributes
WHERE region = 'us-east-1' AND data__Identifier = '<InstanceArn>|<Name>';

INSERT example

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

Required Properties

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

All Properties

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

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: predefined_attribute
    props:
      - name: InstanceArn
        value: '{{ InstanceArn }}'
      - name: Name
        value: '{{ Name }}'
      - name: Values
        value:
          StringList:
            - '{{ StringList[0] }}'

DELETE example

/*+ delete */
DELETE FROM aws.connect.predefined_attributes
WHERE data__Identifier = '<InstanceArn|Name>'
AND region = 'us-east-1';

Permissions

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

Create

connect:CreatePredefinedAttribute

Read

connect:DescribePredefinedAttribute

Delete

connect:DeletePredefinedAttribute

Update

connect:UpdatePredefinedAttribute

List

connect:ListPredefinedAttributes