athena

package
v3.38.1 Latest Latest
Warning

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

 Go to latest Published: Apr 13, 2021 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 Database 

type Database struct {
	pulumi.CustomResourceState

	// Name of s3 bucket to save the results of the query execution.
	Bucket pulumi.StringOutput `pulumi:"bucket"`
	// The encryption key block AWS Athena uses to decrypt the data in S3, such as an AWS Key Management Service (AWS KMS) key. An `encryptionConfiguration` block is documented below.
	EncryptionConfiguration DatabaseEncryptionConfigurationPtrOutput `pulumi:"encryptionConfiguration"`
	// A boolean that indicates all tables should be deleted from the database so that the database can be destroyed without error. The tables are *not* recoverable.
	ForceDestroy pulumi.BoolPtrOutput `pulumi:"forceDestroy"`
	// Name of the database to create.
	Name pulumi.StringOutput `pulumi:"name"`
}

Provides an Athena database.

## Example Usage

```go package main

import ( 

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

) 

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

```

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 added in v3.13.0 

func (*Database) ElementType() reflect.Type

func (*Database) ToDatabaseOutput added in v3.13.0 

func (i *Database) ToDatabaseOutput() DatabaseOutput

func (*Database) ToDatabaseOutputWithContext added in v3.13.0 

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

func (*Database) ToDatabasePtrOutput added in v3.25.0 

func (i *Database) ToDatabasePtrOutput() DatabasePtrOutput

func (*Database) ToDatabasePtrOutputWithContext added in v3.25.0 

func (i *Database) ToDatabasePtrOutputWithContext(ctx context.Context) DatabasePtrOutput

type DatabaseArgs 

type DatabaseArgs struct {
	// Name of s3 bucket to save the results of the query execution.
	Bucket pulumi.StringInput
	// The encryption key block AWS Athena uses to decrypt the data in S3, such as an AWS Key Management Service (AWS KMS) key. An `encryptionConfiguration` block is documented below.
	EncryptionConfiguration DatabaseEncryptionConfigurationPtrInput
	// A boolean that indicates all tables should be deleted from the database so that the database can be destroyed without error. The tables are *not* recoverable.
	ForceDestroy pulumi.BoolPtrInput
	// Name of the database to create.
	Name pulumi.StringPtrInput
}

The set of arguments for constructing a Database resource.

func (DatabaseArgs) ElementType 

func (DatabaseArgs) ElementType() reflect.Type

type DatabaseArray added in v3.25.0 

type DatabaseArray []DatabaseInput

func (DatabaseArray) ElementType added in v3.25.0 

func (DatabaseArray) ElementType() reflect.Type

func (DatabaseArray) ToDatabaseArrayOutput added in v3.25.0 

func (i DatabaseArray) ToDatabaseArrayOutput() DatabaseArrayOutput

func (DatabaseArray) ToDatabaseArrayOutputWithContext added in v3.25.0 

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

type DatabaseArrayInput added in v3.25.0 

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 added in v3.25.0 

type DatabaseArrayOutput struct{ *pulumi.OutputState }

func (DatabaseArrayOutput) ElementType added in v3.25.0 

func (DatabaseArrayOutput) ElementType() reflect.Type

func (DatabaseArrayOutput) Index added in v3.25.0 

func (o DatabaseArrayOutput) Index(i pulumi.IntInput) DatabaseOutput

func (DatabaseArrayOutput) ToDatabaseArrayOutput added in v3.25.0 

func (o DatabaseArrayOutput) ToDatabaseArrayOutput() DatabaseArrayOutput

func (DatabaseArrayOutput) ToDatabaseArrayOutputWithContext added in v3.25.0 

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

type DatabaseEncryptionConfiguration 

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

type DatabaseEncryptionConfigurationArgs 

