@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
77 lines (76 loc) • 2.37 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Data source for managing an AWS SQS (Simple Queue) Queues.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.sqs.getQueues({
* queueNamePrefix: "example",
* });
* ```
*/
export declare function getQueues(args?: GetQueuesArgs, opts?: pulumi.InvokeOptions): Promise<GetQueuesResult>;
/**
* A collection of arguments for invoking getQueues.
*/
export interface GetQueuesArgs {
/**
* A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned. Queue URLs and names are case-sensitive.
*/
queueNamePrefix?: 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;
}
/**
* A collection of values returned by getQueues.
*/
export interface GetQueuesResult {
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly queueNamePrefix?: string;
/**
* A list of queue URLs.
*/
readonly queueUrls: string[];
readonly region: string;
}
/**
* Data source for managing an AWS SQS (Simple Queue) Queues.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.sqs.getQueues({
* queueNamePrefix: "example",
* });
* ```
*/
export declare function getQueuesOutput(args?: GetQueuesOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetQueuesResult>;
/**
* A collection of arguments for invoking getQueues.
*/
export interface GetQueuesOutputArgs {
/**
* A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned. Queue URLs and names are case-sensitive.
*/
queueNamePrefix?: 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>;
}