1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. connect
  5. Queue

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.connect.Queue

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Resource Type definition for AWS::Connect::Queue

Create Queue Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Queue(name: string, args: QueueArgs, opts?: CustomResourceOptions);
@overload
def Queue(resource_name: str,
          args: QueueArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Queue(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          hours_of_operation_arn: Optional[str] = None,
          instance_arn: Optional[str] = None,
          description: Optional[str] = None,
          max_contacts: Optional[int] = None,
          name: Optional[str] = None,
          outbound_caller_config: Optional[QueueOutboundCallerConfigArgs] = None,
          outbound_email_config: Optional[QueueOutboundEmailConfigArgs] = None,
          quick_connect_arns: Optional[Sequence[str]] = None,
          status: Optional[QueueStatus] = None,
          tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewQueue(ctx *Context, name string, args QueueArgs, opts ...ResourceOption) (*Queue, error)
public Queue(string name, QueueArgs args, CustomResourceOptions? opts = null)
public Queue(String name, QueueArgs args)
public Queue(String name, QueueArgs args, CustomResourceOptions options)
type: aws-native:connect:Queue
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. QueueArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. QueueArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. QueueArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. QueueArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. QueueArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Queue Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Queue resource accepts the following input properties:

HoursOfOperationArn This property is required. string
The identifier for the hours of operation.
InstanceArn This property is required. string
The identifier of the Amazon Connect instance.
Description string
The description of the queue.
MaxContacts int
The maximum number of contacts that can be in the queue before it is considered full.
Name string
The name of the queue.
OutboundCallerConfig Pulumi.AwsNative.Connect.Inputs.QueueOutboundCallerConfig
The outbound caller ID name, number, and outbound whisper flow.
OutboundEmailConfig Pulumi.AwsNative.Connect.Inputs.QueueOutboundEmailConfig
The outbound email address ID.
QuickConnectArns List<string>
The quick connects available to agents who are working the queue.
Status Pulumi.AwsNative.Connect.QueueStatus
The status of the queue.
Tags List<Pulumi.AwsNative.Inputs.Tag>
An array of key-value pairs to apply to this resource.
HoursOfOperationArn This property is required. string
The identifier for the hours of operation.
InstanceArn This property is required. string
The identifier of the Amazon Connect instance.
Description string
The description of the queue.
MaxContacts int
The maximum number of contacts that can be in the queue before it is considered full.
Name string
The name of the queue.
OutboundCallerConfig QueueOutboundCallerConfigArgs
The outbound caller ID name, number, and outbound whisper flow.
OutboundEmailConfig QueueOutboundEmailConfigArgs
The outbound email address ID.
QuickConnectArns []string
The quick connects available to agents who are working the queue.
Status QueueStatus
The status of the queue.
Tags TagArgs
An array of key-value pairs to apply to this resource.
hoursOfOperationArn This property is required. String
The identifier for the hours of operation.
instanceArn This property is required. String
The identifier of the Amazon Connect instance.
description String
The description of the queue.
maxContacts Integer
The maximum number of contacts that can be in the queue before it is considered full.
name String
The name of the queue.
outboundCallerConfig QueueOutboundCallerConfig
The outbound caller ID name, number, and outbound whisper flow.
outboundEmailConfig QueueOutboundEmailConfig
The outbound email address ID.
quickConnectArns List<String>
The quick connects available to agents who are working the queue.
status QueueStatus
The status of the queue.
tags List<Tag>
An array of key-value pairs to apply to this resource.
hoursOfOperationArn This property is required. string
The identifier for the hours of operation.
instanceArn This property is required. string
The identifier of the Amazon Connect instance.
description string
The description of the queue.
maxContacts number
The maximum number of contacts that can be in the queue before it is considered full.
name string
The name of the queue.
outboundCallerConfig QueueOutboundCallerConfig
The outbound caller ID name, number, and outbound whisper flow.
outboundEmailConfig QueueOutboundEmailConfig
The outbound email address ID.
quickConnectArns string[]
The quick connects available to agents who are working the queue.
status QueueStatus
The status of the queue.
tags Tag[]
An array of key-value pairs to apply to this resource.
hours_of_operation_arn This property is required. str
The identifier for the hours of operation.
instance_arn This property is required. str
The identifier of the Amazon Connect instance.
description str
The description of the queue.
max_contacts int
The maximum number of contacts that can be in the queue before it is considered full.
name str
The name of the queue.
outbound_caller_config QueueOutboundCallerConfigArgs
The outbound caller ID name, number, and outbound whisper flow.
outbound_email_config QueueOutboundEmailConfigArgs
The outbound email address ID.
quick_connect_arns Sequence[str]
The quick connects available to agents who are working the queue.
status QueueStatus
The status of the queue.
tags Sequence[TagArgs]
An array of key-value pairs to apply to this resource.
hoursOfOperationArn This property is required. String
The identifier for the hours of operation.
instanceArn This property is required. String
The identifier of the Amazon Connect instance.
description String
The description of the queue.
maxContacts Number
The maximum number of contacts that can be in the queue before it is considered full.
name String
The name of the queue.
outboundCallerConfig Property Map
The outbound caller ID name, number, and outbound whisper flow.
outboundEmailConfig Property Map
The outbound email address ID.
quickConnectArns List<String>
The quick connects available to agents who are working the queue.
status "ENABLED" | "DISABLED"
The status of the queue.
tags List<Property Map>
An array of key-value pairs to apply to this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Queue resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
QueueArn string
The Amazon Resource Name (ARN) for the queue.
Type Pulumi.AwsNative.Connect.QueueType
The type of queue.
Id string
The provider-assigned unique ID for this managed resource.
QueueArn string
The Amazon Resource Name (ARN) for the queue.
Type QueueType
The type of queue.
id String
The provider-assigned unique ID for this managed resource.
queueArn String
The Amazon Resource Name (ARN) for the queue.
type QueueType
The type of queue.
id string
The provider-assigned unique ID for this managed resource.
queueArn string
The Amazon Resource Name (ARN) for the queue.
type QueueType
The type of queue.
id str
The provider-assigned unique ID for this managed resource.
queue_arn str
The Amazon Resource Name (ARN) for the queue.
type QueueType
The type of queue.
id String
The provider-assigned unique ID for this managed resource.
queueArn String
The Amazon Resource Name (ARN) for the queue.
type "STANDARD" | "AGENT"
The type of queue.

Supporting Types

QueueOutboundCallerConfig
, QueueOutboundCallerConfigArgs

OutboundCallerIdName string
The caller ID name.
OutboundCallerIdNumberArn string

The Amazon Resource Name (ARN) of the outbound caller ID number.

Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid . This is the same ARN format that is returned when you create a phone number using CloudFormation , or when you call the ListPhoneNumbersV2 API.

OutboundFlowArn string
The Amazon Resource Name (ARN) of the outbound flow.
OutboundCallerIdName string
The caller ID name.
OutboundCallerIdNumberArn string

The Amazon Resource Name (ARN) of the outbound caller ID number.

Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid . This is the same ARN format that is returned when you create a phone number using CloudFormation , or when you call the ListPhoneNumbersV2 API.

OutboundFlowArn string
The Amazon Resource Name (ARN) of the outbound flow.
outboundCallerIdName String
The caller ID name.
outboundCallerIdNumberArn String

The Amazon Resource Name (ARN) of the outbound caller ID number.

Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid . This is the same ARN format that is returned when you create a phone number using CloudFormation , or when you call the ListPhoneNumbersV2 API.

outboundFlowArn String
The Amazon Resource Name (ARN) of the outbound flow.
outboundCallerIdName string
The caller ID name.
outboundCallerIdNumberArn string

The Amazon Resource Name (ARN) of the outbound caller ID number.

Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid . This is the same ARN format that is returned when you create a phone number using CloudFormation , or when you call the ListPhoneNumbersV2 API.

outboundFlowArn string
The Amazon Resource Name (ARN) of the outbound flow.
outbound_caller_id_name str
The caller ID name.
outbound_caller_id_number_arn str

The Amazon Resource Name (ARN) of the outbound caller ID number.

Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid . This is the same ARN format that is returned when you create a phone number using CloudFormation , or when you call the ListPhoneNumbersV2 API.

outbound_flow_arn str
The Amazon Resource Name (ARN) of the outbound flow.
outboundCallerIdName String
The caller ID name.
outboundCallerIdNumberArn String

The Amazon Resource Name (ARN) of the outbound caller ID number.

Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid . This is the same ARN format that is returned when you create a phone number using CloudFormation , or when you call the ListPhoneNumbersV2 API.

outboundFlowArn String
The Amazon Resource Name (ARN) of the outbound flow.

QueueOutboundEmailConfig
, QueueOutboundEmailConfigArgs

OutboundEmailAddressId string
The identifier of the email address.
OutboundEmailAddressId string
The identifier of the email address.
outboundEmailAddressId String
The identifier of the email address.
outboundEmailAddressId string
The identifier of the email address.
outbound_email_address_id str
The identifier of the email address.
outboundEmailAddressId String
The identifier of the email address.

QueueStatus
, QueueStatusArgs

Enabled
ENABLED
Disabled
DISABLED
QueueStatusEnabled
ENABLED
QueueStatusDisabled
DISABLED
Enabled
ENABLED
Disabled
DISABLED
Enabled
ENABLED
Disabled
DISABLED
ENABLED
ENABLED
DISABLED
DISABLED
"ENABLED"
ENABLED
"DISABLED"
DISABLED

QueueType
, QueueTypeArgs

Standard
STANDARD
Agent
AGENT
QueueTypeStandard
STANDARD
QueueTypeAgent
AGENT
Standard
STANDARD
Agent
AGENT
Standard
STANDARD
Agent
AGENT
STANDARD
STANDARD
AGENT
AGENT
"STANDARD"
STANDARD
"AGENT"
AGENT

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi