athena

package
v5.43.0 Latest Latest
Warning

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

 Go to latest Published: Nov 21, 2023 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 added in v5.5.0 

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.
	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/v5/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{
			Description: pulumi.String("Example Athena data catalog"),
			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"),
			},
			Type: pulumi.String("LAMBDA"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Hive based Data Catalog

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v5/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{
			Description: pulumi.String("Hive based Data Catalog"),
			Parameters: pulumi.StringMap{
				"metadata-function": pulumi.String("arn:aws:lambda:eu-central-1:123456789012:function:not-important-lambda-function"),
			},
			Type: pulumi.String("HIVE"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Glue based Data Catalog

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v5/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{
			Description: pulumi.String("Glue based Data Catalog"),
			Parameters: pulumi.StringMap{
				"catalog-id": pulumi.String("123456789012"),
			},
			Type: pulumi.String("GLUE"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Lambda based Data Catalog

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v5/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{
			Description: pulumi.String("Lambda based Data Catalog"),
			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"),
			},
			Type: pulumi.String("LAMBDA"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Data catalogs can be imported using their `name`, e.g.,

```sh 

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

```

func GetDataCatalog added in v5.5.0 

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 added in v5.5.0 

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 added in v5.5.0 

func (*DataCatalog) ElementType() reflect.Type

func (*DataCatalog) ToDataCatalogOutput added in v5.5.0 

func (i *DataCatalog) ToDataCatalogOutput() DataCatalogOutput

func (*DataCatalog) ToDataCatalogOutputWithContext added in v5.5.0 

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

type DataCatalogArgs added in v5.5.0 

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 added in v5.5.0 

func (DataCatalogArgs) ElementType() reflect.Type

type DataCatalogArray added in v5.5.0 

type DataCatalogArray []DataCatalogInput

func (DataCatalogArray) ElementType added in v5.5.0 

func (DataCatalogArray) ElementType() reflect.Type

func (DataCatalogArray) ToDataCatalogArrayOutput added in v5.5.0 

func (i DataCatalogArray) ToDataCatalogArrayOutput() DataCatalogArrayOutput

func (DataCatalogArray) ToDataCatalogArrayOutputWithContext added in v5.5.0 

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

type DataCatalogArrayInput added in v5.5.0 

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 added in v5.5.0 

type DataCatalogArrayOutput struct{ *pulumi.OutputState }

func (DataCatalogArrayOutput) ElementType added in v5.5.0 

func (DataCatalogArrayOutput) ElementType() reflect.Type

func (DataCatalogArrayOutput) Index added in v5.5.0 

func (o DataCatalogArrayOutput) Index(i pulumi.IntInput) DataCatalogOutput

func (DataCatalogArrayOutput) ToDataCatalogArrayOutput added in v5.5.0 

func (o DataCatalogArrayOutput) ToDataCatalogArrayOutput() DataCatalogArrayOutput

func (DataCatalogArrayOutput) ToDataCatalogArrayOutputWithContext added in v5.5.0 

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

type DataCatalogInput added in v5.5.0 

type DataCatalogInput interface {
	pulumi.Input

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

type DataCatalogMap added in v5.5.0 

type DataCatalogMap map[string]DataCatalogInput

func (DataCatalogMap) ElementType added in v5.5.0 

func (DataCatalogMap) ElementType() reflect.Type

func (DataCatalogMap) ToDataCatalogMapOutput added in v5.5.0 

func (i DataCatalogMap) ToDataCatalogMapOutput() DataCatalogMapOutput

func (DataCatalogMap) ToDataCatalogMapOutputWithContext added in v5.5.0 

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

type DataCatalogMapInput added in v5.5.0 

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 added in v5.5.0 

type DataCatalogMapOutput struct{ *pulumi.OutputState }

func (DataCatalogMapOutput) ElementType added in v5.5.0 

func (DataCatalogMapOutput) ElementType() reflect.Type

func (DataCatalogMapOutput) MapIndex added in v5.5.0 

func (o DataCatalogMapOutput) MapIndex(k pulumi.StringInput) DataCatalogOutput

func (DataCatalogMapOutput) ToDataCatalogMapOutput added in v5.5.0 

func (o DataCatalogMapOutput) ToDataCatalogMapOutput() DataCatalogMapOutput

func (DataCatalogMapOutput) ToDataCatalogMapOutputWithContext added in v5.5.0 

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

type DataCatalogOutput added in v5.5.0 

type DataCatalogOutput struct{ *pulumi.OutputState }

func (DataCatalogOutput) Arn added in v5.5.0 

func (o DataCatalogOutput) Arn() pulumi.StringOutput

ARN of the data catalog.

func (DataCatalogOutput) Description added in v5.5.0 

func (o DataCatalogOutput) Description() pulumi.StringOutput

Description of the data catalog.

func (DataCatalogOutput) ElementType added in v5.5.0 

func (DataCatalogOutput) ElementType() reflect.Type

func (DataCatalogOutput) Name added in v5.5.0 

func (o DataCatalogOutput) Name() pulumi.StringOutput

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 added in v5.5.0 

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 added in v5.5.0 

func (o DataCatalogOutput) Tags() pulumi.StringMapOutput

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 added in v5.5.0 

func (o DataCatalogOutput) TagsAll() pulumi.StringMapOutput

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

func (DataCatalogOutput) ToDataCatalogOutput added in v5.5.0 

func (o DataCatalogOutput) ToDataCatalogOutput() DataCatalogOutput

func (DataCatalogOutput) ToDataCatalogOutputWithContext added in v5.5.0 

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

func (DataCatalogOutput) Type added in v5.5.0 

func (o DataCatalogOutput) Type() pulumi.StringOutput

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

type DataCatalogState added in v5.5.0 

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.
	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 added in v5.5.0 

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/v5/go/aws/athena"
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/s3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

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

```

## Import

Athena Databases can be imported using their name, e.g.,

```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 configuration on an imported resource, the provider will always show a difference. To workaround this behavior, either omit the argument from the configuration or use `ignore_changes` to hide the difference, e.g., terraform resource "aws_athena_database" "example" {

name

= "database_name"

bucket = aws_s3_bucket.example.id

There is no API for reading bucket 

lifecycle {

ignore_changes = [bucket]

} }

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 added in v5.1.0 

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 added in v5.1.0 

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 added in v5.1.0 

func (DatabaseAclConfigurationArgs) ElementType() reflect.Type

func (DatabaseAclConfigurationArgs) ToDatabaseAclConfigurationOutput added in v5.1.0 

func (i DatabaseAclConfigurationArgs) ToDatabaseAclConfigurationOutput() DatabaseAclConfigurationOutput

func (DatabaseAclConfigurationArgs) ToDatabaseAclConfigurationOutputWithContext added in v5.1.0 

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

func (DatabaseAclConfigurationArgs) ToDatabaseAclConfigurationPtrOutput added in v5.1.0 

func (i DatabaseAclConfigurationArgs) ToDatabaseAclConfigurationPtrOutput() DatabaseAclConfigurationPtrOutput

func (DatabaseAclConfigurationArgs) ToDatabaseAclConfigurationPtrOutputWithContext added in v5.1.0 

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

type DatabaseAclConfigurationInput added in v5.1.0 

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 added in v5.1.0 

type DatabaseAclConfigurationOutput struct{ *pulumi.OutputState }

func (DatabaseAclConfigurationOutput) ElementType added in v5.1.0 

func (DatabaseAclConfigurationOutput) ElementType() reflect.Type

func (DatabaseAclConfigurationOutput) S3AclOption added in v5.1.0 

func (o DatabaseAclConfigurationOutput) S3AclOption() pulumi.StringOutput

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 added in v5.1.0 

func (o DatabaseAclConfigurationOutput) ToDatabaseAclConfigurationOutput() DatabaseAclConfigurationOutput

func (DatabaseAclConfigurationOutput) ToDatabaseAclConfigurationOutputWithContext added in v5.1.0 

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

func (DatabaseAclConfigurationOutput) ToDatabaseAclConfigurationPtrOutput added in v5.1.0 

func (o DatabaseAclConfigurationOutput) ToDatabaseAclConfigurationPtrOutput() DatabaseAclConfigurationPtrOutput

func (DatabaseAclConfigurationOutput) ToDatabaseAclConfigurationPtrOutputWithContext added in v5.1.0 

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

type DatabaseAclConfigurationPtrInput added in v5.1.0 

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

func DatabaseAclConfigurationPtr added in v5.1.0 

func DatabaseAclConfigurationPtr(v *DatabaseAclConfigurationArgs) DatabaseAclConfigurationPtrInput

type DatabaseAclConfigurationPtrOutput added in v5.1.0 

type DatabaseAclConfigurationPtrOutput struct{ *pulumi.OutputState }

func (DatabaseAclConfigurationPtrOutput) Elem added in v5.1.0 

func (o DatabaseAclConfigurationPtrOutput) Elem() DatabaseAclConfigurationOutput

func (DatabaseAclConfigurationPtrOutput) ElementType added in v5.1.0 

func (DatabaseAclConfigurationPtrOutput) ElementType() reflect.Type

func (DatabaseAclConfigurationPtrOutput) S3AclOption added in v5.1.0 

func (o DatabaseAclConfigurationPtrOutput) S3AclOption() pulumi.StringPtrOutput

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 added in v5.1.0 

func (o DatabaseAclConfigurationPtrOutput) ToDatabaseAclConfigurationPtrOutput() DatabaseAclConfigurationPtrOutput

func (DatabaseAclConfigurationPtrOutput) ToDatabaseAclConfigurationPtrOutputWithContext added in v5.1.0 

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 (o DatabaseArrayOutput) Index(i pulumi.IntInput) DatabaseOutput

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) ElementType() reflect.Type

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) ElementType() reflect.Type

func (DatabaseEncryptionConfigurationOutput) EncryptionOption 

func (o DatabaseEncryptionConfigurationOutput) EncryptionOption() pulumi.StringOutput

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

func (DatabaseEncryptionConfigurationOutput) KmsKey 

func (o DatabaseEncryptionConfigurationOutput) KmsKey() pulumi.StringPtrOutput

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

func DatabaseEncryptionConfigurationPtr 

func DatabaseEncryptionConfigurationPtr(v *DatabaseEncryptionConfigurationArgs) DatabaseEncryptionConfigurationPtrInput

type DatabaseEncryptionConfigurationPtrOutput 

type DatabaseEncryptionConfigurationPtrOutput struct{ *pulumi.OutputState }

func (DatabaseEncryptionConfigurationPtrOutput) Elem 

func (o DatabaseEncryptionConfigurationPtrOutput) Elem() DatabaseEncryptionConfigurationOutput

func (DatabaseEncryptionConfigurationPtrOutput) ElementType 

func (DatabaseEncryptionConfigurationPtrOutput) ElementType() reflect.Type

func (DatabaseEncryptionConfigurationPtrOutput) EncryptionOption 

func (o DatabaseEncryptionConfigurationPtrOutput) EncryptionOption() pulumi.StringPtrOutput

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

func (DatabaseEncryptionConfigurationPtrOutput) KmsKey 

func (o DatabaseEncryptionConfigurationPtrOutput) KmsKey() pulumi.StringPtrOutput

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 (o DatabaseMapOutput) MapIndex(k pulumi.StringInput) DatabaseOutput

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 added in v5.4.0 

func (o DatabaseOutput) AclConfiguration() DatabaseAclConfigurationPtrOutput

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

func (DatabaseOutput) Bucket added in v5.4.0 

func (o DatabaseOutput) Bucket() pulumi.StringPtrOutput

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

func (DatabaseOutput) Comment added in v5.4.0 

func (o DatabaseOutput) Comment() pulumi.StringPtrOutput

Description of the database.

func (DatabaseOutput) ElementType 

func (DatabaseOutput) ElementType() reflect.Type

func (DatabaseOutput) EncryptionConfiguration added in v5.4.0 

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 added in v5.4.0 

func (o DatabaseOutput) ExpectedBucketOwner() pulumi.StringPtrOutput

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

func (DatabaseOutput) ForceDestroy added in v5.4.0 

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 added in v5.4.0 

func (o DatabaseOutput) Name() pulumi.StringOutput

Name of the database to create.

func (DatabaseOutput) Properties added in v5.4.0 

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 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/v5/go/aws/athena"
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/kms"
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/s3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		hogeBucketV2, err := s3.NewBucketV2(ctx, "hogeBucketV2", nil)
		if err != nil {
			return err
		}
		testKey, err := kms.NewKey(ctx, "testKey", &kms.KeyArgs{
			DeletionWindowInDays: pulumi.Int(7),
			Description:          pulumi.String("Athena KMS Key"),
		})
		if err != nil {
			return err
		}
		testWorkgroup, err := athena.NewWorkgroup(ctx, "testWorkgroup", &athena.WorkgroupArgs{
			Configuration: &athena.WorkgroupConfigurationArgs{
				ResultConfiguration: &athena.WorkgroupConfigurationResultConfigurationArgs{
					EncryptionConfiguration: &athena.WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs{
						EncryptionOption: pulumi.String("SSE_KMS"),
						KmsKeyArn:        testKey.Arn,
					},
				},
			},
		})
		if err != nil {
			return err
		}
		hogeDatabase, err := athena.NewDatabase(ctx, "hogeDatabase", &athena.DatabaseArgs{
			Name:   pulumi.String("users"),
			Bucket: hogeBucketV2.ID(),
		})
		if err != nil {
			return err
		}
		_, err = athena.NewNamedQuery(ctx, "foo", &athena.NamedQueryArgs{
			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

Athena Named Query can be imported using the query ID, e.g.,

```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 (o NamedQueryArrayOutput) Index(i pulumi.IntInput) NamedQueryOutput

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 (o NamedQueryMapOutput) MapIndex(k pulumi.StringInput) NamedQueryOutput

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 added in v5.4.0 

func (o NamedQueryOutput) Database() pulumi.StringOutput

Database to which the query belongs.

func (NamedQueryOutput) Description added in v5.4.0 

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 added in v5.4.0 

func (o NamedQueryOutput) Name() pulumi.StringOutput

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

func (NamedQueryOutput) Query added in v5.4.0 

func (o NamedQueryOutput) Query() pulumi.StringOutput

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 added in v5.4.0 

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 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.
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
}

Provides an Athena Workgroup.

## Example Usage

```go package main

import ( 

"fmt"

"github.com/pulumi/pulumi-aws/sdk/v5/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{
			Configuration: &athena.WorkgroupConfigurationArgs{
				EnforceWorkgroupConfiguration:   pulumi.Bool(true),
				PublishCloudwatchMetricsEnabled: pulumi.Bool(true),
				ResultConfiguration: &athena.WorkgroupConfigurationResultConfigurationArgs{
					OutputLocation: pulumi.String(fmt.Sprintf("s3://%v/output/", aws_s3_bucket.Example.Bucket)),
					EncryptionConfiguration: &athena.WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs{
						EncryptionOption: pulumi.String("SSE_KMS"),
						KmsKeyArn:        pulumi.Any(aws_kms_key.Example.Arn),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Athena Workgroups can be imported using their name, e.g.,

```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 (o WorkgroupArrayOutput) Index(i pulumi.IntInput) WorkgroupOutput

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) ElementType() reflect.Type

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 

func (o WorkgroupConfigurationEngineVersionOutput) EffectiveEngineVersion() pulumi.StringPtrOutput

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) ElementType() reflect.Type

func (WorkgroupConfigurationEngineVersionOutput) SelectedEngineVersion 

func (o WorkgroupConfigurationEngineVersionOutput) SelectedEngineVersion() pulumi.StringPtrOutput

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

func WorkgroupConfigurationEngineVersionPtr 

func WorkgroupConfigurationEngineVersionPtr(v *WorkgroupConfigurationEngineVersionArgs) WorkgroupConfigurationEngineVersionPtrInput

type WorkgroupConfigurationEngineVersionPtrOutput 

type WorkgroupConfigurationEngineVersionPtrOutput struct{ *pulumi.OutputState }

func (WorkgroupConfigurationEngineVersionPtrOutput) EffectiveEngineVersion 

func (o WorkgroupConfigurationEngineVersionPtrOutput) EffectiveEngineVersion() pulumi.StringPtrOutput

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 (o WorkgroupConfigurationEngineVersionPtrOutput) Elem() WorkgroupConfigurationEngineVersionOutput

func (WorkgroupConfigurationEngineVersionPtrOutput) ElementType 

func (WorkgroupConfigurationEngineVersionPtrOutput) ElementType() reflect.Type

func (WorkgroupConfigurationEngineVersionPtrOutput) SelectedEngineVersion 

func (o WorkgroupConfigurationEngineVersionPtrOutput) SelectedEngineVersion() pulumi.StringPtrOutput

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) ElementType() reflect.Type

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 

func (o WorkgroupConfigurationOutput) EngineVersion() WorkgroupConfigurationEngineVersionPtrOutput

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 added in v5.27.0 

func (o WorkgroupConfigurationOutput) ExecutionRole() pulumi.StringPtrOutput

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 

func (o WorkgroupConfigurationOutput) ResultConfiguration() WorkgroupConfigurationResultConfigurationPtrOutput

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

func WorkgroupConfigurationPtr 

func WorkgroupConfigurationPtr(v *WorkgroupConfigurationArgs) WorkgroupConfigurationPtrInput

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 (o WorkgroupConfigurationPtrOutput) Elem() WorkgroupConfigurationOutput

func (WorkgroupConfigurationPtrOutput) ElementType 

func (WorkgroupConfigurationPtrOutput) ElementType() reflect.Type

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 

func (o WorkgroupConfigurationPtrOutput) EngineVersion() WorkgroupConfigurationEngineVersionPtrOutput

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 added in v5.27.0 

func (o WorkgroupConfigurationPtrOutput) ExecutionRole() pulumi.StringPtrOutput

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 

func (o WorkgroupConfigurationPtrOutput) ResultConfiguration() WorkgroupConfigurationResultConfigurationPtrOutput

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 added in v5.2.0 

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 added in v5.2.0 

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 added in v5.2.0 

func (WorkgroupConfigurationResultConfigurationAclConfigurationArgs) ElementType() reflect.Type

func (WorkgroupConfigurationResultConfigurationAclConfigurationArgs) ToWorkgroupConfigurationResultConfigurationAclConfigurationOutput added in v5.2.0 

func (i WorkgroupConfigurationResultConfigurationAclConfigurationArgs) ToWorkgroupConfigurationResultConfigurationAclConfigurationOutput() WorkgroupConfigurationResultConfigurationAclConfigurationOutput

func (WorkgroupConfigurationResultConfigurationAclConfigurationArgs) ToWorkgroupConfigurationResultConfigurationAclConfigurationOutputWithContext added in v5.2.0 

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

func (WorkgroupConfigurationResultConfigurationAclConfigurationArgs) ToWorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput added in v5.2.0 

func (i WorkgroupConfigurationResultConfigurationAclConfigurationArgs) ToWorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput() WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput

func (WorkgroupConfigurationResultConfigurationAclConfigurationArgs) ToWorkgroupConfigurationResultConfigurationAclConfigurationPtrOutputWithContext added in v5.2.0 

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

type WorkgroupConfigurationResultConfigurationAclConfigurationInput added in v5.2.0 

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 added in v5.2.0 

type WorkgroupConfigurationResultConfigurationAclConfigurationOutput struct{ *pulumi.OutputState }

func (WorkgroupConfigurationResultConfigurationAclConfigurationOutput) ElementType added in v5.2.0 

func (WorkgroupConfigurationResultConfigurationAclConfigurationOutput) ElementType() reflect.Type

func (WorkgroupConfigurationResultConfigurationAclConfigurationOutput) S3AclOption added in v5.2.0 

func (o WorkgroupConfigurationResultConfigurationAclConfigurationOutput) S3AclOption() pulumi.StringOutput

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

func (WorkgroupConfigurationResultConfigurationAclConfigurationOutput) ToWorkgroupConfigurationResultConfigurationAclConfigurationOutput added in v5.2.0 

func (o WorkgroupConfigurationResultConfigurationAclConfigurationOutput) ToWorkgroupConfigurationResultConfigurationAclConfigurationOutput() WorkgroupConfigurationResultConfigurationAclConfigurationOutput

func (WorkgroupConfigurationResultConfigurationAclConfigurationOutput) ToWorkgroupConfigurationResultConfigurationAclConfigurationOutputWithContext added in v5.2.0 

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

func (WorkgroupConfigurationResultConfigurationAclConfigurationOutput) ToWorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput added in v5.2.0 

func (o WorkgroupConfigurationResultConfigurationAclConfigurationOutput) ToWorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput() WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput

func (WorkgroupConfigurationResultConfigurationAclConfigurationOutput) ToWorkgroupConfigurationResultConfigurationAclConfigurationPtrOutputWithContext added in v5.2.0 

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

type WorkgroupConfigurationResultConfigurationAclConfigurationPtrInput added in v5.2.0 

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

func WorkgroupConfigurationResultConfigurationAclConfigurationPtr added in v5.2.0 

func WorkgroupConfigurationResultConfigurationAclConfigurationPtr(v *WorkgroupConfigurationResultConfigurationAclConfigurationArgs) WorkgroupConfigurationResultConfigurationAclConfigurationPtrInput

type WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput added in v5.2.0 

type WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput struct{ *pulumi.OutputState }

func (WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput) Elem added in v5.2.0 

func (o WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput) Elem() WorkgroupConfigurationResultConfigurationAclConfigurationOutput

func (WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput) ElementType added in v5.2.0 

func (WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput) ElementType() reflect.Type

func (WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput) S3AclOption added in v5.2.0 

func (o WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput) S3AclOption() pulumi.StringPtrOutput

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

func (WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput) ToWorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput added in v5.2.0 

func (o WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput) ToWorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput() WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput

func (WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput) ToWorkgroupConfigurationResultConfigurationAclConfigurationPtrOutputWithContext added in v5.2.0 

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) ElementType() reflect.Type

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) ElementType() reflect.Type

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput 

func (i WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput() WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutputWithContext 

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

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput 

func (i WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput() WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput

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) ElementType() reflect.Type

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) EncryptionOption 

func (o WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) EncryptionOption() pulumi.StringPtrOutput

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 

func (o WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) KmsKeyArn() pulumi.StringPtrOutput

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

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput 

func (o WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput() WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutputWithContext 

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

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput 

func (o WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput() WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput

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

func WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtr 

func WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtr(v *WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs) WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrInput

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput 

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput struct{ *pulumi.OutputState }

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) Elem 

func (o WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) Elem() WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) ElementType 

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) ElementType() reflect.Type

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) EncryptionOption 

func (o WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) EncryptionOption() pulumi.StringPtrOutput

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 

func (o WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) KmsKeyArn() pulumi.StringPtrOutput

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

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput 

func (o WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput() WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutputWithContext 

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

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 added in v5.2.0 

func (o WorkgroupConfigurationResultConfigurationOutput) AclConfiguration() WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput

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) ElementType() reflect.Type

func (WorkgroupConfigurationResultConfigurationOutput) EncryptionConfiguration 

func (o WorkgroupConfigurationResultConfigurationOutput) EncryptionConfiguration() WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput

Configuration block with encryption settings. See Encryption Configuration below.

func (WorkgroupConfigurationResultConfigurationOutput) ExpectedBucketOwner added in v5.2.0 

func (o WorkgroupConfigurationResultConfigurationOutput) ExpectedBucketOwner() pulumi.StringPtrOutput

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

func (WorkgroupConfigurationResultConfigurationOutput) OutputLocation 

func (o WorkgroupConfigurationResultConfigurationOutput) OutputLocation() pulumi.StringPtrOutput

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

func WorkgroupConfigurationResultConfigurationPtr 

func WorkgroupConfigurationResultConfigurationPtr(v *WorkgroupConfigurationResultConfigurationArgs) WorkgroupConfigurationResultConfigurationPtrInput

type WorkgroupConfigurationResultConfigurationPtrOutput 

type WorkgroupConfigurationResultConfigurationPtrOutput struct{ *pulumi.OutputState }

func (WorkgroupConfigurationResultConfigurationPtrOutput) AclConfiguration added in v5.2.0 

func (o WorkgroupConfigurationResultConfigurationPtrOutput) AclConfiguration() WorkgroupConfigurationResultConfigurationAclConfigurationPtrOutput

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

func (WorkgroupConfigurationResultConfigurationPtrOutput) Elem 

func (o WorkgroupConfigurationResultConfigurationPtrOutput) Elem() WorkgroupConfigurationResultConfigurationOutput

func (WorkgroupConfigurationResultConfigurationPtrOutput) ElementType 

func (WorkgroupConfigurationResultConfigurationPtrOutput) ElementType() reflect.Type

func (WorkgroupConfigurationResultConfigurationPtrOutput) EncryptionConfiguration 

func (o WorkgroupConfigurationResultConfigurationPtrOutput) EncryptionConfiguration() WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput

Configuration block with encryption settings. See Encryption Configuration below.

func (WorkgroupConfigurationResultConfigurationPtrOutput) ExpectedBucketOwner added in v5.2.0 

func (o WorkgroupConfigurationResultConfigurationPtrOutput) ExpectedBucketOwner() pulumi.StringPtrOutput

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

func (WorkgroupConfigurationResultConfigurationPtrOutput) OutputLocation 

func (o WorkgroupConfigurationResultConfigurationPtrOutput) OutputLocation() pulumi.StringPtrOutput

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 (o WorkgroupMapOutput) MapIndex(k pulumi.StringInput) WorkgroupOutput

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 added in v5.4.0 

func (o WorkgroupOutput) Arn() pulumi.StringOutput

ARN of the workgroup

func (WorkgroupOutput) Configuration added in v5.4.0 

func (o WorkgroupOutput) Configuration() WorkgroupConfigurationPtrOutput

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

func (WorkgroupOutput) Description added in v5.4.0 

func (o WorkgroupOutput) Description() pulumi.StringPtrOutput

Description of the workgroup.

func (WorkgroupOutput) ElementType 

func (WorkgroupOutput) ElementType() reflect.Type

func (WorkgroupOutput) ForceDestroy added in v5.4.0 

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 added in v5.4.0 

func (o WorkgroupOutput) Name() pulumi.StringOutput

Name of the workgroup.

func (WorkgroupOutput) State added in v5.4.0 

func (o WorkgroupOutput) State() pulumi.StringPtrOutput

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

func (WorkgroupOutput) Tags added in v5.4.0 

func (o WorkgroupOutput) Tags() pulumi.StringMapOutput

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 added in v5.4.0 

func (o WorkgroupOutput) TagsAll() pulumi.StringMapOutput

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

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.
	TagsAll pulumi.StringMapInput
}

func (WorkgroupState) ElementType 

func (WorkgroupState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.