Class Workgroup

Provides an Athena Workgroup.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.Athena.Workgroup("example", new Aws.Athena.WorkgroupArgs
    {
        Configuration = new Aws.Athena.Inputs.WorkgroupConfigurationArgs
        {
            EnforceWorkgroupConfiguration = true,
            PublishCloudwatchMetricsEnabled = true,
            ResultConfiguration = new Aws.Athena.Inputs.WorkgroupConfigurationResultConfigurationArgs
            {
                EncryptionConfiguration = new Aws.Athena.Inputs.WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs
                {
                    EncryptionOption = "SSE_KMS",
                    KmsKeyArn = aws_kms_key.Example.Arn,
                },
                OutputLocation = "s3://{aws_s3_bucket.example.bucket}/output/",
            },
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Workgroup

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Athena

Assembly: Pulumi.Aws.dll

Syntax

public class Workgroup : CustomResource

Constructors

Workgroup(String, WorkgroupArgs, CustomResourceOptions)

Create a Workgroup resource with the given unique name, arguments, and options.

Declaration

public Workgroup(string name, WorkgroupArgs args = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
WorkgroupArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

Amazon Resource Name (ARN) of the workgroup

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

Configuration

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

Declaration

public Output<WorkgroupConfiguration> Configuration { get; }

Property Value

Type	Description
Output<WorkgroupConfiguration>

Description

Description of the workgroup.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

ForceDestroy

The option to delete the workgroup and its contents even if the workgroup contains any named queries.

Declaration

public Output<bool?> ForceDestroy { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Name

Name of the workgroup.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

State

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

Declaration

public Output<string> State { get; }

Property Value

Type	Description
Output<System.String>

Tags

Key-value map of resource tags for the workgroup.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Methods

Get(String, Input<String>, WorkgroupState, CustomResourceOptions)

Get an existing Workgroup resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Workgroup Get(string name, Input<string> id, WorkgroupState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
WorkgroupState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Workgroup