connections

Creates, updates, deletes or gets a connection resource or lists connections in a region

Overview

Name	connections
Type	Resource
Description	Resource Type definition for AWS::Events::Connection.
Id	aws.events.connections

Fields

Name	Datatype	Description
name	string	Name of the connection.
arn	string	The arn of the connection resource.
secret_arn	string	The arn of the secrets manager secret created in the customer account.
description	string	Description of the connection.
authorization_type	string
auth_parameters	object
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	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 connections in a region.

SELECT
region,
name,
arn,
secret_arn,
description,
authorization_type,
auth_parameters
FROM aws.events.connections
WHERE region = 'us-east-1';

Gets all properties from an individual connection.

SELECT
region,
name,
arn,
secret_arn,
description,
authorization_type,
auth_parameters
FROM aws.events.connections
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.events.connections (
 Name,
 Description,
 AuthorizationType,
 AuthParameters,
 region
)
SELECT 
'{{ Name }}',
 '{{ Description }}',
 '{{ AuthorizationType }}',
 '{{ AuthParameters }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.events.connections (
 Name,
 Description,
 AuthorizationType,
 AuthParameters,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Description }}',
 '{{ AuthorizationType }}',
 '{{ AuthParameters }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: connection
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Description
        value: '{{ Description }}'
      - name: AuthorizationType
        value: '{{ AuthorizationType }}'
      - name: AuthParameters
        value:
          ApiKeyAuthParameters:
            ApiKeyName: '{{ ApiKeyName }}'
            ApiKeyValue: '{{ ApiKeyValue }}'
          BasicAuthParameters:
            Username: '{{ Username }}'
            Password: '{{ Password }}'
          OAuthParameters:
            ClientParameters:
              ClientID: '{{ ClientID }}'
              ClientSecret: '{{ ClientSecret }}'
            AuthorizationEndpoint: '{{ AuthorizationEndpoint }}'
            HttpMethod: '{{ HttpMethod }}'
            OAuthHttpParameters:
              HeaderParameters:
                - Key: '{{ Key }}'
                  Value: '{{ Value }}'
                  IsValueSecret: '{{ IsValueSecret }}'
              QueryStringParameters:
                - null
              BodyParameters:
                - null
          InvocationHttpParameters: null

DELETE example

/*+ delete */
DELETE FROM aws.events.connections
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

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

Create

events:CreateConnection,
events:DescribeConnection,
secretsmanager:CreateSecret,
secretsmanager:GetSecretValue,
secretsmanager:PutSecretValue,
iam:CreateServiceLinkedRole

Read

events:DescribeConnection

Update

events:UpdateConnection,
events:DescribeConnection,
secretsmanager:CreateSecret,
secretsmanager:UpdateSecret,
secretsmanager:GetSecretValue,
secretsmanager:PutSecretValue

Delete

events:DeleteConnection,
events:DescribeConnection

List

events:ListConnections