integration_associations

Creates, updates, deletes or gets an integration_association resource or lists integration_associations in a region

Overview

Name	integration_associations
Type	Resource
Description	Resource Type definition for AWS::Connect::IntegrationAssociation
Id	awscc.connect.integration_associations

Fields

get (all properties)

Name	Datatype	Description
integration_association_id	string	Identifier of the association with Connect Instance
instance_id	string	Amazon Connect instance identifier
integration_arn	string	ARN of Integration being associated with the instance
integration_type	string	Specifies the integration type to be associated with the instance
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
instance_id	string	Amazon Connect instance identifier
integration_arn	string	ARN of Integration being associated with the instance
integration_type	string	Specifies the integration type to be associated with the instance
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	integration_associations	INSERT	InstanceId, IntegrationType, IntegrationArn, region
delete_resource	integration_associations	DELETE	Identifier, region
list_resources	integration_associations_list_only	SELECT	region
get_resource	integration_associations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual integration_association.

SELECT
  region,
  integration_association_id,
  instance_id,
  integration_arn,
  integration_type
FROM awscc.connect.integration_associations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ instance_id }}|{{ integration_type }}|{{ integration_arn }}';

list (identifiers only)

Lists all integration_associations in a region.

SELECT
  region,
  instance_id,
  integration_type,
  integration_arn
FROM awscc.connect.integration_associations_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.connect.integration_associations (
  InstanceId,
  IntegrationArn,
  IntegrationType,
  region
)
SELECT
  '{{ instance_id }}',
  '{{ integration_arn }}',
  '{{ integration_type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.connect.integration_associations (
  InstanceId,
  IntegrationArn,
  IntegrationType,
  region
)
SELECT
  '{{ instance_id }}',
  '{{ integration_arn }}',
  '{{ integration_type }}',
  '{{ 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: integration_association
  props:
    - name: instance_id
      value: '{{ instance_id }}'
    - name: integration_arn
      value: '{{ integration_arn }}'
    - name: integration_type
      value: '{{ integration_type }}'

DELETE example

/*+ delete */
DELETE FROM awscc.connect.integration_associations
WHERE
  Identifier = '{{ instance_id }}|{{ integration_type }}|{{ integration_arn }}' 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 integration_associations resource, the following permissions are required:

Create

connect:DescribeInstance,
ds:DescribeDirectories,
app-integrations:CreateEventIntegrationAssociation,
mobiletargeting:GetApp,
cases:GetDomain,
wisdom:GetAssistant,
wisdom:GetKnowledgeBase,
wisdom:TagResource,
voiceid:DescribeDomain,
events:PutTargets,
events:PutRule,
connect:AssociateBot,
connect:AssociateLambdaFunction,
connect:CreateIntegrationAssociation,
connect:ListBots,
connect:ListLambdaFunctions,
connect:ListIntegrationAssociations,
lambda:addPermission,
lex:GetBot,
lex:DescribeBotAlias,
lex:CreateResourcePolicy,
lex:UpdateResourcePolicy,
lex:CreateResourcePolicyStatement,
lambda:AddPermission,
app-integrations:GetApplication,
app-integrations:CreateApplicationAssociation,
iam:AttachRolePolicy,
iam:CreateServiceLinkedRole,
iam:GetRolePolicy,
iam:PutRolePolicy

Read

connect:ListBots,
connect:ListLambdaFunctions,
connect:ListIntegrationAssociations

Delete

connect:DescribeInstance,
ds:DescribeDirectories,
app-integrations:DeleteEventIntegrationAssociation,
app-integrations:DeleteApplicationAssociation,
events:ListTargetsByRule,
events:RemoveTargets,
events:DeleteRule,
connect:DisassociateBot,
connect:DisassociateLambdaFunction,
connect:DeleteIntegrationAssociation,
connect:ListBots,
connect:ListLambdaFunctions,
connect:ListIntegrationAssociations,
lex:DeleteResourcePolicy,
lex:DeleteResourcePolicyStatement,
lambda:RemovePermission,
iam:GetRolePolicy,
iam:DeleteRolePolicy,
iam:PutRolePolicy

List

connect:ListBots,
connect:ListLambdaFunctions,
connect:ListIntegrationAssociations