type DatabaseEncryptionConfigurationArgs struct {
	// The type of key; one of `SSE_S3`, `SSE_KMS`, `CSE_KMS`
	EncryptionOption pulumi.StringInput `pulumi:"encryptionOption"`
	// The 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

The type of key; one of `SSE_S3`, `SSE_KMS`, `CSE_KMS`

func (DatabaseEncryptionConfigurationOutput) KmsKey 

func (o DatabaseEncryptionConfigurationOutput) KmsKey() pulumi.StringPtrOutput

The 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

The type of key; one of `SSE_S3`, `SSE_KMS`, `CSE_KMS`

func (DatabaseEncryptionConfigurationPtrOutput) KmsKey 

func (o DatabaseEncryptionConfigurationPtrOutput) KmsKey() pulumi.StringPtrOutput

The 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 added in v3.13.0 

type DatabaseInput interface {
	pulumi.Input

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

type DatabaseMap added in v3.25.0 

type DatabaseMap map[string]DatabaseInput

func (DatabaseMap) ElementType added in v3.25.0 

func (DatabaseMap) ElementType() reflect.Type

func (DatabaseMap) ToDatabaseMapOutput added in v3.25.0 

func (i DatabaseMap) ToDatabaseMapOutput() DatabaseMapOutput

func (DatabaseMap) ToDatabaseMapOutputWithContext added in v3.25.0 

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

type DatabaseMapInput added in v3.25.0 

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 added in v3.25.0 

type DatabaseMapOutput struct{ *pulumi.OutputState }

func (DatabaseMapOutput) ElementType added in v3.25.0 

func (DatabaseMapOutput) ElementType() reflect.Type

func (DatabaseMapOutput) MapIndex added in v3.25.0 

func (o DatabaseMapOutput) MapIndex(k pulumi.StringInput) DatabaseOutput

func (DatabaseMapOutput) ToDatabaseMapOutput added in v3.25.0 

func (o DatabaseMapOutput) ToDatabaseMapOutput() DatabaseMapOutput

func (DatabaseMapOutput) ToDatabaseMapOutputWithContext added in v3.25.0 

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

type DatabaseOutput added in v3.13.0 

type DatabaseOutput struct {
	*pulumi.OutputState
}

func (DatabaseOutput) ElementType added in v3.13.0 

func (DatabaseOutput) ElementType() reflect.Type

func (DatabaseOutput) ToDatabaseOutput added in v3.13.0 

func (o DatabaseOutput) ToDatabaseOutput() DatabaseOutput

func (DatabaseOutput) ToDatabaseOutputWithContext added in v3.13.0 

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

func (DatabaseOutput) ToDatabasePtrOutput added in v3.25.0 

func (o DatabaseOutput) ToDatabasePtrOutput() DatabasePtrOutput

func (DatabaseOutput) ToDatabasePtrOutputWithContext added in v3.25.0 

func (o DatabaseOutput) ToDatabasePtrOutputWithContext(ctx context.Context) DatabasePtrOutput

type DatabasePtrInput added in v3.25.0 

type DatabasePtrInput interface {
	pulumi.Input

	ToDatabasePtrOutput() DatabasePtrOutput
	ToDatabasePtrOutputWithContext(ctx context.Context) DatabasePtrOutput
}

type DatabasePtrOutput added in v3.25.0 

type DatabasePtrOutput struct {
	*pulumi.OutputState
}

func (DatabasePtrOutput) ElementType added in v3.25.0 

func (DatabasePtrOutput) ElementType() reflect.Type

func (DatabasePtrOutput) ToDatabasePtrOutput added in v3.25.0 

func (o DatabasePtrOutput) ToDatabasePtrOutput() DatabasePtrOutput

func (DatabasePtrOutput) ToDatabasePtrOutputWithContext added in v3.25.0 

func (o DatabasePtrOutput) ToDatabasePtrOutputWithContext(ctx context.Context) DatabasePtrOutput

type DatabaseState 

type DatabaseState struct {
	// Name of s3 bucket to save the results of the query execution.
	Bucket pulumi.StringPtrInput
	// The encryption key block AWS Athena uses to decrypt the data in S3, such as an AWS Key Management Service (AWS KMS) key. An `encryptionConfiguration` block is documented below.
	EncryptionConfiguration DatabaseEncryptionConfigurationPtrInput
	// A boolean that indicates all tables should be deleted from the database so that the database can be destroyed without error. The tables are *not* recoverable.
	ForceDestroy pulumi.BoolPtrInput
	// Name of the database to create.
	Name pulumi.StringPtrInput
}

func (DatabaseState) ElementType 

func (DatabaseState) ElementType() reflect.Type

type NamedQuery 

type NamedQuery struct {
	pulumi.CustomResourceState

	// The database to which the query belongs.
	Database pulumi.StringOutput `pulumi:"database"`
	// A brief explanation of the query. Maximum length of 1024.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The plain language name for the query. Maximum length of 128.
	Name pulumi.StringOutput `pulumi:"name"`
	// The text of the query itself. In other words, all query statements. Maximum length of 262144.
	Query pulumi.StringOutput `pulumi:"query"`
	// The 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/v3/go/aws/athena"
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/kms"
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/s3"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		hogeBucket, err := s3.NewBucket(ctx, "hogeBucket", 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: hogeBucket.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("%v%v%v", "SELECT * FROM ", name, " limit 10;"), 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 added in v3.13.0 

func (*NamedQuery) ElementType() reflect.Type

func (*NamedQuery) ToNamedQueryOutput added in v3.13.0 

func (i *NamedQuery) ToNamedQueryOutput() NamedQueryOutput

func (*NamedQuery) ToNamedQueryOutputWithContext added in v3.13.0 

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

func (*NamedQuery) ToNamedQueryPtrOutput added in v3.25.0 

func (i *NamedQuery) ToNamedQueryPtrOutput() NamedQueryPtrOutput

func (*NamedQuery) ToNamedQueryPtrOutputWithContext added in v3.25.0 

func (i *NamedQuery) ToNamedQueryPtrOutputWithContext(ctx context.Context) NamedQueryPtrOutput

type NamedQueryArgs 

type NamedQueryArgs struct {
	// The database to which the query belongs.
	Database pulumi.StringInput
	// A brief explanation of the query. Maximum length of 1024.
	Description pulumi.StringPtrInput
	// The plain language name for the query. Maximum length of 128.
	Name pulumi.StringPtrInput
	// The text of the query itself. In other words, all query statements. Maximum length of 262144.
	Query pulumi.StringInput
	// The 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 added in v3.25.0 

type NamedQueryArray []NamedQueryInput

func (NamedQueryArray) ElementType added in v3.25.0 

func (NamedQueryArray) ElementType() reflect.Type

func (NamedQueryArray) ToNamedQueryArrayOutput added in v3.25.0 

func (i NamedQueryArray) ToNamedQueryArrayOutput() NamedQueryArrayOutput

func (NamedQueryArray) ToNamedQueryArrayOutputWithContext added in v3.25.0 

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

type NamedQueryArrayInput added in v3.25.0 

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 added in v3.25.0 

type NamedQueryArrayOutput struct{ *pulumi.OutputState }

func (NamedQueryArrayOutput) ElementType added in v3.25.0 

func (NamedQueryArrayOutput) ElementType() reflect.Type

func (NamedQueryArrayOutput) Index added in v3.25.0 

func (o NamedQueryArrayOutput) Index(i pulumi.IntInput) NamedQueryOutput

func (NamedQueryArrayOutput) ToNamedQueryArrayOutput added in v3.25.0 

func (o NamedQueryArrayOutput) ToNamedQueryArrayOutput() NamedQueryArrayOutput

func (NamedQueryArrayOutput) ToNamedQueryArrayOutputWithContext added in v3.25.0 

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

type NamedQueryInput added in v3.13.0 

type NamedQueryInput interface {
	pulumi.Input

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

type NamedQueryMap added in v3.25.0 

type NamedQueryMap map[string]NamedQueryInput

func (NamedQueryMap) ElementType added in v3.25.0 

func (NamedQueryMap) ElementType() reflect.Type

func (NamedQueryMap) ToNamedQueryMapOutput added in v3.25.0 

func (i NamedQueryMap) ToNamedQueryMapOutput() NamedQueryMapOutput

func (NamedQueryMap) ToNamedQueryMapOutputWithContext added in v3.25.0 

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

type NamedQueryMapInput added in v3.25.0 

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 added in v3.25.0 

type NamedQueryMapOutput struct{ *pulumi.OutputState }

func (NamedQueryMapOutput) ElementType added in v3.25.0 

func (NamedQueryMapOutput) ElementType() reflect.Type

func (NamedQueryMapOutput) MapIndex added in v3.25.0 

func (o NamedQueryMapOutput) MapIndex(k pulumi.StringInput) NamedQueryOutput

func (NamedQueryMapOutput) ToNamedQueryMapOutput added in v3.25.0 

func (o NamedQueryMapOutput) ToNamedQueryMapOutput() NamedQueryMapOutput

func (NamedQueryMapOutput) ToNamedQueryMapOutputWithContext added in v3.25.0 

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

type NamedQueryOutput added in v3.13.0 

type NamedQueryOutput struct {
	*pulumi.OutputState
}

func (NamedQueryOutput) ElementType added in v3.13.0 

func (NamedQueryOutput) ElementType() reflect.Type

func (NamedQueryOutput) ToNamedQueryOutput added in v3.13.0 

func (o NamedQueryOutput) ToNamedQueryOutput() NamedQueryOutput

func (NamedQueryOutput) ToNamedQueryOutputWithContext added in v3.13.0 

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

func (NamedQueryOutput) ToNamedQueryPtrOutput added in v3.25.0 

func (o NamedQueryOutput) ToNamedQueryPtrOutput() NamedQueryPtrOutput

func (NamedQueryOutput) ToNamedQueryPtrOutputWithContext added in v3.25.0 

func (o NamedQueryOutput) ToNamedQueryPtrOutputWithContext(ctx context.Context) NamedQueryPtrOutput

type NamedQueryPtrInput added in v3.25.0 

type NamedQueryPtrInput interface {
	pulumi.Input

	ToNamedQueryPtrOutput() NamedQueryPtrOutput
	ToNamedQueryPtrOutputWithContext(ctx context.Context) NamedQueryPtrOutput
}

type NamedQueryPtrOutput added in v3.25.0 

type NamedQueryPtrOutput struct {
	*pulumi.OutputState
}

func (NamedQueryPtrOutput) ElementType added in v3.25.0 

func (NamedQueryPtrOutput) ElementType() reflect.Type

func (NamedQueryPtrOutput) ToNamedQueryPtrOutput added in v3.25.0 

func (o NamedQueryPtrOutput) ToNamedQueryPtrOutput() NamedQueryPtrOutput

func (NamedQueryPtrOutput) ToNamedQueryPtrOutputWithContext added in v3.25.0 

func (o NamedQueryPtrOutput) ToNamedQueryPtrOutputWithContext(ctx context.Context) NamedQueryPtrOutput

type NamedQueryState 

type NamedQueryState struct {
	// The database to which the query belongs.
	Database pulumi.StringPtrInput
	// A brief explanation of the query. Maximum length of 1024.
	Description pulumi.StringPtrInput
	// The plain language name for the query. Maximum length of 128.
	Name pulumi.StringPtrInput
	// The text of the query itself. In other words, all query statements. Maximum length of 262144.
	Query pulumi.StringPtrInput
	// The 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

	// Amazon Resource Name (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"`
	// The 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.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

Provides an Athena Workgroup.

## Example Usage

```go package main

import ( 

"fmt"

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/athena"
"github.com/pulumi/pulumi/sdk/v2/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("%v%v%v", "s3://", aws_s3_bucket.Example.Bucket, "/output/")),
					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 added in v3.13.0 

func (*Workgroup) ElementType() reflect.Type

func (*Workgroup) ToWorkgroupOutput added in v3.13.0 

func (i *Workgroup) ToWorkgroupOutput() WorkgroupOutput

func (*Workgroup) ToWorkgroupOutputWithContext added in v3.13.0 

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

func (*Workgroup) ToWorkgroupPtrOutput added in v3.25.0 

func (i *Workgroup) ToWorkgroupPtrOutput() WorkgroupPtrOutput

func (*Workgroup) ToWorkgroupPtrOutputWithContext added in v3.25.0 

func (i *Workgroup) ToWorkgroupPtrOutputWithContext(ctx context.Context) WorkgroupPtrOutput

type WorkgroupArgs 

type WorkgroupArgs struct {
	// Configuration block with various settings for the workgroup. Documented below.
	Configuration WorkgroupConfigurationPtrInput
	// Description of the workgroup.
	Description pulumi.StringPtrInput
	// The 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.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Workgroup resource.

func (WorkgroupArgs) ElementType 

func (WorkgroupArgs) ElementType() reflect.Type

type WorkgroupArray added in v3.25.0 

type WorkgroupArray []WorkgroupInput

func (WorkgroupArray) ElementType added in v3.25.0 

func (WorkgroupArray) ElementType() reflect.Type

func (WorkgroupArray) ToWorkgroupArrayOutput added in v3.25.0 

func (i WorkgroupArray) ToWorkgroupArrayOutput() WorkgroupArrayOutput

func (WorkgroupArray) ToWorkgroupArrayOutputWithContext added in v3.25.0 

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

type WorkgroupArrayInput added in v3.25.0 

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 added in v3.25.0 

type WorkgroupArrayOutput struct{ *pulumi.OutputState }

func (WorkgroupArrayOutput) ElementType added in v3.25.0 

func (WorkgroupArrayOutput) ElementType() reflect.Type

func (WorkgroupArrayOutput) Index added in v3.25.0 

func (o WorkgroupArrayOutput) Index(i pulumi.IntInput) WorkgroupOutput

func (WorkgroupArrayOutput) ToWorkgroupArrayOutput added in v3.25.0 

func (o WorkgroupArrayOutput) ToWorkgroupArrayOutput() WorkgroupArrayOutput

func (WorkgroupArrayOutput) ToWorkgroupArrayOutputWithContext added in v3.25.0 

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"`
	// Boolean whether Amazon CloudWatch metrics are enabled for the workgroup. Defaults to `true`.
	PublishCloudwatchMetricsEnabled *bool `pulumi:"publishCloudwatchMetricsEnabled"`
	// Configuration block with result settings. Documented 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"`
	// Boolean whether Amazon CloudWatch metrics are enabled for the workgroup. Defaults to `true`.
	PublishCloudwatchMetricsEnabled pulumi.BoolPtrInput `pulumi:"publishCloudwatchMetricsEnabled"`
	// Configuration block with result settings. Documented 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 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) PublishCloudwatchMetricsEnabled 

func (o WorkgroupConfigurationOutput) PublishCloudwatchMetricsEnabled() pulumi.BoolPtrOutput

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

func (WorkgroupConfigurationOutput) ResultConfiguration 

func (o WorkgroupConfigurationOutput) ResultConfiguration() WorkgroupConfigurationResultConfigurationPtrOutput

Configuration block with result settings. Documented 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) PublishCloudwatchMetricsEnabled 

func (o WorkgroupConfigurationPtrOutput) PublishCloudwatchMetricsEnabled() pulumi.BoolPtrOutput

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

func (WorkgroupConfigurationPtrOutput) ResultConfiguration 

func (o WorkgroupConfigurationPtrOutput) ResultConfiguration() WorkgroupConfigurationResultConfigurationPtrOutput

Configuration block with result settings. Documented 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 {
	// Configuration block with encryption settings. Documented below.
	EncryptionConfiguration *WorkgroupConfigurationResultConfigurationEncryptionConfiguration `pulumi:"encryptionConfiguration"`
	// The 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 WorkgroupConfigurationResultConfigurationArgs 

type WorkgroupConfigurationResultConfigurationArgs struct {
	// Configuration block with encryption settings. Documented below.
	EncryptionConfiguration WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrInput `pulumi:"encryptionConfiguration"`
	// The 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 {
	// Indicates 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 Amazon Resource Name (ARN).
	KmsKeyArn *string `pulumi:"kmsKeyArn"`
}

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs 

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs struct {
	// Indicates 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 Amazon Resource Name (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

Indicates 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 Amazon Resource Name (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

Indicates 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 Amazon Resource Name (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) ElementType 

func (WorkgroupConfigurationResultConfigurationOutput) ElementType() reflect.Type

func (WorkgroupConfigurationResultConfigurationOutput) EncryptionConfiguration 

func (o WorkgroupConfigurationResultConfigurationOutput) EncryptionConfiguration() WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput

Configuration block with encryption settings. Documented below.

func (WorkgroupConfigurationResultConfigurationOutput) OutputLocation 

func (o WorkgroupConfigurationResultConfigurationOutput) OutputLocation() pulumi.StringPtrOutput

The 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) 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. Documented below.

func (WorkgroupConfigurationResultConfigurationPtrOutput) OutputLocation 

func (o WorkgroupConfigurationResultConfigurationPtrOutput) OutputLocation() pulumi.StringPtrOutput

The 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 added in v3.13.0 

type WorkgroupInput interface {
	pulumi.Input

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

type WorkgroupMap added in v3.25.0 

type WorkgroupMap map[string]WorkgroupInput

func (WorkgroupMap) ElementType added in v3.25.0 

func (WorkgroupMap) ElementType() reflect.Type

func (WorkgroupMap) ToWorkgroupMapOutput added in v3.25.0 

func (i WorkgroupMap) ToWorkgroupMapOutput() WorkgroupMapOutput

func (WorkgroupMap) ToWorkgroupMapOutputWithContext added in v3.25.0 

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

type WorkgroupMapInput added in v3.25.0 

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 added in v3.25.0 

type WorkgroupMapOutput struct{ *pulumi.OutputState }

func (WorkgroupMapOutput) ElementType added in v3.25.0 

func (WorkgroupMapOutput) ElementType() reflect.Type

func (WorkgroupMapOutput) MapIndex added in v3.25.0 

func (o WorkgroupMapOutput) MapIndex(k pulumi.StringInput) WorkgroupOutput

func (WorkgroupMapOutput) ToWorkgroupMapOutput added in v3.25.0 

func (o WorkgroupMapOutput) ToWorkgroupMapOutput() WorkgroupMapOutput

func (WorkgroupMapOutput) ToWorkgroupMapOutputWithContext added in v3.25.0 

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

type WorkgroupOutput added in v3.13.0 

type WorkgroupOutput struct {
	*pulumi.OutputState
}

func (WorkgroupOutput) ElementType added in v3.13.0 

func (WorkgroupOutput) ElementType() reflect.Type

func (WorkgroupOutput) ToWorkgroupOutput added in v3.13.0 

func (o WorkgroupOutput) ToWorkgroupOutput() WorkgroupOutput

func (WorkgroupOutput) ToWorkgroupOutputWithContext added in v3.13.0 

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

func (WorkgroupOutput) ToWorkgroupPtrOutput added in v3.25.0 

func (o WorkgroupOutput) ToWorkgroupPtrOutput() WorkgroupPtrOutput

func (WorkgroupOutput) ToWorkgroupPtrOutputWithContext added in v3.25.0 

func (o WorkgroupOutput) ToWorkgroupPtrOutputWithContext(ctx context.Context) WorkgroupPtrOutput

type WorkgroupPtrInput added in v3.25.0 

type WorkgroupPtrInput interface {
	pulumi.Input

	ToWorkgroupPtrOutput() WorkgroupPtrOutput
	ToWorkgroupPtrOutputWithContext(ctx context.Context) WorkgroupPtrOutput
}

type WorkgroupPtrOutput added in v3.25.0 

type WorkgroupPtrOutput struct {
	*pulumi.OutputState
}

func (WorkgroupPtrOutput) ElementType added in v3.25.0 

func (WorkgroupPtrOutput) ElementType() reflect.Type

func (WorkgroupPtrOutput) ToWorkgroupPtrOutput added in v3.25.0 

func (o WorkgroupPtrOutput) ToWorkgroupPtrOutput() WorkgroupPtrOutput

func (WorkgroupPtrOutput) ToWorkgroupPtrOutputWithContext added in v3.25.0 

func (o WorkgroupPtrOutput) ToWorkgroupPtrOutputWithContext(ctx context.Context) WorkgroupPtrOutput

type WorkgroupState 

type WorkgroupState struct {
	// Amazon Resource Name (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
	// The 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.
	Tags 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.