getQueue

Use this data source to get the ARN and URL of queue in AWS Simple Queue Service (SQS). By using this data source, you can reference SQS queues without having to hardcode the ARNs as input.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Aws.Sqs.GetQueue.InvokeAsync(new Aws.Sqs.GetQueueArgs
        {
            Name = "queue",
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/sqs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sqs.LookupQueue(ctx, &sqs.LookupQueueArgs{
			Name: "queue",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_aws as aws

example = aws.sqs.get_queue(name="queue")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = pulumi.output(aws.sqs.getQueue({
    name: "queue",
}, { async: true }));

Using getQueue

function getQueue(args: GetQueueArgs, opts?: InvokeOptions): Promise<GetQueueResult>
def get_queue(name: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None,
              opts: Optional[InvokeOptions] = None) -> GetQueueResult
func LookupQueue(ctx *Context, args *LookupQueueArgs, opts ...InvokeOption) (*LookupQueueResult, error)

Note: This function is named LookupQueue in the Go SDK.

public static class GetQueue {
    public static Task<GetQueueResult> InvokeAsync(GetQueueArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string
The name of the queue to match.
Tags Dictionary<string, string>
A map of tags for the resource.
Name string
The name of the queue to match.
Tags map[string]string
A map of tags for the resource.
name string
The name of the queue to match.
tags {[key: string]: string}
A map of tags for the resource.
name str
The name of the queue to match.
tags Mapping[str, str]
A map of tags for the resource.

getQueue Result

The following output properties are available:

Arn string
The Amazon Resource Name (ARN) of the queue.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Tags Dictionary<string, string>
A map of tags for the resource.
Url string
The URL of the queue.
Arn string
The Amazon Resource Name (ARN) of the queue.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Tags map[string]string
A map of tags for the resource.
Url string
The URL of the queue.
arn string
The Amazon Resource Name (ARN) of the queue.
id string
The provider-assigned unique ID for this managed resource.
name string
tags {[key: string]: string}
A map of tags for the resource.
url string
The URL of the queue.
arn str
The Amazon Resource Name (ARN) of the queue.
id str
The provider-assigned unique ID for this managed resource.
name str
tags Mapping[str, str]
A map of tags for the resource.
url str
The URL of the queue.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.