Workgroup class
Provides an Athena Workgroup.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.athena.Workgroup("example", {
configuration: {
resultConfiguration: {
encryptionConfiguration: {
encryptionOption: "SSE_KMS",
kmsKeyArn: exampleAwsKmsKey.arn,
},
outputLocation: `s3://${exampleAwsS3Bucket.bucket}/output/`,
},
enforceWorkgroupConfiguration: true,
publishCloudwatchMetricsEnabled: true,
},
name: "example",
});
import pulumi
import pulumi_aws as aws
example = aws.athena.Workgroup("example",
configuration={
"result_configuration": {
"encryption_configuration": {
"encryption_option": "SSE_KMS",
"kms_key_arn": example_aws_kms_key["arn"],
},
"output_location": f"s3://{example_aws_s3_bucket['bucket']}/output/",
},
"enforce_workgroup_configuration": True,
"publish_cloudwatch_metrics_enabled": True,
},
name="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Athena.Workgroup("example", new()
{
Configuration = new Aws.Athena.Inputs.WorkgroupConfigurationArgs
{
ResultConfiguration = new Aws.Athena.Inputs.WorkgroupConfigurationResultConfigurationArgs
{
EncryptionConfiguration = new Aws.Athena.Inputs.WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs
{
EncryptionOption = "SSE_KMS",
KmsKeyArn = exampleAwsKmsKey.Arn,
},
OutputLocation = $"s3://{exampleAwsS3Bucket.Bucket}/output/",
},
EnforceWorkgroupConfiguration = true,
PublishCloudwatchMetricsEnabled = true,
},
Name = "example",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/athena"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := athena.NewWorkgroup(ctx, "example", &athena.WorkgroupArgs{
Configuration: &athena.WorkgroupConfigurationArgs{
ResultConfiguration: &athena.WorkgroupConfigurationResultConfigurationArgs{
EncryptionConfiguration: &athena.WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs{
EncryptionOption: pulumi.String("SSE_KMS"),
KmsKeyArn: pulumi.Any(exampleAwsKmsKey.Arn),
},
OutputLocation: pulumi.Sprintf("s3://%v/output/", exampleAwsS3Bucket.Bucket),
},
EnforceWorkgroupConfiguration: pulumi.Bool(true),
PublishCloudwatchMetricsEnabled: pulumi.Bool(true),
},
Name: pulumi.String("example"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_athena_workgroup" "example" {
configuration = {
result_configuration = {
encryption_configuration = {
encryption_option = "SSE_KMS"
kms_key_arn = exampleAwsKmsKey.arn
}
output_location ="s3://${exampleAwsS3Bucket.bucket}/output/"
}
enforce_workgroup_configuration = true
publish_cloudwatch_metrics_enabled = true
}
name = "example"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.athena.Workgroup;
import com.pulumi.aws.athena.WorkgroupArgs;
import com.pulumi.aws.athena.inputs.WorkgroupConfigurationArgs;
import com.pulumi.aws.athena.inputs.WorkgroupConfigurationResultConfigurationArgs;
import com.pulumi.aws.athena.inputs.WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Workgroup("example", WorkgroupArgs.builder()
.configuration(WorkgroupConfigurationArgs.builder()
.resultConfiguration(WorkgroupConfigurationResultConfigurationArgs.builder()
.encryptionConfiguration(WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs.builder()
.encryptionOption("SSE_KMS")
.kmsKeyArn(exampleAwsKmsKey.arn())
.build())
.outputLocation(String.format("s3://%s/output/", exampleAwsS3Bucket.bucket()))
.build())
.enforceWorkgroupConfiguration(true)
.publishCloudwatchMetricsEnabled(true)
.build())
.name("example")
.build());
}
}
resources:
example:
type: aws:athena:Workgroup
properties:
configuration:
resultConfiguration:
encryptionConfiguration:
encryptionOption: SSE_KMS
kmsKeyArn: ${exampleAwsKmsKey.arn}
outputLocation: s3://${exampleAwsS3Bucket.bucket}/output/
enforceWorkgroupConfiguration: true
publishCloudwatchMetricsEnabled: true
name: example
Import
Using pulumi import, import Athena Workgroups using their name. For example:
$ pulumi import aws:athena/workgroup:Workgroup example example
Constructors
- Workgroup(String name, {WorkgroupArgs? args, CustomResourceOptions? options})
-
Creates a new Workgroup.
nameThe Pulumi resource name.argsArguments used to configure this Workgroup. The set of arguments for Workgroup.optionsResource options controlling this resource's behavior. - Workgroup.reference(String urn)
- Creates a typed reference to an existing Workgroup resource.
Properties
-
arn
↔ Output<
String> -
ARN of the workgroup
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
configuration
↔ Output<
WorkgroupConfiguration?> -
Configuration block with various settings for the workgroup. Documented below.
latefinal
-
description
↔ Output<
String?> -
Description of the workgroup.
latefinal
-
forceDestroy
↔ Output<
bool?> -
Option to delete the workgroup and its contents even if the workgroup contains any named queries.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
Name of the workgroup.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
state
↔ Output<
String?> -
State of the workgroup. Valid values are
DISABLEDorENABLED. Defaults toENABLED.latefinal -
Key-value map of resource tags for the workgroup. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited