AWS CDK Reference

Appearance

v2.274.0

CfnQueueProps Struct ​

Properties for defining a CfnQueue.

Source
Generated code
Type last changed
v2.245.0 · 27 Mar 2026

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_connect as connect } from 'aws-cdk-lib';
const cfnQueueProps: connect.CfnQueueProps = {
  hoursOfOperationArn: 'hoursOfOperationArn',
  instanceArn: 'instanceArn',
  name: 'name',

  // the properties below are optional
  additionalEmailAddresses: [{
    emailAddressArn: 'emailAddressArn',
  }],
  description: 'description',
  maxContacts: 123,
  outboundCallerConfig: {
    outboundCallerIdName: 'outboundCallerIdName',
    outboundCallerIdNumberArn: 'outboundCallerIdNumberArn',
    outboundFlowArn: 'outboundFlowArn',
  },
  outboundEmailConfig: {
    outboundEmailAddressId: 'outboundEmailAddressId',
  },
  quickConnectArns: ['quickConnectArns'],
  status: 'status',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

additionalEmailAddressesIResolvable | IResolvable | CfnQueue.EmailAddressProperty[]additional_email_addressestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, EmailAddressProperty]]]additionalEmailAddressesIResolvableAdditionalEmailAddressesIResolvableAdditionalEmailAddressesinterface{}#
The email addresses that agents can use when replying to or initiating email contacts.
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#
The description of the queue.
hoursOfOperationArnstringhours_of_operation_arnstrhoursOfOperationArnStringHoursOfOperationArnstringHoursOfOperationArn*stringrequired#
The Amazon Resource Name (ARN) of the hours of operation.
instanceArnstring | IInstanceRefinstance_arntyping.Union[str, IInstanceRef]instanceArnStringInstanceArnstringInstanceArninterface{}required#
The identifier of the Connect Customer instance.
maxContactsnumbermax_contactsint | floatmaxContactsNumberMaxContactsdoubleMaxContacts*float64#
The maximum number of contacts that can be in the queue before it is considered full.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the queue.
outboundCallerConfigIResolvable | CfnQueue.OutboundCallerConfigPropertyoutbound_caller_configtyping.Union[IResolvable, OutboundCallerConfigProperty]outboundCallerConfigIResolvableOutboundCallerConfigIResolvableOutboundCallerConfiginterface{}#
The outbound caller ID name, number, and outbound whisper flow.
outboundEmailConfigIResolvable | CfnQueue.OutboundEmailConfigPropertyoutbound_email_configtyping.Union[IResolvable, OutboundEmailConfigProperty]outboundEmailConfigIResolvableOutboundEmailConfigIResolvableOutboundEmailConfiginterface{}#
The outbound email address ID for a specified queue.
quickConnectArnsstring[]quick_connect_arnstyping.List[str]quickConnectArnsList<String>QuickConnectArnsstring[]QuickConnectArns*[]*string#
The Amazon Resource Names (ARN) of the of the quick connects available to agents who are working the queue.
statusstringstatusstrstatusStringStatusstringStatus*string#
The status of the queue.
tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
The tags used to organize, track, or control access for this resource.

For example, { "Tags": {"key1":"value1", "key2":"value2"} }.