Skip to content
v2.274.0

Amazon Athena Construct Library ​

This module is part of the AWS Cloud Development Kit project.

ts
import * as athena from 'aws-cdk-lib/aws-athena';
python
import aws_cdk.aws_athena as athena
java
import software.amazon.awscdk.services.athena.*;
csharp
using Amazon.CDK.AWS.Athena;
go
import athena "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::Athena.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Types ​

NameKindSummary
CfnCapacityReservationConstruct (L1)Specifies a capacity reservation with the provided name and number of requested data processing units.
CfnDataCatalogConstruct (L1)The AWS::Athena::DataCatalog resource specifies an Amazon Athena data catalog, which contains a name, description, type, parameters, and tags.
CfnNamedQueryConstruct (L1)The AWS::Athena::NamedQuery resource specifies an Amazon Athena saved query, where QueryString contains the SQL query statements that make up the query.
CfnPreparedStatementConstruct (L1)Specifies a prepared statement for use with SQL queries in Athena.
CfnWorkGroupConstruct (L1)The AWS::Athena::WorkGroup resource specifies an Amazon Athena workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroupConfiguration .
CfnCapacityReservation.CapacityAssignmentConfigurationPropertyStructAssigns Athena workgroups (and hence their queries) to capacity reservations.
CfnCapacityReservation.CapacityAssignmentPropertyStructA mapping between one or more workgroups and a capacity reservation.
CfnCapacityReservationPropsStructProperties for defining a CfnCapacityReservation.
CfnDataCatalogPropsStructProperties for defining a CfnDataCatalog.
CfnNamedQueryPropsStructProperties for defining a CfnNamedQuery.
CfnPreparedStatementPropsStructProperties for defining a CfnPreparedStatement.
CfnWorkGroup.AclConfigurationPropertyStructIndicates that an Amazon S3 canned ACL should be set to control ownership of stored query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO.
CfnWorkGroup.ClassificationPropertyStructA classification refers to a set of specific configurations.
CfnWorkGroup.CloudWatchLoggingConfigurationPropertyStructConfiguration settings for delivering logs to Amazon CloudWatch log groups.
CfnWorkGroup.CustomerContentEncryptionConfigurationPropertyStructSpecifies the customer managed KMS key that is used to encrypt the user's data stores in Athena.
CfnWorkGroup.EncryptionConfigurationPropertyStructIf query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS ) and key information.
CfnWorkGroup.EngineConfigurationPropertyStructThe engine configuration for the workgroup, which includes the minimum/maximum number of Data Processing Units (DPU) that queries should use when running in provisioned capacity.
CfnWorkGroup.EngineVersionPropertyStructThe Athena engine version for running queries, or the PySpark engine version for running sessions.
CfnWorkGroup.ManagedLoggingConfigurationPropertyStructConfiguration settings for delivering logs to Amazon S3 buckets.
CfnWorkGroup.ManagedQueryResultsConfigurationPropertyStructThe configuration for storing results in Athena owned storage, which includes whether this feature is enabled;
CfnWorkGroup.ManagedStorageEncryptionConfigurationPropertyStructIndicates the encryption configuration for Athena Managed Storage.
CfnWorkGroup.MonitoringConfigurationPropertyStructContains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.
CfnWorkGroup.ResultConfigurationPropertyStructThe location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results.
CfnWorkGroup.ResultConfigurationUpdatesPropertyStructThe information about the updates in the query results, such as output location and encryption configuration for the query results.
CfnWorkGroup.S3LoggingConfigurationPropertyStructConfiguration settings for delivering logs to Amazon S3 buckets.
CfnWorkGroup.WorkGroupConfigurationPropertyStructThe configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether Amazon CloudWatch Metrics are enabled for the workgroup, and the limit for the amount of bytes scanned (cutoff) per query, if it is specified.
CfnWorkGroup.WorkGroupConfigurationUpdatesPropertyStructThe configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.
CfnWorkGroupPropsStructProperties for defining a CfnWorkGroup.