Resource: awsConnectQueue
Provides an Amazon Connect Queue resource. For more information see Amazon Connect: Getting Started
\~> NOTE: Due to The behaviour of Amazon Connect you cannot delete queues.
Example Usage
Basic
/*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.connectQueue.ConnectQueue(this, "test", {
description: "Example Description",
hoursOfOperationId: "12345678-1234-1234-1234-123456789012",
instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
name: "Example Name",
tags: {
Name: "Example Queue",
},
});
With Quick Connect IDs
/*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.connectQueue.ConnectQueue(this, "test", {
description: "Example Description",
hoursOfOperationId: "12345678-1234-1234-1234-123456789012",
instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
name: "Example Name",
quickConnectIds: ["12345678-abcd-1234-abcd-123456789012"],
tags: {
Name: "Example Queue with Quick Connect IDs",
},
});
With Outbound Caller Config
/*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.connectQueue.ConnectQueue(this, "test", {
description: "Example Description",
hoursOfOperationId: "12345678-1234-1234-1234-123456789012",
instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
name: "Example Name",
outboundCallerConfig: {
outboundCallerIdName: "example",
outboundCallerIdNumberId: "12345678-abcd-1234-abcd-123456789012",
outboundFlowId: "87654321-defg-1234-defg-987654321234",
},
tags: {
Name: "Example Queue with Outbound Caller Config",
},
});
Argument Reference
The following arguments are supported:
description
- (Optional) Specifies the description of the Queue.hoursOfOperationId
- (Required) Specifies the identifier of the Hours of Operation.instanceId
- (Required) Specifies the identifier of the hosting Amazon Connect Instance.maxContacts
- (Optional) Specifies the maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.name
- (Required) Specifies the name of the Queue.outboundCallerConfig
- (Required) A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.quickConnectIds
- (Optional) Specifies a list of quick connects ids that determine the quick connects available to agents who are working the queue.status
- (Optional) Specifies the description of the Queue. Valid values areenabled
,disabled
.tags
- (Optional) Tags to apply to the Queue. If configured with a providerdefaultTags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
A outboundCallerConfig
block supports the following arguments:
outboundCallerIdName
- (Optional) Specifies the caller ID name.outboundCallerIdNumberId
- (Optional) Specifies the caller ID number.outboundFlowId
- (Optional) Specifies outbound whisper flow to be used during an outbound call.
Attributes Reference
In addition to all arguments above, the following attributes are exported:
arn
- The Amazon Resource Name (ARN) of the Queue.queueId
- The identifier for the Queue.id
- The identifier of the hosting Amazon Connect Instance and identifier of the Queue separated by a colon (:
).tagsAll
- A map of tags assigned to the resource, including those inherited from the providerdefaultTags
configuration block.
Import
Amazon Connect Queues can be imported using the instanceId
and queueId
separated by a colon (:
), e.g.,