vmx3.yaml

AWSTemplateFormatVersion: '2010-09-09'

Description: Deploys the Voicemail Express solution for Amazon Connect. Updated for 2024.09.01.

Metadata:
  AWS::CloudFormation::Interface:
    ParameterGroups:
      - Label:
          default: 1. Environment Configuration
        Parameters:
          - AWSRegion
          - ConnectInstanceAlias
          - ConnectInstanceARN
          - VMXKVSStreamPrefix
          - ConnectCTRStreamARN
          - LambdaLoggingLevel
      - Label:
          default: 2. Voicemail Express AWS Delivery Modes
        Parameters:
          - EnableVMToConnectGuidedTask
          - EnableVMToConnectTask
          - EnableVMToEmail
          - VMDefaultMode
      - Label:
          default: 3. Voicemail Express Recording Simple Storage Service (S3) Retention
            Settings
        Parameters:
          - RecordingsExpireInXDays
          - ExpiredRecordingBehavior
      - Label:
          default: 4. Amazon Connect Guided Task Parameters  (Only required for guided
            task delivery)
        Parameters:
          - GuidedTaskRecordingLinksExpireInXMinutes
      - Label:
          default: 5. Amazon Connect Task Parameters (Only required for standard task
            delivery)
        Parameters:
          - TaskRecordingLinksExpireInXDays
      - Label:
          default: 6. Amazon Connect Email Parameters (Only required for email delivery)
        Parameters:
          - VMToEmailDefaultFrom
          - VMToEmailDefaultTo
          - VMAgentAddressKey
          - EmailRecordingLinksExpireInXDays
      - Label:
          default: 7. Voicemail Express Test Parameters
        Parameters:
          - VMTestAgentId
          - VMTestQueueARN
      - Label:
          default: 7. Advanced Settings - Use only in customized deployments
        Parameters:
          - EXPDevBucketPrefix
          - EXPTemplateVersion
    ParameterLabels:
      AWSRegion:
        default: Which AWS region is your Amazon Connect Instance deployed to?
      ConnectCTRStreamARN:
        default: What is the ARN for the Kinesis Data Stream that is configured for
          Contact Record streaming.
      ConnectInstanceAlias:
        default: What is your Amazon Connect instance alias?
      ConnectInstanceARN:
        default: What is your Amazon Connect instance ARN (Amazon Resource Name)?
      EmailRecordingLinksExpireInXDays:
        default: How long should the presigned recording URL be valid for? (# of days)
      EnableVMToConnectTask:
        default: Enable Voicemail delivery as an Amazon Connect Task?
      EnableVMToConnectGuidedTask:
        default: Enable Voicemail delivery as an Amazon Connect Guided Task? (DEFAULT
          MODE)
      EnableVMToEmail:
        default: Enable Voicemail delivery as an Email using Amazon Simple Email
          Service?
      EXPDevBucketPrefix:
        default: (ADVANCED USE ONLY) What is the bucket prefix for your custom code S3
          bucket?
      ExpiredRecordingBehavior:
        default: When the recording reaches its lifecycle, what action should be taken?
      EXPTemplateVersion:
        default: (ADVANCED USE ONLY) What is version you wish to deploy?
      GuidedTaskRecordingLinksExpireInXMinutes:
        default: How long should the presigned recording URL be valid for? (# of
          minutes)
      VMXKVSStreamPrefix:
        default: What is the prefix for the Kinesis Video Streams (KVS) associated with this instance?
      LambdaLoggingLevel:
        default: For the included AWS Lambda functions, what should the default logging
          level be set to?
      RecordingsExpireInXDays:
        default: How long should we keep your voicemail recordings before deleting or
          archiving? (# of days)
      TaskRecordingLinksExpireInXDays:
        default: How long should the presigned recording URL be valid for? (# of days)
      VMAgentAddressKey:
        default: Do you store agent email addresses in the Email, Secondary Email, or
          Username field?
      VMDefaultMode:
        default: What is your default delivery mode?
      VMToEmailDefaultTo:
        default: Fallback TO email for voicemails if no address is provided?
      VMToEmailDefaultFrom:
        default: Fallback FROM email for voicemails if no address is provided?
      VMTestAgentId:
        default: Which agent ID will you use for testing?
      VMTestQueueARN:
        default: Which queue will you use for testing?

Parameters:
  AWSRegion:
    Type: String
    Default: us-east-1
    AllowedValues:
      - us-east-1
      - us-west-2
      - af-south-1
      - ap-southeast-1
      - ap-southeast-2
      - ap-northeast-1
      - ap-northeast-2
      - ca-central-1
      - eu-central-1
      - eu-west-2
    Description: All resources for this template must reside in the same region.
      Validate which region your Amazon Connect instance is deployed in and
      select the corresponding region from the drop-down list. You should run
      this template from this region as well.
  ConnectCTRStreamARN:
    Type: String
    Default: Looks like - arn:aws:kinesis:REGION:ACCOUNT:stream/REPLACEME
    Description: Provide the ARN for the Kinesis Data Stream that receives your
      contact records. This solution is only designed for Amazon Kinesis Data
      Streams, not Kinesis Data Firehose.
  ConnectInstanceAlias:
    Type: String
    Default: REPLACEME
    Description: Provide the instance alias for your Amazon Connect instance. You
      can find this in the in the AWS Console for Amazon Connect. It is shown in
      the list of instances. Please use lowercase letters ONLY.
  ConnectInstanceARN:
    Type: String
    Default: Looks like - arn:aws:connect:REGION:ACCOUNT:instance/REPLACEME
    Description: Provide the instance ARN for your Amazon Connect istance.
  EXPDevBucketPrefix:
    Type: String
    Default: ''
    Description: Not required and only used for development purposes.
  VMXKVSStreamPrefix:
    Type: String
    Default: 'Looks like - PREFIX-connect-ALIAS-contact-'
    Description: The full prefix for the KVS streams. You can find this in the Connect Console at Data Storage > Live media Streaming > Kinesis video stream prefix.
  EmailRecordingLinksExpireInXDays:
    Type: String
    Default: 1
    AllowedValues:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
    Description: Set the number of days.
  TaskRecordingLinksExpireInXDays:
    Type: String
    Default: 1
    AllowedValues:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
    Description: Select the number of days.
  EnableVMToConnectTask:
    Type: String
    Default: 'no'
    AllowedValues:
      - 'yes'
      - 'no'
    Description: Allow voicemails to be delivered to agents as Amazon Connect Tasks.
      Works with Agent Workspace, CCP, or streams. Incoming task will contain
      the transcript and a presigned URL to the recording.
  EnableVMToConnectGuidedTask:
    Type: String
    Default: 'yes'
    AllowedValues:
      - 'yes'
      - 'no'
    Description: Allow voicemails to be delivered to agents as Amazon Connect Guided
      Tasks. Similar to a normal Task, however the presentation of the voicemail
      is via agent guide, which includes a media player experience. This
      requires the agent to use the Agent Workspace or a custom UI that
      incoporates agent guides.
  EnableVMToEmail:
    Type: String
    Default: 'no'
    AllowedValues:
      - 'yes'
      - 'no'
    Description: Allow voicemails to be delivered to agents as external Emails.
      These will not be tracked or routed via Amazon Connect.
  ExpiredRecordingBehavior:
    Type: String
    Default: delete
    AllowedValues:
      - delete
      - keep
      - glacier
    Description: When recordings expire, do you want to delete the recording, keep
      it, or move it to Glacier?
  EXPTemplateVersion:
    Type: String
    Default: 2024.09.01
    Description: Template version. ONLY change if you have built a custom version.
  GuidedTaskRecordingLinksExpireInXMinutes:
    Type: String
    Default: 2
    AllowedValues:
      - 2
      - 5
      - 10
    Description: Number of minutes recordings are accessible via link. This is
      limited by the maximum amount of time that a presigned URL can be active.
  LambdaLoggingLevel:
    Type: String
    Default: INFO
    AllowedValues:
      - ERROR
      - WARN
      - INFO
      - DEBUG
    Description: Default is Info. This can be changed later. Details on logging can
      be found at
      https://docs.aws.amazon.com/lambda/latest/dg/monitoring-cloudwatchlogs.html#monitoring-cloudwatchlogs-runtime-logging
  RecordingsExpireInXDays:
    Type: String
    Default: 7
    Description: Number of days recordings are saved before they are lifecycled.
      Once this limit hits, the recording file will be lifecycled in the manner
      that you have selected.
  VMAgentAddressKey:
    Type: String
    Default: Email
    AllowedValues:
      - Email
      - SecondaryEmail
      - Username
    Description: Typically, SAML uses SecondaryEmail and Non-SAML configs use
      Email.  Or, if you set the Username value to the agent e-mail address,
      select Username.
  VMDefaultMode:
    Type: String
    Default: AmazonConnectGuidedTask
    AllowedValues:
      - AmazonConnectGuidedTask
      - AmazonConnectTask
      - AmazonSimpleEmailService
    Description: If no other voicemail delivery model can be identified, which model
      should be used?
  VMToEmailDefaultFrom:
    Type: String
    Default: voicemail_from@test.com
    Description: Email address to use when sending voicemails when another FROM
      address could not be identified. This will also be configured as the test
      FROM address.
  VMToEmailDefaultTo:
    Type: String
    Default: voicemail_to@test.com
    Description: Email address to receive voicemails where another TO address could
      not be identified. This will also be configured as the test TO address.
  VMTestAgentId:
    Type: String
    Default: Looks like - jdoe or jdoe@test.com
    Description: Agent ID to use for the voicemail test function.
  VMTestQueueARN:
    Type: String
    Default: Looks like -
      arn:aws:connect:REGION:ACCOUNT:instance/INSTANCEID/queue/QUEUEID
    Description: The Queue ARN can be found in the Amazon Connect UI by navigating
      to Routing > Queue, choosing the queue, then expanding the 'Show
      additional queue information' section.

Conditions:
  ConnectTasksEnabled: !Equals
    - !Ref EnableVMToConnectTask
    - 'yes'
  ConnectGuidedTasksEnabled: !Equals
    - !Ref EnableVMToConnectGuidedTask
    - 'yes'
  AWSEmailEnabled: !Equals
    - !Ref EnableVMToEmail
    - 'yes'
  NonGuidedOptions: !Or
    - !Equals
      - !Ref EnableVMToConnectTask
      - 'yes'
    - !Equals
      - !Ref EnableVMToEmail
      - 'yes'

Mappings:
  VMModes:
    AmazonConnectTask:
      mode: task
    AmazonSimpleEmailService:
      mode: email
    AmazonConnectGuidedTask:
      mode: guided_task

Resources:

  VMXCoreStack:
    Type: AWS::CloudFormation::Stack
    Properties:
      Parameters:
        ConnectInstanceAlias: !Ref ConnectInstanceAlias
        ExpiredRecordingBehavior: !Ref ExpiredRecordingBehavior
        RecordingsExpireInXDays: !Ref RecordingsExpireInXDays
        EnableVMToConnectTask: !Ref EnableVMToConnectTask
        EnableVMToConnectGuidedTask: !Ref EnableVMToConnectGuidedTask
        EnableVMToEmail: !Ref EnableVMToEmail
      TemplateURL: !Join
        - ''
        - - https://
          - !Ref EXPDevBucketPrefix
          - vmx-source-
          - !Ref AWSRegion
          - .s3.
          - !Ref AWSRegion
          - .amazonaws.com/vmx3/
          - !Ref EXPTemplateVersion
          - /cloudformation/vmx3-core.yaml
      TimeoutInMinutes: 5

  VMXContactFlowStack:
    Type: AWS::CloudFormation::Stack
    DependsOn:
      - VMXCoreStack
    Properties:
      Parameters:
        EXPTemplateVersion: !Ref EXPTemplateVersion
        EXPDevBucketPrefix: !Ref EXPDevBucketPrefix
        AWSRegion: !Ref AWSRegion
        ConnectInstanceAlias: !Ref ConnectInstanceAlias
        ConnectInstanceARN: !Ref ConnectInstanceARN
        EnableVMToConnectTask: !Ref EnableVMToConnectTask
        EnableVMToConnectGuidedTask: !Ref EnableVMToConnectGuidedTask
        EnableVMToEmail: !Ref EnableVMToEmail
        VMToEmailDefaultFrom: !Ref VMToEmailDefaultFrom
        VMToEmailDefaultTo: !Ref VMToEmailDefaultTo
        VMTestAgentId: !Ref VMTestAgentId
        VMTestQueueARN: !Ref VMTestQueueARN
        VMXS3RecordingsBucket: !GetAtt VMXCoreStack.Outputs.VMXS3RecordingsBucket
        GuidedTaskRecordingLinksExpireInXMinutes: !Ref GuidedTaskRecordingLinksExpireInXMinutes
        VMXGuidedFlowPresignerRoleArn: !If
          - ConnectGuidedTasksEnabled
          - !GetAtt VMXCoreStack.Outputs.VMXGuidedFlowPresignerRoleArn
          - AWS::NoValue
        VMXGuidedFlowPresignerRole: !If
          - ConnectGuidedTasksEnabled
          - !GetAtt VMXCoreStack.Outputs.VMXGuidedFlowPresignerRole
          - AWS::NoValue
        LambdaLoggingLevel: !Ref LambdaLoggingLevel
      TemplateURL: !Join
        - ''
        - - https://
          - !Ref EXPDevBucketPrefix
          - vmx-source-
          - !Ref AWSRegion
          - .s3.
          - !Ref AWSRegion
          - .amazonaws.com/vmx3/
          - !Ref EXPTemplateVersion
          - /cloudformation/vmx3-contactflows.yaml
      TimeoutInMinutes: 5

  VMXSESSetupStack:
    Type: AWS::CloudFormation::Stack
    Condition: AWSEmailEnabled
    DependsOn:
      - VMXCoreStack
    Properties:
      Parameters:
        AWSRegion: !Ref AWSRegion
        ConnectInstanceAlias: !Ref ConnectInstanceAlias
        EXPDevBucketPrefix: !Ref EXPDevBucketPrefix
        EXPTemplateVersion: !Ref EXPTemplateVersion
        LambdaLoggingLevel: !Ref LambdaLoggingLevel
        VMXSESTemplateRoleArn: !GetAtt VMXCoreStack.Outputs.VMXSESTemplateRoleArn
      TemplateURL: !Join
        - ''
        - - https://
          - !Ref EXPDevBucketPrefix
          - vmx-source-
          - !Ref AWSRegion
          - .s3.
          - !Ref AWSRegion
          - .amazonaws.com/vmx3/
          - !Ref EXPTemplateVersion
          - /cloudformation/vmx3-ses-setup.yaml
      TimeoutInMinutes: 5

  VMXLambdaStack:
    Type: AWS::CloudFormation::Stack
    DependsOn:
      - VMXCoreStack
      - VMXContactFlowStack
    Properties:
      Parameters:
        EXPTemplateVersion: !Ref EXPTemplateVersion
        AWSRegion: !Ref AWSRegion
        ConnectInstanceAlias: !Ref ConnectInstanceAlias
        EnableVMToConnectTask: !Ref EnableVMToConnectTask
        EnableVMToConnectGuidedTask: !Ref EnableVMToConnectGuidedTask
        EnableVMToEmail: !Ref EnableVMToEmail
        EXPDevBucketPrefix: !Ref EXPDevBucketPrefix
        LambdaLoggingLevel: !Ref LambdaLoggingLevel
        RecordingsExpireInXDays: !Ref RecordingsExpireInXDays
        VMEmailDefaultAgentTemplate: !If
          - AWSEmailEnabled
          - !GetAtt VMXSESSetupStack.Outputs.VMEmailDefaultAgentTemplate
          - AWS::NoValue
        VMEmailDefaultQueueTemplate: !If
          - AWSEmailEnabled
          - !GetAtt VMXSESSetupStack.Outputs.VMEmailDefaultQueueTemplate
          - AWS::NoValue
        VMDefaultMode: !Ref VMDefaultMode
        VMToEmailDefaultFrom: !Ref VMToEmailDefaultFrom
        VMToEmailDefaultTo: !Ref VMToEmailDefaultTo
        VMXDefaultTaskFlow: !If
          - ConnectTasksEnabled
          - !GetAtt VMXContactFlowStack.Outputs.VMXExampleTaskFlowID
          - AWS::NoValue
        VMXDefaultGuidedTaskFlow: !If
          - ConnectGuidedTasksEnabled
          - !GetAtt VMXContactFlowStack.Outputs.VMXExampleGuidedTaskFlowID
          - AWS::NoValue
        VMXSecrets: !If
          - NonGuidedOptions
          - !GetAtt VMXCoreStack.Outputs.VMXSecrets
          - AWS::NoValue
        VMXS3RecordingsBucket: !GetAtt VMXCoreStack.Outputs.VMXS3RecordingsBucket
        VMXS3TranscriptsBucket: !GetAtt VMXCoreStack.Outputs.VMXS3TranscriptsBucket
        VMAgentAddressKey: !Ref VMAgentAddressKey
        VMXKVStoS3RoleArn: !GetAtt VMXCoreStack.Outputs.VMXKVStoS3RoleArn
        VMXKVStoS3Role: !GetAtt VMXCoreStack.Outputs.VMXKVStoS3Role
        VMXPackagerRoleArn: !GetAtt VMXCoreStack.Outputs.VMXPackagerRoleArn
        VMXPackagerRole: !GetAtt VMXCoreStack.Outputs.VMXPackagerRole
        VMXPresignerRole: !If
          - NonGuidedOptions
          - !GetAtt VMXCoreStack.Outputs.VMXPresignerRole
          - AWS::NoValue
        VMXPresignerRoleArn: !If
          - NonGuidedOptions
          - !GetAtt VMXCoreStack.Outputs.VMXPresignerRoleArn
          - AWS::NoValue
        VMXTranscriberRole: !GetAtt VMXCoreStack.Outputs.VMXTranscriberRole
        VMXTranscriberRoleArn: !GetAtt VMXCoreStack.Outputs.VMXTranscriberRoleArn
        VMXTranscriberErrorRole: !GetAtt VMXCoreStack.Outputs.VMXTranscriberErrorRole
        VMXTranscriberErrorRoleArn: !GetAtt VMXCoreStack.Outputs.VMXTranscriberErrorRoleArn
        TaskRecordingLinksExpireInXDays: !Ref TaskRecordingLinksExpireInXDays
        EmailRecordingLinksExpireInXDays: !Ref EmailRecordingLinksExpireInXDays
      TemplateURL: !Join
        - ''
        - - https://
          - !Ref EXPDevBucketPrefix
          - vmx-source-
          - !Ref AWSRegion
          - .s3.
          - !Ref AWSRegion
          - .amazonaws.com/vmx3/
          - !Ref EXPTemplateVersion
          - /cloudformation/vmx3-lambda-functions.yaml
      TimeoutInMinutes: 10

  VMXPolicyStack:
    Type: AWS::CloudFormation::Stack
    DependsOn:
      - VMXLambdaStack
    Properties:
      Parameters:
        ConnectInstanceAlias: !Ref ConnectInstanceAlias
        ConnectInstanceARN: !Ref ConnectInstanceARN
        VMXGuidedFlowPresignerRole: !If
          - ConnectGuidedTasksEnabled
          - !GetAtt VMXCoreStack.Outputs.VMXGuidedFlowPresignerRole
          - AWS::NoValue
        VMXKVStoS3Role: !GetAtt VMXCoreStack.Outputs.VMXKVStoS3Role
        VMXPackagerRole: !GetAtt VMXCoreStack.Outputs.VMXPackagerRole
        VMXPresignerRole: !If
          - NonGuidedOptions
          - !GetAtt VMXCoreStack.Outputs.VMXPresignerRole
          - AWS::NoValue
        VMXSESTemplateRole: !If
          - AWSEmailEnabled
          - !GetAtt VMXCoreStack.Outputs.VMXSESTemplateRole
          - AWS::NoValue
        VMXTranscriberRole: !GetAtt VMXCoreStack.Outputs.VMXTranscriberRole
        VMXTranscriberErrorRole: !GetAtt VMXCoreStack.Outputs.VMXTranscriberErrorRole
        VMXS3RecordingsBucketArn: !GetAtt VMXCoreStack.Outputs.VMXS3RecordingsBuckettArn
        VMXS3TranscriptsBucketArn: !GetAtt VMXCoreStack.Outputs.VMXS3TranscriptsBucketArn
        VMXKVSStreamPrefix: !Ref VMXKVSStreamPrefix
        ConnectCTRStreamARN: !Ref ConnectCTRStreamARN
        AWSRegion: !Ref AWSRegion
        VMXPresignerArn: !If
          - NonGuidedOptions
          - !GetAtt VMXLambdaStack.Outputs.VMXPresignerArn
          - AWS::NoValue
        EnableVMToEmail: !Ref EnableVMToEmail
        EnableVMToConnectTask: !Ref EnableVMToConnectTask
        EnableVMToConnectGuidedTask: !Ref EnableVMToConnectGuidedTask
      TemplateURL: !Join
        - ''
        - - https://
          - !Ref EXPDevBucketPrefix
          - vmx-source-
          - !Ref AWSRegion
          - .s3.
          - !Ref AWSRegion
          - .amazonaws.com/vmx3/
          - !Ref EXPTemplateVersion
          - /cloudformation/vmx3-policy-builder.yaml
      TimeoutInMinutes: 10

  VMXTriggersStack:
    Type: AWS::CloudFormation::Stack
    DependsOn:
      - VMXPolicyStack
    Properties:
      Parameters:
        ConnectInstanceARN: !Ref ConnectInstanceARN
        EXPTemplateVersion: !Ref EXPTemplateVersion
        ConnectCTRStreamARN: !Ref ConnectCTRStreamARN
        VMXS3RecordingsBucket: !GetAtt VMXCoreStack.Outputs.VMXS3RecordingsBucket
        VMXS3TranscriptsBucket: !GetAtt VMXCoreStack.Outputs.VMXS3TranscriptsBucket
        VMXS3RecordingsBucketArn: !GetAtt VMXCoreStack.Outputs.VMXS3RecordingsBuckettArn
        VMXPackagerArn: !GetAtt VMXLambdaStack.Outputs.VMXPackagerArn
        VMXS3TranscriptsBucketArn: !GetAtt VMXCoreStack.Outputs.VMXS3TranscriptsBucketArn
        VMXTranscriberArn: !GetAtt VMXLambdaStack.Outputs.VMXTranscriberArn
        VMXKVStoS3: !GetAtt VMXLambdaStack.Outputs.VMXKVStoS3
        ConnectInstanceAlias: !Ref ConnectInstanceAlias
        VMXTranscribeErrorArn: !GetAtt VMXLambdaStack.Outputs.VMXTranscribeErrorArn
        VMXGuidedFlowPresignerArn: !If
          - ConnectGuidedTasksEnabled
          - !GetAtt VMXContactFlowStack.Outputs.VMXGuidedFlowPresignerArn
          - AWS::NoValue
        EnableVMToConnectGuidedTask: !Ref EnableVMToConnectGuidedTask

      TemplateURL: !Join
        - ''
        - - https://
          - !Ref EXPDevBucketPrefix
          - vmx-source-
          - !Ref AWSRegion
          - .s3.
          - !Ref AWSRegion
          - .amazonaws.com/vmx3/
          - !Ref EXPTemplateVersion
          - /cloudformation/vmx3-triggers.yaml
      TimeoutInMinutes: 10