AWS::Connect::IntegrationAssociation

Specifies the association of an AWS resource such as Lex bot (both v1 and v2) and Lambda function with an Amazon Connect instance.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Connect::IntegrationAssociation",
  "Properties" : {
      "InstanceId" : String,
      "IntegrationArn" : String,
      "IntegrationType" : String
    }
}

YAML

Type: AWS::Connect::IntegrationAssociation
Properties:
  InstanceId: String
  IntegrationArn: String
  IntegrationType: String

Properties

InstanceId

The Amazon Resource Name (ARN) of the instance.

Minimum: 1

Maximum: 100

Required: Yes

Type: String

Pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$

Minimum: 1

Maximum: 100

Update requires: Replacement

IntegrationArn

ARN of the integration being associated with the instance.

Minimum: 1

Maximum: 140

Required: Yes

Type: String

Minimum: 1

Maximum: 140

Update requires: Replacement

IntegrationType

Specifies the integration type to be associated with the instance.

Allowed Values: LEX_BOT | LAMBDA_FUNCTION

Required: Yes

Type: String

Allowed values: LEX_BOT | LAMBDA_FUNCTION | APPLICATION

Update requires: Replacement

Return values

Ref

Fn::GetAtt

IntegrationAssociationId

Identifier of the association with an Amazon Connect instance.

Examples

Specify a Lex V1 Bot integration

The following example specifies a Lex V1 Bot integration for an Amazon Connect instance.

YAML

AWSTemplateFormatVersion: 2010-09-09
Description: Specifies a Lex V1 Bot integration for an Amazon Connect instance
Resources:
  IntegrationAssociation:
    Type: AWS::Connect::IntegrationAssociation
    Properties:
      InstanceId: arn:aws:connect:region-name:aws-account-id:instance/instance-id
      IntegrationType: LEX_BOT
      IntegrationArn: arn:aws:lex:region-name:aws-account-id:bot/bot-name

Specify a Lex V2 Bot integration

The following example specifies a Lex V2 Bot integration for an Amazon Connect instance.

YAML

AWSTemplateFormatVersion: 2010-09-09
Description: Specifies a Lex V2 Bot integration for an Amazon Connect instance
Resources:
  IntegrationAssociation:
    Type: AWS::Connect::IntegrationAssociation
    Properties:
      InstanceId: arn:aws:connect:region-name:aws-account-id:instance/instance-id
      IntegrationType: LEX_BOT
      IntegrationArn: arn:aws:lex:region-name:aws-account-id:bot-alias/bot-id/alias-id

Specify a Lambda Function integration

The following example specifies a Lambda Function for an Amazon Connect instance.

YAML

AWSTemplateFormatVersion: 2010-09-09
Description: Specifies a Lambda Function integration for an Amazon Connect instance
Resources:
  IntegrationAssociation:
    Type: AWS::Connect::IntegrationAssociation
    Properties:
      InstanceId: arn:aws:connect:region-name:aws-account-id:instance/instance-id
      IntegrationType: LAMBDA_FUNCTION
      IntegrationArn: arn:aws:lambda:region-name:aws-account-id:function:function-arn