Queue class
Provides an Amazon Connect Queue resource. For more information see Amazon Connect: Getting Started
Example Usage
Basic
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.connect.Queue("test", {
instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
name: "Example Name",
description: "Example Description",
hoursOfOperationId: "12345678-1234-1234-1234-123456789012",
tags: {
Name: "Example Queue",
},
});
import pulumi
import pulumi_aws as aws
test = aws.connect.Queue("test",
instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
name="Example Name",
description="Example Description",
hours_of_operation_id="12345678-1234-1234-1234-123456789012",
tags={
"Name": "Example Queue",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.Connect.Queue("test", new()
{
InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
Name = "Example Name",
Description = "Example Description",
HoursOfOperationId = "12345678-1234-1234-1234-123456789012",
Tags =
{
{ "Name", "Example Queue" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/connect"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := connect.NewQueue(ctx, "test", &connect.QueueArgs{
InstanceId: pulumi.String("aaaaaaaa-bbbb-cccc-dddd-111111111111"),
Name: pulumi.String("Example Name"),
Description: pulumi.String("Example Description"),
HoursOfOperationId: pulumi.String("12345678-1234-1234-1234-123456789012"),
Tags: pulumi.StringMap{
"Name": pulumi.String("Example Queue"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_connect_queue" "test" {
instance_id = "aaaaaaaa-bbbb-cccc-dddd-111111111111"
name = "Example Name"
description = "Example Description"
hours_of_operation_id = "12345678-1234-1234-1234-123456789012"
tags = {
"Name" = "Example Queue"
}
}
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());
}
}
resources:
test:
type: aws:connect:Queue
properties:
instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
name: Example Name
description: Example Description
hoursOfOperationId: 12345678-1234-1234-1234-123456789012
tags:
Name: Example Queue
With Quick Connect IDs
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.connect.Queue("test", {
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: {
Name: "Example Queue with Quick Connect IDs",
},
});
import pulumi
import pulumi_aws as aws
test = aws.connect.Queue("test",
instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
name="Example Name",
description="Example Description",
hours_of_operation_id="12345678-1234-1234-1234-123456789012",
quick_connect_ids=["12345678-abcd-1234-abcd-123456789012"],
tags={
"Name": "Example Queue with Quick Connect IDs",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.Connect.Queue("test", new()
{
InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
Name = "Example Name",
Description = "Example Description",
HoursOfOperationId = "12345678-1234-1234-1234-123456789012",
QuickConnectIds = new[]
{
"12345678-abcd-1234-abcd-123456789012",
},
Tags =
{
{ "Name", "Example Queue with Quick Connect IDs" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/connect"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := connect.NewQueue(ctx, "test", &connect.QueueArgs{
InstanceId: pulumi.String("aaaaaaaa-bbbb-cccc-dddd-111111111111"),
Name: pulumi.String("Example Name"),
Description: pulumi.String("Example Description"),
HoursOfOperationId: pulumi.String("12345678-1234-1234-1234-123456789012"),
QuickConnectIds: pulumi.StringArray{
pulumi.String("12345678-abcd-1234-abcd-123456789012"),
},
Tags: pulumi.StringMap{
"Name": pulumi.String("Example Queue with Quick Connect IDs"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_connect_queue" "test" {
instance_id = "aaaaaaaa-bbbb-cccc-dddd-111111111111"
name = "Example Name"
description = "Example Description"
hours_of_operation_id = "12345678-1234-1234-1234-123456789012"
quick_connect_ids = ["12345678-abcd-1234-abcd-123456789012"]
tags = {
"Name" = "Example Queue 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());
}
}
resources:
test:
type: aws:connect:Queue
properties:
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:
Name: Example Queue with Quick Connect IDs
With Outbound Caller Config
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.connect.Queue("test", {
outboundCallerConfig: {
outboundCallerIdName: "example",
outboundCallerIdNumberId: "12345678-abcd-1234-abcd-123456789012",
outboundFlowId: "87654321-defg-1234-defg-987654321234",
},
instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
name: "Example Name",
description: "Example Description",
hoursOfOperationId: "12345678-1234-1234-1234-123456789012",
tags: {
Name: "Example Queue with Outbound Caller Config",
},
});
import pulumi
import pulumi_aws as aws
test = aws.connect.Queue("test",
outbound_caller_config={
"outbound_caller_id_name": "example",
"outbound_caller_id_number_id": "12345678-abcd-1234-abcd-123456789012",
"outbound_flow_id": "87654321-defg-1234-defg-987654321234",
},
instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
name="Example Name",
description="Example Description",
hours_of_operation_id="12345678-1234-1234-1234-123456789012",
tags={
"Name": "Example Queue with Outbound Caller Config",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.Connect.Queue("test", new()
{
OutboundCallerConfig = new Aws.Connect.Inputs.QueueOutboundCallerConfigArgs
{
OutboundCallerIdName = "example",
OutboundCallerIdNumberId = "12345678-abcd-1234-abcd-123456789012",
OutboundFlowId = "87654321-defg-1234-defg-987654321234",
},
InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
Name = "Example Name",
Description = "Example Description",
HoursOfOperationId = "12345678-1234-1234-1234-123456789012",
Tags =
{
{ "Name", "Example Queue with Outbound Caller Config" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/connect"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := connect.NewQueue(ctx, "test", &connect.QueueArgs{
OutboundCallerConfig: &connect.QueueOutboundCallerConfigArgs{
OutboundCallerIdName: pulumi.String("example"),
OutboundCallerIdNumberId: pulumi.String("12345678-abcd-1234-abcd-123456789012"),
OutboundFlowId: pulumi.String("87654321-defg-1234-defg-987654321234"),
},
InstanceId: pulumi.String("aaaaaaaa-bbbb-cccc-dddd-111111111111"),
Name: pulumi.String("Example Name"),
Description: pulumi.String("Example Description"),
HoursOfOperationId: pulumi.String("12345678-1234-1234-1234-123456789012"),
Tags: pulumi.StringMap{
"Name": pulumi.String("Example Queue with Outbound Caller Config"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_connect_queue" "test" {
outbound_caller_config = {
outbound_caller_id_name = "example"
outbound_caller_id_number_id = "12345678-abcd-1234-abcd-123456789012"
outbound_flow_id = "87654321-defg-1234-defg-987654321234"
}
instance_id = "aaaaaaaa-bbbb-cccc-dddd-111111111111"
name = "Example Name"
description = "Example Description"
hours_of_operation_id = "12345678-1234-1234-1234-123456789012"
tags = {
"Name" = "Example Queue 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());
}
}
resources:
test:
type: aws:connect:Queue
properties:
outboundCallerConfig:
outboundCallerIdName: example
outboundCallerIdNumberId: 12345678-abcd-1234-abcd-123456789012
outboundFlowId: 87654321-defg-1234-defg-987654321234
instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
name: Example Name
description: Example Description
hoursOfOperationId: 12345678-1234-1234-1234-123456789012
tags:
Name: Example Queue with Outbound Caller Config
Import
Using pulumi import, import Amazon Connect Queues using the instanceId and queueId separated by a colon (:). For example:
$ pulumi import aws:connect/queue:Queue example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5
Constructors
- Queue(String name, {QueueArgs? args, CustomResourceOptions? options})
-
Creates a new Queue.
nameThe Pulumi resource name.argsArguments used to configure this Queue. The set of arguments for Queue.optionsResource options controlling this resource's behavior. - Queue.reference(String urn)
- Creates a typed reference to an existing Queue resource.
Properties
-
arn
↔ Output<
String> -
ARN of the Queue.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
description
↔ Output<
String?> -
Specifies the description of the Queue.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
hoursOfOperationId
↔ Output<
String> -
Specifies the identifier of the Hours of Operation.
latefinal
-
id
↔ Output<
String> -
getter/setter pairinherited
-
instanceId
↔ Output<
String> -
Specifies the identifier of the hosting Amazon Connect Instance.
latefinal
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
maxContacts
↔ Output<
int?> -
Specifies the maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
latefinal
-
name
↔ Output<
String> -
Specifies the name of the Queue.
latefinal
-
outboundCallerConfig
↔ Output<
QueueOutboundCallerConfig?> -
A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
latefinal
-
queueId
↔ Output<
String> -
The identifier for the Queue.
latefinal
-
quickConnectIds
↔ Output<
List< String> ?> -
Specifies a list of quick connects ids that determine the quick connects available to agents who are working the queue.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
status
↔ Output<
String> -
Specifies the description of the Queue. Valid values are
ENABLED,DISABLED.latefinal -
Tags to apply to the Queue. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited