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	awscc.connect.predefined_attributes

Fields

get (all properties)

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.
purposes	array	The assigned purposes of the predefined attribute.
▶attribute_configuration	object	Custom metadata associated to a Predefined attribute that controls how the attribute behaves when used by upstream services.
last_modified_region	string	Last modified region.
last_modified_time	number	Last modified time.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
instance_arn	string	The identifier of the Amazon Connect instance.
name	string	The name of the predefined attribute.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	predefined_attributes	INSERT	InstanceArn, Name, region
delete_resource	predefined_attributes	DELETE	Identifier, region
update_resource	predefined_attributes	UPDATE	Identifier, PatchDocument, region
list_resources	predefined_attributes_list_only	SELECT	region
get_resource	predefined_attributes	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual predefined_attribute.

SELECT
  region,
  instance_arn,
  name,
  values,
  purposes,
  attribute_configuration,
  last_modified_region,
  last_modified_time
FROM awscc.connect.predefined_attributes
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ instance_arn }}|{{ name }}';

list (identifiers only)

Lists all predefined_attributes in a region.

SELECT
  region,
  instance_arn,
  name
FROM awscc.connect.predefined_attributes_list_only
WHERE
  region = 'us-east-1';

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 awscc.connect.predefined_attributes (
  InstanceArn,
  Name,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.connect.predefined_attributes (
  InstanceArn,
  Name,
  Values,
  Purposes,
  AttributeConfiguration,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ name }}',
  '{{ values }}',
  '{{ purposes }}',
  '{{ attribute_configuration }}',
  '{{ 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: instance_arn
        value: '{{ instance_arn }}'
      - name: name
        value: '{{ name }}'
      - name: values
        value:
          string_list:
            - '{{ string_list[0] }}'
      - name: purposes
        value:
          - '{{ purposes[0] }}'
      - name: attribute_configuration
        value:
          enable_value_validation_on_association: '{{ enable_value_validation_on_association }}'
          is_read_only: '{{ is_read_only }}'

UPDATE example

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

/*+ update */
UPDATE awscc.connect.predefined_attributes
SET PatchDocument = string('{{ {
    "Values": values,
    "Purposes": purposes,
    "AttributeConfiguration": attribute_configuration
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ instance_arn }}|{{ name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.connect.predefined_attributes
WHERE
  Identifier = '{{ instance_arn }}|{{ 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