Interface CfnQueueProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnQueueProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-05-15T23:29:00.442Z")
@Stability(Stable)
public interface CfnQueueProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnQueue.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.connect.*;
 CfnQueueProps cfnQueueProps = CfnQueueProps.builder()
         .hoursOfOperationArn("hoursOfOperationArn")
         .instanceArn("instanceArn")
         .name("name")
         // the properties below are optional
         .description("description")
         .maxContacts(123)
         .outboundCallerConfig(OutboundCallerConfigProperty.builder()
                 .outboundCallerIdName("outboundCallerIdName")
                 .outboundCallerIdNumberArn("outboundCallerIdNumberArn")
                 .outboundFlowArn("outboundFlowArn")
                 .build())
         .outboundEmailConfig(OutboundEmailConfigProperty.builder()
                 .outboundEmailAddressId("outboundEmailAddressId")
                 .build())
         .quickConnectArns(List.of("quickConnectArns"))
         .status("status")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-queue.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnQueueProps.Builder	A builder for CfnQueueProps
static final class	CfnQueueProps.Jsii$Proxy	An implementation for CfnQueueProps

Method Summary

Modifier and Type	Method	Description
static CfnQueueProps.Builder	builder()
default String	getDescription()	The description of the queue.
String	getHoursOfOperationArn()	The Amazon Resource Name (ARN) of the hours of operation.
String	getInstanceArn()	The identifier of the Amazon Connect instance.
default Number	getMaxContacts()	The maximum number of contacts that can be in the queue before it is considered full.
String	getName()	The name of the queue.
default Object	getOutboundCallerConfig()	The outbound caller ID name, number, and outbound whisper flow.
default Object	getOutboundEmailConfig()	The outbound email address ID for a specified queue.
default List<String>	getQuickConnectArns()	The Amazon Resource Names (ARN) of the of the quick connects available to agents who are working the queue.
default String	getStatus()	The status of the queue.
default List<CfnTag>	getTags()	The tags used to organize, track, or control access for this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHoursOfOperationArn

@Stability(Stable)
@NotNull
String getHoursOfOperationArn()

The Amazon Resource Name (ARN) of the hours of operation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-queue.html#cfn-connect-queue-hoursofoperationarn

getInstanceArn

@Stability(Stable)
@NotNull
String getInstanceArn()

The identifier of the Amazon Connect instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-queue.html#cfn-connect-queue-instancearn

getName

@Stability(Stable)
@NotNull
String getName()

The name of the queue.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-queue.html#cfn-connect-queue-name

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the queue.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-queue.html#cfn-connect-queue-description

getMaxContacts

@Stability(Stable)
@Nullable
default Number getMaxContacts()

The maximum number of contacts that can be in the queue before it is considered full.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-queue.html#cfn-connect-queue-maxcontacts

getOutboundCallerConfig

@Stability(Stable)
@Nullable
default Object getOutboundCallerConfig()

The outbound caller ID name, number, and outbound whisper flow.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-queue.html#cfn-connect-queue-outboundcallerconfig

getOutboundEmailConfig

@Stability(Stable)
@Nullable
default Object getOutboundEmailConfig()

The outbound email address ID for a specified queue.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-queue.html#cfn-connect-queue-outboundemailconfig

getQuickConnectArns

@Stability(Stable)
@Nullable
default List<String> getQuickConnectArns()

The Amazon Resource Names (ARN) of the of the quick connects available to agents who are working the queue.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-queue.html#cfn-connect-queue-quickconnectarns

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

The status of the queue.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-queue.html#cfn-connect-queue-status

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags used to organize, track, or control access for this resource.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-queue.html#cfn-connect-queue-tags

builder

@Stability(Stable)
static CfnQueueProps.Builder builder()

Returns:

a CfnQueueProps.Builder of CfnQueueProps