joeykilpatrick / cdk-amazon-connect

A complete Amazon Connect contact center described entirely with the AWS CDK.

cdk-amazon-connect

A complete Amazon Connect contact center described entirely with the AWS CDK.

This contact center consists of a small IVR and a single queue with a single agent user. The IVR has one contact flow, two Lambda Functions, and one Lex Bot.

Official CloudFormation support for Amazon Connect is limited and custom resources must be developed to use a pure Infrastructure as Code approach to development on the platform. Some experimental custom resource implementations are available in the package cdk-amazon-connect-resources and can be found on npm and on GitHub.

Here is a list of provisioned resources, showing both the custom ones and the native CloudFormation ones:

• Connect Instance
  • AWS::CloudFormation::Instance
• Phone Number
  • AWS::Connect::PhoneNumber
  • Custom::ConnectPhoneNumberContactFlowAssociation
• IVR
  • AWS::Connect::ContactFlow
  • Custom::ConnectExistingPrompt
  • AWS::Lex::Bot
  • AWS::Lex::BotVersion
  • AWS::Lex::BotAlias
  • Custom::ConnectLexBotAssociation
  • AWS::Lambda::Function
  • Custom::ConnectLambdaFunctionAssociation
• Queue
  • AWS::Connect::ContactFlow
  • AWS::Connect::HoursOfOperation
  • Custom::ConnectQueue
• Agent
  • AWS::Connect::User
  • Custom::ConnectRoutingProfile
  • Custom::ConnectSecurityProfile

Deploying

If you have not deployed a CDK application in your AWS account before, you will need to bootstrap the account with:

npm install --global aws-cdk
cdk bootstrap aws://YOUR_ACCOUNT_ID/YOUR_AWS_REGION

Then you can clone this repository and install dependencies:

git clone https://github.com/joeykilpatrick/cdk-amazon-connect.git
cd cdk-amazon-connect
npm install

To deploy, you need to set some environment variables for the deploy command. Replace the dummy values below with your own AWS account id and region you would like to deploy into.

On Linux and Mac:

ACCOUNT_ID=123456789012 REGION=us-east-1 npm run deploy

On Windows:

npm install --global cross-env
cross-env ACCOUNT_ID=123456789012 REGION=us-east-1 npm run deploy

This will create a CloudFormation stack with the name cdk-amazon-connect-YOUR_ACCOUNT_ID. Once the stack is finished creating, a CloudFormation output will be generated with the phone number provisioned for your application.

Outputs:
cdk-amazon-connect-ACCOUNT_ID.phoneNumberOutput = [phone]

You can immediately call the phone number to test your new contact center. If you would like to accept your call as an agent, you can navigate to the login page for your new Connect Instance and login as user fredjones with password cHANGEmE123 to reach the Agent CCP.

Clean Up

You can run the following command to delete the provisioned resources:

ACCOUNT_ID=123456789012 REGION=us-east-1 npm run destroy

Because some Amazon Connect instance resources do not support deletion (like Queues or Routing Profiles) deletion will fail. However, these resources will be deleted when the Amazon Connect instance is automatically deleted. Though these resources have a policy of "RETAIN", other items that are linked to these resources (such as Hours of Operation) may not be able to be deleted. CloudFormation will error when deleting these resources in the stack and you must manually agree to retain them in the CloudFormation console.