UNPKG

@pulumi/aws

Version:

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

87 lines (86 loc) 2.51 kB
import * as pulumi from "@pulumi/pulumi"; /** * Provides an Athena Named Query data source. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.athena.getNamedQuery({ * name: "athenaQueryName", * }); * ``` */ export declare function getNamedQuery(args: GetNamedQueryArgs, opts?: pulumi.InvokeOptions): Promise<GetNamedQueryResult>; /** * A collection of arguments for invoking getNamedQuery. */ export interface GetNamedQueryArgs { /** * The plain language name for the query. Maximum length of 128. */ 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; /** * The workgroup to which the query belongs. Defaults to `primary`. */ workgroup?: string; } /** * A collection of values returned by getNamedQuery. */ export interface GetNamedQueryResult { /** * Database to which the query belongs. */ readonly database: string; /** * Brief explanation of the query. */ readonly description: string; /** * The provider-assigned unique ID for this managed resource. */ readonly id: string; readonly name: string; readonly querystring: string; readonly region: string; readonly workgroup?: string; } /** * Provides an Athena Named Query data source. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.athena.getNamedQuery({ * name: "athenaQueryName", * }); * ``` */ export declare function getNamedQueryOutput(args: GetNamedQueryOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetNamedQueryResult>; /** * A collection of arguments for invoking getNamedQuery. */ export interface GetNamedQueryOutputArgs { /** * The plain language name for the query. Maximum length of 128. */ 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>; /** * The workgroup to which the query belongs. Defaults to `primary`. */ workgroup?: pulumi.Input<string>; }