athena

package
v1.25.0 Latest Latest
Warning

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

 Go to latest Published: Mar 9, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

nolint: lll

nolint: lll

nolint: lll

nolint: lll

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.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/athena_database.html.markdown.

func GetDatabase 

func GetDatabase(ctx *pulumi.Context,
	name string, id pulumi.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.

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 added in v1.19.0 

func (DatabaseArgs) ElementType() reflect.Type

type DatabaseEncryptionConfiguration added in v1.19.0 

type DatabaseEncryptionConfiguration struct {
	EncryptionOption string  `pulumi:"encryptionOption"`
	KmsKey           *string `pulumi:"kmsKey"`
}

type DatabaseEncryptionConfigurationArgs added in v1.19.0 

type DatabaseEncryptionConfigurationArgs struct {
	EncryptionOption pulumi.StringInput    `pulumi:"encryptionOption"`
	KmsKey           pulumi.StringPtrInput `pulumi:"kmsKey"`
}

func (DatabaseEncryptionConfigurationArgs) ElementType added in v1.19.0 

func (DatabaseEncryptionConfigurationArgs) ElementType() reflect.Type

func (DatabaseEncryptionConfigurationArgs) ToDatabaseEncryptionConfigurationOutput added in v1.19.0 

func (i DatabaseEncryptionConfigurationArgs) ToDatabaseEncryptionConfigurationOutput() DatabaseEncryptionConfigurationOutput

func (DatabaseEncryptionConfigurationArgs) ToDatabaseEncryptionConfigurationOutputWithContext added in v1.19.0 

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

func (DatabaseEncryptionConfigurationArgs) ToDatabaseEncryptionConfigurationPtrOutput added in v1.19.0 

func (i DatabaseEncryptionConfigurationArgs) ToDatabaseEncryptionConfigurationPtrOutput() DatabaseEncryptionConfigurationPtrOutput

func (DatabaseEncryptionConfigurationArgs) ToDatabaseEncryptionConfigurationPtrOutputWithContext added in v1.19.0 

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

type DatabaseEncryptionConfigurationInput added in v1.19.0 

type DatabaseEncryptionConfigurationInput interface {
	pulumi.Input

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

type DatabaseEncryptionConfigurationOutput added in v1.19.0 

type DatabaseEncryptionConfigurationOutput struct{ *pulumi.OutputState }

func (DatabaseEncryptionConfigurationOutput) ElementType added in v1.19.0 

func (DatabaseEncryptionConfigurationOutput) ElementType() reflect.Type

func (DatabaseEncryptionConfigurationOutput) EncryptionOption added in v1.19.0 

func (o DatabaseEncryptionConfigurationOutput) EncryptionOption() pulumi.StringOutput

func (DatabaseEncryptionConfigurationOutput) KmsKey added in v1.19.0 

func (o DatabaseEncryptionConfigurationOutput) KmsKey() pulumi.StringPtrOutput

func (DatabaseEncryptionConfigurationOutput) ToDatabaseEncryptionConfigurationOutput added in v1.19.0 

func (o DatabaseEncryptionConfigurationOutput) ToDatabaseEncryptionConfigurationOutput() DatabaseEncryptionConfigurationOutput

func (DatabaseEncryptionConfigurationOutput) ToDatabaseEncryptionConfigurationOutputWithContext added in v1.19.0 

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

func (DatabaseEncryptionConfigurationOutput) ToDatabaseEncryptionConfigurationPtrOutput added in v1.19.0 

func (o DatabaseEncryptionConfigurationOutput) ToDatabaseEncryptionConfigurationPtrOutput() DatabaseEncryptionConfigurationPtrOutput

func (DatabaseEncryptionConfigurationOutput) ToDatabaseEncryptionConfigurationPtrOutputWithContext added in v1.19.0 

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

type DatabaseEncryptionConfigurationPtrInput added in v1.19.0 

type DatabaseEncryptionConfigurationPtrInput interface {
	pulumi.Input

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

func DatabaseEncryptionConfigurationPtr added in v1.19.0 

func DatabaseEncryptionConfigurationPtr(v *DatabaseEncryptionConfigurationArgs) DatabaseEncryptionConfigurationPtrInput

type DatabaseEncryptionConfigurationPtrOutput added in v1.19.0 

type DatabaseEncryptionConfigurationPtrOutput struct{ *pulumi.OutputState }

func (DatabaseEncryptionConfigurationPtrOutput) Elem added in v1.19.0 

func (o DatabaseEncryptionConfigurationPtrOutput) Elem() DatabaseEncryptionConfigurationOutput

func (DatabaseEncryptionConfigurationPtrOutput) ElementType added in v1.19.0 

func (DatabaseEncryptionConfigurationPtrOutput) ElementType() reflect.Type

func (DatabaseEncryptionConfigurationPtrOutput) EncryptionOption added in v1.19.0 

func (o DatabaseEncryptionConfigurationPtrOutput) EncryptionOption() pulumi.StringOutput

func (DatabaseEncryptionConfigurationPtrOutput) KmsKey added in v1.19.0 

func (o DatabaseEncryptionConfigurationPtrOutput) KmsKey() pulumi.StringPtrOutput

func (DatabaseEncryptionConfigurationPtrOutput) ToDatabaseEncryptionConfigurationPtrOutput added in v1.19.0 

func (o DatabaseEncryptionConfigurationPtrOutput) ToDatabaseEncryptionConfigurationPtrOutput() DatabaseEncryptionConfigurationPtrOutput

func (DatabaseEncryptionConfigurationPtrOutput) ToDatabaseEncryptionConfigurationPtrOutputWithContext added in v1.19.0 

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

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 added in v1.19.0 

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.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/athena_named_query.html.markdown.

func GetNamedQuery 

func GetNamedQuery(ctx *pulumi.Context,
	name string, id pulumi.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.

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 added in v1.19.0 

func (NamedQueryArgs) ElementType() reflect.Type

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 added in v1.19.0 

func (NamedQueryState) ElementType() reflect.Type

type Workgroup added in v0.18.21 

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"`
	// 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 mapping of resource tags for the workgroup.
	Tags pulumi.MapOutput `pulumi:"tags"`
}

Provides an Athena Workgroup.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/athena_workgroup.html.markdown.

func GetWorkgroup added in v0.18.21 

func GetWorkgroup(ctx *pulumi.Context,
	name string, id pulumi.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 added in v0.18.21 

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.

type WorkgroupArgs added in v0.18.21 

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

The set of arguments for constructing a Workgroup resource.

func (WorkgroupArgs) ElementType added in v1.19.0 

func (WorkgroupArgs) ElementType() reflect.Type

type WorkgroupConfiguration added in v1.19.0 

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 added in v1.19.0 

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 added in v1.19.0 

func (WorkgroupConfigurationArgs) ElementType() reflect.Type

func (WorkgroupConfigurationArgs) ToWorkgroupConfigurationOutput added in v1.19.0 

func (i WorkgroupConfigurationArgs) ToWorkgroupConfigurationOutput() WorkgroupConfigurationOutput

func (WorkgroupConfigurationArgs) ToWorkgroupConfigurationOutputWithContext added in v1.19.0 

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

func (WorkgroupConfigurationArgs) ToWorkgroupConfigurationPtrOutput added in v1.19.0 

func (i WorkgroupConfigurationArgs) ToWorkgroupConfigurationPtrOutput() WorkgroupConfigurationPtrOutput

func (WorkgroupConfigurationArgs) ToWorkgroupConfigurationPtrOutputWithContext added in v1.19.0 

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

type WorkgroupConfigurationInput added in v1.19.0 

type WorkgroupConfigurationInput interface {
	pulumi.Input

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

type WorkgroupConfigurationOutput added in v1.19.0 

type WorkgroupConfigurationOutput struct{ *pulumi.OutputState }

func (WorkgroupConfigurationOutput) BytesScannedCutoffPerQuery added in v1.19.0 

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 added in v1.19.0 

func (WorkgroupConfigurationOutput) ElementType() reflect.Type

func (WorkgroupConfigurationOutput) EnforceWorkgroupConfiguration added in v1.19.0 

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 added in v1.19.0 

func (o WorkgroupConfigurationOutput) PublishCloudwatchMetricsEnabled() pulumi.BoolPtrOutput

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

func (WorkgroupConfigurationOutput) ResultConfiguration added in v1.19.0 

func (o WorkgroupConfigurationOutput) ResultConfiguration() WorkgroupConfigurationResultConfigurationPtrOutput

Configuration block with result settings. Documented below.

func (WorkgroupConfigurationOutput) ToWorkgroupConfigurationOutput added in v1.19.0 

func (o WorkgroupConfigurationOutput) ToWorkgroupConfigurationOutput() WorkgroupConfigurationOutput

func (WorkgroupConfigurationOutput) ToWorkgroupConfigurationOutputWithContext added in v1.19.0 

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

func (WorkgroupConfigurationOutput) ToWorkgroupConfigurationPtrOutput added in v1.19.0 

func (o WorkgroupConfigurationOutput) ToWorkgroupConfigurationPtrOutput() WorkgroupConfigurationPtrOutput

func (WorkgroupConfigurationOutput) ToWorkgroupConfigurationPtrOutputWithContext added in v1.19.0 

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

type WorkgroupConfigurationPtrInput added in v1.19.0 

type WorkgroupConfigurationPtrInput interface {
	pulumi.Input

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

func WorkgroupConfigurationPtr added in v1.19.0 

func WorkgroupConfigurationPtr(v *WorkgroupConfigurationArgs) WorkgroupConfigurationPtrInput

type WorkgroupConfigurationPtrOutput added in v1.19.0 

type WorkgroupConfigurationPtrOutput struct{ *pulumi.OutputState }

func (WorkgroupConfigurationPtrOutput) BytesScannedCutoffPerQuery added in v1.19.0 

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 added in v1.19.0 

func (o WorkgroupConfigurationPtrOutput) Elem() WorkgroupConfigurationOutput

func (WorkgroupConfigurationPtrOutput) ElementType added in v1.19.0 

func (WorkgroupConfigurationPtrOutput) ElementType() reflect.Type

func (WorkgroupConfigurationPtrOutput) EnforceWorkgroupConfiguration added in v1.19.0 

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 added in v1.19.0 

func (o WorkgroupConfigurationPtrOutput) PublishCloudwatchMetricsEnabled() pulumi.BoolPtrOutput

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

func (WorkgroupConfigurationPtrOutput) ResultConfiguration added in v1.19.0 

func (o WorkgroupConfigurationPtrOutput) ResultConfiguration() WorkgroupConfigurationResultConfigurationPtrOutput

Configuration block with result settings. Documented below.

func (WorkgroupConfigurationPtrOutput) ToWorkgroupConfigurationPtrOutput added in v1.19.0 

func (o WorkgroupConfigurationPtrOutput) ToWorkgroupConfigurationPtrOutput() WorkgroupConfigurationPtrOutput

func (WorkgroupConfigurationPtrOutput) ToWorkgroupConfigurationPtrOutputWithContext added in v1.19.0 

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

type WorkgroupConfigurationResultConfiguration added in v1.19.0 

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 added in v1.19.0 

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 added in v1.19.0 

func (WorkgroupConfigurationResultConfigurationArgs) ElementType() reflect.Type

func (WorkgroupConfigurationResultConfigurationArgs) ToWorkgroupConfigurationResultConfigurationOutput added in v1.19.0 

func (i WorkgroupConfigurationResultConfigurationArgs) ToWorkgroupConfigurationResultConfigurationOutput() WorkgroupConfigurationResultConfigurationOutput

func (WorkgroupConfigurationResultConfigurationArgs) ToWorkgroupConfigurationResultConfigurationOutputWithContext added in v1.19.0 

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

func (WorkgroupConfigurationResultConfigurationArgs) ToWorkgroupConfigurationResultConfigurationPtrOutput added in v1.19.0 

func (i WorkgroupConfigurationResultConfigurationArgs) ToWorkgroupConfigurationResultConfigurationPtrOutput() WorkgroupConfigurationResultConfigurationPtrOutput

func (WorkgroupConfigurationResultConfigurationArgs) ToWorkgroupConfigurationResultConfigurationPtrOutputWithContext added in v1.19.0 

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

type WorkgroupConfigurationResultConfigurationEncryptionConfiguration added in v1.19.0 

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 added in v1.19.0 

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 added in v1.19.0 

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs) ElementType() reflect.Type

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput added in v1.19.0 

func (i WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput() WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutputWithContext added in v1.19.0 

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

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput added in v1.19.0 

func (i WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput() WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutputWithContext added in v1.19.0 

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

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationInput added in v1.19.0 

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationInput interface {
	pulumi.Input

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

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput added in v1.19.0 

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput struct{ *pulumi.OutputState }

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) ElementType added in v1.19.0 

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) ElementType() reflect.Type

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) EncryptionOption added in v1.19.0 

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 added in v1.19.0 

func (o WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) KmsKeyArn() pulumi.StringPtrOutput

For SSE-KMS and CSE-KMS, this is the KMS key Amazon Resource Name (ARN).

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput added in v1.19.0 

func (o WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput() WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationOutputWithContext added in v1.19.0 

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

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput added in v1.19.0 

func (o WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput() WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutputWithContext added in v1.19.0 

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

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrInput added in v1.19.0 

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrInput interface {
	pulumi.Input

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

func WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtr added in v1.19.0 

func WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtr(v *WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs) WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrInput

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput added in v1.19.0 

type WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput struct{ *pulumi.OutputState }

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) Elem added in v1.19.0 

func (o WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) Elem() WorkgroupConfigurationResultConfigurationEncryptionConfigurationOutput

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) ElementType added in v1.19.0 

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) ElementType() reflect.Type

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) EncryptionOption added in v1.19.0 

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 added in v1.19.0 

func (o WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) KmsKeyArn() pulumi.StringPtrOutput

For SSE-KMS and CSE-KMS, this is the KMS key Amazon Resource Name (ARN).

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput added in v1.19.0 

func (o WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput() WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput

func (WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput) ToWorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutputWithContext added in v1.19.0 

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

type WorkgroupConfigurationResultConfigurationInput added in v1.19.0 

type WorkgroupConfigurationResultConfigurationInput interface {
	pulumi.Input

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

type WorkgroupConfigurationResultConfigurationOutput added in v1.19.0 

type WorkgroupConfigurationResultConfigurationOutput struct{ *pulumi.OutputState }

func (WorkgroupConfigurationResultConfigurationOutput) ElementType added in v1.19.0 

func (WorkgroupConfigurationResultConfigurationOutput) ElementType() reflect.Type

func (WorkgroupConfigurationResultConfigurationOutput) EncryptionConfiguration added in v1.19.0 

func (o WorkgroupConfigurationResultConfigurationOutput) EncryptionConfiguration() WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput

Configuration block with encryption settings. Documented below.

func (WorkgroupConfigurationResultConfigurationOutput) OutputLocation added in v1.19.0 

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 added in v1.19.0 

func (o WorkgroupConfigurationResultConfigurationOutput) ToWorkgroupConfigurationResultConfigurationOutput() WorkgroupConfigurationResultConfigurationOutput

func (WorkgroupConfigurationResultConfigurationOutput) ToWorkgroupConfigurationResultConfigurationOutputWithContext added in v1.19.0 

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

func (WorkgroupConfigurationResultConfigurationOutput) ToWorkgroupConfigurationResultConfigurationPtrOutput added in v1.19.0 

func (o WorkgroupConfigurationResultConfigurationOutput) ToWorkgroupConfigurationResultConfigurationPtrOutput() WorkgroupConfigurationResultConfigurationPtrOutput

func (WorkgroupConfigurationResultConfigurationOutput) ToWorkgroupConfigurationResultConfigurationPtrOutputWithContext added in v1.19.0 

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

type WorkgroupConfigurationResultConfigurationPtrInput added in v1.19.0 

type WorkgroupConfigurationResultConfigurationPtrInput interface {
	pulumi.Input

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

func WorkgroupConfigurationResultConfigurationPtr added in v1.19.0 

func WorkgroupConfigurationResultConfigurationPtr(v *WorkgroupConfigurationResultConfigurationArgs) WorkgroupConfigurationResultConfigurationPtrInput

type WorkgroupConfigurationResultConfigurationPtrOutput added in v1.19.0 

type WorkgroupConfigurationResultConfigurationPtrOutput struct{ *pulumi.OutputState }

func (WorkgroupConfigurationResultConfigurationPtrOutput) Elem added in v1.19.0 

func (o WorkgroupConfigurationResultConfigurationPtrOutput) Elem() WorkgroupConfigurationResultConfigurationOutput

func (WorkgroupConfigurationResultConfigurationPtrOutput) ElementType added in v1.19.0 

func (WorkgroupConfigurationResultConfigurationPtrOutput) ElementType() reflect.Type

func (WorkgroupConfigurationResultConfigurationPtrOutput) EncryptionConfiguration added in v1.19.0 

func (o WorkgroupConfigurationResultConfigurationPtrOutput) EncryptionConfiguration() WorkgroupConfigurationResultConfigurationEncryptionConfigurationPtrOutput

Configuration block with encryption settings. Documented below.

func (WorkgroupConfigurationResultConfigurationPtrOutput) OutputLocation added in v1.19.0 

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 added in v1.19.0 

func (o WorkgroupConfigurationResultConfigurationPtrOutput) ToWorkgroupConfigurationResultConfigurationPtrOutput() WorkgroupConfigurationResultConfigurationPtrOutput

func (WorkgroupConfigurationResultConfigurationPtrOutput) ToWorkgroupConfigurationResultConfigurationPtrOutputWithContext added in v1.19.0 

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

type WorkgroupState added in v0.18.21 

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
	// 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 mapping of resource tags for the workgroup.
	Tags pulumi.MapInput
}

func (WorkgroupState) ElementType added in v1.19.0 

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.