Package software.amazon.awscdk.services.connect

Class CfnQueue

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.connect.CfnQueue
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, IQueueRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:01.541Z") @Stability(Stable) public class CfnQueue extends CfnResource implements IInspectable, IQueueRef, ITaggableV2
Contains information about a queue.

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.*;
 CfnQueue cfnQueue = CfnQueue.Builder.create(this, "MyCfnQueue")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnQueue

      protected CfnQueue(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnQueue

      protected CfnQueue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnQueue

      @Stability(Stable) public CfnQueue(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnQueueProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrQueueArn

      @Stability(Stable) @NotNull public String getAttrQueueArn()
      The Amazon Resource Name (ARN) of the queue.

    • getAttrType

      @Stability(Stable) @NotNull public String getAttrType()
      The type of queue.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getQueueRef

      @Stability(Stable) @NotNull public QueueReference getQueueRef()
      A reference to a Queue resource.
      Specified by:
      getQueueRef in interface IQueueRef

    • getHoursOfOperationArn

      @Stability(Stable) @NotNull public String getHoursOfOperationArn()
      The Amazon Resource Name (ARN) of the hours of operation.

    • setHoursOfOperationArn

      @Stability(Stable) public void setHoursOfOperationArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the hours of operation.

    • getInstanceArn

      @Stability(Stable) @NotNull public String getInstanceArn()
      The identifier of the Amazon Connect instance.

    • setInstanceArn

      @Stability(Stable) public void setInstanceArn(@NotNull String value)
      The identifier of the Amazon Connect instance.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the queue.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the queue.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the queue.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the queue.

    • getMaxContacts

      @Stability(Stable) @Nullable public Number getMaxContacts()
      The maximum number of contacts that can be in the queue before it is considered full.

    • setMaxContacts

      @Stability(Stable) public void setMaxContacts(@Nullable Number value)
      The maximum number of contacts that can be in the queue before it is considered full.

    • getOutboundCallerConfig

      @Stability(Stable) @Nullable public Object getOutboundCallerConfig()
      The outbound caller ID name, number, and outbound whisper flow.

      Returns union: either IResolvable or CfnQueue.OutboundCallerConfigProperty

    • setOutboundCallerConfig

      @Stability(Stable) public void setOutboundCallerConfig(@Nullable IResolvable value)
      The outbound caller ID name, number, and outbound whisper flow.

    • setOutboundCallerConfig

      @Stability(Stable) public void setOutboundCallerConfig(@Nullable CfnQueue.OutboundCallerConfigProperty value)
      The outbound caller ID name, number, and outbound whisper flow.

    • getOutboundEmailConfig

      @Stability(Stable) @Nullable public Object getOutboundEmailConfig()
      The outbound email address ID for a specified queue.

      Returns union: either IResolvable or CfnQueue.OutboundEmailConfigProperty

    • setOutboundEmailConfig

      @Stability(Stable) public void setOutboundEmailConfig(@Nullable IResolvable value)
      The outbound email address ID for a specified queue.

    • setOutboundEmailConfig

      @Stability(Stable) public void setOutboundEmailConfig(@Nullable CfnQueue.OutboundEmailConfigProperty value)
      The outbound email address ID for a specified queue.

    • getQuickConnectArns

      @Stability(Stable) @Nullable public List<String> getQuickConnectArns()
      The Amazon Resource Names (ARN) of the of the quick connects available to agents who are working the queue.

    • setQuickConnectArns

      @Stability(Stable) public void setQuickConnectArns(@Nullable List<String> value)
      The Amazon Resource Names (ARN) of the of the quick connects available to agents who are working the queue.

    • getStatus

      @Stability(Stable) @Nullable public String getStatus()
      The status of the queue.

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable String value)
      The status of the queue.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags used to organize, track, or control access for this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags used to organize, track, or control access for this resource.