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	awscc.events.connections

Fields

get (all properties)

Name	Datatype	Description
name	string	Name of the connection.
arn	string	The arn of the connection resource.
arn_for_policy	string	The arn of the connection resource to be used in IAM policies.
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
▶invocation_connectivity_parameters	object	The private resource the HTTP request will be sent to.
kms_key_identifier	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string	Name of the connection.
region	string	AWS region.

For more information, see AWS::Events::Connection.

Methods

Name	Resource	Accessible by	Required Params
create_resource	connections	INSERT	region
delete_resource	connections	DELETE	Identifier, region
update_resource	connections	UPDATE	Identifier, PatchDocument, region
list_resources	connections_list_only	SELECT	region
get_resource	connections	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual connection.

SELECT
  region,
  name,
  arn,
  arn_for_policy,
  secret_arn,
  description,
  authorization_type,
  auth_parameters,
  invocation_connectivity_parameters,
  kms_key_identifier
FROM awscc.events.connections
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all connections in a region.

SELECT
  region,
  name
FROM awscc.events.connections_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.events.connections (
  Name,
  Description,
  AuthorizationType,
  AuthParameters,
  InvocationConnectivityParameters,
  KmsKeyIdentifier,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ authorization_type }}',
  '{{ auth_parameters }}',
  '{{ invocation_connectivity_parameters }}',
  '{{ kms_key_identifier }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.events.connections (
  Name,
  Description,
  AuthorizationType,
  AuthParameters,
  InvocationConnectivityParameters,
  KmsKeyIdentifier,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ authorization_type }}',
  '{{ auth_parameters }}',
  '{{ invocation_connectivity_parameters }}',
  '{{ kms_key_identifier }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: authorization_type
      value: '{{ authorization_type }}'
    - name: auth_parameters
      value:
        api_key_auth_parameters:
          api_key_name: '{{ api_key_name }}'
          api_key_value: '{{ api_key_value }}'
        basic_auth_parameters:
          username: '{{ username }}'
          password: '{{ password }}'
        oauth_parameters:
          client_parameters:
            client_id: '{{ client_id }}'
            client_secret: '{{ client_secret }}'
          authorization_endpoint: '{{ authorization_endpoint }}'
          http_method: '{{ http_method }}'
          oauth_http_parameters:
            header_parameters:
              - key: '{{ key }}'
                value: '{{ value }}'
                is_value_secret: '{{ is_value_secret }}'
            query_string_parameters:
              - null
            body_parameters:
              - null
        invocation_http_parameters: null
        connectivity_parameters:
          resource_parameters:
            resource_configuration_arn: '{{ resource_configuration_arn }}'
            resource_association_arn: '{{ resource_association_arn }}'
    - name: invocation_connectivity_parameters
      value:
        resource_parameters: null
    - name: kms_key_identifier
      value: '{{ kms_key_identifier }}'

UPDATE example

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

/*+ update */
UPDATE awscc.events.connections
SET PatchDocument = string('{{ {
    "Description": description,
    "AuthorizationType": authorization_type,
    "KmsKeyIdentifier": kms_key_identifier
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.events.connections
WHERE
  Identifier = '{{ name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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,
kms:DescribeKey,
kms:GenerateDataKey

Read

events:DescribeConnection,
kms:Decrypt

Update

events:UpdateConnection,
events:DescribeConnection,
secretsmanager:CreateSecret,
secretsmanager:UpdateSecret,
secretsmanager:GetSecretValue,
secretsmanager:PutSecretValue,
kms:Decrypt,
kms:DescribeKey,
kms:Encrypt,
kms:GenerateDataKey

Delete

events:DeleteConnection,
events:DescribeConnection

List

events:ListConnections