@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
105 lines (104 loc) • 3.24 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides the aliases, ARNs, and workspace IDs of Amazon Prometheus workspaces.
*
* ## Example Usage
*
* The following example returns all of the workspaces in a region:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.amp.getWorkspaces({});
* ```
*
* The following example filters the workspaces by alias. Only the workspaces with
* aliases that begin with the value of `aliasPrefix` will be returned:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.amp.getWorkspaces({
* aliasPrefix: "example",
* });
* ```
*/
export declare function getWorkspaces(args?: GetWorkspacesArgs, opts?: pulumi.InvokeOptions): Promise<GetWorkspacesResult>;
/**
* A collection of arguments for invoking getWorkspaces.
*/
export interface GetWorkspacesArgs {
/**
* Limits results to workspaces with aliases that begin with this value.
*/
aliasPrefix?: 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 getWorkspaces.
*/
export interface GetWorkspacesResult {
readonly aliasPrefix?: string;
/**
* List of aliases of the matched Prometheus workspaces.
*/
readonly aliases: string[];
/**
* List of ARNs of the matched Prometheus workspaces.
*/
readonly arns: string[];
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly region: string;
/**
* List of workspace IDs of the matched Prometheus workspaces.
*/
readonly workspaceIds: string[];
}
/**
* Provides the aliases, ARNs, and workspace IDs of Amazon Prometheus workspaces.
*
* ## Example Usage
*
* The following example returns all of the workspaces in a region:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.amp.getWorkspaces({});
* ```
*
* The following example filters the workspaces by alias. Only the workspaces with
* aliases that begin with the value of `aliasPrefix` will be returned:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.amp.getWorkspaces({
* aliasPrefix: "example",
* });
* ```
*/
export declare function getWorkspacesOutput(args?: GetWorkspacesOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetWorkspacesResult>;
/**
* A collection of arguments for invoking getWorkspaces.
*/
export interface GetWorkspacesOutputArgs {
/**
* Limits results to workspaces with aliases that begin with this value.
*/
aliasPrefix?: 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>;
}