Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. connect
  5. Queue
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.connect.Queue

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    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",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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
	})
}

    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 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.List;
import java.util.ArrayList;
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",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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
	})
}

    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 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.List;
import java.util.ArrayList;
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", {
    instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    name: "Example Name",
    description: "Example Description",
    hoursOfOperationId: "12345678-1234-1234-1234-123456789012",
    outboundCallerConfig: {
        outboundCallerIdName: "example",
        outboundCallerIdNumberId: "12345678-abcd-1234-abcd-123456789012",
        outboundFlowId: "87654321-defg-1234-defg-987654321234",
    },
    tags: {
        Name: "Example Queue with Outbound Caller Config",
    },
});

    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",
    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",
    },
    tags={
        "Name": "Example Queue with Outbound Caller Config",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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"),
			OutboundCallerConfig: &connect.QueueOutboundCallerConfigArgs{
				OutboundCallerIdName:     pulumi.String("example"),
				OutboundCallerIdNumberId: pulumi.String("12345678-abcd-1234-abcd-123456789012"),
				OutboundFlowId:           pulumi.String("87654321-defg-1234-defg-987654321234"),
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Example Queue with Outbound Caller Config"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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",
        OutboundCallerConfig = new Aws.Connect.Inputs.QueueOutboundCallerConfigArgs
        {
            OutboundCallerIdName = "example",
            OutboundCallerIdNumberId = "12345678-abcd-1234-abcd-123456789012",
            OutboundFlowId = "87654321-defg-1234-defg-987654321234",
        },
        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.List;
import java.util.ArrayList;
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")
            .outboundCallerConfig(QueueOutboundCallerConfigArgs.builder()
                .outboundCallerIdName("example")
                .outboundCallerIdNumberId("12345678-abcd-1234-abcd-123456789012")
                .outboundFlowId("87654321-defg-1234-defg-987654321234")
                .build())
            .tags(Map.of("Name", "Example Queue with Outbound Caller Config"))
            .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
      outboundCallerConfig:
        outboundCallerIdName: example
        outboundCallerIdNumberId: 12345678-abcd-1234-abcd-123456789012
        outboundFlowId: 87654321-defg-1234-defg-987654321234
      tags:
        Name: Example Queue with Outbound Caller Config

    Create Queue Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Queue(name: string, args: QueueArgs, opts?: CustomResourceOptions);
    @overload
def Queue(resource_name: str,
          args: QueueArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Queue(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          hours_of_operation_id: Optional[str] = None,
          instance_id: Optional[str] = None,
          description: Optional[str] = None,
          max_contacts: Optional[int] = None,
          name: Optional[str] = None,
          outbound_caller_config: Optional[QueueOutboundCallerConfigArgs] = None,
          quick_connect_ids: Optional[Sequence[str]] = None,
          status: Optional[str] = None,
          tags: Optional[Mapping[str, str]] = None)
    func NewQueue(ctx *Context, name string, args QueueArgs, opts ...ResourceOption) (*Queue, error)
    public Queue(string name, QueueArgs args, CustomResourceOptions? opts = null)
    public Queue(String name, QueueArgs args)
public Queue(String name, QueueArgs args, CustomResourceOptions options)

    type: aws:connect:Queue
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args QueueArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args QueueArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args QueueArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args QueueArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args QueueArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var queueResource = new Aws.Connect.Queue("queueResource", new()
{
    HoursOfOperationId = "string",
    InstanceId = "string",
    Description = "string",
    MaxContacts = 0,
    Name = "string",
    OutboundCallerConfig = new Aws.Connect.Inputs.QueueOutboundCallerConfigArgs
    {
        OutboundCallerIdName = "string",
        OutboundCallerIdNumberId = "string",
        OutboundFlowId = "string",
    },
    QuickConnectIds = new[]
    {
        "string",
    },
    Status = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := connect.NewQueue(ctx, "queueResource", &connect.QueueArgs{
	HoursOfOperationId: pulumi.String("string"),
	InstanceId:         pulumi.String("string"),
	Description:        pulumi.String("string"),
	MaxContacts:        pulumi.Int(0),
	Name:               pulumi.String("string"),
	OutboundCallerConfig: &connect.QueueOutboundCallerConfigArgs{
		OutboundCallerIdName:     pulumi.String("string"),
		OutboundCallerIdNumberId: pulumi.String("string"),
		OutboundFlowId:           pulumi.String("string"),
	},
	QuickConnectIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Status: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var queueResource = new Queue("queueResource", QueueArgs.builder()
    .hoursOfOperationId("string")
    .instanceId("string")
    .description("string")
    .maxContacts(0)
    .name("string")
    .outboundCallerConfig(QueueOutboundCallerConfigArgs.builder()
        .outboundCallerIdName("string")
        .outboundCallerIdNumberId("string")
        .outboundFlowId("string")
        .build())
    .quickConnectIds("string")
    .status("string")
    .tags(Map.of("string", "string"))
    .build());

    queue_resource = aws.connect.Queue("queueResource",
    hours_of_operation_id="string",
    instance_id="string",
    description="string",
    max_contacts=0,
    name="string",
    outbound_caller_config={
        "outboundCallerIdName": "string",
        "outboundCallerIdNumberId": "string",
        "outboundFlowId": "string",
    },
    quick_connect_ids=["string"],
    status="string",
    tags={
        "string": "string",
    })

    const queueResource = new aws.connect.Queue("queueResource", {
    hoursOfOperationId: "string",
    instanceId: "string",
    description: "string",
    maxContacts: 0,
    name: "string",
    outboundCallerConfig: {
        outboundCallerIdName: "string",
        outboundCallerIdNumberId: "string",
        outboundFlowId: "string",
    },
    quickConnectIds: ["string"],
    status: "string",
    tags: {
        string: "string",
    },
});

    type: aws:connect:Queue
properties:
    description: string
    hoursOfOperationId: string
    instanceId: string
    maxContacts: 0
    name: string
    outboundCallerConfig:
        outboundCallerIdName: string
        outboundCallerIdNumberId: string
        outboundFlowId: string
    quickConnectIds:
        - string
    status: string
    tags:
        string: string

    Queue Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Queue resource accepts the following input properties:

    HoursOfOperationId string
    Specifies the identifier of the Hours of Operation.
    InstanceId string
    Specifies the identifier of the hosting Amazon Connect Instance.
    Description string
    Specifies the description of the Queue.
    MaxContacts int
    Specifies the maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
    Name string
    Specifies the name of the Queue.
    OutboundCallerConfig QueueOutboundCallerConfig
    A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
    QuickConnectIds List<string>
    Specifies a list of quick connects ids that determine the quick connects available to agents who are working the queue.
    Status string
    Specifies the description of the Queue. Valid values are ENABLED, DISABLED.
    Tags Dictionary<string, string>
    Tags to apply to the Queue. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    HoursOfOperationId string
    Specifies the identifier of the Hours of Operation.
    InstanceId string
    Specifies the identifier of the hosting Amazon Connect Instance.
    Description string
    Specifies the description of the Queue.
    MaxContacts int
    Specifies the maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
    Name string
    Specifies the name of the Queue.
    OutboundCallerConfig QueueOutboundCallerConfigArgs
    A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
    QuickConnectIds []string
    Specifies a list of quick connects ids that determine the quick connects available to agents who are working the queue.
    Status string
    Specifies the description of the Queue. Valid values are ENABLED, DISABLED.
    Tags map[string]string
    Tags to apply to the Queue. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    hoursOfOperationId String
    Specifies the identifier of the Hours of Operation.
    instanceId String
    Specifies the identifier of the hosting Amazon Connect Instance.
    description String
    Specifies the description of the Queue.
    maxContacts Integer
    Specifies the maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
    name String
    Specifies the name of the Queue.
    outboundCallerConfig QueueOutboundCallerConfig
    A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
    quickConnectIds List<String>
    Specifies a list of quick connects ids that determine the quick connects available to agents who are working the queue.
    status String
    Specifies the description of the Queue. Valid values are ENABLED, DISABLED.
    tags Map<String,String>
    Tags to apply to the Queue. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    hoursOfOperationId string
    Specifies the identifier of the Hours of Operation.
    instanceId string
    Specifies the identifier of the hosting Amazon Connect Instance.
    description string
    Specifies the description of the Queue.
    maxContacts number
    Specifies the maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
    name string
    Specifies the name of the Queue.
    outboundCallerConfig QueueOutboundCallerConfig
    A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
    quickConnectIds string[]
    Specifies a list of quick connects ids that determine the quick connects available to agents who are working the queue.
    status string
    Specifies the description of the Queue. Valid values are ENABLED, DISABLED.
    tags {[key: string]: string}
    Tags to apply to the Queue. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    hours_of_operation_id str
    Specifies the identifier of the Hours of Operation.
    instance_id str
    Specifies the identifier of the hosting Amazon Connect Instance.
    description str
    Specifies the description of the Queue.
    max_contacts int
    Specifies the maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
    name str
    Specifies the name of the Queue.
    outbound_caller_config QueueOutboundCallerConfigArgs
    A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
    quick_connect_ids Sequence[str]
    Specifies a list of quick connects ids that determine the quick connects available to agents who are working the queue.
    status str
    Specifies the description of the Queue. Valid values are ENABLED, DISABLED.
    tags Mapping[str, str]
    Tags to apply to the Queue. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    hoursOfOperationId String
    Specifies the identifier of the Hours of Operation.
    instanceId String
    Specifies the identifier of the hosting Amazon Connect Instance.
    description String
    Specifies the description of the Queue.
    maxContacts Number
    Specifies the maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
    name String
    Specifies the name of the Queue.
    outboundCallerConfig Property Map
    A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
    quickConnectIds List<String>
    Specifies a list of quick connects ids that determine the quick connects available to agents who are working the queue.
    status String
    Specifies the description of the Queue. Valid values are ENABLED, DISABLED.
    tags Map<String>
    Tags to apply to the Queue. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Queue resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the Queue.
    Id string
    The provider-assigned unique ID for this managed resource.
    QueueId string
    The identifier for the Queue.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) of the Queue.
    Id string
    The provider-assigned unique ID for this managed resource.
    QueueId string
    The identifier for the Queue.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) of the Queue.
    id String
    The provider-assigned unique ID for this managed resource.
    queueId String
    The identifier for the Queue.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) of the Queue.
    id string
    The provider-assigned unique ID for this managed resource.
    queueId string
    The identifier for the Queue.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) of the Queue.
    id str
    The provider-assigned unique ID for this managed resource.
    queue_id str
    The identifier for the Queue.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) of the Queue.
    id String
    The provider-assigned unique ID for this managed resource.
    queueId String
    The identifier for the Queue.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Queue Resource

    Get an existing Queue resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: QueueState, opts?: CustomResourceOptions): Queue
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        hours_of_operation_id: Optional[str] = None,
        instance_id: Optional[str] = None,
        max_contacts: Optional[int] = None,
        name: Optional[str] = None,
        outbound_caller_config: Optional[QueueOutboundCallerConfigArgs] = None,
        queue_id: Optional[str] = None,
        quick_connect_ids: Optional[Sequence[str]] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Queue
    func GetQueue(ctx *Context, name string, id IDInput, state *QueueState, opts ...ResourceOption) (*Queue, error)
    public static Queue Get(string name, Input<string> id, QueueState? state, CustomResourceOptions? opts = null)
    public static Queue get(String name, Output<String> id, QueueState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The Amazon Resource Name (ARN) of the Queue.
    Description string
    Specifies the description of the Queue.
    HoursOfOperationId string
    Specifies the identifier of the Hours of Operation.
    InstanceId string
    Specifies the identifier of the hosting Amazon Connect Instance.
    MaxContacts int
    Specifies the maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
    Name string
    Specifies the name of the Queue.
    OutboundCallerConfig QueueOutboundCallerConfig
    A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
    QueueId string
    The identifier for the Queue.
    QuickConnectIds List<string>
    Specifies a list of quick connects ids that determine the quick connects available to agents who are working the queue.
    Status string
    Specifies the description of the Queue. Valid values are ENABLED, DISABLED.
    Tags Dictionary<string, string>
    Tags to apply to the Queue. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) of the Queue.
    Description string
    Specifies the description of the Queue.
    HoursOfOperationId string
    Specifies the identifier of the Hours of Operation.
    InstanceId string
    Specifies the identifier of the hosting Amazon Connect Instance.
    MaxContacts int
    Specifies the maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
    Name string
    Specifies the name of the Queue.
    OutboundCallerConfig QueueOutboundCallerConfigArgs
    A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
    QueueId string
    The identifier for the Queue.
    QuickConnectIds []string
    Specifies a list of quick connects ids that determine the quick connects available to agents who are working the queue.
    Status string
    Specifies the description of the Queue. Valid values are ENABLED, DISABLED.
    Tags map[string]string
    Tags to apply to the Queue. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) of the Queue.
    description String
    Specifies the description of the Queue.
    hoursOfOperationId String
    Specifies the identifier of the Hours of Operation.
    instanceId String
    Specifies the identifier of the hosting Amazon Connect Instance.
    maxContacts Integer
    Specifies the maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
    name String
    Specifies the name of the Queue.
    outboundCallerConfig QueueOutboundCallerConfig
    A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
    queueId String
    The identifier for the Queue.
    quickConnectIds List<String>
    Specifies a list of quick connects ids that determine the quick connects available to agents who are working the queue.
    status String
    Specifies the description of the Queue. Valid values are ENABLED, DISABLED.
    tags Map<String,String>
    Tags to apply to the Queue. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) of the Queue.
    description string
    Specifies the description of the Queue.
    hoursOfOperationId string
    Specifies the identifier of the Hours of Operation.
    instanceId string
    Specifies the identifier of the hosting Amazon Connect Instance.
    maxContacts number
    Specifies the maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
    name string
    Specifies the name of the Queue.
    outboundCallerConfig QueueOutboundCallerConfig
    A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
    queueId string
    The identifier for the Queue.
    quickConnectIds string[]
    Specifies a list of quick connects ids that determine the quick connects available to agents who are working the queue.
    status string
    Specifies the description of the Queue. Valid values are ENABLED, DISABLED.
    tags {[key: string]: string}
    Tags to apply to the Queue. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) of the Queue.
    description str
    Specifies the description of the Queue.
    hours_of_operation_id str
    Specifies the identifier of the Hours of Operation.
    instance_id str
    Specifies the identifier of the hosting Amazon Connect Instance.
    max_contacts int
    Specifies the maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
    name str
    Specifies the name of the Queue.
    outbound_caller_config QueueOutboundCallerConfigArgs
    A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
    queue_id str
    The identifier for the Queue.
    quick_connect_ids Sequence[str]
    Specifies a list of quick connects ids that determine the quick connects available to agents who are working the queue.
    status str
    Specifies the description of the Queue. Valid values are ENABLED, DISABLED.
    tags Mapping[str, str]
    Tags to apply to the Queue. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) of the Queue.
    description String
    Specifies the description of the Queue.
    hoursOfOperationId String
    Specifies the identifier of the Hours of Operation.
    instanceId String
    Specifies the identifier of the hosting Amazon Connect Instance.
    maxContacts Number
    Specifies the maximum number of contacts that can be in the queue before it is considered full. Minimum value of 0.
    name String
    Specifies the name of the Queue.
    outboundCallerConfig Property Map
    A block that defines the outbound caller ID name, number, and outbound whisper flow. The Outbound Caller Config block is documented below.
    queueId String
    The identifier for the Queue.
    quickConnectIds List<String>
    Specifies a list of quick connects ids that determine the quick connects available to agents who are working the queue.
    status String
    Specifies the description of the Queue. Valid values are ENABLED, DISABLED.
    tags Map<String>
    Tags to apply to the Queue. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    QueueOutboundCallerConfig, QueueOutboundCallerConfigArgs

    OutboundCallerIdName string
    Specifies the caller ID name.
    OutboundCallerIdNumberId string
    Specifies the caller ID number.
    OutboundFlowId string
    Specifies outbound whisper flow to be used during an outbound call.
    OutboundCallerIdName string
    Specifies the caller ID name.
    OutboundCallerIdNumberId string
    Specifies the caller ID number.
    OutboundFlowId string
    Specifies outbound whisper flow to be used during an outbound call.
    outboundCallerIdName String
    Specifies the caller ID name.
    outboundCallerIdNumberId String
    Specifies the caller ID number.
    outboundFlowId String
    Specifies outbound whisper flow to be used during an outbound call.
    outboundCallerIdName string
    Specifies the caller ID name.
    outboundCallerIdNumberId string
    Specifies the caller ID number.
    outboundFlowId string
    Specifies outbound whisper flow to be used during an outbound call.
    outbound_caller_id_name str
    Specifies the caller ID name.
    outbound_caller_id_number_id str
    Specifies the caller ID number.
    outbound_flow_id str
    Specifies outbound whisper flow to be used during an outbound call.
    outboundCallerIdName String
    Specifies the caller ID name.
    outboundCallerIdNumberId String
    Specifies the caller ID number.
    outboundFlowId String
    Specifies outbound whisper flow to be used during an outbound call.

    Import

    Using pulumi import, import Amazon Connect Queues using the instance_id and queue_id separated by a colon (:). For example:

    $ pulumi import aws:connect/queue:Queue example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws