athena

package
v6.42.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 29, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DataCatalog

type DataCatalog struct {
	pulumi.CustomResourceState

	// ARN of the data catalog.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// Description of the data catalog.
	Description pulumi.StringOutput `pulumi:"description"`
	// Name of the data catalog. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
	Name pulumi.StringOutput `pulumi:"name"`
	// Key value pairs that specifies the Lambda function or functions to use for the data catalog. The mapping used depends on the catalog type.
	Parameters pulumi.StringMapOutput `pulumi:"parameters"`
	// Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
	// Type of data catalog: `LAMBDA` for a federated catalog, `GLUE` for AWS Glue Catalog, or `HIVE` for an external hive metastore.
	Type pulumi.StringOutput `pulumi:"type"`
}

Provides an Athena data catalog.

More information about Athena and Athena data catalogs can be found in the [Athena User Guide](https://docs.aws.amazon.com/athena/latest/ug/what-is.html).

> **Tip:** for a more detailed explanation on the usage of `parameters`, see the [DataCatalog API documentation](https://docs.aws.amazon.com/athena/latest/APIReference/API_DataCatalog.html)

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/athena"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := athena.NewDataCatalog(ctx, "example", &athena.DataCatalogArgs{
			Name:        pulumi.String("athena-data-catalog"),
			Description: pulumi.String("Example Athena data catalog"),
			Type:        pulumi.String("LAMBDA"),
			Parameters: pulumi.StringMap{
				"function": pulumi.String("arn:aws:lambda:eu-central-1:123456789012:function:not-important-lambda-function"),
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("example-athena-data-catalog"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

### Hive based Data Catalog

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/athena"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := athena.NewDataCatalog(ctx, "example", &athena.DataCatalogArgs{
			Name:        pulumi.String("hive-data-catalog"),
			Description: pulumi.String("Hive based Data Catalog"),
			Type:        pulumi.String("HIVE"),
			Parameters: pulumi.StringMap{
				"metadata-function": pulumi.String("arn:aws:lambda:eu-central-1:123456789012:function:not-important-lambda-function"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

### Glue based Data Catalog

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/athena"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := athena.NewDataCatalog(ctx, "example", &athena.DataCatalogArgs{
			Name:        pulumi.String("glue-data-catalog"),
			Description: pulumi.String("Glue based Data Catalog"),
			Type:        pulumi.String("GLUE"),
			Parameters: pulumi.StringMap{
				"catalog-id": pulumi.String("123456789012"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

### Lambda based Data Catalog

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/athena"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := athena.NewDataCatalog(ctx, "example", &athena.DataCatalogArgs{
			Name:        pulumi.String("lambda-data-catalog"),
			Description: pulumi.String("Lambda based Data Catalog"),
			Type:        pulumi.String("LAMBDA"),
			Parameters: pulumi.StringMap{
				"metadata-function": pulumi.String("arn:aws:lambda:eu-central-1:123456789012:function:not-important-lambda-function-1"),
				"record-function":   pulumi.String("arn:aws:lambda:eu-central-1:123456789012:function:not-important-lambda-function-2"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Using `pulumi import`, import data catalogs using their `name`. For example:

```sh $ pulumi import aws:athena/dataCatalog:DataCatalog example example-data-catalog ```

func GetDataCatalog

func GetDataCatalog(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DataCatalogState, opts ...pulumi.ResourceOption) (*DataCatalog, error)

GetDataCatalog gets an existing DataCatalog 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 NewDataCatalog

func NewDataCatalog(ctx *pulumi.Context,
	name string, args *DataCatalogArgs, opts ...pulumi.ResourceOption) (*DataCatalog, error)

NewDataCatalog registers a new resource with the given unique name, arguments, and options.

func (*DataCatalog) ElementType

func (*DataCatalog) ElementType() reflect.Type

func (*DataCatalog) ToDataCatalogOutput

func (i *DataCatalog) ToDataCatalogOutput() DataCatalogOutput

func (*DataCatalog) ToDataCatalogOutputWithContext

func (i *DataCatalog) ToDataCatalogOutputWithContext(ctx context.Context) DataCatalogOutput

type DataCatalogArgs

type DataCatalogArgs struct {
	// Description of the data catalog.
	Description pulumi.StringInput
	// Name of the data catalog. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
	Name pulumi.StringPtrInput
	// Key value pairs that specifies the Lambda function or functions to use for the data catalog. The mapping used depends on the catalog type.
	Parameters pulumi.StringMapInput
	// Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
	// Type of data catalog: `LAMBDA` for a federated catalog, `GLUE` for AWS Glue Catalog, or `HIVE` for an external hive metastore.
	Type pulumi.StringInput
}

The set of arguments for constructing a DataCatalog resource.

func (DataCatalogArgs) ElementType

func (DataCatalogArgs) ElementType() reflect.Type

type DataCatalogArray

type DataCatalogArray []DataCatalogInput

func (DataCatalogArray) ElementType

func (DataCatalogArray) ElementType() reflect.Type

func (DataCatalogArray) ToDataCatalogArrayOutput

func (i DataCatalogArray) ToDataCatalogArrayOutput() DataCatalogArrayOutput

func (DataCatalogArray) ToDataCatalogArrayOutputWithContext

func (i DataCatalogArray) ToDataCatalogArrayOutputWithContext(ctx context.Context) DataCatalogArrayOutput

type DataCatalogArrayInput

type DataCatalogArrayInput interface {
	pulumi.Input

	ToDataCatalogArrayOutput() DataCatalogArrayOutput
	ToDataCatalogArrayOutputWithContext(context.Context) DataCatalogArrayOutput
}

DataCatalogArrayInput is an input type that accepts DataCatalogArray and DataCatalogArrayOutput values. You can construct a concrete instance of `DataCatalogArrayInput` via:

DataCatalogArray{ DataCatalogArgs{...} }

type DataCatalogArrayOutput

type DataCatalogArrayOutput struct{ *pulumi.OutputState }

func (DataCatalogArrayOutput) ElementType

func (DataCatalogArrayOutput) ElementType() reflect.Type

func (DataCatalogArrayOutput) Index

func (DataCatalogArrayOutput) ToDataCatalogArrayOutput

func (o DataCatalogArrayOutput) ToDataCatalogArrayOutput() DataCatalogArrayOutput

func (DataCatalogArrayOutput) ToDataCatalogArrayOutputWithContext

func (o DataCatalogArrayOutput) ToDataCatalogArrayOutputWithContext(ctx context.Context) DataCatalogArrayOutput

type DataCatalogInput

type DataCatalogInput interface {
	pulumi.Input

	ToDataCatalogOutput() DataCatalogOutput
	ToDataCatalogOutputWithContext(ctx context.Context) DataCatalogOutput
}

type DataCatalogMap

type DataCatalogMap map[string]DataCatalogInput

func (DataCatalogMap) ElementType

func (DataCatalogMap) ElementType() reflect.Type

func (DataCatalogMap) ToDataCatalogMapOutput

func (i DataCatalogMap) ToDataCatalogMapOutput() DataCatalogMapOutput

func (DataCatalogMap) ToDataCatalogMapOutputWithContext

func (i DataCatalogMap) ToDataCatalogMapOutputWithContext(ctx context.Context) DataCatalogMapOutput

type DataCatalogMapInput

type DataCatalogMapInput interface {
	pulumi.Input

	ToDataCatalogMapOutput() DataCatalogMapOutput
	ToDataCatalogMapOutputWithContext(context.Context) DataCatalogMapOutput
}

DataCatalogMapInput is an input type that accepts DataCatalogMap and DataCatalogMapOutput values. You can construct a concrete instance of `DataCatalogMapInput` via:

DataCatalogMap{ "key": DataCatalogArgs{...} }

type DataCatalogMapOutput

type DataCatalogMapOutput struct{ *pulumi.OutputState }

func (DataCatalogMapOutput) ElementType

func (DataCatalogMapOutput) ElementType() reflect.Type

func (DataCatalogMapOutput) MapIndex

func (DataCatalogMapOutput) ToDataCatalogMapOutput

func (o DataCatalogMapOutput) ToDataCatalogMapOutput() DataCatalogMapOutput

func (DataCatalogMapOutput) ToDataCatalogMapOutputWithContext

func (o DataCatalogMapOutput) ToDataCatalogMapOutputWithContext(ctx context.Context) DataCatalogMapOutput

type DataCatalogOutput

type DataCatalogOutput struct{ *pulumi.OutputState }

func (DataCatalogOutput) Arn

ARN of the data catalog.

func (DataCatalogOutput) Description

func (o DataCatalogOutput) Description() pulumi.StringOutput

Description of the data catalog.

func (DataCatalogOutput) ElementType

func (DataCatalogOutput) ElementType() reflect.Type

func (DataCatalogOutput) Name

Name of the data catalog. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.

func (DataCatalogOutput) Parameters

func (o DataCatalogOutput) Parameters() pulumi.StringMapOutput

Key value pairs that specifies the Lambda function or functions to use for the data catalog. The mapping used depends on the catalog type.

func (DataCatalogOutput) Tags

Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

func (DataCatalogOutput) TagsAll deprecated

Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

Deprecated: Please use `tags` instead.

func (DataCatalogOutput) ToDataCatalogOutput

func (o DataCatalogOutput) ToDataCatalogOutput() DataCatalogOutput

func (DataCatalogOutput) ToDataCatalogOutputWithContext

func (o DataCatalogOutput) ToDataCatalogOutputWithContext(ctx context.Context) DataCatalogOutput

func (DataCatalogOutput) Type

Type of data catalog: `LAMBDA` for a federated catalog, `GLUE` for AWS Glue Catalog, or `HIVE` for an external hive metastore.

type DataCatalogState

type DataCatalogState struct {
	// ARN of the data catalog.
	Arn pulumi.StringPtrInput
	// Description of the data catalog.
	Description pulumi.StringPtrInput
	// Name of the data catalog. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.
	Name pulumi.StringPtrInput
	// Key value pairs that specifies the Lambda function or functions to use for the data catalog. The mapping used depends on the catalog type.
	Parameters pulumi.StringMapInput
	// Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
	// Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll pulumi.StringMapInput
	// Type of data catalog: `LAMBDA` for a federated catalog, `GLUE` for AWS Glue Catalog, or `HIVE` for an external hive metastore.
	Type pulumi.StringPtrInput
}

func (DataCatalogState) ElementType

func (DataCatalogState) ElementType() reflect.Type

type Database

type Database struct {
	pulumi.CustomResourceState

	// That an Amazon S3 canned ACL should be set to control ownership of stored query results. See ACL Configuration below.
	AclConfiguration DatabaseAclConfigurationPtrOutput `pulumi:"aclConfiguration"`
	// Name of S3 bucket to save the results of the query execution.
	Bucket pulumi.StringPtrOutput `pulumi:"bucket"`
	// Description of the database.
	Comment pulumi.StringPtrOutput `pulumi:"comment"`
	// Encryption key block AWS Athena uses to decrypt the data in S3, such as an AWS Key Management Service (AWS KMS) key. See Encryption Configuration below.
	EncryptionConfiguration DatabaseEncryptionConfigurationPtrOutput `pulumi:"encryptionConfiguration"`
	// AWS account ID that you expect to be the owner of the Amazon S3 bucket.
	ExpectedBucketOwner pulumi.StringPtrOutput `pulumi:"expectedBucketOwner"`
	// 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 pulumi.BoolPtrOutput `pulumi:"forceDestroy"`
	// Name of the database to create.
	Name pulumi.StringOutput `pulumi:"name"`
	// Key-value map of custom metadata properties for the database definition.
	Properties pulumi.StringMapOutput `pulumi:"properties"`
}

Provides an Athena database.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/athena"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/s3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := s3.NewBucketV2(ctx, "example", &s3.BucketV2Args{
			Bucket: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		_, err = athena.NewDatabase(ctx, "example", &athena.DatabaseArgs{
			Name:   pulumi.String("database_name"),
			Bucket: example.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Using `pulumi import`, import Athena Databases using their name. For example:

```sh $ pulumi import aws:athena/database:Database example example ``` Certain resource arguments, like `encryption_configuration` and `bucket`, do not have an API method for reading the information after creation. If the argument is set in the Pulumi program on an imported resource, Pulumi will always show a difference. To workaround this behavior, either omit the argument from the Pulumi program or use `ignore_changes` to hide the difference. For example:

func GetDatabase

func GetDatabase(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DatabaseState, opts ...pulumi.ResourceOption) (*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.ResourceOption) (*Database, error)

NewDatabase registers a new resource with the given unique name, arguments, and options.

func (*Database) ElementType

func (*Database) ElementType() reflect.Type

func (*Database) ToDatabaseOutput

func (i *Database) ToDatabaseOutput() DatabaseOutput

func (*Database) ToDatabaseOutputWithContext

func (i *Database) ToDatabaseOutputWithContext(ctx context.Context) DatabaseOutput

type DatabaseAclConfiguration

type DatabaseAclConfiguration struct {
	// Amazon S3 canned ACL that Athena should specify when storing query results. Valid value is `BUCKET_OWNER_FULL_CONTROL`.
	//
	// > **NOTE:** When Athena queries are executed, result files may be created in the specified bucket. Consider using `forceDestroy` on the bucket too in order to avoid any problems when destroying the bucket.
	S3AclOption string `pulumi:"s3AclOption"`
}

type DatabaseAclConfigurationArgs

type DatabaseAclConfigurationArgs struct {
	// Amazon S3 canned ACL that Athena should specify when storing query results. Valid value is `BUCKET_OWNER_FULL_CONTROL`.
	//
	// > **NOTE:** When Athena queries are executed, result files may be created in the specified bucket. Consider using `forceDestroy` on the bucket too in order to avoid any problems when destroying the bucket.
	S3AclOption pulumi.StringInput `pulumi:"s3AclOption"`
}

func (DatabaseAclConfigurationArgs) ElementType

func (DatabaseAclConfigurationArgs) ToDatabaseAclConfigurationOutput

func (i DatabaseAclConfigurationArgs) ToDatabaseAclConfigurationOutput() DatabaseAclConfigurationOutput

func (DatabaseAclConfigurationArgs) ToDatabaseAclConfigurationOutputWithContext

func (i DatabaseAclConfigurationArgs) ToDatabaseAclConfigurationOutputWithContext(ctx context.Context) DatabaseAclConfigurationOutput

func (DatabaseAclConfigurationArgs) ToDatabaseAclConfigurationPtrOutput

func (i DatabaseAclConfigurationArgs) ToDatabaseAclConfigurationPtrOutput() DatabaseAclConfigurationPtrOutput

func (DatabaseAclConfigurationArgs) ToDatabaseAclConfigurationPtrOutputWithContext

func (i DatabaseAclConfigurationArgs) ToDatabaseAclConfigurationPtrOutputWithContext(ctx context.Context) DatabaseAclConfigurationPtrOutput

type DatabaseAclConfigurationInput

type DatabaseAclConfigurationInput interface {
	pulumi.Input

	ToDatabaseAclConfigurationOutput() DatabaseAclConfigurationOutput
	ToDatabaseAclConfigurationOutputWithContext(context.Context) DatabaseAclConfigurationOutput
}

DatabaseAclConfigurationInput is an input type that accepts DatabaseAclConfigurationArgs and DatabaseAclConfigurationOutput values. You can construct a concrete instance of `DatabaseAclConfigurationInput` via:

DatabaseAclConfigurationArgs{...}

type DatabaseAclConfigurationOutput

type DatabaseAclConfigurationOutput struct{ *pulumi.OutputState }

func (DatabaseAclConfigurationOutput) ElementType

func (DatabaseAclConfigurationOutput) S3AclOption

Amazon S3 canned ACL that Athena should specify when storing query results. Valid value is `BUCKET_OWNER_FULL_CONTROL`.

> **NOTE:** When Athena queries are executed, result files may be created in the specified bucket. Consider using `forceDestroy` on the bucket too in order to avoid any problems when destroying the bucket.

func (DatabaseAclConfigurationOutput) ToDatabaseAclConfigurationOutput

func (o DatabaseAclConfigurationOutput) ToDatabaseAclConfigurationOutput() DatabaseAclConfigurationOutput

func (DatabaseAclConfigurationOutput) ToDatabaseAclConfigurationOutputWithContext

func (o DatabaseAclConfigurationOutput) ToDatabaseAclConfigurationOutputWithContext(ctx context.Context) DatabaseAclConfigurationOutput

func (DatabaseAclConfigurationOutput) ToDatabaseAclConfigurationPtrOutput

func (o DatabaseAclConfigurationOutput) ToDatabaseAclConfigurationPtrOutput() DatabaseAclConfigurationPtrOutput

func (DatabaseAclConfigurationOutput) ToDatabaseAclConfigurationPtrOutputWithContext

func (o DatabaseAclConfigurationOutput) ToDatabaseAclConfigurationPtrOutputWithContext(ctx context.Context) DatabaseAclConfigurationPtrOutput

type DatabaseAclConfigurationPtrInput

type DatabaseAclConfigurationPtrInput interface {
	pulumi.Input

	ToDatabaseAclConfigurationPtrOutput() DatabaseAclConfigurationPtrOutput
	ToDatabaseAclConfigurationPtrOutputWithContext(context.Context) DatabaseAclConfigurationPtrOutput
}

DatabaseAclConfigurationPtrInput is an input type that accepts DatabaseAclConfigurationArgs, DatabaseAclConfigurationPtr and DatabaseAclConfigurationPtrOutput values. You can construct a concrete instance of `DatabaseAclConfigurationPtrInput` via:

        DatabaseAclConfigurationArgs{...}

or:

        nil

type DatabaseAclConfigurationPtrOutput

type DatabaseAclConfigurationPtrOutput struct{ *pulumi.OutputState }

func (DatabaseAclConfigurationPtrOutput) Elem

func (DatabaseAclConfigurationPtrOutput) ElementType

func (DatabaseAclConfigurationPtrOutput) S3AclOption

Amazon S3 canned ACL that Athena should specify when storing query results. Valid value is `BUCKET_OWNER_FULL_CONTROL`.

> **NOTE:** When Athena queries are executed, result files may be created in the specified bucket. Consider using `forceDestroy` on the bucket too in order to avoid any problems when destroying the bucket.

func (DatabaseAclConfigurationPtrOutput) ToDatabaseAclConfigurationPtrOutput

func (o DatabaseAclConfigurationPtrOutput) ToDatabaseAclConfigurationPtrOutput() DatabaseAclConfigurationPtrOutput

func (DatabaseAclConfigurationPtrOutput) ToDatabaseAclConfigurationPtrOutputWithContext

func (o DatabaseAclConfigurationPtrOutput) ToDatabaseAclConfigurationPtrOutputWithContext(ctx context.Context) DatabaseAclConfigurationPtrOutput

type DatabaseArgs

type DatabaseArgs struct {
	// That an Amazon S3 canned ACL should be set to control ownership of stored query results. See ACL Configuration below.
	AclConfiguration DatabaseAclConfigurationPtrInput
	// Name of S3 bucket to save the results of the query execution.
	Bucket pulumi.StringPtrInput
	// Description of the database.
	Comment pulumi.StringPtrInput
	// Encryption key block AWS Athena uses to decrypt the data in S3, such as an AWS Key Management Service (AWS KMS) key. See Encryption Configuration below.
	EncryptionConfiguration DatabaseEncryptionConfigurationPtrInput
	// AWS account ID that you expect to be the owner of the Amazon S3 bucket.
	ExpectedBucketOwner pulumi.StringPtrInput
	// 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 pulumi.BoolPtrInput
	// Name of the database to create.
	Name pulumi.StringPtrInput
	// Key-value map of custom metadata properties for the database definition.
	Properties pulumi.StringMapInput
}

The set of arguments for constructing a Database resource.

func (DatabaseArgs) ElementType

func (DatabaseArgs) ElementType() reflect.Type

type DatabaseArray

type DatabaseArray []DatabaseInput

func (DatabaseArray) ElementType

func (DatabaseArray) ElementType() reflect.Type

func (DatabaseArray) ToDatabaseArrayOutput

func (i DatabaseArray) ToDatabaseArrayOutput() DatabaseArrayOutput

func (DatabaseArray) ToDatabaseArrayOutputWithContext

func (i DatabaseArray) ToDatabaseArrayOutputWithContext(ctx context.Context) DatabaseArrayOutput

type DatabaseArrayInput

type DatabaseArrayInput interface {
	pulumi.Input

	ToDatabaseArrayOutput() DatabaseArrayOutput
	ToDatabaseArrayOutputWithContext(context.Context) DatabaseArrayOutput
}

DatabaseArrayInput is an input type that accepts DatabaseArray and DatabaseArrayOutput values. You can construct a concrete instance of `DatabaseArrayInput` via:

DatabaseArray{ DatabaseArgs{...} }

type DatabaseArrayOutput

type DatabaseArrayOutput struct{ *pulumi.OutputState }

func (DatabaseArrayOutput) ElementType

func (DatabaseArrayOutput) ElementType() reflect.Type

func (DatabaseArrayOutput) Index

func (DatabaseArrayOutput) ToDatabaseArrayOutput

func (o DatabaseArrayOutput) ToDatabaseArrayOutput() DatabaseArrayOutput

func (DatabaseArrayOutput) ToDatabaseArrayOutputWithContext

func (o DatabaseArrayOutput) ToDatabaseArrayOutputWithContext(ctx context.Context) DatabaseArrayOutput

type DatabaseEncryptionConfiguration

type DatabaseEncryptionConfiguration struct {
	// Type of key; one of `SSE_S3`, `SSE_KMS`, `CSE_KMS`
	EncryptionOption string `pulumi:"encryptionOption"`
	// KMS key ARN or ID; required for key types `SSE_KMS` and `CSE_KMS`.
	KmsKey *string `pulumi:"kmsKey"`
}

type DatabaseEncryptionConfigurationArgs

type DatabaseEncryptionConfigurationArgs struct {
	// Type of key; one of `SSE_S3`, `SSE_KMS`, `CSE_KMS`
	EncryptionOption pulumi.StringInput `pulumi:"encryptionOption"`
	// KMS key ARN or ID; required for key types `SSE_KMS` and `CSE_KMS`.
	KmsKey pulumi.StringPtrInput `pulumi:"kmsKey"`
}

func (DatabaseEncryptionConfigurationArgs) ElementType

func (DatabaseEncryptionConfigurationArgs) ToDatabaseEncryptionConfigurationOutput

func (i DatabaseEncryptionConfigurationArgs) ToDatabaseEncryptionConfigurationOutput() DatabaseEncryptionConfigurationOutput

func (DatabaseEncryptionConfigurationArgs) ToDatabaseEncryptionConfigurationOutputWithContext

func (i DatabaseEncryptionConfigurationArgs) ToDatabaseEncryptionConfigurationOutputWithContext(ctx context.Context) DatabaseEncryptionConfigurationOutput

func (DatabaseEncryptionConfigurationArgs) ToDatabaseEncryptionConfigurationPtrOutput

func (i DatabaseEncryptionConfigurationArgs) ToDatabaseEncryptionConfigurationPtrOutput() DatabaseEncryptionConfigurationPtrOutput

func (DatabaseEncryptionConfigurationArgs) ToDatabaseEncryptionConfigurationPtrOutputWithContext

func (i DatabaseEncryptionConfigurationArgs) ToDatabaseEncryptionConfigurationPtrOutputWithContext(ctx context.Context) DatabaseEncryptionConfigurationPtrOutput

type DatabaseEncryptionConfigurationInput

type DatabaseEncryptionConfigurationInput interface {
	pulumi.Input

	ToDatabaseEncryptionConfigurationOutput() DatabaseEncryptionConfigurationOutput
	ToDatabaseEncryptionConfigurationOutputWithContext(context.Context) DatabaseEncryptionConfigurationOutput
}

DatabaseEncryptionConfigurationInput is an input type that accepts DatabaseEncryptionConfigurationArgs and DatabaseEncryptionConfigurationOutput values. You can construct a concrete instance of `DatabaseEncryptionConfigurationInput` via:

DatabaseEncryptionConfigurationArgs{...}

type DatabaseEncryptionConfigurationOutput

type DatabaseEncryptionConfigurationOutput struct{ *pulumi.OutputState }

func (DatabaseEncryptionConfigurationOutput) ElementType

func (DatabaseEncryptionConfigurationOutput) EncryptionOption

Type of key; one of `SSE_S3`, `SSE_KMS`, `CSE_KMS`

func (DatabaseEncryptionConfigurationOutput) KmsKey

KMS key ARN or ID; required for key types `SSE_KMS` and `CSE_KMS`.

func (DatabaseEncryptionConfigurationOutput) ToDatabaseEncryptionConfigurationOutput

func (o DatabaseEncryptionConfigurationOutput) ToDatabaseEncryptionConfigurationOutput() DatabaseEncryptionConfigurationOutput

func (DatabaseEncryptionConfigurationOutput) ToDatabaseEncryptionConfigurationOutputWithContext

func (o DatabaseEncryptionConfigurationOutput) ToDatabaseEncryptionConfigurationOutputWithContext(ctx context.Context) DatabaseEncryptionConfigurationOutput

func (DatabaseEncryptionConfigurationOutput) ToDatabaseEncryptionConfigurationPtrOutput

func (o DatabaseEncryptionConfigurationOutput) ToDatabaseEncryptionConfigurationPtrOutput() DatabaseEncryptionConfigurationPtrOutput

func (DatabaseEncryptionConfigurationOutput) ToDatabaseEncryptionConfigurationPtrOutputWithContext

func (o DatabaseEncryptionConfigurationOutput) ToDatabaseEncryptionConfigurationPtrOutputWithContext(ctx context.Context) DatabaseEncryptionConfigurationPtrOutput

type DatabaseEncryptionConfigurationPtrInput

type DatabaseEncryptionConfigurationPtrInput interface {
	pulumi.Input

	ToDatabaseEncryptionConfigurationPtrOutput() DatabaseEncryptionConfigurationPtrOutput
	ToDatabaseEncryptionConfigurationPtrOutputWithContext(context.Context) DatabaseEncryptionConfigurationPtrOutput
}

DatabaseEncryptionConfigurationPtrInput is an input type that accepts DatabaseEncryptionConfigurationArgs, DatabaseEncryptionConfigurationPtr and DatabaseEncryptionConfigurationPtrOutput values. You can construct a concrete instance of `DatabaseEncryptionConfigurationPtrInput` via:

        DatabaseEncryptionConfigurationArgs{...}

or:

        nil

type DatabaseEncryptionConfigurationPtrOutput

type DatabaseEncryptionConfigurationPtrOutput struct{ *pulumi.OutputState }

func (DatabaseEncryptionConfigurationPtrOutput) Elem

func (DatabaseEncryptionConfigurationPtrOutput) ElementType

func (DatabaseEncryptionConfigurationPtrOutput) EncryptionOption

Type of key; one of `SSE_S3`, `SSE_KMS`, `CSE_KMS`

func (DatabaseEncryptionConfigurationPtrOutput) KmsKey

KMS key ARN or ID; required for key types `SSE_KMS` and `CSE_KMS`.

func (DatabaseEncryptionConfigurationPtrOutput) ToDatabaseEncryptionConfigurationPtrOutput

func (o DatabaseEncryptionConfigurationPtrOutput) ToDatabaseEncryptionConfigurationPtrOutput() DatabaseEncryptionConfigurationPtrOutput

func (DatabaseEncryptionConfigurationPtrOutput) ToDatabaseEncryptionConfigurationPtrOutputWithContext

func (o DatabaseEncryptionConfigurationPtrOutput) ToDatabaseEncryptionConfigurationPtrOutputWithContext(ctx context.Context) DatabaseEncryptionConfigurationPtrOutput

type DatabaseInput

type DatabaseInput interface {
	pulumi.Input

	ToDatabaseOutput() DatabaseOutput
	ToDatabaseOutputWithContext(ctx context.Context) DatabaseOutput
}

type DatabaseMap

type DatabaseMap map[string]DatabaseInput

func (DatabaseMap) ElementType

func (DatabaseMap) ElementType() reflect.Type

func (DatabaseMap) ToDatabaseMapOutput

func (i DatabaseMap) ToDatabaseMapOutput() DatabaseMapOutput

func (DatabaseMap) ToDatabaseMapOutputWithContext

func (i DatabaseMap) ToDatabaseMapOutputWithContext(ctx context.Context) DatabaseMapOutput

type DatabaseMapInput

type DatabaseMapInput interface {
	pulumi.Input

	ToDatabaseMapOutput() DatabaseMapOutput
	ToDatabaseMapOutputWithContext(context.Context) DatabaseMapOutput
}

DatabaseMapInput is an input type that accepts DatabaseMap and DatabaseMapOutput values. You can construct a concrete instance of `DatabaseMapInput` via:

DatabaseMap{ "key": DatabaseArgs{...} }

type DatabaseMapOutput

type DatabaseMapOutput struct{ *pulumi.OutputState }

func (DatabaseMapOutput) ElementType

func (DatabaseMapOutput) ElementType() reflect.Type

func (DatabaseMapOutput) MapIndex

func (DatabaseMapOutput) ToDatabaseMapOutput

func (o DatabaseMapOutput) ToDatabaseMapOutput() DatabaseMapOutput

func (DatabaseMapOutput) ToDatabaseMapOutputWithContext

func (o DatabaseMapOutput) ToDatabaseMapOutputWithContext(ctx context.Context) DatabaseMapOutput

type DatabaseOutput

type DatabaseOutput struct{ *pulumi.OutputState }

func (DatabaseOutput) AclConfiguration

That an Amazon S3 canned ACL should be set to control ownership of stored query results. See ACL Configuration below.

func (DatabaseOutput) Bucket

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

func (DatabaseOutput) Comment

Description of the database.

func (DatabaseOutput) ElementType

func (DatabaseOutput) ElementType() reflect.Type

func (DatabaseOutput) EncryptionConfiguration

func (o DatabaseOutput) EncryptionConfiguration() DatabaseEncryptionConfigurationPtrOutput

Encryption key block AWS Athena uses to decrypt the data in S3, such as an AWS Key Management Service (AWS KMS) key. See Encryption Configuration below.

func (DatabaseOutput) ExpectedBucketOwner

func (o DatabaseOutput) ExpectedBucketOwner() pulumi.StringPtrOutput

AWS account ID that you expect to be the owner of the Amazon S3 bucket.

func (DatabaseOutput) ForceDestroy

func (o DatabaseOutput) ForceDestroy() pulumi.BoolPtrOutput

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 (DatabaseOutput) Name

Name of the database to create.

func (DatabaseOutput) Properties

func (o DatabaseOutput) Properties() pulumi.StringMapOutput

Key-value map of custom metadata properties for the database definition.

func (DatabaseOutput) ToDatabaseOutput

func (o DatabaseOutput) ToDatabaseOutput() DatabaseOutput

func (DatabaseOutput) ToDatabaseOutputWithContext

func (o DatabaseOutput) ToDatabaseOutputWithContext(ctx context.Context) DatabaseOutput

type DatabaseState

type DatabaseState struct {
	// That an Amazon S3 canned ACL should be set to control ownership of stored query results. See ACL Configuration below.
	AclConfiguration DatabaseAclConfigurationPtrInput
	// Name of S3 bucket to save the results of the query execution.
	Bucket pulumi.StringPtrInput
	// Description of the database.
	Comment pulumi.StringPtrInput
	// Encryption key block AWS Athena uses to decrypt the data in S3, such as an AWS Key Management Service (AWS KMS) key. See Encryption Configuration below.
	EncryptionConfiguration DatabaseEncryptionConfigurationPtrInput
	// AWS account ID that you expect to be the owner of the Amazon S3 bucket.
	ExpectedBucketOwner pulumi.StringPtrInput
	// 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 pulumi.BoolPtrInput
	// Name of the database to create.
	Name pulumi.StringPtrInput
	// Key-value map of custom metadata properties for the database definition.
	Properties pulumi.StringMapInput
}

func (DatabaseState) ElementType

func (DatabaseState) ElementType() reflect.Type

type LookupNamedQueryArgs added in v6.9.0

type LookupNamedQueryArgs struct {
	// The plain language name for the query. Maximum length of 128.
	Name string `pulumi:"name"`
	// The workgroup to which the query belongs. Defaults to `primary`.
	Workgroup *string `pulumi:"workgroup"`
}

A collection of arguments for invoking getNamedQuery.

type LookupNamedQueryOutputArgs added in v6.9.0

type LookupNamedQueryOutputArgs struct {
	// The plain language name for the query. Maximum length of 128.
	Name pulumi.StringInput `pulumi:"name"`
	// The workgroup to which the query belongs. Defaults to `primary`.
	Workgroup pulumi.StringPtrInput `pulumi:"workgroup"`
}

A collection of arguments for invoking getNamedQuery.

func (LookupNamedQueryOutputArgs) ElementType added in v6.9.0

func (LookupNamedQueryOutputArgs) ElementType() reflect.Type

type LookupNamedQueryResult added in v6.9.0

type LookupNamedQueryResult struct {
	// Database to which the query belongs.
	Database string `pulumi:"database"`
	// Brief explanation of the query.
	Description string `pulumi:"description"`
	// The provider-assigned unique ID for this managed resource.
	Id          string  `pulumi:"id"`
	Name        string  `pulumi:"name"`
	Querystring string  `pulumi:"querystring"`
	Workgroup   *string `pulumi:"workgroup"`
}

A collection of values returned by getNamedQuery.

func LookupNamedQuery added in v6.9.0

func LookupNamedQuery(ctx *pulumi.Context, args *LookupNamedQueryArgs, opts ...pulumi.InvokeOption) (*LookupNamedQueryResult, error)

Provides an Athena Named Query data source.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/athena"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := athena.LookupNamedQuery(ctx, &athena.LookupNamedQueryArgs{
			Name: "athenaQueryName",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type LookupNamedQueryResultOutput added in v6.9.0

type LookupNamedQueryResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getNamedQuery.

func LookupNamedQueryOutput added in v6.9.0

func (LookupNamedQueryResultOutput) Database added in v6.9.0

Database to which the query belongs.

func (LookupNamedQueryResultOutput) Description added in v6.9.0

Brief explanation of the query.

func (LookupNamedQueryResultOutput) ElementType added in v6.9.0

func (LookupNamedQueryResultOutput) Id added in v6.9.0

The provider-assigned unique ID for this managed resource.

func (LookupNamedQueryResultOutput) Name added in v6.9.0

func (LookupNamedQueryResultOutput) Querystring added in v6.9.0

func (LookupNamedQueryResultOutput) ToLookupNamedQueryResultOutput added in v6.9.0

func (o LookupNamedQueryResultOutput) ToLookupNamedQueryResultOutput() LookupNamedQueryResultOutput

func (LookupNamedQueryResultOutput) ToLookupNamedQueryResultOutputWithContext added in v6.9.0

func (o LookupNamedQueryResultOutput) ToLookupNamedQueryResultOutputWithContext(ctx context.Context) LookupNamedQueryResultOutput

func (LookupNamedQueryResultOutput) Workgroup added in v6.9.0

type NamedQuery

type NamedQuery struct {
	pulumi.CustomResourceState

	// Database to which the query belongs.
	Database pulumi.StringOutput `pulumi:"database"`
	// Brief explanation of the query. Maximum length of 1024.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Plain language name for the query. Maximum length of 128.
	Name pulumi.StringOutput `pulumi:"name"`
	// Text of the query itself. In other words, all query statements. Maximum length of 262144.
	Query pulumi.StringOutput `pulumi:"query"`
	// Workgroup to which the query belongs. Defaults to `primary`
	Workgroup pulumi.StringPtrOutput `pulumi:"workgroup"`
}

Provides an Athena Named Query resource.

## Example Usage

```go package main

import (

"fmt"

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/athena"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kms"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/s3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		hoge, err := s3.NewBucketV2(ctx, "hoge", &s3.BucketV2Args{
			Bucket: pulumi.String("tf-test"),
		})
		if err != nil {
			return err
		}
		test, err := kms.NewKey(ctx, "test", &kms.KeyArgs{
			DeletionWindowInDays: pulumi.Int(7),
			Description:          pulumi.String("Athena KMS Key"),
		})
		if err != nil {
			return err
		}
		testWorkgroup, err := athena.NewWorkgroup(ctx, "test", &athena.WorkgroupArgs{
			Name: pulumi.String("example"),
			Configuration: &athena.WorkgroupConfigurationArgs{
				ResultConfiguration: &athena.WorkgroupConfigurationResultConfigurationArgs{
					EncryptionConfiguration: &athena.WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs{
						EncryptionOption: pulumi.String("SSE_KMS"),
						KmsKeyArn:        test.Arn,
					},
				},
			},
		})
		if err != nil {
			return err
		}
		hogeDatabase, err := athena.NewDatabase(ctx, "hoge", &athena.DatabaseArgs{
			Name:   pulumi.String("users"),
			Bucket: hoge.ID(),
		})
		if err != nil {
			return err
		}
		_, err = athena.NewNamedQuery(ctx, "foo", &athena.NamedQueryArgs{
			Name:      pulumi.String("bar"),
			Workgroup: testWorkgroup.ID(),
			Database:  hogeDatabase.Name,
			Query: hogeDatabase.Name.ApplyT(func(name string) (string, error) {
				return fmt.Sprintf("SELECT * FROM %v limit 10;", name), nil
			}).(pulumi.StringOutput),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Using `pulumi import`, import Athena Named Query using the query ID. For example:

```sh $ pulumi import aws:athena/namedQuery:NamedQuery example 0123456789 ```

func GetNamedQuery

func GetNamedQuery(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *NamedQueryState, opts ...pulumi.ResourceOption) (*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.ResourceOption) (*NamedQuery, error)

NewNamedQuery registers a new resource with the given unique name, arguments, and options.

func (*NamedQuery) ElementType

func (*NamedQuery) ElementType() reflect.Type

func (*NamedQuery) ToNamedQueryOutput

func (i *NamedQuery) ToNamedQueryOutput() NamedQueryOutput

func (*NamedQuery) ToNamedQueryOutputWithContext

func (i *NamedQuery) ToNamedQueryOutputWithContext(ctx context.Context) NamedQueryOutput

type NamedQueryArgs

type NamedQueryArgs struct {
	// Database to which the query belongs.
	Database pulumi.StringInput
	// Brief explanation of the query. Maximum length of 1024.
	Description pulumi.StringPtrInput
	// Plain language name for the query. Maximum length of 128.
	Name pulumi.StringPtrInput
	// Text of the query itself. In other words, all query statements. Maximum length of 262144.
	Query pulumi.StringInput
	// Workgroup to which the query belongs. Defaults to `primary`
	Workgroup pulumi.StringPtrInput
}

The set of arguments for constructing a NamedQuery resource.

func (NamedQueryArgs) ElementType

func (NamedQueryArgs) ElementType() reflect.Type

type NamedQueryArray

type NamedQueryArray []NamedQueryInput

func (NamedQueryArray) ElementType

func (NamedQueryArray) ElementType() reflect.Type

func (NamedQueryArray) ToNamedQueryArrayOutput

func (i NamedQueryArray) ToNamedQueryArrayOutput() NamedQueryArrayOutput

func (NamedQueryArray) ToNamedQueryArrayOutputWithContext

func (i NamedQueryArray) ToNamedQueryArrayOutputWithContext(ctx context.Context) NamedQueryArrayOutput

type NamedQueryArrayInput

type NamedQueryArrayInput interface {
	pulumi.Input

	ToNamedQueryArrayOutput() NamedQueryArrayOutput
	ToNamedQueryArrayOutputWithContext(context.Context) NamedQueryArrayOutput
}

NamedQueryArrayInput is an input type that accepts NamedQueryArray and NamedQueryArrayOutput values. You can construct a concrete instance of `NamedQueryArrayInput` via:

NamedQueryArray{ NamedQueryArgs{...} }

type NamedQueryArrayOutput

type NamedQueryArrayOutput struct{ *pulumi.OutputState }

func (NamedQueryArrayOutput) ElementType

func (NamedQueryArrayOutput) ElementType() reflect.Type

func (NamedQueryArrayOutput) Index

func (NamedQueryArrayOutput) ToNamedQueryArrayOutput

func (o NamedQueryArrayOutput) ToNamedQueryArrayOutput() NamedQueryArrayOutput

func (NamedQueryArrayOutput) ToNamedQueryArrayOutputWithContext

func (o NamedQueryArrayOutput) ToNamedQueryArrayOutputWithContext(ctx context.Context) NamedQueryArrayOutput

type NamedQueryInput

type NamedQueryInput interface {
	pulumi.Input

	ToNamedQueryOutput() NamedQueryOutput
	ToNamedQueryOutputWithContext(ctx context.Context) NamedQueryOutput
}

type NamedQueryMap

type NamedQueryMap map[string]NamedQueryInput

func (NamedQueryMap) ElementType

func (NamedQueryMap) ElementType() reflect.Type

func (NamedQueryMap) ToNamedQueryMapOutput

func (i NamedQueryMap) ToNamedQueryMapOutput() NamedQueryMapOutput

func (NamedQueryMap) ToNamedQueryMapOutputWithContext

func (i NamedQueryMap) ToNamedQueryMapOutputWithContext(ctx context.Context) NamedQueryMapOutput

type NamedQueryMapInput

type NamedQueryMapInput interface {
	pulumi.Input

	ToNamedQueryMapOutput() NamedQueryMapOutput
	ToNamedQueryMapOutputWithContext(context.Context) NamedQueryMapOutput
}

NamedQueryMapInput is an input type that accepts NamedQueryMap and NamedQueryMapOutput values. You can construct a concrete instance of `NamedQueryMapInput` via:

NamedQueryMap{ "key": NamedQueryArgs{...} }

type NamedQueryMapOutput

type NamedQueryMapOutput struct{ *pulumi.OutputState }

func (NamedQueryMapOutput) ElementType

func (NamedQueryMapOutput) ElementType() reflect.Type

func (NamedQueryMapOutput) MapIndex

func (NamedQueryMapOutput) ToNamedQueryMapOutput

func (o NamedQueryMapOutput) ToNamedQueryMapOutput() NamedQueryMapOutput

func (NamedQueryMapOutput) ToNamedQueryMapOutputWithContext

func (o NamedQueryMapOutput) ToNamedQueryMapOutputWithContext(ctx context.Context) NamedQueryMapOutput

type NamedQueryOutput

type NamedQueryOutput struct{ *pulumi.OutputState }

func (NamedQueryOutput) Database

func (o NamedQueryOutput) Database() pulumi.StringOutput

Database to which the query belongs.

func (NamedQueryOutput) Description

func (o NamedQueryOutput) Description() pulumi.StringPtrOutput

Brief explanation of the query. Maximum length of 1024.

func (NamedQueryOutput) ElementType

func (NamedQueryOutput) ElementType() reflect.Type

func (NamedQueryOutput) Name

Plain language name for the query. Maximum length of 128.

func (NamedQueryOutput) Query

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

func (NamedQueryOutput) ToNamedQueryOutput

func (o NamedQueryOutput) ToNamedQueryOutput() NamedQueryOutput

func (NamedQueryOutput) ToNamedQueryOutputWithContext

func (o NamedQueryOutput) ToNamedQueryOutputWithContext(ctx context.Context) NamedQueryOutput

func (NamedQueryOutput) Workgroup

func (o NamedQueryOutput) Workgroup() pulumi.StringPtrOutput

Workgroup to which the query belongs. Defaults to `primary`

type NamedQueryState

type NamedQueryState struct {
	// Database to which the query belongs.
	Database pulumi.StringPtrInput
	// Brief explanation of the query. Maximum length of 1024.
	Description pulumi.StringPtrInput
	// Plain language name for the query. Maximum length of 128.
	Name pulumi.StringPtrInput
	// Text of the query itself. In other words, all query statements. Maximum length of 262144.
	Query pulumi.StringPtrInput
	// Workgroup to which the query belongs. Defaults to `primary`
	Workgroup pulumi.StringPtrInput
}

func (NamedQueryState) ElementType

func (NamedQueryState) ElementType() reflect.Type

type PreparedStatement added in v6.9.0

type PreparedStatement struct {
	pulumi.CustomResourceState

	// Brief explanation of prepared statement. Maximum length of 1024.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The name of the prepared statement. Maximum length of 256.
	Name pulumi.StringOutput `pulumi:"name"`
	// The query string for the prepared statement.
	QueryStatement pulumi.StringOutput `pulumi:"queryStatement"`
	// The name of the workgroup to which the prepared statement belongs.
	Workgroup pulumi.StringOutput `pulumi:"workgroup"`
}

Resource for managing an Athena Prepared Statement.

## Example Usage

```go package main

import (

"fmt"

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/athena"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/s3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := s3.NewBucketV2(ctx, "test", &s3.BucketV2Args{
			Bucket:       pulumi.String("tf-test"),
			ForceDestroy: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		testWorkgroup, err := athena.NewWorkgroup(ctx, "test", &athena.WorkgroupArgs{
			Name: pulumi.String("tf-test"),
		})
		if err != nil {
			return err
		}
		testDatabase, err := athena.NewDatabase(ctx, "test", &athena.DatabaseArgs{
			Name:   pulumi.String("example"),
			Bucket: test.Bucket,
		})
		if err != nil {
			return err
		}
		_, err = athena.NewPreparedStatement(ctx, "test", &athena.PreparedStatementArgs{
			Name: pulumi.String("tf_test"),
			QueryStatement: testDatabase.Name.ApplyT(func(name string) (string, error) {
				return fmt.Sprintf("SELECT * FROM %v WHERE x = ?", name), nil
			}).(pulumi.StringOutput),
			Workgroup: testWorkgroup.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Using `pulumi import`, import Athena Prepared Statement using the `WORKGROUP-NAME/STATEMENT-NAME`. For example:

```sh $ pulumi import aws:athena/preparedStatement:PreparedStatement example 12345abcde/example ```

func GetPreparedStatement added in v6.9.0

func GetPreparedStatement(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PreparedStatementState, opts ...pulumi.ResourceOption) (*PreparedStatement, error)

GetPreparedStatement gets an existing PreparedStatement 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 NewPreparedStatement added in v6.9.0

func NewPreparedStatement(ctx *pulumi.Context,
	name string, args *PreparedStatementArgs, opts ...pulumi.ResourceOption) (*PreparedStatement, error)

NewPreparedStatement registers a new resource with the given unique name, arguments, and options.

func (*PreparedStatement) ElementType added in v6.9.0

func (*PreparedStatement) ElementType() reflect.Type

func (*PreparedStatement) ToPreparedStatementOutput added in v6.9.0

func (i *PreparedStatement) ToPreparedStatementOutput() PreparedStatementOutput

func (*PreparedStatement) ToPreparedStatementOutputWithContext added in v6.9.0

func (i *PreparedStatement) ToPreparedStatementOutputWithContext(ctx context.Context) PreparedStatementOutput

type PreparedStatementArgs added in v6.9.0

type PreparedStatementArgs struct {
	// Brief explanation of prepared statement. Maximum length of 1024.
	Description pulumi.StringPtrInput
	// The name of the prepared statement. Maximum length of 256.
	Name pulumi.StringPtrInput
	// The query string for the prepared statement.
	QueryStatement pulumi.StringInput
	// The name of the workgroup to which the prepared statement belongs.
	Workgroup pulumi.StringInput
}

The set of arguments for constructing a PreparedStatement resource.

func (PreparedStatementArgs) ElementType added in v6.9.0

func (PreparedStatementArgs) ElementType() reflect.Type

type PreparedStatementArray added in v6.9.0

type PreparedStatementArray []PreparedStatementInput

func (PreparedStatementArray) ElementType added in v6.9.0

func (PreparedStatementArray) ElementType() reflect.Type

func (PreparedStatementArray) ToPreparedStatementArrayOutput added in v6.9.0

func (i PreparedStatementArray) ToPreparedStatementArrayOutput() PreparedStatementArrayOutput

func (PreparedStatementArray) ToPreparedStatementArrayOutputWithContext added in v6.9.0

func (i PreparedStatementArray) ToPreparedStatementArrayOutputWithContext(ctx context.Context) PreparedStatementArrayOutput

type PreparedStatementArrayInput added in v6.9.0

type PreparedStatementArrayInput interface {
	pulumi.Input

	ToPreparedStatementArrayOutput() PreparedStatementArrayOutput
	ToPreparedStatementArrayOutputWithContext(context.Context) PreparedStatementArrayOutput
}

PreparedStatementArrayInput is an input type that accepts PreparedStatementArray and PreparedStatementArrayOutput values. You can construct a concrete instance of `PreparedStatementArrayInput` via:

PreparedStatementArray{ PreparedStatementArgs{...} }

type PreparedStatementArrayOutput added in v6.9.0

type PreparedStatementArrayOutput struct{ *pulumi.OutputState }

func (PreparedStatementArrayOutput) ElementType added in v6.9.0

func (PreparedStatementArrayOutput) Index added in v6.9.0

func (PreparedStatementArrayOutput) ToPreparedStatementArrayOutput added in v6.9.0

func (o PreparedStatementArrayOutput) ToPreparedStatementArrayOutput() PreparedStatementArrayOutput

func (PreparedStatementArrayOutput) ToPreparedStatementArrayOutputWithContext added in v6.9.0

func (o PreparedStatementArrayOutput) ToPreparedStatementArrayOutputWithContext(ctx context.Context) PreparedStatementArrayOutput

type PreparedStatementInput added in v6.9.0

type PreparedStatementInput interface {
	pulumi.Input

	ToPreparedStatementOutput() PreparedStatementOutput
	ToPreparedStatementOutputWithContext(ctx context.Context) PreparedStatementOutput
}

type PreparedStatementMap added in v6.9.0

type PreparedStatementMap map[string]PreparedStatementInput

func (PreparedStatementMap) ElementType added in v6.9.0

func (PreparedStatementMap) ElementType() reflect.Type

func (PreparedStatementMap) ToPreparedStatementMapOutput added in v6.9.0

func (i PreparedStatementMap) ToPreparedStatementMapOutput() PreparedStatementMapOutput

func (PreparedStatementMap) ToPreparedStatementMapOutputWithContext added in v6.9.0

func (i PreparedStatementMap) ToPreparedStatementMapOutputWithContext(ctx context.Context) PreparedStatementMapOutput

type PreparedStatementMapInput added in v6.9.0

type PreparedStatementMapInput interface {
	pulumi.Input

	ToPreparedStatementMapOutput() PreparedStatementMapOutput
	ToPreparedStatementMapOutputWithContext(context.Context) PreparedStatementMapOutput
}

PreparedStatementMapInput is an input type that accepts PreparedStatementMap and PreparedStatementMapOutput values. You can construct a concrete instance of `PreparedStatementMapInput` via:

PreparedStatementMap{ "key": PreparedStatementArgs{...} }

type PreparedStatementMapOutput added in v6.9.0

type PreparedStatementMapOutput struct{ *pulumi.OutputState }

func (PreparedStatementMapOutput) ElementType added in v6.9.0

func (PreparedStatementMapOutput) ElementType() reflect.Type

func (PreparedStatementMapOutput) MapIndex added in v6.9.0

func (PreparedStatementMapOutput) ToPreparedStatementMapOutput added in v6.9.0

func (o PreparedStatementMapOutput) ToPreparedStatementMapOutput() PreparedStatementMapOutput

func (PreparedStatementMapOutput) ToPreparedStatementMapOutputWithContext added in v6.9.0

func (o PreparedStatementMapOutput) ToPreparedStatementMapOutputWithContext(ctx context.Context) PreparedStatementMapOutput

type PreparedStatementOutput added in v6.9.0

type PreparedStatementOutput struct{ *pulumi.OutputState }

func (PreparedStatementOutput) Description added in v6.9.0

Brief explanation of prepared statement. Maximum length of 1024.

func (PreparedStatementOutput) ElementType added in v6.9.0

func (PreparedStatementOutput) ElementType() reflect.Type

func (PreparedStatementOutput) Name added in v6.9.0

The name of the prepared statement. Maximum length of 256.

func (PreparedStatementOutput) QueryStatement added in v6.9.0

func (o PreparedStatementOutput) QueryStatement() pulumi.StringOutput

The query string for the prepared statement.

func (PreparedStatementOutput) ToPreparedStatementOutput added in v6.9.0

func (o PreparedStatementOutput) ToPreparedStatementOutput() PreparedStatementOutput

func (PreparedStatementOutput) ToPreparedStatementOutputWithContext added in v6.9.0

func (o PreparedStatementOutput) ToPreparedStatementOutputWithContext(ctx context.Context) PreparedStatementOutput

func (PreparedStatementOutput) Workgroup added in v6.9.0

The name of the workgroup to which the prepared statement belongs.

type PreparedStatementState added in v6.9.0

type PreparedStatementState struct {
	// Brief explanation of prepared statement. Maximum length of 1024.
	Description pulumi.StringPtrInput
	// The name of the prepared statement. Maximum length of 256.
	Name pulumi.StringPtrInput
	// The query string for the prepared statement.
	QueryStatement pulumi.StringPtrInput
	// The name of the workgroup to which the prepared statement belongs.
	Workgroup pulumi.StringPtrInput
}

func (PreparedStatementState) ElementType added in v6.9.0

func (PreparedStatementState) ElementType() reflect.Type

type Workgroup

type Workgroup struct {
	pulumi.CustomResourceState

	// ARN of the workgroup
	Arn pulumi.StringOutput `pulumi:"arn"`
	// Configuration block with various settings for the workgroup. Documented below.
	Configuration WorkgroupConfigurationPtrOutput `pulumi:"configuration"`
	// Description of the workgroup.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Option to delete the workgroup and its contents even if the workgroup contains any named queries.
	ForceDestroy pulumi.BoolPtrOutput `pulumi:"forceDestroy"`
	// Name of the workgroup.
	Name pulumi.StringOutput `pulumi:"name"`
	// State of the workgroup. Valid values are `DISABLED` or `ENABLED`. Defaults to `ENABLED`.
	State pulumi.StringPtrOutput `pulumi:"state"`
	// Key-value map of resource tags for the workgroup. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
}

Provides an Athena Workgroup.

## Example Usage

```go package main

import (

"fmt"

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/athena"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := athena.NewWorkgroup(ctx, "example", &athena.WorkgroupArgs{
			Name: pulumi.String("example"),
			Configuration: &athena.WorkgroupConfigurationArgs{
				EnforceWorkgroupConfiguration:   pulumi.Bool(true),
				PublishCloudwatchMetricsEnabled: pulumi.Bool(true),
				ResultConfiguration: &athena.WorkgroupConfigurationResultConfigurationArgs{
					OutputLocation: pulumi.String(fmt.Sprintf("s3://%v/output/", exampleAwsS3Bucket.Bucket)),
					EncryptionConfiguration: &athena.WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs{
						EncryptionOption: pulumi.String("SSE_KMS"),
						KmsKeyArn:        pulumi.Any(exampleAwsKmsKey.Arn),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Using `pulumi import`, import Athena Workgroups using their name. For example:

```sh $ pulumi import aws:athena/workgroup:Workgroup example example ```

func GetWorkgroup

func GetWorkgroup(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *WorkgroupState, opts ...pulumi.ResourceOption) (*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

func NewWorkgroup(ctx *pulumi.Context,
	name string, args *WorkgroupArgs, opts ...pulumi.ResourceOption) (*Workgroup, error)

NewWorkgroup registers a new resource with the given unique name, arguments, and options.

func (*Workgroup) ElementType

func (*Workgroup) ElementType() reflect.Type

func (*Workgroup) ToWorkgroupOutput

func (i *Workgroup) ToWorkgroupOutput() WorkgroupOutput

func (*Workgroup) ToWorkgroupOutputWithContext

func (i *Workgroup) ToWorkgroupOutputWithContext(ctx context.Context) WorkgroupOutput

type WorkgroupArgs

type WorkgroupArgs struct {
	// Configuration block with various settings for the workgroup. Documented below.
	Configuration WorkgroupConfigurationPtrInput
	// Description of the workgroup.
	Description pulumi.StringPtrInput
	// Option to delete the workgroup and its contents even if the workgroup contains any named queries.
	ForceDestroy pulumi.BoolPtrInput
	// Name of the workgroup.
	Name pulumi.StringPtrInput
	// State of the workgroup. Valid values are `DISABLED` or `ENABLED`. Defaults to `ENABLED`.
	State pulumi.StringPtrInput
	// Key-value map of resource tags for the workgroup. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Workgroup resource.

func (WorkgroupArgs) ElementType

func (WorkgroupArgs) ElementType() reflect.Type

type WorkgroupArray

type WorkgroupArray []WorkgroupInput

func (WorkgroupArray) ElementType

func (WorkgroupArray) ElementType() reflect.Type

func (WorkgroupArray) ToWorkgroupArrayOutput

func (i WorkgroupArray) ToWorkgroupArrayOutput() WorkgroupArrayOutput

func (WorkgroupArray) ToWorkgroupArrayOutputWithContext

func (i WorkgroupArray) ToWorkgroupArrayOutputWithContext(ctx context.Context) WorkgroupArrayOutput

type WorkgroupArrayInput

type WorkgroupArrayInput interface {
	pulumi.Input

	ToWorkgroupArrayOutput() WorkgroupArrayOutput
	ToWorkgroupArrayOutputWithContext(context.Context) WorkgroupArrayOutput
}

WorkgroupArrayInput is an input type that accepts WorkgroupArray and WorkgroupArrayOutput values. You can construct a concrete instance of `WorkgroupArrayInput` via:

WorkgroupArray{ WorkgroupArgs{...} }

type WorkgroupArrayOutput

type WorkgroupArrayOutput struct{ *pulumi.OutputState }

func (WorkgroupArrayOutput) ElementType

func (WorkgroupArrayOutput) ElementType() reflect.Type

func (WorkgroupArrayOutput) Index

func (WorkgroupArrayOutput) ToWorkgroupArrayOutput

func (o WorkgroupArrayOutput) ToWorkgroupArrayOutput() WorkgroupArrayOutput

func (WorkgroupArrayOutput) ToWorkgroupArrayOutputWithContext

func (o WorkgroupArrayOutput) ToWorkgroupArrayOutputWithContext(ctx context.Context) WorkgroupArrayOutput

type WorkgroupConfiguration

type WorkgroupConfiguration struct {
	// Integer for the upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. Must be at least `10485760`.
	BytesScannedCutoffPerQuery *int `pulumi:"bytesScannedCutoffPerQuery"`
	// Boolean whether the settings for the workgroup override client-side settings. For more information, see [Workgroup Settings Override Client-Side Settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). Defaults to `true`.
	EnforceWorkgroupConfiguration *bool `pulumi:"enforceWorkgroupConfiguration"`
	// Configuration block for the Athena Engine Versioning. For more information, see [Athena Engine Versioning](https://docs.aws.amazon.com/athena/latest/ug/engine-versions.html). See Engine Version below.
	EngineVersion *WorkgroupConfigurationEngineVersion `pulumi:"engineVersion"`
	// Role used in a notebook session for accessing the user's resources.
	ExecutionRole *string `pulumi:"executionRole"`
	// Boolean whether Amazon CloudWatch metrics are enabled for the workgroup. Defaults to `true`.
	PublishCloudwatchMetricsEnabled *bool `pulumi:"publishCloudwatchMetricsEnabled"`
	// If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see [Requester Pays Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html) in the Amazon Simple Storage Service Developer Guide.
	RequesterPaysEnabled *bool `pulumi:"requesterPaysEnabled"`
	// Configuration block with result settings. See Result Configuration below.
	ResultConfiguration *WorkgroupConfigurationResultConfiguration `pulumi:"resultConfiguration"`
}

type WorkgroupConfigurationArgs

type WorkgroupConfigurationArgs struct {
	// Integer for the upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. Must be at least `10485760`.
	BytesScannedCutoffPerQuery pulumi.IntPtrInput `pulumi:"bytesScannedCutoffPerQuery"`
	// Boolean whether the settings for the workgroup override client-side settings. For more information, see [Workgroup Settings Override Client-Side Settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). Defaults to `true`.
	EnforceWorkgroupConfiguration pulumi.BoolPtrInput `pulumi:"enforceWorkgroupConfiguration"`
	// Configuration block for the Athena Engine Versioning. For more information, see [Athena Engine Versioning](https://docs.aws.amazon.com/athena/latest/ug/engine-versions.html). See Engine Version below.
	EngineVersion WorkgroupConfigurationEngineVersionPtrInput `pulumi:"engineVersion"`
	// Role used in a notebook session for accessing the user's resources.
	ExecutionRole pulumi.StringPtrInput `pulumi:"executionRole"`
	// Boolean whether Amazon CloudWatch metrics are enabled for the workgroup. Defaults to `true`.
	PublishCloudwatchMetricsEnabled pulumi.BoolPtrInput `pulumi:"publishCloudwatchMetricsEnabled"`
	// If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see [Requester Pays Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html) in the Amazon Simple Storage Service Developer Guide.
	RequesterPaysEnabled pulumi.BoolPtrInput `pulumi:"requesterPaysEnabled"`
	// Configuration block with result settings. See Result Configuration below.
	ResultConfiguration WorkgroupConfigurationResultConfigurationPtrInput `pulumi:"resultConfiguration"`
}

func (WorkgroupConfigurationArgs) ElementType

func (WorkgroupConfigurationArgs) ElementType() reflect.Type

func (WorkgroupConfigurationArgs) ToWorkgroupConfigurationOutput

func (i WorkgroupConfigurationArgs) ToWorkgroupConfigurationOutput() WorkgroupConfigurationOutput

func (WorkgroupConfigurationArgs) ToWorkgroupConfigurationOutputWithContext

func (i WorkgroupConfigurationArgs) ToWorkgroupConfigurationOutputWithContext(ctx context.Context) WorkgroupConfigurationOutput

func (WorkgroupConfigurationArgs) ToWorkgroupConfigurationPtrOutput

func (i WorkgroupConfigurationArgs) ToWorkgroupConfigurationPtrOutput() WorkgroupConfigurationPtrOutput

func (WorkgroupConfigurationArgs) ToWorkgroupConfigurationPtrOutputWithContext

func (i WorkgroupConfigurationArgs) ToWorkgroupConfigurationPtrOutputWithContext(ctx context.Context) WorkgroupConfigurationPtrOutput

type WorkgroupConfigurationEngineVersion

type WorkgroupConfigurationEngineVersion struct {
	// The engine version on which the query runs. If `selectedEngineVersion` is set to `AUTO`, the effective engine version is chosen by Athena.
	EffectiveEngineVersion *string `pulumi:"effectiveEngineVersion"`
	// Requested engine version. Defaults to `AUTO`.
	SelectedEngineVersion *string `pulumi:"selectedEngineVersion"`
}

type WorkgroupConfigurationEngineVersionArgs

type WorkgroupConfigurationEngineVersionArgs struct {
	// The engine version on which the query runs. If `selectedEngineVersion` is set to `AUTO`, the effective engine version is chosen by Athena.
	EffectiveEngineVersion pulumi.StringPtrInput `pulumi:"effectiveEngineVersion"`
	// Requested engine version. Defaults to `AUTO`.
	SelectedEngineVersion pulumi.StringPtrInput `pulumi:"selectedEngineVersion"`
}

func (WorkgroupConfigurationEngineVersionArgs) ElementType

func (WorkgroupConfigurationEngineVersionArgs) ToWorkgroupConfigurationEngineVersionOutput

func (i WorkgroupConfigurationEngineVersionArgs) ToWorkgroupConfigurationEngineVersionOutput() WorkgroupConfigurationEngineVersionOutput

func (WorkgroupConfigurationEngineVersionArgs) ToWorkgroupConfigurationEngineVersionOutputWithContext

func (i WorkgroupConfigurationEngineVersionArgs) ToWorkgroupConfigurationEngineVersionOutputWithContext(ctx context.Context) WorkgroupConfigurationEngineVersionOutput

func (WorkgroupConfigurationEngineVersionArgs) ToWorkgroupConfigurationEngineVersionPtrOutput

func (i WorkgroupConfigurationEngineVersionArgs) ToWorkgroupConfigurationEngineVersionPtrOutput() WorkgroupConfigurationEngineVersionPtrOutput

func (WorkgroupConfigurationEngineVersionArgs) ToWorkgroupConfigurationEngineVersionPtrOutputWithContext

func (i WorkgroupConfigurationEngineVersionArgs) ToWorkgroupConfigurationEngineVersionPtrOutputWithContext(ctx context.Context) WorkgroupConfigurationEngineVersionPtrOutput

type WorkgroupConfigurationEngineVersionInput

type WorkgroupConfigurationEngineVersionInput interface {
	pulumi.Input

	ToWorkgroupConfigurationEngineVersionOutput() WorkgroupConfigurationEngineVersionOutput
	ToWorkgroupConfigurationEngineVersionOutputWithContext(context.Context) WorkgroupConfigurationEngineVersionOutput
}

WorkgroupConfigurationEngineVersionInput is an input type that accepts WorkgroupConfigurationEngineVersionArgs and WorkgroupConfigurationEngineVersionOutput values. You can construct a concrete instance of `WorkgroupConfigurationEngineVersionInput` via:

WorkgroupConfigurationEngineVersionArgs{...}

type WorkgroupConfigurationEngineVersionOutput

type WorkgroupConfigurationEngineVersionOutput struct{ *pulumi.OutputState }

func (WorkgroupConfigurationEngineVersionOutput) EffectiveEngineVersion

The engine version on which the query runs. If `selectedEngineVersion` is set to `AUTO`, the effective engine version is chosen by Athena.

func (WorkgroupConfigurationEngineVersionOutput) ElementType

func (WorkgroupConfigurationEngineVersionOutput) SelectedEngineVersion

Requested engine version. Defaults to `AUTO`.

func (WorkgroupConfigurationEngineVersionOutput) ToWorkgroupConfigurationEngineVersionOutput

func (o WorkgroupConfigurationEngineVersionOutput) ToWorkgroupConfigurationEngineVersionOutput() WorkgroupConfigurationEngineVersionOutput

func (WorkgroupConfigurationEngineVersionOutput) ToWorkgroupConfigurationEngineVersionOutputWithContext

func (o WorkgroupConfigurationEngineVersionOutput) ToWorkgroupConfigurationEngineVersionOutputWithContext(ctx context.Context) WorkgroupConfigurationEngineVersionOutput

func (WorkgroupConfigurationEngineVersionOutput) ToWorkgroupConfigurationEngineVersionPtrOutput

func (o WorkgroupConfigurationEngineVersionOutput) ToWorkgroupConfigurationEngineVersionPtrOutput() WorkgroupConfigurationEngineVersionPtrOutput

func (WorkgroupConfigurationEngineVersionOutput) ToWorkgroupConfigurationEngineVersionPtrOutputWithContext

func (o WorkgroupConfigurationEngineVersionOutput) ToWorkgroupConfigurationEngineVersionPtrOutputWithContext(ctx context.Context) WorkgroupConfigurationEngineVersionPtrOutput

type WorkgroupConfigurationEngineVersionPtrInput

type WorkgroupConfigurationEngineVersionPtrInput interface {
	pulumi.Input

	ToWorkgroupConfigurationEngineVersionPtrOutput() WorkgroupConfigurationEngineVersionPtrOutput
	ToWorkgroupConfigurationEngineVersionPtrOutputWithContext(context.Context) WorkgroupConfigurationEngineVersionPtrOutput
}

WorkgroupConfigurationEngineVersionPtrInput is an input type that accepts WorkgroupConfigurationEngineVersionArgs, WorkgroupConfigurationEngineVersionPtr and WorkgroupConfigurationEngineVersionPtrOutput values. You can construct a concrete instance of `WorkgroupConfigurationEngineVersionPtrInput` via:

        WorkgroupConfigurationEngineVersionArgs{...}

or:

        nil

type WorkgroupConfigurationEngineVersionPtrOutput

type WorkgroupConfigurationEngineVersionPtrOutput struct{ *pulumi.OutputState }

func (WorkgroupConfigurationEngineVersionPtrOutput) EffectiveEngineVersion

The engine version on which the query runs. If `selectedEngineVersion` is set to `AUTO`, the effective engine version is chosen by Athena.

func (WorkgroupConfigurationEngineVersionPtrOutput) Elem

func (WorkgroupConfigurationEngineVersionPtrOutput) ElementType

func (WorkgroupConfigurationEngineVersionPtrOutput) SelectedEngineVersion

Requested engine version. Defaults to `AUTO`.

func (WorkgroupConfigurationEngineVersionPtrOutput) ToWorkgroupConfigurationEngineVersionPtrOutput

func (o WorkgroupConfigurationEngineVersionPtrOutput) ToWorkgroupConfigurationEngineVersionPtrOutput() WorkgroupConfigurationEngineVersionPtrOutput

func (WorkgroupConfigurationEngineVersionPtrOutput) ToWorkgroupConfigurationEngineVersionPtrOutputWithContext

func (o WorkgroupConfigurationEngineVersionPtrOutput) ToWorkgroupConfigurationEngineVersionPtrOutputWithContext(ctx context.Context) WorkgroupConfigurationEngineVersionPtrOutput

type WorkgroupConfigurationInput

type WorkgroupConfigurationInput interface {
	pulumi.Input

	ToWorkgroupConfigurationOutput() WorkgroupConfigurationOutput
	ToWorkgroupConfigurationOutputWithContext(context.Context) WorkgroupConfigurationOutput
}

WorkgroupConfigurationInput is an input type that accepts WorkgroupConfigurationArgs and WorkgroupConfigurationOutput values. You can construct a concrete instance of `WorkgroupConfigurationInput` via:

WorkgroupConfigurationArgs{...}

type WorkgroupConfigurationOutput

type WorkgroupConfigurationOutput struct{ *pulumi.OutputState }

func (WorkgroupConfigurationOutput) BytesScannedCutoffPerQuery

func (o WorkgroupConfigurationOutput) BytesScannedCutoffPerQuery() pulumi.IntPtrOutput

Integer for the upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. Must be at least `10485760`.

func (WorkgroupConfigurationOutput) ElementType

func (WorkgroupConfigurationOutput) EnforceWorkgroupConfiguration

func (o WorkgroupConfigurationOutput) EnforceWorkgroupConfiguration() pulumi.BoolPtrOutput

Boolean whether the settings for the workgroup override client-side settings. For more information, see [Workgroup Settings Override Client-Side Settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). Defaults to `true`.

func (WorkgroupConfigurationOutput) EngineVersion

Configuration block for the Athena Engine Versioning. For more information, see [Athena Engine Versioning](https://docs.aws.amazon.com/athena/latest/ug/engine-versions.html). See Engine Version below.

func (WorkgroupConfigurationOutput) ExecutionRole

Role used in a notebook session for accessing the user's resources.

func (WorkgroupConfigurationOutput) PublishCloudwatchMetricsEnabled

func (o WorkgroupConfigurationOutput) PublishCloudwatchMetricsEnabled() pulumi.BoolPtrOutput

Boolean whether Amazon CloudWatch metrics are enabled for the workgroup. Defaults to `true`.

func (WorkgroupConfigurationOutput) RequesterPaysEnabled

func (o WorkgroupConfigurationOutput) RequesterPaysEnabled() pulumi.BoolPtrOutput

If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see [Requester Pays Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html) in the Amazon Simple Storage Service Developer Guide.

func (WorkgroupConfigurationOutput) ResultConfiguration

Configuration block with result settings. See Result Configuration below.

func (WorkgroupConfigurationOutput) ToWorkgroupConfigurationOutput

func (o WorkgroupConfigurationOutput) ToWorkgroupConfigurationOutput() WorkgroupConfigurationOutput

func (WorkgroupConfigurationOutput) ToWorkgroupConfigurationOutputWithContext

func (o WorkgroupConfigurationOutput) ToWorkgroupConfigurationOutputWithContext(ctx context.Context) WorkgroupConfigurationOutput

func (WorkgroupConfigurationOutput) ToWorkgroupConfigurationPtrOutput

func (o WorkgroupConfigurationOutput) ToWorkgroupConfigurationPtrOutput() WorkgroupConfigurationPtrOutput

func (WorkgroupConfigurationOutput) ToWorkgroupConfigurationPtrOutputWithContext

func (o WorkgroupConfigurationOutput) ToWorkgroupConfigurationPtrOutputWithContext(ctx context.Context) WorkgroupConfigurationPtrOutput

type WorkgroupConfigurationPtrInput

type WorkgroupConfigurationPtrInput interface {
	pulumi.Input

	ToWorkgroupConfigurationPtrOutput() WorkgroupConfigurationPtrOutput
	ToWorkgroupConfigurationPtrOutputWithContext(context.Context) WorkgroupConfigurationPtrOutput
}

WorkgroupConfigurationPtrInput is an input type that accepts WorkgroupConfigurationArgs, WorkgroupConfigurationPtr and WorkgroupConfigurationPtrOutput values. You can construct a concrete instance of `WorkgroupConfigurationPtrInput` via:

        WorkgroupConfigurationArgs{...}

or:

        nil

type WorkgroupConfigurationPtrOutput

type WorkgroupConfigurationPtrOutput struct{ *pulumi.OutputState }

func (WorkgroupConfigurationPtrOutput) BytesScannedCutoffPerQuery

func (o WorkgroupConfigurationPtrOutput) BytesScannedCutoffPerQuery() pulumi.IntPtrOutput

Integer for the upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. Must be at least `10485760`.

func (WorkgroupConfigurationPtrOutput) Elem

func (WorkgroupConfigurationPtrOutput) ElementType

func (WorkgroupConfigurationPtrOutput) EnforceWorkgroupConfiguration

func (o WorkgroupConfigurationPtrOutput) EnforceWorkgroupConfiguration() pulumi.BoolPtrOutput

Boolean whether the settings for the workgroup override client-side settings. For more information, see [Workgroup Settings Override Client-Side Settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). Defaults to `true`.

func (WorkgroupConfigurationPtrOutput) EngineVersion

Configuration block for the Athena Engine Versioning. For more information, see [Athena Engine Versioning](https://docs.aws.amazon.com/athena/latest/ug/engine-versions.html). See Engine Version below.

func (WorkgroupConfigurationPtrOutput) ExecutionRole

Role used in a notebook session for accessing the user's resources.

func (WorkgroupConfigurationPtrOutput) PublishCloudwatchMetricsEnabled

func (o WorkgroupConfigurationPtrOutput) PublishCloudwatchMetricsEnabled() pulumi.BoolPtrOutput

Boolean whether Amazon CloudWatch metrics are enabled for the workgroup. Defaults to `true`.

func (WorkgroupConfigurationPtrOutput) RequesterPaysEnabled

func (o WorkgroupConfigurationPtrOutput) RequesterPaysEnabled() pulumi.BoolPtrOutput

If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see [Requester Pays Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html) in the Amazon Simple Storage Service Developer Guide.

func (WorkgroupConfigurationPtrOutput) ResultConfiguration

Configuration block with result settings. See Result Configuration below.

func (WorkgroupConfigurationPtrOutput) ToWorkgroupConfigurationPtrOutput

func (o WorkgroupConfigurationPtrOutput) ToWorkgroupConfigurationPtrOutput() WorkgroupConfigurationPtrOutput

func (WorkgroupConfigurationPtrOutput) ToWorkgroupConfigurationPtrOutputWithContext

func (o WorkgroupConfigurationPtrOutput) ToWorkgroupConfigurationPtrOutputWithContext(ctx context.Context) WorkgroupConfigurationPtrOutput

type WorkgroupConfigurationResultConfiguration

type WorkgroupConfigurationResultConfiguration struct {
	// That an Amazon S3 canned ACL should be set to control ownership of stored query results. See ACL Configuration below.
	AclConfiguration *WorkgroupConfigurationResultConfigurationAclConfiguration `pulumi:"aclConfiguration"`
	// Configuration block with encryption settings. See Encryption Configuration below.
	EncryptionConfiguration *WorkgroupConfigurationResultConfigurationEncryptionConfiguration `pulumi:"encryptionConfiguration"`
	// AWS account ID that you expect to be the owner of the Amazon S3 bucket.
	ExpectedBucketOwner *string `pulumi:"expectedBucketOwner"`
	// Location in Amazon S3 where your query results are stored, such as `s3://path/to/query/bucket/`. For more information, see [Queries and Query Result Files](https://docs.aws.amazon.com/athena/latest/ug/querying.html).
	OutputLocation *string `pulumi:"outputLocation"`
}

type WorkgroupConfigurationResultConfigurationAclConfiguration

type WorkgroupConfigurationResultConfigurationAclConfiguration struct {
	// Amazon S3 canned ACL that Athena should specify when storing query results. Valid value is `BUCKET_OWNER_FULL_CONTROL`.
	S3AclOption string `pulumi:"s3AclOption"`
}

type WorkgroupConfigurationResultConfigurationAclConfigurationArgs

type WorkgroupConfigurationResultConfigurationAclConfigurationArgs struct {
	// Amazon S3 canned ACL that Athena should specify when storing query results. Valid value is `BUCKET_OWNER_FULL_CONTROL`.
	S3AclOption pulumi.StringInput `pulumi:"s3AclOption"`
}

func (WorkgroupConfigurationResultConfigurationAclConfigurationArgs) ElementType

func (WorkgroupConfigurationResultConfigurationAclConfigurationArgs) ToWorkgroupConfigurationResultConfigurationAclConfigurationOutput

func (WorkgroupConfigurationResultConfigurationAclConfigurationArgs) ToWorkgroupConfigurationResultConfigurationAclConfigurationOutputWithContext

func (i WorkgroupConfigurationResultConfigurationAclConfigurationArgs) ToWorkgroupConfigurationResultConfigurationAclConfigurationOutputWithContext(ctx context.Context) WorkgroupConfigurationResultConfigurationAclConfigurationOutput

func (WorkgroupConfigurationResultConfigurationAclConfigurationArgs) ToWorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput

func (WorkgroupConfigurationResultConfigurationAclConfigurationArgs) ToWorkgroupConfigurationResultConfigurationAclConfigurationPtrOutputWithContext

func (i WorkgroupConfigurationResultConfigurationAclConfigurationArgs) ToWorkgroupConfigurationResultConfigurationAclConfigurationPtrOutputWithContext(ctx context.Context) WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput

type WorkgroupConfigurationResultConfigurationAclConfigurationInput

type WorkgroupConfigurationResultConfigurationAclConfigurationInput interface {
	pulumi.Input

	ToWorkgroupConfigurationResultConfigurationAclConfigurationOutput() WorkgroupConfigurationResultConfigurationAclConfigurationOutput
	ToWorkgroupConfigurationResultConfigurationAclConfigurationOutputWithContext(context.Context) WorkgroupConfigurationResultConfigurationAclConfigurationOutput
}

WorkgroupConfigurationResultConfigurationAclConfigurationInput is an input type that accepts WorkgroupConfigurationResultConfigurationAclConfigurationArgs and WorkgroupConfigurationResultConfigurationAclConfigurationOutput values. You can construct a concrete instance of `WorkgroupConfigurationResultConfigurationAclConfigurationInput` via:

WorkgroupConfigurationResultConfigurationAclConfigurationArgs{...}

type WorkgroupConfigurationResultConfigurationAclConfigurationOutput

type WorkgroupConfigurationResultConfigurationAclConfigurationOutput struct{ *pulumi.OutputState }

func (WorkgroupConfigurationResultConfigurationAclConfigurationOutput) ElementType

func (WorkgroupConfigurationResultConfigurationAclConfigurationOutput) S3AclOption

Amazon S3 canned ACL that Athena should specify when storing query results. Valid value is `BUCKET_OWNER_FULL_CONTROL`.

func (WorkgroupConfigurationResultConfigurationAclConfigurationOutput) ToWorkgroupConfigurationResultConfigurationAclConfigurationOutput

func (WorkgroupConfigurationResultConfigurationAclConfigurationOutput) ToWorkgroupConfigurationResultConfigurationAclConfigurationOutputWithContext

func (o WorkgroupConfigurationResultConfigurationAclConfigurationOutput) ToWorkgroupConfigurationResultConfigurationAclConfigurationOutputWithContext(ctx context.Context) WorkgroupConfigurationResultConfigurationAclConfigurationOutput

func (WorkgroupConfigurationResultConfigurationAclConfigurationOutput) ToWorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput

func (WorkgroupConfigurationResultConfigurationAclConfigurationOutput) ToWorkgroupConfigurationResultConfigurationAclConfigurationPtrOutputWithContext

func (o WorkgroupConfigurationResultConfigurationAclConfigurationOutput) ToWorkgroupConfigurationResultConfigurationAclConfigurationPtrOutputWithContext(ctx context.Context) WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput

type WorkgroupConfigurationResultConfigurationAclConfigurationPtrInput

type WorkgroupConfigurationResultConfigurationAclConfigurationPtrInput interface {
	pulumi.Input

	ToWorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput() WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput
	ToWorkgroupConfigurationResultConfigurationAclConfigurationPtrOutputWithContext(context.Context) WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput
}

WorkgroupConfigurationResultConfigurationAclConfigurationPtrInput is an input type that accepts WorkgroupConfigurationResultConfigurationAclConfigurationArgs, WorkgroupConfigurationResultConfigurationAclConfigurationPtr and WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput values. You can construct a concrete instance of `WorkgroupConfigurationResultConfigurationAclConfigurationPtrInput` via:

        WorkgroupConfigurationResultConfigurationAclConfigurationArgs{...}

or:

        nil

type WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput

type WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput struct{ *pulumi.OutputState }

func (WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput) Elem

func (WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput) ElementType

func (WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput) S3AclOption

Amazon S3 canned ACL that Athena should specify when storing query results. Valid value is `BUCKET_OWNER_FULL_CONTROL`.

func (WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput) ToWorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput

func (WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput) ToWorkgroupConfigurationResultConfigurationAclConfigurationPtrOutputWithContext

func (o WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput) ToWorkgroupConfigurationResultConfigurationAclConfigurationPtrOutputWithContext(ctx context.Context) WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput

type WorkgroupConfigurationResultConfigurationArgs

type WorkgroupConfigurationResultConfigurationArgs struct {
	// That an Amazon S3 canned ACL should be set to control ownership of stored query results. See ACL Configuration below.
	AclConfiguration WorkgroupConfigurationResultConfigurationAclConfigurationPtrInput `pulumi:"aclConfiguration"`
	// Configuration block with encryption settings. See Encryption Configuration below.
	EncryptionConfiguration WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrInput `pulumi:"encryptionConfiguration"`
	// AWS account ID that you expect to be the owner of the Amazon S3 bucket.
	ExpectedBucketOwner pulumi.StringPtrInput `pulumi:"expectedBucketOwner"`
	// Location in Amazon S3 where your query results are stored, such as `s3://path/to/query/bucket/`. For more information, see [Queries and Query Result Files](https://docs.aws.amazon.com/athena/latest/ug/querying.html).
	OutputLocation pulumi.StringPtrInput `pulumi:"outputLocation"`
}

func (WorkgroupConfigurationResultConfigurationArgs) ElementType

func (WorkgroupConfigurationResultConfigurationArgs) ToWorkgroupConfigurationResultConfigurationOutput

func (i WorkgroupConfigurationResultConfigurationArgs) ToWorkgroupConfigurationResultConfigurationOutput() WorkgroupConfigurationResultConfigurationOutput

func (WorkgroupConfigurationResultConfigurationArgs) ToWorkgroupConfigurationResultConfigurationOutputWithContext

func (i WorkgroupConfigurationResultConfigurationArgs) ToWorkgroupConfigurationResultConfigurationOutputWithContext(ctx context.Context) WorkgroupConfigurationResultConfigurationOutput

func (WorkgroupConfigurationResultConfigurationArgs) ToWorkgroupConfigurationResultConfigurationPtrOutput

func (i WorkgroupConfigurationResultConfigurationArgs) ToWorkgroupConfigurationResultConfigurationPtrOutput() WorkgroupConfigurationResultConfigurationPtrOutput

func (WorkgroupConfigurationResultConfigurationArgs) ToWorkgroupConfigurationResultConfigurationPtrOutputWithContext

func (i WorkgroupConfigurationResultConfigurationArgs) ToWorkgroupConfigurationResultConfigurationPtrOutputWithContext(ctx context.Context) WorkgroupConfigurationResultConfigurationPtrOutput

type WorkgroupConfigurationResultConfigurationEncryptionConfiguration

type WorkgroupConfigurationResultConfigurationEncryptionConfiguration struct {
	// Whether Amazon S3 server-side encryption with Amazon S3-managed keys (`SSE_S3`), server-side encryption with KMS-managed keys (`SSE_KMS`), or client-side encryption with KMS-managed keys (`CSE_KMS`) is used. If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.
	EncryptionOption *string `pulumi:"encryptionOption"`
	// For `SSE_KMS` and `CSE_KMS`, this is the KMS key ARN.
	KmsKeyArn *string `pulumi:"kmsKeyArn"`
}

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs struct {
	// Whether Amazon S3 server-side encryption with Amazon S3-managed keys (`SSE_S3`), server-side encryption with KMS-managed keys (`SSE_KMS`), or client-side encryption with KMS-managed keys (`CSE_KMS`) is used. If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.
	EncryptionOption pulumi.StringPtrInput `pulumi:"encryptionOption"`
	// For `SSE_KMS` and `CSE_KMS`, this is the KMS key ARN.
	KmsKeyArn pulumi.StringPtrInput `pulumi:"kmsKeyArn"`
}

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs) ElementType

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutputWithContext

func (i WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutputWithContext(ctx context.Context) WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutputWithContext

func (i WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutputWithContext(ctx context.Context) WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationInput

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationInput interface {
	pulumi.Input

	ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput() WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput
	ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutputWithContext(context.Context) WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput
}

WorkgroupConfigurationResultConfigurationEncryptionConfigurationInput is an input type that accepts WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs and WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput values. You can construct a concrete instance of `WorkgroupConfigurationResultConfigurationEncryptionConfigurationInput` via:

WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs{...}

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput struct{ *pulumi.OutputState }

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) ElementType

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) EncryptionOption

Whether Amazon S3 server-side encryption with Amazon S3-managed keys (`SSE_S3`), server-side encryption with KMS-managed keys (`SSE_KMS`), or client-side encryption with KMS-managed keys (`CSE_KMS`) is used. If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) KmsKeyArn

For `SSE_KMS` and `CSE_KMS`, this is the KMS key ARN.

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutputWithContext

func (o WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutputWithContext(ctx context.Context) WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutputWithContext

func (o WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutputWithContext(ctx context.Context) WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrInput

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrInput interface {
	pulumi.Input

	ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput() WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput
	ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutputWithContext(context.Context) WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput
}

WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrInput is an input type that accepts WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs, WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtr and WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput values. You can construct a concrete instance of `WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrInput` via:

        WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs{...}

or:

        nil

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput struct{ *pulumi.OutputState }

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) Elem

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) ElementType

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) EncryptionOption

Whether Amazon S3 server-side encryption with Amazon S3-managed keys (`SSE_S3`), server-side encryption with KMS-managed keys (`SSE_KMS`), or client-side encryption with KMS-managed keys (`CSE_KMS`) is used. If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) KmsKeyArn

For `SSE_KMS` and `CSE_KMS`, this is the KMS key ARN.

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutputWithContext

type WorkgroupConfigurationResultConfigurationInput

type WorkgroupConfigurationResultConfigurationInput interface {
	pulumi.Input

	ToWorkgroupConfigurationResultConfigurationOutput() WorkgroupConfigurationResultConfigurationOutput
	ToWorkgroupConfigurationResultConfigurationOutputWithContext(context.Context) WorkgroupConfigurationResultConfigurationOutput
}

WorkgroupConfigurationResultConfigurationInput is an input type that accepts WorkgroupConfigurationResultConfigurationArgs and WorkgroupConfigurationResultConfigurationOutput values. You can construct a concrete instance of `WorkgroupConfigurationResultConfigurationInput` via:

WorkgroupConfigurationResultConfigurationArgs{...}

type WorkgroupConfigurationResultConfigurationOutput

type WorkgroupConfigurationResultConfigurationOutput struct{ *pulumi.OutputState }

func (WorkgroupConfigurationResultConfigurationOutput) AclConfiguration

That an Amazon S3 canned ACL should be set to control ownership of stored query results. See ACL Configuration below.

func (WorkgroupConfigurationResultConfigurationOutput) ElementType

func (WorkgroupConfigurationResultConfigurationOutput) EncryptionConfiguration

Configuration block with encryption settings. See Encryption Configuration below.

func (WorkgroupConfigurationResultConfigurationOutput) ExpectedBucketOwner

AWS account ID that you expect to be the owner of the Amazon S3 bucket.

func (WorkgroupConfigurationResultConfigurationOutput) OutputLocation

Location in Amazon S3 where your query results are stored, such as `s3://path/to/query/bucket/`. For more information, see [Queries and Query Result Files](https://docs.aws.amazon.com/athena/latest/ug/querying.html).

func (WorkgroupConfigurationResultConfigurationOutput) ToWorkgroupConfigurationResultConfigurationOutput

func (o WorkgroupConfigurationResultConfigurationOutput) ToWorkgroupConfigurationResultConfigurationOutput() WorkgroupConfigurationResultConfigurationOutput

func (WorkgroupConfigurationResultConfigurationOutput) ToWorkgroupConfigurationResultConfigurationOutputWithContext

func (o WorkgroupConfigurationResultConfigurationOutput) ToWorkgroupConfigurationResultConfigurationOutputWithContext(ctx context.Context) WorkgroupConfigurationResultConfigurationOutput

func (WorkgroupConfigurationResultConfigurationOutput) ToWorkgroupConfigurationResultConfigurationPtrOutput

func (o WorkgroupConfigurationResultConfigurationOutput) ToWorkgroupConfigurationResultConfigurationPtrOutput() WorkgroupConfigurationResultConfigurationPtrOutput

func (WorkgroupConfigurationResultConfigurationOutput) ToWorkgroupConfigurationResultConfigurationPtrOutputWithContext

func (o WorkgroupConfigurationResultConfigurationOutput) ToWorkgroupConfigurationResultConfigurationPtrOutputWithContext(ctx context.Context) WorkgroupConfigurationResultConfigurationPtrOutput

type WorkgroupConfigurationResultConfigurationPtrInput

type WorkgroupConfigurationResultConfigurationPtrInput interface {
	pulumi.Input

	ToWorkgroupConfigurationResultConfigurationPtrOutput() WorkgroupConfigurationResultConfigurationPtrOutput
	ToWorkgroupConfigurationResultConfigurationPtrOutputWithContext(context.Context) WorkgroupConfigurationResultConfigurationPtrOutput
}

WorkgroupConfigurationResultConfigurationPtrInput is an input type that accepts WorkgroupConfigurationResultConfigurationArgs, WorkgroupConfigurationResultConfigurationPtr and WorkgroupConfigurationResultConfigurationPtrOutput values. You can construct a concrete instance of `WorkgroupConfigurationResultConfigurationPtrInput` via:

        WorkgroupConfigurationResultConfigurationArgs{...}

or:

        nil

type WorkgroupConfigurationResultConfigurationPtrOutput

type WorkgroupConfigurationResultConfigurationPtrOutput struct{ *pulumi.OutputState }

func (WorkgroupConfigurationResultConfigurationPtrOutput) AclConfiguration

That an Amazon S3 canned ACL should be set to control ownership of stored query results. See ACL Configuration below.

func (WorkgroupConfigurationResultConfigurationPtrOutput) Elem

func (WorkgroupConfigurationResultConfigurationPtrOutput) ElementType

func (WorkgroupConfigurationResultConfigurationPtrOutput) EncryptionConfiguration

Configuration block with encryption settings. See Encryption Configuration below.

func (WorkgroupConfigurationResultConfigurationPtrOutput) ExpectedBucketOwner

AWS account ID that you expect to be the owner of the Amazon S3 bucket.

func (WorkgroupConfigurationResultConfigurationPtrOutput) OutputLocation

Location in Amazon S3 where your query results are stored, such as `s3://path/to/query/bucket/`. For more information, see [Queries and Query Result Files](https://docs.aws.amazon.com/athena/latest/ug/querying.html).

func (WorkgroupConfigurationResultConfigurationPtrOutput) ToWorkgroupConfigurationResultConfigurationPtrOutput

func (o WorkgroupConfigurationResultConfigurationPtrOutput) ToWorkgroupConfigurationResultConfigurationPtrOutput() WorkgroupConfigurationResultConfigurationPtrOutput

func (WorkgroupConfigurationResultConfigurationPtrOutput) ToWorkgroupConfigurationResultConfigurationPtrOutputWithContext

func (o WorkgroupConfigurationResultConfigurationPtrOutput) ToWorkgroupConfigurationResultConfigurationPtrOutputWithContext(ctx context.Context) WorkgroupConfigurationResultConfigurationPtrOutput

type WorkgroupInput

type WorkgroupInput interface {
	pulumi.Input

	ToWorkgroupOutput() WorkgroupOutput
	ToWorkgroupOutputWithContext(ctx context.Context) WorkgroupOutput
}

type WorkgroupMap

type WorkgroupMap map[string]WorkgroupInput

func (WorkgroupMap) ElementType

func (WorkgroupMap) ElementType() reflect.Type

func (WorkgroupMap) ToWorkgroupMapOutput

func (i WorkgroupMap) ToWorkgroupMapOutput() WorkgroupMapOutput

func (WorkgroupMap) ToWorkgroupMapOutputWithContext

func (i WorkgroupMap) ToWorkgroupMapOutputWithContext(ctx context.Context) WorkgroupMapOutput

type WorkgroupMapInput

type WorkgroupMapInput interface {
	pulumi.Input

	ToWorkgroupMapOutput() WorkgroupMapOutput
	ToWorkgroupMapOutputWithContext(context.Context) WorkgroupMapOutput
}

WorkgroupMapInput is an input type that accepts WorkgroupMap and WorkgroupMapOutput values. You can construct a concrete instance of `WorkgroupMapInput` via:

WorkgroupMap{ "key": WorkgroupArgs{...} }

type WorkgroupMapOutput

type WorkgroupMapOutput struct{ *pulumi.OutputState }

func (WorkgroupMapOutput) ElementType

func (WorkgroupMapOutput) ElementType() reflect.Type

func (WorkgroupMapOutput) MapIndex

func (WorkgroupMapOutput) ToWorkgroupMapOutput

func (o WorkgroupMapOutput) ToWorkgroupMapOutput() WorkgroupMapOutput

func (WorkgroupMapOutput) ToWorkgroupMapOutputWithContext

func (o WorkgroupMapOutput) ToWorkgroupMapOutputWithContext(ctx context.Context) WorkgroupMapOutput

type WorkgroupOutput

type WorkgroupOutput struct{ *pulumi.OutputState }

func (WorkgroupOutput) Arn

ARN of the workgroup

func (WorkgroupOutput) Configuration

Configuration block with various settings for the workgroup. Documented below.

func (WorkgroupOutput) Description

func (o WorkgroupOutput) Description() pulumi.StringPtrOutput

Description of the workgroup.

func (WorkgroupOutput) ElementType

func (WorkgroupOutput) ElementType() reflect.Type

func (WorkgroupOutput) ForceDestroy

func (o WorkgroupOutput) ForceDestroy() pulumi.BoolPtrOutput

Option to delete the workgroup and its contents even if the workgroup contains any named queries.

func (WorkgroupOutput) Name

Name of the workgroup.

func (WorkgroupOutput) State

State of the workgroup. Valid values are `DISABLED` or `ENABLED`. Defaults to `ENABLED`.

func (WorkgroupOutput) Tags

Key-value map of resource tags for the workgroup. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

func (WorkgroupOutput) TagsAll deprecated

Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

Deprecated: Please use `tags` instead.

func (WorkgroupOutput) ToWorkgroupOutput

func (o WorkgroupOutput) ToWorkgroupOutput() WorkgroupOutput

func (WorkgroupOutput) ToWorkgroupOutputWithContext

func (o WorkgroupOutput) ToWorkgroupOutputWithContext(ctx context.Context) WorkgroupOutput

type WorkgroupState

type WorkgroupState struct {
	// ARN of the workgroup
	Arn pulumi.StringPtrInput
	// Configuration block with various settings for the workgroup. Documented below.
	Configuration WorkgroupConfigurationPtrInput
	// Description of the workgroup.
	Description pulumi.StringPtrInput
	// Option to delete the workgroup and its contents even if the workgroup contains any named queries.
	ForceDestroy pulumi.BoolPtrInput
	// Name of the workgroup.
	Name pulumi.StringPtrInput
	// State of the workgroup. Valid values are `DISABLED` or `ENABLED`. Defaults to `ENABLED`.
	State pulumi.StringPtrInput
	// Key-value map of resource tags for the workgroup. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
	// Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll pulumi.StringMapInput
}

func (WorkgroupState) ElementType

func (WorkgroupState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL