Module athena

athena

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.
class pulumi_aws.athena.Database(resource_name, opts=None, bucket=None, encryption_configuration=None, force_destroy=None, name=None, __props__=None, __name__=None, __opts__=None)

Provides an Athena database.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • bucket (pulumi.Input[str]) – Name of s3 bucket to save the results of the query execution.
  • encryption_configuration (pulumi.Input[dict]) – The encryption key block AWS Athena uses to decrypt the data in S3, such as an AWS Key Management Service (AWS KMS) key. An encryption_configuration block is documented below.
  • force_destroy (pulumi.Input[bool]) – A 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 (pulumi.Input[str]) – Name of the database to create.
bucket = None

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

encryption_configuration = None

The encryption key block AWS Athena uses to decrypt the data in S3, such as an AWS Key Management Service (AWS KMS) key. An encryption_configuration block is documented below.

force_destroy = None

A 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 = None

Name of the database to create.

static get(resource_name, id, opts=None, bucket=None, encryption_configuration=None, force_destroy=None, name=None)

Get an existing Database resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] bucket: Name of s3 bucket to save the results of the query execution. :param pulumi.Input[dict] encryption_configuration: The encryption key block AWS Athena uses to decrypt the data in S3, such as an AWS Key Management Service (AWS KMS) key. An encryption_configuration block is documented below. :param pulumi.Input[bool] force_destroy: A 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. :param pulumi.Input[str] name: Name of the database to create.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.athena.NamedQuery(resource_name, opts=None, database=None, description=None, name=None, query=None, workgroup=None, __props__=None, __name__=None, __opts__=None)

Provides an Athena Named Query resource.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • database (pulumi.Input[str]) – The database to which the query belongs.
  • description (pulumi.Input[str]) – A brief explanation of the query. Maximum length of 1024.
  • name (pulumi.Input[str]) – The plain language name for the query. Maximum length of 128.
  • query (pulumi.Input[str]) – The text of the query itself. In other words, all query statements. Maximum length of 262144.
  • workgroup (pulumi.Input[str]) – The workgroup to which the query belongs. Defaults to primary
database = None

The database to which the query belongs.

description = None

A brief explanation of the query. Maximum length of 1024.

name = None

The plain language name for the query. Maximum length of 128.

query = None

The text of the query itself. In other words, all query statements. Maximum length of 262144.

workgroup = None

The workgroup to which the query belongs. Defaults to primary

static get(resource_name, id, opts=None, database=None, description=None, name=None, query=None, workgroup=None)

Get an existing NamedQuery resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] database: The database to which the query belongs. :param pulumi.Input[str] description: A brief explanation of the query. Maximum length of 1024. :param pulumi.Input[str] name: The plain language name for the query. Maximum length of 128. :param pulumi.Input[str] query: The text of the query itself. In other words, all query statements. Maximum length of 262144. :param pulumi.Input[str] workgroup: The workgroup to which the query belongs. Defaults to primary

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.athena.Workgroup(resource_name, opts=None, configuration=None, description=None, name=None, state=None, tags=None, __props__=None, __name__=None, __opts__=None)

Provides an Athena Workgroup.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • configuration (pulumi.Input[dict]) – Configuration block with various settings for the workgroup. Documented below.
  • description (pulumi.Input[str]) – Description of the workgroup.
  • name (pulumi.Input[str]) – Name of the workgroup.
  • state (pulumi.Input[str]) – State of the workgroup. Valid values are DISABLED or ENABLED. Defaults to ENABLED.
  • tags (pulumi.Input[dict]) – Key-value mapping of resource tags for the workgroup.
arn = None

Amazon Resource Name (ARN) of the workgroup

configuration = None

Configuration block with various settings for the workgroup. Documented below.

description = None

Description of the workgroup.

name = None

Name of the workgroup.

state = None

State of the workgroup. Valid values are DISABLED or ENABLED. Defaults to ENABLED.

tags = None

Key-value mapping of resource tags for the workgroup.

static get(resource_name, id, opts=None, arn=None, configuration=None, description=None, name=None, state=None, tags=None)

Get an existing Workgroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup. :param str resource_name: The unique name of the resulting resource. :param str id: The unique provider ID of the resource to lookup. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] arn: Amazon Resource Name (ARN) of the workgroup :param pulumi.Input[dict] configuration: Configuration block with various settings for the workgroup. Documented below. :param pulumi.Input[str] description: Description of the workgroup. :param pulumi.Input[str] name: Name of the workgroup. :param pulumi.Input[str] state: State of the workgroup. Valid values are DISABLED or ENABLED. Defaults to ENABLED. :param pulumi.Input[dict] tags: Key-value mapping of resource tags for the workgroup.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str