athena_database.md

permalink
/athena_database/

athena_database

athena_database represents the aws_athena_database Terraform resource.

This package contains functions and utilities for setting up the resource using Jsonnet code.

Index

• fn new()
• fn newAttrs()
• fn withAclConfiguration()
• fn withAclConfigurationMixin()
• fn withBucket()
• fn withComment()
• fn withEncryptionConfiguration()
• fn withEncryptionConfigurationMixin()
• fn withExpectedBucketOwner()
• fn withForceDestroy()
• fn withName()
• fn withProperties()
• obj acl_configuration
  • fn new()
• obj encryption_configuration
  • fn new()

Fields

fn new

new()

aws.athena_database.new injects a new aws_athena_database Terraform resource block into the root module document.

Additionally, this inserts a private function into the _ref attribute that generates references to attributes of the resource. For example, if you added a new instance to the root using:

# arguments omitted for brevity
aws.athena_database.new('some_id')

You can get the reference to the id field of the created aws.athena_database using the reference:

$._ref.aws_athena_database.some_id.get('id')

This is the same as directly entering "${ aws_athena_database.some_id.id }" as the value.

NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use super, self, or $ to refer to the root object. Instead, make an explicit outer object using local.

Args:

• resourceLabel (string): The name label of the block.
• bucket (string): Set the bucket field on the resulting resource block. When null, the bucket field will be omitted from the resulting object.
• comment (string): Set the comment field on the resulting resource block. When null, the comment field will be omitted from the resulting object.
• expected_bucket_owner (string): Set the expected_bucket_owner field on the resulting resource block. When null, the expected_bucket_owner field will be omitted from the resulting object.
• force_destroy (bool): Set the force_destroy field on the resulting resource block. When null, the force_destroy field will be omitted from the resulting object.
• name (string): Set the name field on the resulting resource block.
• properties (obj): Set the properties field on the resulting resource block. When null, the properties field will be omitted from the resulting object.
• acl_configuration (list[obj]): Set the acl_configuration field on the resulting resource block. When null, the acl_configuration sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.athena_database.acl_configuration.new constructor.
• encryption_configuration (list[obj]): Set the encryption_configuration field on the resulting resource block. When null, the encryption_configuration sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.athena_database.encryption_configuration.new constructor.

Returns:

• A mixin object that injects the new resource into the root Terraform configuration.

fn newAttrs

newAttrs()

aws.athena_database.newAttrs constructs a new object with attributes and blocks configured for the athena_database Terraform resource.

Unlike aws.athena_database.new, this function will not inject the resource block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withResource function to build a complete block.

This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to injecting into a complete block.

Args:

• bucket (string): Set the bucket field on the resulting object. When null, the bucket field will be omitted from the resulting object.
• comment (string): Set the comment field on the resulting object. When null, the comment field will be omitted from the resulting object.
• expected_bucket_owner (string): Set the expected_bucket_owner field on the resulting object. When null, the expected_bucket_owner field will be omitted from the resulting object.
• force_destroy (bool): Set the force_destroy field on the resulting object. When null, the force_destroy field will be omitted from the resulting object.
• name (string): Set the name field on the resulting object.
• properties (obj): Set the properties field on the resulting object. When null, the properties field will be omitted from the resulting object.
• acl_configuration (list[obj]): Set the acl_configuration field on the resulting object. When null, the acl_configuration sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.athena_database.acl_configuration.new constructor.
• encryption_configuration (list[obj]): Set the encryption_configuration field on the resulting object. When null, the encryption_configuration sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.athena_database.encryption_configuration.new constructor.

Returns:

• An attribute object that can be used with tf.withResource to construct a new athena_database resource into the root Terraform configuration.

fn withAclConfiguration

withAclConfiguration()

aws.list[obj].withAclConfiguration constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the acl_configuration field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withAclConfigurationMixin function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the acl_configuration field.

fn withAclConfigurationMixin

withAclConfigurationMixin()

aws.list[obj].withAclConfigurationMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the acl_configuration field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withAclConfiguration function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the acl_configuration field.

fn withBucket

withBucket()

aws.string.withBucket constructs a mixin object that can be merged into the string Terraform resource block to set or update the bucket field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the bucket field.

fn withComment

withComment()

aws.string.withComment constructs a mixin object that can be merged into the string Terraform resource block to set or update the comment field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the comment field.

fn withEncryptionConfiguration

withEncryptionConfiguration()

aws.list[obj].withEncryptionConfiguration constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the encryption_configuration field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withEncryptionConfigurationMixin function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the encryption_configuration field.

fn withEncryptionConfigurationMixin

withEncryptionConfigurationMixin()

aws.list[obj].withEncryptionConfigurationMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the encryption_configuration field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withEncryptionConfiguration function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the encryption_configuration field.

fn withExpectedBucketOwner

withExpectedBucketOwner()

aws.string.withExpectedBucketOwner constructs a mixin object that can be merged into the string Terraform resource block to set or update the expected_bucket_owner field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the expected_bucket_owner field.

fn withForceDestroy

withForceDestroy()

aws.bool.withForceDestroy constructs a mixin object that can be merged into the bool Terraform resource block to set or update the force_destroy field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (bool): The value to set for the force_destroy field.

fn withName

withName()

aws.string.withName constructs a mixin object that can be merged into the string Terraform resource block to set or update the name field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the name field.

fn withProperties

withProperties()

aws.obj.withProperties constructs a mixin object that can be merged into the obj Terraform resource block to set or update the properties field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the properties field.

obj acl_configuration

fn acl_configuration.new

new()

aws.athena_database.acl_configuration.new constructs a new object with attributes and blocks configured for the acl_configuration Terraform sub block.

Args:

• s3_acl_option (string): Set the s3_acl_option field on the resulting object.

Returns:

• An attribute object that represents the acl_configuration sub block.

obj encryption_configuration

fn encryption_configuration.new

new()

aws.athena_database.encryption_configuration.new constructs a new object with attributes and blocks configured for the encryption_configuration Terraform sub block.

Args:

• encryption_option (string): Set the encryption_option field on the resulting object.
• kms_key (string): Set the kms_key field on the resulting object. When null, the kms_key field will be omitted from the resulting object.

Returns:

• An attribute object that represents the encryption_configuration sub block.