Package com.pulumi.aws.athena

Class NamedQuery

  • public class NamedQuery
extends com.pulumi.resources.CustomResource
    Provides an Athena Named Query resource. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.s3.Bucket;
 import com.pulumi.aws.s3.BucketArgs;
 import com.pulumi.aws.kms.Key;
 import com.pulumi.aws.kms.KeyArgs;
 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 com.pulumi.aws.athena.Database;
 import com.pulumi.aws.athena.DatabaseArgs;
 import com.pulumi.aws.athena.NamedQuery;
 import com.pulumi.aws.athena.NamedQueryArgs;
 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 hoge = new Bucket("hoge", BucketArgs.builder()
             .bucket("tf-test")
             .build());
 
         var test = new Key("test", KeyArgs.builder()
             .deletionWindowInDays(7)
             .description("Athena KMS Key")
             .build());
 
         var testWorkgroup = new Workgroup("testWorkgroup", WorkgroupArgs.builder()
             .configuration(WorkgroupConfigurationArgs.builder()
                 .resultConfiguration(WorkgroupConfigurationResultConfigurationArgs.builder()
                     .encryptionConfiguration(WorkgroupConfigurationResultConfigurationEncryptionConfigurationArgs.builder()
                         .encryptionOption("SSE_KMS")
                         .kmsKeyArn(test.arn())
                         .build())
                     .build())
                 .build())
             .name("example")
             .build());
 
         var hogeDatabase = new Database("hogeDatabase", DatabaseArgs.builder()
             .name("users")
             .bucket(hoge.id())
             .build());
 
         var foo = new NamedQuery("foo", NamedQueryArgs.builder()
             .name("bar")
             .workgroup(testWorkgroup.id())
             .database(hogeDatabase.name())
             .query(hogeDatabase.name().applyValue(_name -> String.format("SELECT * FROM %s limit 10;", _name)))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Athena Named Query using the query ID. For example: ```sh $ pulumi import aws:athena/namedQuery:NamedQuery example 0123456789 ```

    • 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> database()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static NamedQuery get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, NamedQueryState 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.lang.String> query()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> workgroup()  

      • 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

      • NamedQuery

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

      • NamedQuery

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

      • NamedQuery

        public NamedQuery​(java.lang.String name,
                  NamedQueryArgs 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

      • database

        public com.pulumi.core.Output<java.lang.String> database()
        Returns:
        Database to which the query belongs.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Brief explanation of the query. Maximum length of 1024.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Plain language name for the query. Maximum length of 128.

      • query

        public com.pulumi.core.Output<java.lang.String> query()
        Returns:
        Text of the query itself. In other words, all query statements. Maximum length of 262144.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • workgroup

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> workgroup()
        Returns:
        Workgroup to which the query belongs. Defaults to `primary`

      • get

        public static NamedQuery get​(java.lang.String name,
                             com.pulumi.core.Output<java.lang.String> id,
                             @Nullable
                             NamedQueryState 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.