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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
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.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	security_keys	INSERT	Key, InstanceId, region
delete_resource	security_keys	DELETE	Identifier, region
list_resources	security_keys_list_only	SELECT	region
get_resource	security_keys	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual security_key.

SELECT
  region,
  key,
  instance_id,
  association_id
FROM awscc.connect.security_keys
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ instance_id }}|{{ association_id }}';

list (identifiers only)

Lists all security_keys in a region.

SELECT
  region,
  instance_id,
  association_id
FROM awscc.connect.security_keys_list_only
WHERE
  region = 'us-east-1';

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 awscc.connect.security_keys (
  Key,
  InstanceId,
  region
)
SELECT
  '{{ key }}',
  '{{ instance_id }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.connect.security_keys (
  Key,
  InstanceId,
  region
)
SELECT
  '{{ key }}',
  '{{ instance_id }}',
  '{{ 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: instance_id
        value: '{{ instance_id }}'

DELETE example

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