Package com.pulumi.aws.connect

Class Queue

  • public class Queue
extends com.pulumi.resources.CustomResource
    Provides an Amazon Connect Queue resource. For more information see [Amazon Connect: Getting Started](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-get-started.html) ## Example Usage ### Basic 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.connect.Queue;
 import com.pulumi.aws.connect.QueueArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var test = new Queue("test", QueueArgs.builder()
             .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
             .name("Example Name")
             .description("Example Description")
             .hoursOfOperationId("12345678-1234-1234-1234-123456789012")
             .tags(Map.of("Name", "Example Queue"))
             .build());
 
     }
 }
    ### With Quick Connect IDs 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.connect.Queue;
 import com.pulumi.aws.connect.QueueArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var test = new Queue("test", QueueArgs.builder()
             .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
             .name("Example Name")
             .description("Example Description")
             .hoursOfOperationId("12345678-1234-1234-1234-123456789012")
             .quickConnectIds("12345678-abcd-1234-abcd-123456789012")
             .tags(Map.of("Name", "Example Queue with Quick Connect IDs"))
             .build());
 
     }
 }
    ### With Outbound Caller Config 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.connect.Queue;
 import com.pulumi.aws.connect.QueueArgs;
 import com.pulumi.aws.connect.inputs.QueueOutboundCallerConfigArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var test = new Queue("test", QueueArgs.builder()
             .outboundCallerConfig(QueueOutboundCallerConfigArgs.builder()
                 .outboundCallerIdName("example")
                 .outboundCallerIdNumberId("12345678-abcd-1234-abcd-123456789012")
                 .outboundFlowId("87654321-defg-1234-defg-987654321234")
                 .build())
             .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
             .name("Example Name")
             .description("Example Description")
             .hoursOfOperationId("12345678-1234-1234-1234-123456789012")
             .tags(Map.of("Name", "Example Queue with Outbound Caller Config"))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Amazon Connect Queues using the `instanceId` and `queueId` separated by a colon (`:`). For example: ```sh $ pulumi import aws:connect/queue:Queue example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Queue​(java.lang.String name)  
      Queue​(java.lang.String name, QueueArgs args)  
      Queue​(java.lang.String name, QueueArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static Queue get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, QueueState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> hoursOfOperationId()  
      com.pulumi.core.Output<java.lang.String> instanceId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> maxContacts()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.util.Optional<QueueOutboundCallerConfig>> outboundCallerConfig()  
      com.pulumi.core.Output<java.lang.String> queueId()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> quickConnectIds()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> status()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Queue

        public Queue​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Queue

        public Queue​(java.lang.String name,
             QueueArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Queue

        public Queue​(java.lang.String name,
             QueueArgs args,
             @Nullable
             com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the Queue.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Specifies the description of the Queue.

      • hoursOfOperationId

        public com.pulumi.core.Output<java.lang.String> hoursOfOperationId()
        Returns:
        Specifies the identifier of the Hours of Operation.

      • instanceId

        public com.pulumi.core.Output<java.lang.String> instanceId()
        Returns:
        Specifies the identifier of the hosting Amazon Connect Instance.

      • maxContacts

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> maxContacts()
        Returns:
        Specifies the maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Specifies the name of the Queue.

      • outboundCallerConfig

        public com.pulumi.core.Output<java.util.Optional<QueueOutboundCallerConfig>> outboundCallerConfig()
        Returns:
        A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.

      • queueId

        public com.pulumi.core.Output<java.lang.String> queueId()
        Returns:
        The identifier for the Queue.

      • quickConnectIds

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> quickConnectIds()
        Returns:
        Specifies a list of quick connects IDs that determine the quick connects available to agents who are working the queue.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Specifies the description of the Queue. Valid values are `ENABLED`, `DISABLED`.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Tags to apply to the Queue. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static Queue get​(java.lang.String name,
                        com.pulumi.core.Output<java.lang.String> id,
                        @Nullable
                        QueueState state,
                        @Nullable
                        com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.