AWS Cloud Control v1.27.0, Apr 14 25

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.athena.WorkGroup

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-aws-native

Example

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var myAthenaWorkGroup = new AwsNative.Athena.WorkGroup("myAthenaWorkGroup", new()
    {
        Name = "MyCustomWorkGroup",
        Description = "My WorkGroup",
        State = AwsNative.Athena.WorkGroupState.Enabled,
        Tags = new[]
        {
            new AwsNative.Inputs.TagArgs
            {
                Key = "key1",
                Value = "value1",
            },
            new AwsNative.Inputs.TagArgs
            {
                Key = "key2",
                Value = "value2",
            },
        },
        WorkGroupConfiguration = new AwsNative.Athena.Inputs.WorkGroupConfigurationArgs
        {
            BytesScannedCutoffPerQuery = 200000000,
            EnforceWorkGroupConfiguration = false,
            PublishCloudWatchMetricsEnabled = false,
            RequesterPaysEnabled = true,
            ResultConfiguration = new AwsNative.Athena.Inputs.WorkGroupResultConfigurationArgs
            {
                OutputLocation = "s3://path/to/my/bucket/",
            },
        },
    });

});

package main

import (
	awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws"
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/athena"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := athena.NewWorkGroup(ctx, "myAthenaWorkGroup", &athena.WorkGroupArgs{
			Name:        pulumi.String("MyCustomWorkGroup"),
			Description: pulumi.String("My WorkGroup"),
			State:       athena.WorkGroupStateEnabled,
			Tags: aws.TagArray{
				&aws.TagArgs{
					Key:   pulumi.String("key1"),
					Value: pulumi.String("value1"),
				},
				&aws.TagArgs{
					Key:   pulumi.String("key2"),
					Value: pulumi.String("value2"),
				},
			},
			WorkGroupConfiguration: &athena.WorkGroupConfigurationArgs{
				BytesScannedCutoffPerQuery:      pulumi.Int(200000000),
				EnforceWorkGroupConfiguration:   pulumi.Bool(false),
				PublishCloudWatchMetricsEnabled: pulumi.Bool(false),
				RequesterPaysEnabled:            pulumi.Bool(true),
				ResultConfiguration: &athena.WorkGroupResultConfigurationArgs{
					OutputLocation: pulumi.String("s3://path/to/my/bucket/"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const myAthenaWorkGroup = new aws_native.athena.WorkGroup("myAthenaWorkGroup", {
    name: "MyCustomWorkGroup",
    description: "My WorkGroup",
    state: aws_native.athena.WorkGroupState.Enabled,
    tags: [
        {
            key: "key1",
            value: "value1",
        },
        {
            key: "key2",
            value: "value2",
        },
    ],
    workGroupConfiguration: {
        bytesScannedCutoffPerQuery: 200000000,
        enforceWorkGroupConfiguration: false,
        publishCloudWatchMetricsEnabled: false,
        requesterPaysEnabled: true,
        resultConfiguration: {
            outputLocation: "s3://path/to/my/bucket/",
        },
    },
});

import pulumi
import pulumi_aws_native as aws_native

my_athena_work_group = aws_native.athena.WorkGroup("myAthenaWorkGroup",
    name="MyCustomWorkGroup",
    description="My WorkGroup",
    state=aws_native.athena.WorkGroupState.ENABLED,
    tags=[
        {
            "key": "key1",
            "value": "value1",
        },
        {
            "key": "key2",
            "value": "value2",
        },
    ],
    work_group_configuration={
        "bytes_scanned_cutoff_per_query": 200000000,
        "enforce_work_group_configuration": False,
        "publish_cloud_watch_metrics_enabled": False,
        "requester_pays_enabled": True,
        "result_configuration": {
            "output_location": "s3://path/to/my/bucket/",
        },
    })

Coming soon!

Example

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var myAthenaWorkGroup = new AwsNative.Athena.WorkGroup("myAthenaWorkGroup", new()
    {
        Name = "MyCustomWorkGroup",
        Description = "My WorkGroup",
        State = AwsNative.Athena.WorkGroupState.Enabled,
        Tags = new[]
        {
            new AwsNative.Inputs.TagArgs
            {
                Key = "key1",
                Value = "value1",
            },
            new AwsNative.Inputs.TagArgs
            {
                Key = "key2",
                Value = "value2",
            },
        },
        WorkGroupConfiguration = new AwsNative.Athena.Inputs.WorkGroupConfigurationArgs
        {
            BytesScannedCutoffPerQuery = 200000000,
            EnforceWorkGroupConfiguration = false,
            PublishCloudWatchMetricsEnabled = false,
            RequesterPaysEnabled = true,
            ResultConfiguration = new AwsNative.Athena.Inputs.WorkGroupResultConfigurationArgs
            {
                OutputLocation = "s3://path/to/my/bucket/",
            },
        },
    });

});

package main

import (
	awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws"
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/athena"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := athena.NewWorkGroup(ctx, "myAthenaWorkGroup", &athena.WorkGroupArgs{
			Name:        pulumi.String("MyCustomWorkGroup"),
			Description: pulumi.String("My WorkGroup"),
			State:       athena.WorkGroupStateEnabled,
			Tags: aws.TagArray{
				&aws.TagArgs{
					Key:   pulumi.String("key1"),
					Value: pulumi.String("value1"),
				},
				&aws.TagArgs{
					Key:   pulumi.String("key2"),
					Value: pulumi.String("value2"),
				},
			},
			WorkGroupConfiguration: &athena.WorkGroupConfigurationArgs{
				BytesScannedCutoffPerQuery:      pulumi.Int(200000000),
				EnforceWorkGroupConfiguration:   pulumi.Bool(false),
				PublishCloudWatchMetricsEnabled: pulumi.Bool(false),
				RequesterPaysEnabled:            pulumi.Bool(true),
				ResultConfiguration: &athena.WorkGroupResultConfigurationArgs{
					OutputLocation: pulumi.String("s3://path/to/my/bucket/"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const myAthenaWorkGroup = new aws_native.athena.WorkGroup("myAthenaWorkGroup", {
    name: "MyCustomWorkGroup",
    description: "My WorkGroup",
    state: aws_native.athena.WorkGroupState.Enabled,
    tags: [
        {
            key: "key1",
            value: "value1",
        },
        {
            key: "key2",
            value: "value2",
        },
    ],
    workGroupConfiguration: {
        bytesScannedCutoffPerQuery: 200000000,
        enforceWorkGroupConfiguration: false,
        publishCloudWatchMetricsEnabled: false,
        requesterPaysEnabled: true,
        resultConfiguration: {
            outputLocation: "s3://path/to/my/bucket/",
        },
    },
});

import pulumi
import pulumi_aws_native as aws_native

my_athena_work_group = aws_native.athena.WorkGroup("myAthenaWorkGroup",
    name="MyCustomWorkGroup",
    description="My WorkGroup",
    state=aws_native.athena.WorkGroupState.ENABLED,
    tags=[
        {
            "key": "key1",
            "value": "value1",
        },
        {
            "key": "key2",
            "value": "value2",
        },
    ],
    work_group_configuration={
        "bytes_scanned_cutoff_per_query": 200000000,
        "enforce_work_group_configuration": False,
        "publish_cloud_watch_metrics_enabled": False,
        "requester_pays_enabled": True,
        "result_configuration": {
            "output_location": "s3://path/to/my/bucket/",
        },
    })

Coming soon!

Example

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var myAthenaWorkGroup = new AwsNative.Athena.WorkGroup("myAthenaWorkGroup", new()
    {
        Name = "MyCustomWorkGroup",
        Description = "My WorkGroup Updated",
        State = AwsNative.Athena.WorkGroupState.Disabled,
        Tags = new[]
        {
            new AwsNative.Inputs.TagArgs
            {
                Key = "key1",
                Value = "value1",
            },
            new AwsNative.Inputs.TagArgs
            {
                Key = "key2",
                Value = "value2",
            },
        },
        WorkGroupConfigurationUpdates = new AwsNative.Athena.Inputs.WorkGroupConfigurationUpdatesArgs
        {
            BytesScannedCutoffPerQuery = 10000000,
            EnforceWorkGroupConfiguration = true,
            PublishCloudWatchMetricsEnabled = true,
            RequesterPaysEnabled = false,
            ResultConfigurationUpdates = new AwsNative.Athena.Inputs.WorkGroupResultConfigurationUpdatesArgs
            {
                EncryptionConfiguration = new AwsNative.Athena.Inputs.WorkGroupEncryptionConfigurationArgs
                {
                    EncryptionOption = AwsNative.Athena.WorkGroupEncryptionOption.SseS3,
                },
                OutputLocation = "s3://path/to/my/bucket/updated/",
            },
        },
    });

});

package main

import (
	awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws"
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/athena"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := athena.NewWorkGroup(ctx, "myAthenaWorkGroup", &athena.WorkGroupArgs{
			Name:        pulumi.String("MyCustomWorkGroup"),
			Description: pulumi.String("My WorkGroup Updated"),
			State:       athena.WorkGroupStateDisabled,
			Tags: aws.TagArray{
				&aws.TagArgs{
					Key:   pulumi.String("key1"),
					Value: pulumi.String("value1"),
				},
				&aws.TagArgs{
					Key:   pulumi.String("key2"),
					Value: pulumi.String("value2"),
				},
			},
			WorkGroupConfigurationUpdates: &athena.WorkGroupConfigurationUpdatesArgs{
				BytesScannedCutoffPerQuery:      pulumi.Int(10000000),
				EnforceWorkGroupConfiguration:   pulumi.Bool(true),
				PublishCloudWatchMetricsEnabled: pulumi.Bool(true),
				RequesterPaysEnabled:            pulumi.Bool(false),
				ResultConfigurationUpdates: &athena.WorkGroupResultConfigurationUpdatesArgs{
					EncryptionConfiguration: &athena.WorkGroupEncryptionConfigurationArgs{
						EncryptionOption: athena.WorkGroupEncryptionOptionSseS3,
					},
					OutputLocation: pulumi.String("s3://path/to/my/bucket/updated/"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const myAthenaWorkGroup = new aws_native.athena.WorkGroup("myAthenaWorkGroup", {
    name: "MyCustomWorkGroup",
    description: "My WorkGroup Updated",
    state: aws_native.athena.WorkGroupState.Disabled,
    tags: [
        {
            key: "key1",
            value: "value1",
        },
        {
            key: "key2",
            value: "value2",
        },
    ],
    workGroupConfigurationUpdates: {
        bytesScannedCutoffPerQuery: 10000000,
        enforceWorkGroupConfiguration: true,
        publishCloudWatchMetricsEnabled: true,
        requesterPaysEnabled: false,
        resultConfigurationUpdates: {
            encryptionConfiguration: {
                encryptionOption: aws_native.athena.WorkGroupEncryptionOption.SseS3,
            },
            outputLocation: "s3://path/to/my/bucket/updated/",
        },
    },
});

import pulumi
import pulumi_aws_native as aws_native

my_athena_work_group = aws_native.athena.WorkGroup("myAthenaWorkGroup",
    name="MyCustomWorkGroup",
    description="My WorkGroup Updated",
    state=aws_native.athena.WorkGroupState.DISABLED,
    tags=[
        {
            "key": "key1",
            "value": "value1",
        },
        {
            "key": "key2",
            "value": "value2",
        },
    ],
    work_group_configuration_updates={
        "bytes_scanned_cutoff_per_query": 10000000,
        "enforce_work_group_configuration": True,
        "publish_cloud_watch_metrics_enabled": True,
        "requester_pays_enabled": False,
        "result_configuration_updates": {
            "encryption_configuration": {
                "encryption_option": aws_native.athena.WorkGroupEncryptionOption.SSE_S3,
            },
            "output_location": "s3://path/to/my/bucket/updated/",
        },
    })

Coming soon!

Example

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var myAthenaWorkGroup = new AwsNative.Athena.WorkGroup("myAthenaWorkGroup", new()
    {
        Name = "MyCustomWorkGroup",
        Description = "My WorkGroup Updated",
        State = AwsNative.Athena.WorkGroupState.Disabled,
        Tags = new[]
        {
            new AwsNative.Inputs.TagArgs
            {
                Key = "key1",
                Value = "value1",
            },
            new AwsNative.Inputs.TagArgs
            {
                Key = "key2",
                Value = "value2",
            },
        },
        WorkGroupConfigurationUpdates = new AwsNative.Athena.Inputs.WorkGroupConfigurationUpdatesArgs
        {
            BytesScannedCutoffPerQuery = 10000000,
            EnforceWorkGroupConfiguration = true,
            PublishCloudWatchMetricsEnabled = true,
            RequesterPaysEnabled = false,
            ResultConfigurationUpdates = new AwsNative.Athena.Inputs.WorkGroupResultConfigurationUpdatesArgs
            {
                EncryptionConfiguration = new AwsNative.Athena.Inputs.WorkGroupEncryptionConfigurationArgs
                {
                    EncryptionOption = AwsNative.Athena.WorkGroupEncryptionOption.SseS3,
                },
                OutputLocation = "s3://path/to/my/bucket/updated/",
            },
        },
    });

});

package main

import (
	awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws"
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/athena"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := athena.NewWorkGroup(ctx, "myAthenaWorkGroup", &athena.WorkGroupArgs{
			Name:        pulumi.String("MyCustomWorkGroup"),
			Description: pulumi.String("My WorkGroup Updated"),
			State:       athena.WorkGroupStateDisabled,
			Tags: aws.TagArray{
				&aws.TagArgs{
					Key:   pulumi.String("key1"),
					Value: pulumi.String("value1"),
				},
				&aws.TagArgs{
					Key:   pulumi.String("key2"),
					Value: pulumi.String("value2"),
				},
			},
			WorkGroupConfigurationUpdates: &athena.WorkGroupConfigurationUpdatesArgs{
				BytesScannedCutoffPerQuery:      pulumi.Int(10000000),
				EnforceWorkGroupConfiguration:   pulumi.Bool(true),
				PublishCloudWatchMetricsEnabled: pulumi.Bool(true),
				RequesterPaysEnabled:            pulumi.Bool(false),
				ResultConfigurationUpdates: &athena.WorkGroupResultConfigurationUpdatesArgs{
					EncryptionConfiguration: &athena.WorkGroupEncryptionConfigurationArgs{
						EncryptionOption: athena.WorkGroupEncryptionOptionSseS3,
					},
					OutputLocation: pulumi.String("s3://path/to/my/bucket/updated/"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const myAthenaWorkGroup = new aws_native.athena.WorkGroup("myAthenaWorkGroup", {
    name: "MyCustomWorkGroup",
    description: "My WorkGroup Updated",
    state: aws_native.athena.WorkGroupState.Disabled,
    tags: [
        {
            key: "key1",
            value: "value1",
        },
        {
            key: "key2",
            value: "value2",
        },
    ],
    workGroupConfigurationUpdates: {
        bytesScannedCutoffPerQuery: 10000000,
        enforceWorkGroupConfiguration: true,
        publishCloudWatchMetricsEnabled: true,
        requesterPaysEnabled: false,
        resultConfigurationUpdates: {
            encryptionConfiguration: {
                encryptionOption: aws_native.athena.WorkGroupEncryptionOption.SseS3,
            },
            outputLocation: "s3://path/to/my/bucket/updated/",
        },
    },
});

import pulumi
import pulumi_aws_native as aws_native

my_athena_work_group = aws_native.athena.WorkGroup("myAthenaWorkGroup",
    name="MyCustomWorkGroup",
    description="My WorkGroup Updated",
    state=aws_native.athena.WorkGroupState.DISABLED,
    tags=[
        {
            "key": "key1",
            "value": "value1",
        },
        {
            "key": "key2",
            "value": "value2",
        },
    ],
    work_group_configuration_updates={
        "bytes_scanned_cutoff_per_query": 10000000,
        "enforce_work_group_configuration": True,
        "publish_cloud_watch_metrics_enabled": True,
        "requester_pays_enabled": False,
        "result_configuration_updates": {
            "encryption_configuration": {
                "encryption_option": aws_native.athena.WorkGroupEncryptionOption.SSE_S3,
            },
            "output_location": "s3://path/to/my/bucket/updated/",
        },
    })

Coming soon!

Create WorkGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

TypeScript
Python
Go
C#
Java
YAML

new WorkGroup(name: string, args?: WorkGroupArgs, opts?: CustomResourceOptions);

@overload
def WorkGroup(resource_name: str,
              args: Optional[WorkGroupArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def WorkGroup(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              description: Optional[str] = None,
              name: Optional[str] = None,
              recursive_delete_option: Optional[bool] = None,
              state: Optional[WorkGroupState] = None,
              tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
              work_group_configuration: Optional[WorkGroupConfigurationArgs] = None,
              work_group_configuration_updates: Optional[WorkGroupConfigurationUpdatesArgs] = None)

func NewWorkGroup(ctx *Context, name string, args *WorkGroupArgs, opts ...ResourceOption) (*WorkGroup, error)

public WorkGroup(string name, WorkGroupArgs? args = null, CustomResourceOptions? opts = null)

public WorkGroup(String name, WorkGroupArgs args)
public WorkGroup(String name, WorkGroupArgs args, CustomResourceOptions options)

type: aws-native:athena:WorkGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args WorkGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args WorkGroupArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args WorkGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args WorkGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args WorkGroupArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

WorkGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The WorkGroup resource accepts the following input properties:

Description string: The workgroup description.
Name string: The workGroup name.
RecursiveDeleteOption bool: The option to delete the workgroup and its contents even if the workgroup contains any named queries.
State Pulumi.AwsNative.Athena.WorkGroupState: The state of the workgroup: ENABLED or DISABLED.
Tags List<Pulumi.AwsNative.Inputs.Tag>: One or more tags, separated by commas, that you want to attach to the workgroup as you create it
WorkGroupConfiguration Pulumi.AwsNative.Athena.Inputs.WorkGroupConfiguration: The workgroup configuration
WorkGroupConfigurationUpdates Pulumi.AwsNative.Athena.Inputs.WorkGroupConfigurationUpdates: The workgroup configuration update object

Description string: The workgroup description.
Name string: The workGroup name.
RecursiveDeleteOption bool: The option to delete the workgroup and its contents even if the workgroup contains any named queries.
State WorkGroupStateEnum: The state of the workgroup: ENABLED or DISABLED.
Tags TagArgs: One or more tags, separated by commas, that you want to attach to the workgroup as you create it
WorkGroupConfiguration WorkGroupConfigurationArgs: The workgroup configuration
WorkGroupConfigurationUpdates WorkGroupConfigurationUpdatesArgs: The workgroup configuration update object

description String: The workgroup description.
name String: The workGroup name.
recursiveDeleteOption Boolean: The option to delete the workgroup and its contents even if the workgroup contains any named queries.
state WorkGroupState: The state of the workgroup: ENABLED or DISABLED.
tags List<Tag>: One or more tags, separated by commas, that you want to attach to the workgroup as you create it
workGroupConfiguration WorkGroupConfiguration: The workgroup configuration
workGroupConfigurationUpdates WorkGroupConfigurationUpdates: The workgroup configuration update object

description string: The workgroup description.
name string: The workGroup name.
recursiveDeleteOption boolean: The option to delete the workgroup and its contents even if the workgroup contains any named queries.
state WorkGroupState: The state of the workgroup: ENABLED or DISABLED.
tags Tag[]: One or more tags, separated by commas, that you want to attach to the workgroup as you create it
workGroupConfiguration WorkGroupConfiguration: The workgroup configuration
workGroupConfigurationUpdates WorkGroupConfigurationUpdates: The workgroup configuration update object

description str: The workgroup description.
name str: The workGroup name.
recursive_delete_option bool: The option to delete the workgroup and its contents even if the workgroup contains any named queries.
state WorkGroupState: The state of the workgroup: ENABLED or DISABLED.
tags Sequence[TagArgs]: One or more tags, separated by commas, that you want to attach to the workgroup as you create it
work_group_configuration WorkGroupConfigurationArgs: The workgroup configuration
work_group_configuration_updates WorkGroupConfigurationUpdatesArgs: The workgroup configuration update object

description String: The workgroup description.
name String: The workGroup name.
recursiveDeleteOption Boolean: The option to delete the workgroup and its contents even if the workgroup contains any named queries.
state "ENABLED" | "DISABLED": The state of the workgroup: ENABLED or DISABLED.
tags List<Property Map>: One or more tags, separated by commas, that you want to attach to the workgroup as you create it
workGroupConfiguration Property Map: The workgroup configuration
workGroupConfigurationUpdates Property Map: The workgroup configuration update object

Outputs

All input properties are implicitly available as output properties. Additionally, the WorkGroup resource produces the following output properties:

CreationTime string: The date and time the workgroup was created.
Id string: The provider-assigned unique ID for this managed resource.

CreationTime string: The date and time the workgroup was created.
Id string: The provider-assigned unique ID for this managed resource.

creationTime String: The date and time the workgroup was created.
id String: The provider-assigned unique ID for this managed resource.

creationTime string: The date and time the workgroup was created.
id string: The provider-assigned unique ID for this managed resource.

creation_time str: The date and time the workgroup was created.
id str: The provider-assigned unique ID for this managed resource.

creationTime String: The date and time the workgroup was created.
id String: The provider-assigned unique ID for this managed resource.

Supporting Types

Tag
, TagArgs

Key string: The key name of the tag
Value string: The value of the tag

Key string: The key name of the tag
Value string: The value of the tag

key String: The key name of the tag
value String: The value of the tag

key string: The key name of the tag
value string: The value of the tag

key str: The key name of the tag
value str: The value of the tag

key String: The key name of the tag
value String: The value of the tag

WorkGroupAclConfiguration
, WorkGroupAclConfigurationArgs

S3AclOption Pulumi.AwsNative.Athena.WorkGroupS3AclOption: The Amazon S3 canned ACL that Athena should specify when storing query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL . If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide .

S3AclOption WorkGroupS3AclOption: The Amazon S3 canned ACL that Athena should specify when storing query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL . If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide .

s3AclOption WorkGroupS3AclOption: The Amazon S3 canned ACL that Athena should specify when storing query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL . If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide .

s3AclOption WorkGroupS3AclOption: The Amazon S3 canned ACL that Athena should specify when storing query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL . If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide .

s3_acl_option WorkGroupS3AclOption: The Amazon S3 canned ACL that Athena should specify when storing query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL . If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide .

s3AclOption "BUCKET_OWNER_FULL_CONTROL": The Amazon S3 canned ACL that Athena should specify when storing query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL . If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide .

WorkGroupConfiguration
, WorkGroupConfigurationArgs

AdditionalConfiguration string: Specifies a user defined JSON string that is passed to the session engine.
BytesScannedCutoffPerQuery int: The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. No default is defined.
This property currently supports integer types. Support for long values is planned.
CustomerContentEncryptionConfiguration Pulumi.AwsNative.Athena.Inputs.WorkGroupCustomerContentEncryptionConfiguration: Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.
EnforceWorkGroupConfiguration bool: If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Override client-side settings .
EngineVersion Pulumi.AwsNative.Athena.Inputs.WorkGroupEngineVersion: The engine version that all queries running on the workgroup use.
ExecutionRole string: Role used to access user resources in an Athena for Apache Spark session. This property applies only to Spark-enabled workgroups in Athena.
PublishCloudWatchMetricsEnabled bool: Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
RequesterPaysEnabled bool: If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide .
ResultConfiguration Pulumi.AwsNative.Athena.Inputs.WorkGroupResultConfiguration: Specifies the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. For more information, see Work with query results and recent queries .

AdditionalConfiguration string: Specifies a user defined JSON string that is passed to the session engine.
BytesScannedCutoffPerQuery int: The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. No default is defined.
This property currently supports integer types. Support for long values is planned.
CustomerContentEncryptionConfiguration WorkGroupCustomerContentEncryptionConfiguration: Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.
EnforceWorkGroupConfiguration bool: If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Override client-side settings .
EngineVersion WorkGroupEngineVersion: The engine version that all queries running on the workgroup use.
ExecutionRole string: Role used to access user resources in an Athena for Apache Spark session. This property applies only to Spark-enabled workgroups in Athena.
PublishCloudWatchMetricsEnabled bool: Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
RequesterPaysEnabled bool: If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide .
ResultConfiguration WorkGroupResultConfiguration: Specifies the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. For more information, see Work with query results and recent queries .

additionalConfiguration String: Specifies a user defined JSON string that is passed to the session engine.
bytesScannedCutoffPerQuery Integer: The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. No default is defined.
This property currently supports integer types. Support for long values is planned.
customerContentEncryptionConfiguration WorkGroupCustomerContentEncryptionConfiguration: Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.
enforceWorkGroupConfiguration Boolean: If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Override client-side settings .
engineVersion WorkGroupEngineVersion: The engine version that all queries running on the workgroup use.
executionRole String: Role used to access user resources in an Athena for Apache Spark session. This property applies only to Spark-enabled workgroups in Athena.
publishCloudWatchMetricsEnabled Boolean: Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
requesterPaysEnabled Boolean: If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide .
resultConfiguration WorkGroupResultConfiguration: Specifies the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. For more information, see Work with query results and recent queries .

additionalConfiguration string: Specifies a user defined JSON string that is passed to the session engine.
bytesScannedCutoffPerQuery number: The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. No default is defined.
This property currently supports integer types. Support for long values is planned.
customerContentEncryptionConfiguration WorkGroupCustomerContentEncryptionConfiguration: Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.
enforceWorkGroupConfiguration boolean: If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Override client-side settings .
engineVersion WorkGroupEngineVersion: The engine version that all queries running on the workgroup use.
executionRole string: Role used to access user resources in an Athena for Apache Spark session. This property applies only to Spark-enabled workgroups in Athena.
publishCloudWatchMetricsEnabled boolean: Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
requesterPaysEnabled boolean: If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide .
resultConfiguration WorkGroupResultConfiguration: Specifies the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. For more information, see Work with query results and recent queries .

additional_configuration str: Specifies a user defined JSON string that is passed to the session engine.
bytes_scanned_cutoff_per_query int: The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. No default is defined.
This property currently supports integer types. Support for long values is planned.
customer_content_encryption_configuration WorkGroupCustomerContentEncryptionConfiguration: Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.
enforce_work_group_configuration bool: If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Override client-side settings .
engine_version WorkGroupEngineVersion: The engine version that all queries running on the workgroup use.
execution_role str: Role used to access user resources in an Athena for Apache Spark session. This property applies only to Spark-enabled workgroups in Athena.
publish_cloud_watch_metrics_enabled bool: Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
requester_pays_enabled bool: If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide .
result_configuration WorkGroupResultConfiguration: Specifies the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. For more information, see Work with query results and recent queries .

additionalConfiguration String: Specifies a user defined JSON string that is passed to the session engine.
bytesScannedCutoffPerQuery Number: The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. No default is defined.
This property currently supports integer types. Support for long values is planned.
customerContentEncryptionConfiguration Property Map: Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.
enforceWorkGroupConfiguration Boolean: If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Override client-side settings .
engineVersion Property Map: The engine version that all queries running on the workgroup use.
executionRole String: Role used to access user resources in an Athena for Apache Spark session. This property applies only to Spark-enabled workgroups in Athena.
publishCloudWatchMetricsEnabled Boolean: Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
requesterPaysEnabled Boolean: If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide .
resultConfiguration Property Map: Specifies the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. For more information, see Work with query results and recent queries .

WorkGroupConfigurationUpdates
, WorkGroupConfigurationUpdatesArgs

AdditionalConfiguration string
BytesScannedCutoffPerQuery int
CustomerContentEncryptionConfiguration Pulumi.AwsNative.Athena.Inputs.WorkGroupCustomerContentEncryptionConfiguration
EnforceWorkGroupConfiguration bool
EngineVersion Pulumi.AwsNative.Athena.Inputs.WorkGroupEngineVersion
ExecutionRole string
PublishCloudWatchMetricsEnabled bool
RemoveBytesScannedCutoffPerQuery bool
RemoveCustomerContentEncryptionConfiguration bool
RequesterPaysEnabled bool
ResultConfigurationUpdates Pulumi.AwsNative.Athena.Inputs.WorkGroupResultConfigurationUpdates

AdditionalConfiguration string
BytesScannedCutoffPerQuery int
CustomerContentEncryptionConfiguration WorkGroupCustomerContentEncryptionConfiguration
EnforceWorkGroupConfiguration bool
EngineVersion WorkGroupEngineVersion
ExecutionRole string
PublishCloudWatchMetricsEnabled bool
RemoveBytesScannedCutoffPerQuery bool
RemoveCustomerContentEncryptionConfiguration bool
RequesterPaysEnabled bool
ResultConfigurationUpdates WorkGroupResultConfigurationUpdates

additionalConfiguration String
bytesScannedCutoffPerQuery Integer
customerContentEncryptionConfiguration WorkGroupCustomerContentEncryptionConfiguration
enforceWorkGroupConfiguration Boolean
engineVersion WorkGroupEngineVersion
executionRole String
publishCloudWatchMetricsEnabled Boolean
removeBytesScannedCutoffPerQuery Boolean
removeCustomerContentEncryptionConfiguration Boolean
requesterPaysEnabled Boolean
resultConfigurationUpdates WorkGroupResultConfigurationUpdates

additionalConfiguration string
bytesScannedCutoffPerQuery number
customerContentEncryptionConfiguration WorkGroupCustomerContentEncryptionConfiguration
enforceWorkGroupConfiguration boolean
engineVersion WorkGroupEngineVersion
executionRole string
publishCloudWatchMetricsEnabled boolean
removeBytesScannedCutoffPerQuery boolean
removeCustomerContentEncryptionConfiguration boolean
requesterPaysEnabled boolean
resultConfigurationUpdates WorkGroupResultConfigurationUpdates

additional_configuration str
bytes_scanned_cutoff_per_query int
customer_content_encryption_configuration WorkGroupCustomerContentEncryptionConfiguration
enforce_work_group_configuration bool
engine_version WorkGroupEngineVersion
execution_role str
publish_cloud_watch_metrics_enabled bool
remove_bytes_scanned_cutoff_per_query bool
remove_customer_content_encryption_configuration bool
requester_pays_enabled bool
result_configuration_updates WorkGroupResultConfigurationUpdates

additionalConfiguration String
bytesScannedCutoffPerQuery Number
customerContentEncryptionConfiguration Property Map
enforceWorkGroupConfiguration Boolean
engineVersion Property Map
executionRole String
publishCloudWatchMetricsEnabled Boolean
removeBytesScannedCutoffPerQuery Boolean
removeCustomerContentEncryptionConfiguration Boolean
requesterPaysEnabled Boolean
resultConfigurationUpdates Property Map

WorkGroupCustomerContentEncryptionConfiguration
, WorkGroupCustomerContentEncryptionConfigurationArgs

KmsKey string: The customer managed KMS key that is used to encrypt the user's data stores in Athena.

KmsKey string: The customer managed KMS key that is used to encrypt the user's data stores in Athena.

kmsKey String: The customer managed KMS key that is used to encrypt the user's data stores in Athena.

kmsKey string: The customer managed KMS key that is used to encrypt the user's data stores in Athena.

kms_key str: The customer managed KMS key that is used to encrypt the user's data stores in Athena.

kmsKey String: The customer managed KMS key that is used to encrypt the user's data stores in Athena.

WorkGroupEncryptionConfiguration
, WorkGroupEncryptionConfigurationArgs

EncryptionOption Pulumi.AwsNative.Athena.WorkGroupEncryptionOption

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.

KmsKey string