Package com.pulumi.aws.athena

Class Workgroup

  • public class Workgroup
extends com.pulumi.resources.CustomResource
    Provides an Athena Workgroup. ## Example Usage <!--Start PulumiCodeChooser --> ```java 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.List; import java.util.ArrayList; 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() .name("example") .configuration(WorkgroupConfigurationArgs.builder() .enforceWorkgroupConfiguration(true) .publishCloudwatchMetricsEnabled(true) .resultConfiguration(WorkgroupConfigurationResultConfigurationArgs.builder() .outputLocation(String.format("s3://%s/output/", exampleAwsS3Bucket.bucket())) .encryptionConfiguration(WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs.builder() .encryptionOption("SSE_KMS") .kmsKeyArn(exampleAwsKmsKey.arn()) .build()) .build()) .build()) .build()); } } ``` <!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import Athena Workgroups using their name. For example: ```sh $ pulumi import aws:athena/workgroup:Workgroup example example ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Workgroup​(java.lang.String name)  
      Workgroup​(java.lang.String name, WorkgroupArgs args)  
      Workgroup​(java.lang.String name, WorkgroupArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<WorkgroupConfiguration>> configuration()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> forceDestroy()  
      static Workgroup get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, WorkgroupState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> state()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Workgroup

        public Workgroup​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Workgroup

        public Workgroup​(java.lang.String name,
                 @Nullable
                 WorkgroupArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Workgroup

        public Workgroup​(java.lang.String name,
                 @Nullable
                 WorkgroupArgs args,
                 @Nullable
                 com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the workgroup

      • configuration

        public com.pulumi.core.Output<java.util.Optional<WorkgroupConfiguration>> configuration()
        Returns:
        Configuration block with various settings for the workgroup. Documented below.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the workgroup.

      • forceDestroy

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> forceDestroy()
        Returns:
        Option to delete the workgroup and its contents even if the workgroup contains any named queries.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the workgroup.

      • state

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> state()
        Returns:
        State of the workgroup. Valid values are `DISABLED` or `ENABLED`. Defaults to `ENABLED`.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags for the workgroup. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.

      • get

        public static Workgroup get​(java.lang.String name,
                            com.pulumi.core.Output<java.lang.String> id,
                            @Nullable
                            WorkgroupState state,
                            @Nullable
                            com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.