security_keys

Creates, updates, deletes or gets a security_key resource or lists security_keys in a region

Overview

Name	security_keys
Type	Resource
Description	Resource Type definition for AWS::Connect::SecurityKey
Id	aws.connect.security_keys

Fields

Name	Datatype	Description
key	string	A valid security key in PEM format.
instance_id	string	Amazon Connect instance identifier
association_id	string	An associationID is automatically generated when a storage config is associated with an instance
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Key, InstanceId, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all security_keys in a region.

SELECT
region,
key,
instance_id,
association_id
FROM aws.connect.security_keys
WHERE region = 'us-east-1';

Gets all properties from an individual security_key.

SELECT
region,
key,
instance_id,
association_id
FROM aws.connect.security_keys
WHERE region = 'us-east-1' AND data__Identifier = '<InstanceId>|<AssociationId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.connect.security_keys (
 Key,
 InstanceId,
 region
)
SELECT 
'{{ Key }}',
 '{{ InstanceId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.connect.security_keys (
 Key,
 InstanceId,
 region
)
SELECT 
 '{{ Key }}',
 '{{ InstanceId }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: security_key
    props:
      - name: Key
        value: '{{ Key }}'
      - name: InstanceId
        value: '{{ InstanceId }}'

DELETE example

/*+ delete */
DELETE FROM aws.connect.security_keys
WHERE data__Identifier = '<InstanceId|AssociationId>'
AND region = 'us-east-1';

Permissions

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

Create

connect:AssociateSecurityKey

Read

connect:ListSecurityKeys

Delete

connect:DisassociateSecurityKey

List

connect:ListSecurityKeys