Package com.pulumi.aws.athena

Class PreparedStatement

  • public class PreparedStatement
extends com.pulumi.resources.CustomResource
    Resource for managing an Athena Prepared Statement. ## 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.athena.Workgroup;
 import com.pulumi.aws.athena.WorkgroupArgs;
 import com.pulumi.aws.athena.Database;
 import com.pulumi.aws.athena.DatabaseArgs;
 import com.pulumi.aws.athena.PreparedStatement;
 import com.pulumi.aws.athena.PreparedStatementArgs;
 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 test = new Bucket("test", BucketArgs.builder()
             .bucket("tf-test")
             .forceDestroy(true)
             .build());
 
         var testWorkgroup = new Workgroup("testWorkgroup", WorkgroupArgs.builder()
             .name("tf-test")
             .build());
 
         var testDatabase = new Database("testDatabase", DatabaseArgs.builder()
             .name("example")
             .bucket(test.bucket())
             .build());
 
         var testPreparedStatement = new PreparedStatement("testPreparedStatement", PreparedStatementArgs.builder()
             .name("tf_test")
             .queryStatement(testDatabase.name().applyValue(_name -> String.format("SELECT * FROM %s WHERE x = ?", _name)))
             .workgroup(testWorkgroup.name())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Athena Prepared Statement using the `WORKGROUP-NAME/STATEMENT-NAME`. For example: ```sh $ pulumi import aws:athena/preparedStatement:PreparedStatement example 12345abcde/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

    • Method Summary

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

      • PreparedStatement

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

      • PreparedStatement

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

      • PreparedStatement

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

      • description

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

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name of the prepared statement. Maximum length of 256.

      • queryStatement

        public com.pulumi.core.Output<java.lang.String> queryStatement()
        Returns:
        The query string for the prepared statement.

      • 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.lang.String> workgroup()
        Returns:
        The name of the workgroup to which the prepared statement belongs.

      • get

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