Skip to content

Resource: awsConnectQuickConnect

Provides an Amazon Connect Quick Connect resource. For more information see Amazon Connect: Getting Started

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.connectQuickConnect.ConnectQuickConnect(this, "test", {
  description: "quick connect phone number",
  instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
  name: "Example Name",
  quickConnectConfig: {
    phoneConfig: [
      {
        phoneNumber: "+12345678912",
      },
    ],
    quickConnectType: "PHONE_NUMBER",
  },
  tags: {
    Name: "Example Quick Connect",
  },
});

Argument Reference

The following arguments are supported:

  • description - (Optional) Specifies the description of the Quick Connect.
  • instanceId - (Required) Specifies the identifier of the hosting Amazon Connect Instance.
  • name - (Required) Specifies the name of the Quick Connect.
  • quickConnectConfig - (Required) A block that defines the configuration information for the Quick Connect: quickConnectType and one of phoneConfig, queueConfig, userConfig . The Quick Connect Config block is documented below.
  • tags - (Optional) Tags to apply to the Quick Connect. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

A quickConnectConfig block supports the following arguments:

  • quickConnectType - (Required) Specifies the configuration type of the quick connect. valid values are PHONE_NUMBER, queue, user.
  • phoneConfig - (Optional) Specifies the phone configuration of the Quick Connect. This is required only if quickConnectType is PHONE_NUMBER. The phoneConfig block is documented below.
  • queueConfig - (Optional) Specifies the queue configuration of the Quick Connect. This is required only if quickConnectType is queue. The queueConfig block is documented below.
  • userConfig - (Optional) Specifies the user configuration of the Quick Connect. This is required only if quickConnectType is user. The userConfig block is documented below.

A phoneConfig block supports the following arguments:

  • phoneNumber - (Required) Specifies the phone number in in E.164 format.

A queueConfig block supports the following arguments:

  • contactFlowId - (Required) Specifies the identifier of the contact flow.
  • queueId - (Required) Specifies the identifier for the queue.

A userConfig block supports the following arguments:

  • contactFlowId - (Required) Specifies the identifier of the contact flow.
  • userId - (Required) Specifies the identifier for the user.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • arn - The Amazon Resource Name (ARN) of the Quick Connect.
  • quickConnectId - The identifier for the Quick Connect.
  • id - The identifier of the hosting Amazon Connect Instance and identifier of the Quick Connect separated by a colon (:).
  • tagsAll - A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

Import

Amazon Connect Quick Connects can be imported using the instanceId and quickConnectId separated by a colon (:), e.g.,

$ terraform import aws_connect_quick_connect.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5