@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
103 lines (102 loc) • 2.89 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* 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.
*
* > **NOTE:** To use this data source, you must have the `sqs:GetQueueAttributes` and `sqs:GetQueueURL` permissions.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.sqs.getQueue({
* name: "queue",
* });
* ```
*/
export declare function getQueue(args: GetQueueArgs, opts?: pulumi.InvokeOptions): Promise<GetQueueResult>;
/**
* A collection of arguments for invoking getQueue.
*/
export interface GetQueueArgs {
/**
* Name of the queue to match.
*/
name: string;
/**
* 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.
*/
region?: string;
/**
* Map of tags for the resource.
*/
tags?: {
[key: string]: string;
};
}
/**
* A collection of values returned by getQueue.
*/
export interface GetQueueResult {
/**
* ARN of the queue.
*/
readonly arn: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly name: string;
readonly region: string;
/**
* Map of tags for the resource.
*/
readonly tags: {
[key: string]: string;
};
/**
* URL of the queue.
*/
readonly url: string;
}
/**
* 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.
*
* > **NOTE:** To use this data source, you must have the `sqs:GetQueueAttributes` and `sqs:GetQueueURL` permissions.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.sqs.getQueue({
* name: "queue",
* });
* ```
*/
export declare function getQueueOutput(args: GetQueueOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetQueueResult>;
/**
* A collection of arguments for invoking getQueue.
*/
export interface GetQueueOutputArgs {
/**
* Name of the queue to match.
*/
name: pulumi.Input<string>;
/**
* 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.
*/
region?: pulumi.Input<string>;
/**
* Map of tags for the resource.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}