Fork me on GitHub

Module athena

@pulumi/aws > athena

Index

athena/database.ts athena/namedQuery.ts

class Database

Provides an Athena database.

constructor

new Database(name: string, args: DatabaseArgs, opts?: pulumi.CustomResourceOptions)

Create a Database resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DatabaseState): Database

Get an existing Database resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property bucket

public bucket: pulumi.Output<string>;

Name of s3 bucket to save the results of the query execution.

property forceDestroy

public forceDestroy: pulumi.Output<boolean | undefined>;

A boolean that indicates all tables should be deleted from the database so that the database can be destroyed without error. The tables are not recoverable.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Name of the database to create.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class NamedQuery

Provides an Athena Named Query resource.

constructor

new NamedQuery(name: string, args: NamedQueryArgs, opts?: pulumi.CustomResourceOptions)

Create a NamedQuery resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NamedQueryState): NamedQuery

Get an existing NamedQuery resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property database

public database: pulumi.Output<string>;

The database to which the query belongs.

property description

public description: pulumi.Output<string | undefined>;

A brief explanation of the query. Maximum length of 1024.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The plain language name for the query. Maximum length of 128.

property query

public query: pulumi.Output<string>;

The text of the query itself. In other words, all query statements. Maximum length of 262144.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

interface DatabaseArgs

The set of arguments for constructing a Database resource.

property bucket

bucket: pulumi.Input<string>;

Name of s3 bucket to save the results of the query execution.

property forceDestroy

forceDestroy?: pulumi.Input<boolean>;

A boolean that indicates all tables should be deleted from the database so that the database can be destroyed without error. The tables are not recoverable.

property name

name?: pulumi.Input<string>;

Name of the database to create.

interface DatabaseState

Input properties used for looking up and filtering Database resources.

property bucket

bucket?: pulumi.Input<string>;

Name of s3 bucket to save the results of the query execution.

property forceDestroy

forceDestroy?: pulumi.Input<boolean>;

A boolean that indicates all tables should be deleted from the database so that the database can be destroyed without error. The tables are not recoverable.

property name

name?: pulumi.Input<string>;

Name of the database to create.

interface NamedQueryArgs

The set of arguments for constructing a NamedQuery resource.

property database

database: pulumi.Input<string>;

The database to which the query belongs.

property description

description?: pulumi.Input<string>;

A brief explanation of the query. Maximum length of 1024.

property name

name?: pulumi.Input<string>;

The plain language name for the query. Maximum length of 128.

property query

query: pulumi.Input<string>;

The text of the query itself. In other words, all query statements. Maximum length of 262144.

interface NamedQueryState

Input properties used for looking up and filtering NamedQuery resources.

property database

database?: pulumi.Input<string>;

The database to which the query belongs.

property description

description?: pulumi.Input<string>;

A brief explanation of the query. Maximum length of 1024.

property name

name?: pulumi.Input<string>;

The plain language name for the query. Maximum length of 128.

property query

query?: pulumi.Input<string>;

The text of the query itself. In other words, all query statements. Maximum length of 262144.