pulumi-aws-kotlin/com.pulumi.aws.athena.kotlin/DatabaseArgs

DatabaseArgs

data class DatabaseArgs(val aclConfiguration: Output<DatabaseAclConfigurationArgs>? = null, val bucket: Output<String>? = null, val comment: Output<String>? = null, val encryptionConfiguration: Output<DatabaseEncryptionConfigurationArgs>? = null, val expectedBucketOwner: Output<String>? = null, val forceDestroy: Output<Boolean>? = null, val name: Output<String>? = null, val properties: Output<Map<String, String>>? = null) : ConvertibleToJava<DatabaseArgs>

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.BucketV2;
import com.pulumi.aws.athena.Database;
import com.pulumi.aws.athena.DatabaseArgs;
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 exampleBucketV2 = new BucketV2("exampleBucketV2");
        var exampleDatabase = new Database("exampleDatabase", DatabaseArgs.builder()
            .name("database_name")
            .bucket(exampleBucketV2.id())
            .build());
    }
}

Import

Using pulumi import, import Athena Databases using their name. For example:

$ pulumi import aws:athena/database:Database example example

Certain resource arguments, like encryption_configuration 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 ignore_changes to hide the difference. For example:

Constructors

DatabaseArgs

fun DatabaseArgs(aclConfiguration: Output<DatabaseAclConfigurationArgs>? = null, bucket: Output<String>? = null, comment: Output<String>? = null, encryptionConfiguration: Output<DatabaseEncryptionConfigurationArgs>? = null, expectedBucketOwner: Output<String>? = null, forceDestroy: Output<Boolean>? = null, name: Output<String>? = null, properties: Output<Map<String, String>>? = null)

Functions

toJava

open override fun toJava(): DatabaseArgs

Properties

aclConfiguration

val aclConfiguration: Output<DatabaseAclConfigurationArgs>? = null

That an Amazon S3 canned ACL should be set to control ownership of stored query results. See ACL Configuration below.

bucket

val bucket: Output<String>? = null

Name of S3 bucket to save the results of the query execution.

comment

val comment: Output<String>? = null

Description of the database.

encryptionConfiguration

val encryptionConfiguration: Output<DatabaseEncryptionConfigurationArgs>? = null

Encryption key block AWS Athena uses to decrypt the data in S3, such as an AWS Key Management Service (AWS KMS) key. See Encryption Configuration below.

expectedBucketOwner

val expectedBucketOwner: Output<String>? = null

AWS account ID that you expect to be the owner of the Amazon S3 bucket.

forceDestroy

val forceDestroy: Output<Boolean>? = null

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

val name: Output<String>? = null

Name of the database to create.

properties

val properties: Output<Map<String, String>>? = null

Key-value map of custom metadata properties for the database definition.