Documentation
¶
Overview ¶
nolint: lll Package athena exports types, functions, subpackages for provisioning athena resources.
> This provider is a derived work of the [Terraform Provider](https://github.com/terraform-providers/terraform-provider-aws) > distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature, > first check the [`pulumi/pulumi-aws` repo](https://github.com/pulumi/pulumi-aws/issues); however, if that doesn't turn up anything, > please consult the source [`terraform-providers/terraform-provider-aws` repo](https://github.com/terraform-providers/terraform-provider-aws/issues).
Index ¶
- type Database
- type DatabaseArgs
- type DatabaseState
- type NamedQuery
- func (r *NamedQuery) Database() *pulumi.StringOutput
- func (r *NamedQuery) Description() *pulumi.StringOutput
- func (r *NamedQuery) ID() *pulumi.IDOutput
- func (r *NamedQuery) Name() *pulumi.StringOutput
- func (r *NamedQuery) Query() *pulumi.StringOutput
- func (r *NamedQuery) URN() *pulumi.URNOutput
- func (r *NamedQuery) Workgroup() *pulumi.StringOutput
- type NamedQueryArgs
- type NamedQueryState
- type Workgroup
- func (r *Workgroup) Arn() *pulumi.StringOutput
- func (r *Workgroup) Configuration() *pulumi.Output
- func (r *Workgroup) Description() *pulumi.StringOutput
- func (r *Workgroup) ID() *pulumi.IDOutput
- func (r *Workgroup) Name() *pulumi.StringOutput
- func (r *Workgroup) State() *pulumi.StringOutput
- func (r *Workgroup) Tags() *pulumi.MapOutput
- func (r *Workgroup) URN() *pulumi.URNOutput
- type WorkgroupArgs
- type WorkgroupState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Database ¶
type Database struct {
// contains filtered or unexported fields
}
Provides an Athena database.
> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/athena_database.html.markdown.
func GetDatabase ¶
func GetDatabase(ctx *pulumi.Context, name string, id pulumi.ID, state *DatabaseState, opts ...pulumi.ResourceOpt) (*Database, error)
GetDatabase gets an existing Database resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewDatabase ¶
func NewDatabase(ctx *pulumi.Context, name string, args *DatabaseArgs, opts ...pulumi.ResourceOpt) (*Database, error)
NewDatabase registers a new resource with the given unique name, arguments, and options.
func (*Database) Bucket ¶
func (r *Database) Bucket() *pulumi.StringOutput
Name of s3 bucket to save the results of the query execution.
func (*Database) EncryptionConfiguration ¶ added in v0.16.1
The encryption key block AWS Athena uses to decrypt the data in S3, such as an AWS Key Management Service (AWS KMS) key. An `encryption_configuration` block is documented below.
func (*Database) ForceDestroy ¶
func (r *Database) ForceDestroy() *pulumi.BoolOutput
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.
func (*Database) Name ¶
func (r *Database) Name() *pulumi.StringOutput
Name of the database to create.
type DatabaseArgs ¶
type DatabaseArgs struct { // Name of s3 bucket to save the results of the query execution. Bucket interface{} // The encryption key block AWS Athena uses to decrypt the data in S3, such as an AWS Key Management Service (AWS KMS) key. An `encryption_configuration` block is documented below. EncryptionConfiguration interface{} // 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. ForceDestroy interface{} // Name of the database to create. Name interface{} }
The set of arguments for constructing a Database resource.
type DatabaseState ¶
type DatabaseState struct { // Name of s3 bucket to save the results of the query execution. Bucket interface{} // The encryption key block AWS Athena uses to decrypt the data in S3, such as an AWS Key Management Service (AWS KMS) key. An `encryption_configuration` block is documented below. EncryptionConfiguration interface{} // 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. ForceDestroy interface{} // Name of the database to create. Name interface{} }
Input properties used for looking up and filtering Database resources.
type NamedQuery ¶
type NamedQuery struct {
// contains filtered or unexported fields
}
Provides an Athena Named Query resource.
> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/athena_named_query.html.markdown.
func GetNamedQuery ¶
func GetNamedQuery(ctx *pulumi.Context, name string, id pulumi.ID, state *NamedQueryState, opts ...pulumi.ResourceOpt) (*NamedQuery, error)
GetNamedQuery gets an existing NamedQuery resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewNamedQuery ¶
func NewNamedQuery(ctx *pulumi.Context, name string, args *NamedQueryArgs, opts ...pulumi.ResourceOpt) (*NamedQuery, error)
NewNamedQuery registers a new resource with the given unique name, arguments, and options.
func (*NamedQuery) Database ¶
func (r *NamedQuery) Database() *pulumi.StringOutput
The database to which the query belongs.
func (*NamedQuery) Description ¶
func (r *NamedQuery) Description() *pulumi.StringOutput
A brief explanation of the query. Maximum length of 1024.
func (*NamedQuery) ID ¶
func (r *NamedQuery) ID() *pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*NamedQuery) Name ¶
func (r *NamedQuery) Name() *pulumi.StringOutput
The plain language name for the query. Maximum length of 128.
func (*NamedQuery) Query ¶
func (r *NamedQuery) Query() *pulumi.StringOutput
The text of the query itself. In other words, all query statements. Maximum length of 262144.
func (*NamedQuery) URN ¶
func (r *NamedQuery) URN() *pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
func (*NamedQuery) Workgroup ¶ added in v0.18.22
func (r *NamedQuery) Workgroup() *pulumi.StringOutput
The workgroup to which the query belongs. Defaults to `primary`
type NamedQueryArgs ¶
type NamedQueryArgs struct { // The database to which the query belongs. Database interface{} // A brief explanation of the query. Maximum length of 1024. Description interface{} // The plain language name for the query. Maximum length of 128. Name interface{} // The text of the query itself. In other words, all query statements. Maximum length of 262144. Query interface{} // The workgroup to which the query belongs. Defaults to `primary` Workgroup interface{} }
The set of arguments for constructing a NamedQuery resource.
type NamedQueryState ¶
type NamedQueryState struct { // The database to which the query belongs. Database interface{} // A brief explanation of the query. Maximum length of 1024. Description interface{} // The plain language name for the query. Maximum length of 128. Name interface{} // The text of the query itself. In other words, all query statements. Maximum length of 262144. Query interface{} // The workgroup to which the query belongs. Defaults to `primary` Workgroup interface{} }
Input properties used for looking up and filtering NamedQuery resources.
type Workgroup ¶ added in v0.18.21
type Workgroup struct {
// contains filtered or unexported fields
}
Provides an Athena Workgroup.
> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/athena_workgroup.html.markdown.
func GetWorkgroup ¶ added in v0.18.21
func GetWorkgroup(ctx *pulumi.Context, name string, id pulumi.ID, state *WorkgroupState, opts ...pulumi.ResourceOpt) (*Workgroup, error)
GetWorkgroup gets an existing Workgroup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewWorkgroup ¶ added in v0.18.21
func NewWorkgroup(ctx *pulumi.Context, name string, args *WorkgroupArgs, opts ...pulumi.ResourceOpt) (*Workgroup, error)
NewWorkgroup registers a new resource with the given unique name, arguments, and options.
func (*Workgroup) Arn ¶ added in v0.18.21
func (r *Workgroup) Arn() *pulumi.StringOutput
Amazon Resource Name (ARN) of the workgroup
func (*Workgroup) Configuration ¶ added in v0.18.21
Configuration block with various settings for the workgroup. Documented below.
func (*Workgroup) Description ¶ added in v0.18.21
func (r *Workgroup) Description() *pulumi.StringOutput
Description of the workgroup.
func (*Workgroup) ID ¶ added in v0.18.21
ID is this resource's unique identifier assigned by its provider.
func (*Workgroup) Name ¶ added in v0.18.21
func (r *Workgroup) Name() *pulumi.StringOutput
Name of the workgroup.
func (*Workgroup) State ¶ added in v0.18.21
func (r *Workgroup) State() *pulumi.StringOutput
State of the workgroup. Valid values are `DISABLED` or `ENABLED`. Defaults to `ENABLED`.
type WorkgroupArgs ¶ added in v0.18.21
type WorkgroupArgs struct { // Configuration block with various settings for the workgroup. Documented below. Configuration interface{} // Description of the workgroup. Description interface{} // Name of the workgroup. Name interface{} // State of the workgroup. Valid values are `DISABLED` or `ENABLED`. Defaults to `ENABLED`. State interface{} // Key-value mapping of resource tags for the workgroup. Tags interface{} }
The set of arguments for constructing a Workgroup resource.
type WorkgroupState ¶ added in v0.18.21
type WorkgroupState struct { // Amazon Resource Name (ARN) of the workgroup Arn interface{} // Configuration block with various settings for the workgroup. Documented below. Configuration interface{} // Description of the workgroup. Description interface{} // Name of the workgroup. Name interface{} // State of the workgroup. Valid values are `DISABLED` or `ENABLED`. Defaults to `ENABLED`. State interface{} // Key-value mapping of resource tags for the workgroup. Tags interface{} }
Input properties used for looking up and filtering Workgroup resources.