Contains information about a queue.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::Connect::Queue",
"Properties" : {
"Description" : String
,
"HoursOfOperationArn" : String
,
"InstanceArn" : String
,
"MaxContacts" : Integer
,
"Name" : String
,
"OutboundCallerConfig" : OutboundCallerConfig
,
"OutboundEmailConfig" : OutboundEmailConfig
,
"QuickConnectArns" : [ String, ... ]
,
"Status" : String
,
"Tags" : [ Tag, ... ]
}
}
YAML
Type: AWS::Connect::Queue
Properties:
Description: String
HoursOfOperationArn: String
InstanceArn: String
MaxContacts: Integer
Name: String
OutboundCallerConfig:
OutboundCallerConfig
OutboundEmailConfig:
OutboundEmailConfig
QuickConnectArns:
- String
Status: String
Tags:
- Tag
Properties
Description
-
The description of the queue.
Required: No
Type: String
Minimum:
1
Maximum:
250
Update requires: No interruption
HoursOfOperationArn
-
The Amazon Resource Name (ARN) of the hours of operation.
Required: Yes
Type: String
Pattern:
^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/operating-hours/[-a-zA-Z0-9]*$
Update requires: No interruption
InstanceArn
-
The identifier of the Amazon Connect instance.
Required: Yes
Type: String
Pattern:
^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$
Update requires: No interruption
MaxContacts
-
The maximum number of contacts that can be in the queue before it is considered full.
Required: No
Type: Integer
Minimum:
0
Update requires: No interruption
Name
-
The name of the queue.
Required: Yes
Type: String
Minimum:
1
Maximum:
127
Update requires: No interruption
OutboundCallerConfig
-
The outbound caller ID name, number, and outbound whisper flow.
Required: No
Type: OutboundCallerConfig
Update requires: No interruption
OutboundEmailConfig
-
The outbound email address ID for a specified queue.
Required: No
Type: OutboundEmailConfig
Update requires: No interruption
QuickConnectArns
-
The Amazon Resource Names (ARN) of the of the quick connects available to agents who are working the queue.
Required: No
Type: Array of String
Minimum:
1
Update requires: No interruption
Status
-
The status of the queue.
Required: No
Type: String
Allowed values:
ENABLED | DISABLED
Update requires: No interruption
-
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Required: No
Type: Array of Tag
Maximum:
50
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the queue name. For example:
{ "Ref": "myQueueName" }
For more information about using the Ref
function, see Ref
.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt
.
QueueArn
-
The Amazon Resource Name (ARN) of the queue.
Type
-
The type of queue.