Package com.pulumi.aws.athena

Class Database

  • public class Database
extends com.pulumi.resources.CustomResource
    Provides an Athena database. ## 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.Database;
 import com.pulumi.aws.athena.DatabaseArgs;
 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 Bucket("example", BucketArgs.builder()
             .bucket("example")
             .build());
 
         var exampleDatabase = new Database("exampleDatabase", DatabaseArgs.builder()
             .name("database_name")
             .bucket(example.id())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Athena Databases using their name. For example: ```sh $ pulumi import aws:athena/database:Database example example ``` Certain resource arguments, like `encryptionConfiguration` and `bucket`, do not have an API method for reading the information after creation. If the argument is set in the Pulumi program on an imported resource, Pulumi will always show a difference. To workaround this behavior, either omit the argument from the Pulumi program or use `ignoreChanges` to hide the difference. For example: 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.athena.Database;
 import com.pulumi.aws.athena.DatabaseArgs;
 import com.pulumi.resources.CustomResourceOptions;
 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 Database("example", DatabaseArgs.builder()
             .name("database_name")
             .bucket(exampleAwsS3Bucket.id())
             .build(), CustomResourceOptions.builder()
                 .ignoreChanges("bucket")
                 .build());
 
     }
 }

    • 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
      Database​(java.lang.String name)  
      Database​(java.lang.String name, DatabaseArgs args)  
      Database​(java.lang.String name, DatabaseArgs 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.util.Optional<DatabaseAclConfiguration>> aclConfiguration()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> bucket()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> comment()  
      com.pulumi.core.Output<java.util.Optional<DatabaseEncryptionConfiguration>> encryptionConfiguration()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> expectedBucketOwner()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> forceDestroy()  
      static Database get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DatabaseState 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.util.Map<java.lang.String,​java.lang.String>>> properties()  
      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

      • Database

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

      • Database

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

      • Database

        public Database​(java.lang.String name,
                @Nullable
                DatabaseArgs 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

      • aclConfiguration

        public com.pulumi.core.Output<java.util.Optional<DatabaseAclConfiguration>> aclConfiguration()
        Returns:
        That an Amazon S3 canned ACL should be set to control ownership of stored query results. See ACL Configuration below.

      • bucket

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> bucket()
        Returns:
        Name of S3 bucket to save the results of the query execution.

      • comment

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

      • encryptionConfiguration

        public com.pulumi.core.Output<java.util.Optional<DatabaseEncryptionConfiguration>> encryptionConfiguration()
        Returns:
        Encryption key block AWS Athena uses to decrypt the data in S3, such as a KMS key. See Encryption Configuration below.

      • expectedBucketOwner

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> expectedBucketOwner()
        Returns:
        AWS account ID that you expect to be the owner of the Amazon S3 bucket.

      • forceDestroy

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> forceDestroy()
        Returns:
        Boolean that indicates all tables should be deleted from the database so that the database can be destroyed without error. The tables are *not* recoverable.

      • name

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

      • properties

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> properties()
        Returns:
        Key-value map of custom metadata properties for the database definition.

      • 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:
        Name of the workgroup.

      • get

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