CfnWorkGroupPropsMixin

class aws_cdk.mixins_preview.aws_athena.mixins.CfnWorkGroupPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::Athena::WorkGroup resource specifies an Amazon Athena workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroupConfiguration .

Each workgroup enables you to isolate queries for you or your group from other queries in the same account. For more information, see CreateWorkGroup in the Amazon Athena API Reference .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html

CloudformationResource:

AWS::Athena::WorkGroup

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_athena import mixins as athena_mixins

cfn_work_group_props_mixin = athena_mixins.CfnWorkGroupPropsMixin(athena_mixins.CfnWorkGroupMixinProps(
    description="description",
    name="name",
    recursive_delete_option=False,
    state="state",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    work_group_configuration=athena_mixins.CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty(
        additional_configuration="additionalConfiguration",
        bytes_scanned_cutoff_per_query=123,
        customer_content_encryption_configuration=athena_mixins.CfnWorkGroupPropsMixin.CustomerContentEncryptionConfigurationProperty(
            kms_key="kmsKey"
        ),
        enforce_work_group_configuration=False,
        engine_configuration=athena_mixins.CfnWorkGroupPropsMixin.EngineConfigurationProperty(
            additional_configs={
                "additional_configs_key": "additionalConfigs"
            },
            classifications=[athena_mixins.CfnWorkGroupPropsMixin.ClassificationProperty(
                name="name",
                properties={
                    "properties_key": "properties"
                }
            )],
            coordinator_dpu_size=123,
            default_executor_dpu_size=123,
            max_concurrent_dpus=123,
            spark_properties={
                "spark_properties_key": "sparkProperties"
            }
        ),
        engine_version=athena_mixins.CfnWorkGroupPropsMixin.EngineVersionProperty(
            effective_engine_version="effectiveEngineVersion",
            selected_engine_version="selectedEngineVersion"
        ),
        execution_role="executionRole",
        managed_query_results_configuration=athena_mixins.CfnWorkGroupPropsMixin.ManagedQueryResultsConfigurationProperty(
            enabled=False,
            encryption_configuration=athena_mixins.CfnWorkGroupPropsMixin.ManagedStorageEncryptionConfigurationProperty(
                kms_key="kmsKey"
            )
        ),
        monitoring_configuration=athena_mixins.CfnWorkGroupPropsMixin.MonitoringConfigurationProperty(
            cloud_watch_logging_configuration=athena_mixins.CfnWorkGroupPropsMixin.CloudWatchLoggingConfigurationProperty(
                enabled=False,
                log_group="logGroup",
                log_stream_name_prefix="logStreamNamePrefix",
                log_types={
                    "log_types_key": ["logTypes"]
                }
            ),
            managed_logging_configuration=athena_mixins.CfnWorkGroupPropsMixin.ManagedLoggingConfigurationProperty(
                enabled=False,
                kms_key="kmsKey"
            ),
            s3_logging_configuration=athena_mixins.CfnWorkGroupPropsMixin.S3LoggingConfigurationProperty(
                enabled=False,
                kms_key="kmsKey",
                log_location="logLocation"
            )
        ),
        publish_cloud_watch_metrics_enabled=False,
        requester_pays_enabled=False,
        result_configuration=athena_mixins.CfnWorkGroupPropsMixin.ResultConfigurationProperty(
            acl_configuration=athena_mixins.CfnWorkGroupPropsMixin.AclConfigurationProperty(
                s3_acl_option="s3AclOption"
            ),
            encryption_configuration=athena_mixins.CfnWorkGroupPropsMixin.EncryptionConfigurationProperty(
                encryption_option="encryptionOption",
                kms_key="kmsKey"
            ),
            expected_bucket_owner="expectedBucketOwner",
            output_location="outputLocation"
        )
    ),
    work_group_configuration_updates=athena_mixins.CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty(
        additional_configuration="additionalConfiguration",
        bytes_scanned_cutoff_per_query=123,
        customer_content_encryption_configuration=athena_mixins.CfnWorkGroupPropsMixin.CustomerContentEncryptionConfigurationProperty(
            kms_key="kmsKey"
        ),
        enforce_work_group_configuration=False,
        engine_configuration=athena_mixins.CfnWorkGroupPropsMixin.EngineConfigurationProperty(
            additional_configs={
                "additional_configs_key": "additionalConfigs"
            },
            classifications=[athena_mixins.CfnWorkGroupPropsMixin.ClassificationProperty(
                name="name",
                properties={
                    "properties_key": "properties"
                }
            )],
            coordinator_dpu_size=123,
            default_executor_dpu_size=123,
            max_concurrent_dpus=123,
            spark_properties={
                "spark_properties_key": "sparkProperties"
            }
        ),
        engine_version=athena_mixins.CfnWorkGroupPropsMixin.EngineVersionProperty(
            effective_engine_version="effectiveEngineVersion",
            selected_engine_version="selectedEngineVersion"
        ),
        execution_role="executionRole",
        managed_query_results_configuration=athena_mixins.CfnWorkGroupPropsMixin.ManagedQueryResultsConfigurationProperty(
            enabled=False,
            encryption_configuration=athena_mixins.CfnWorkGroupPropsMixin.ManagedStorageEncryptionConfigurationProperty(
                kms_key="kmsKey"
            )
        ),
        monitoring_configuration=athena_mixins.CfnWorkGroupPropsMixin.MonitoringConfigurationProperty(
            cloud_watch_logging_configuration=athena_mixins.CfnWorkGroupPropsMixin.CloudWatchLoggingConfigurationProperty(
                enabled=False,
                log_group="logGroup",
                log_stream_name_prefix="logStreamNamePrefix",
                log_types={
                    "log_types_key": ["logTypes"]
                }
            ),
            managed_logging_configuration=athena_mixins.CfnWorkGroupPropsMixin.ManagedLoggingConfigurationProperty(
                enabled=False,
                kms_key="kmsKey"
            ),
            s3_logging_configuration=athena_mixins.CfnWorkGroupPropsMixin.S3LoggingConfigurationProperty(
                enabled=False,
                kms_key="kmsKey",
                log_location="logLocation"
            )
        ),
        publish_cloud_watch_metrics_enabled=False,
        remove_bytes_scanned_cutoff_per_query=False,
        remove_customer_content_encryption_configuration=False,
        requester_pays_enabled=False,
        result_configuration_updates=athena_mixins.CfnWorkGroupPropsMixin.ResultConfigurationUpdatesProperty(
            acl_configuration=athena_mixins.CfnWorkGroupPropsMixin.AclConfigurationProperty(
                s3_acl_option="s3AclOption"
            ),
            encryption_configuration=athena_mixins.CfnWorkGroupPropsMixin.EncryptionConfigurationProperty(
                encryption_option="encryptionOption",
                kms_key="kmsKey"
            ),
            expected_bucket_owner="expectedBucketOwner",
            output_location="outputLocation",
            remove_acl_configuration=False,
            remove_encryption_configuration=False,
            remove_expected_bucket_owner=False,
            remove_output_location=False
        )
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Athena::WorkGroup.

Parameters:

  • props (Union[CfnWorkGroupMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'name', 'recursiveDeleteOption', 'state', 'tags', 'workGroupConfiguration', 'workGroupConfigurationUpdates']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

AclConfigurationProperty

class CfnWorkGroupPropsMixin.AclConfigurationProperty(*, s3_acl_option=None)

Bases: object

Indicates 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.

When Athena stores query results in Amazon S3, the canned ACL is set with the x-amz-acl request header. For more information about S3 Object Ownership, see Object Ownership settings in the Amazon S3 User Guide .

Parameters:

s3_acl_option (Optional[str]) – The Amazon S3 canned ACL that Athena should specify when storing query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL . If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup’s settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-aclconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_athena import mixins as athena_mixins

acl_configuration_property = athena_mixins.CfnWorkGroupPropsMixin.AclConfigurationProperty(
    s3_acl_option="s3AclOption"
)

Attributes

s3_acl_option

The Amazon S3 canned ACL that Athena should specify when storing query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO.

Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL . If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup’s settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-aclconfiguration.html#cfn-athena-workgroup-aclconfiguration-s3acloption

ClassificationProperty

class CfnWorkGroupPropsMixin.ClassificationProperty(*, name=None, properties=None)

Bases: object

A classification refers to a set of specific configurations.

Parameters:

  • name (Optional[str]) – The name of the configuration classification.

  • properties (Union[Mapping[str, str], IResolvable, None]) – A set of properties specified within a configuration classification.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-classification.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_athena import mixins as athena_mixins

classification_property = athena_mixins.CfnWorkGroupPropsMixin.ClassificationProperty(
    name="name",
    properties={
        "properties_key": "properties"
    }
)

Attributes

name

The name of the configuration classification.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-classification.html#cfn-athena-workgroup-classification-name

properties

A set of properties specified within a configuration classification.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-classification.html#cfn-athena-workgroup-classification-properties

CloudWatchLoggingConfigurationProperty

class CfnWorkGroupPropsMixin.CloudWatchLoggingConfigurationProperty(*, enabled=None, log_group=None, log_stream_name_prefix=None, log_types=None)

Bases: object

Configuration settings for delivering logs to Amazon CloudWatch log groups.

Parameters:

  • enabled (Union[bool, IResolvable, None]) – Enables CloudWatch logging.

  • log_group (Optional[str]) – The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.

  • log_stream_name_prefix (Optional[str]) – Prefix for the CloudWatch log stream name.

  • log_types (Union[IResolvable, Mapping[str, Sequence[str]], None]) – The types of logs that you want to publish to CloudWatch.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-cloudwatchloggingconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_athena import mixins as athena_mixins

cloud_watch_logging_configuration_property = athena_mixins.CfnWorkGroupPropsMixin.CloudWatchLoggingConfigurationProperty(
    enabled=False,
    log_group="logGroup",
    log_stream_name_prefix="logStreamNamePrefix",
    log_types={
        "log_types_key": ["logTypes"]
    }
)

Attributes

enabled

Enables CloudWatch logging.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-cloudwatchloggingconfiguration.html#cfn-athena-workgroup-cloudwatchloggingconfiguration-enabled

log_group

The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-cloudwatchloggingconfiguration.html#cfn-athena-workgroup-cloudwatchloggingconfiguration-loggroup

log_stream_name_prefix

Prefix for the CloudWatch log stream name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-cloudwatchloggingconfiguration.html#cfn-athena-workgroup-cloudwatchloggingconfiguration-logstreamnameprefix

log_types

The types of logs that you want to publish to CloudWatch.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-cloudwatchloggingconfiguration.html#cfn-athena-workgroup-cloudwatchloggingconfiguration-logtypes

CustomerContentEncryptionConfigurationProperty

class CfnWorkGroupPropsMixin.CustomerContentEncryptionConfigurationProperty(*, kms_key=None)

Bases: object

Specifies the customer managed KMS key that is used to encrypt the user’s data stores in Athena.

When an AWS managed key is used, this value is null. This setting does not apply to Athena SQL workgroups.

Parameters:

kms_key (Optional[str]) – The customer managed KMS key that is used to encrypt the user’s data stores in Athena.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-customercontentencryptionconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_athena import mixins as athena_mixins

customer_content_encryption_configuration_property = athena_mixins.CfnWorkGroupPropsMixin.CustomerContentEncryptionConfigurationProperty(
    kms_key="kmsKey"
)

Attributes

kms_key

The customer managed KMS key that is used to encrypt the user’s data stores in Athena.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-customercontentencryptionconfiguration.html#cfn-athena-workgroup-customercontentencryptionconfiguration-kmskey

EncryptionConfigurationProperty

class CfnWorkGroupPropsMixin.EncryptionConfigurationProperty(*, encryption_option=None, kms_key=None)

Bases: object

If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS ) and key information.

Parameters:

  • encryption_option (Optional[str]) – Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys ( SSE_S3 ), server-side encryption with KMS-managed keys ( SSE_KMS ), or client-side encryption with KMS-managed keys ( CSE_KMS ) is used. If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup’s setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

  • kms_key (Optional[str]) – For SSE_KMS and CSE_KMS , this is the KMS key ARN or ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-encryptionconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_athena import mixins as athena_mixins

encryption_configuration_property = athena_mixins.CfnWorkGroupPropsMixin.EncryptionConfigurationProperty(
    encryption_option="encryptionOption",
    kms_key="kmsKey"
)

Attributes

encryption_option

Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys ( SSE_S3 ), server-side encryption with KMS-managed keys ( SSE_KMS ), or client-side encryption with KMS-managed keys ( CSE_KMS ) is used.

If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup’s setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-encryptionconfiguration.html#cfn-athena-workgroup-encryptionconfiguration-encryptionoption

kms_key

For SSE_KMS and CSE_KMS , this is the KMS key ARN or ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-encryptionconfiguration.html#cfn-athena-workgroup-encryptionconfiguration-kmskey

EngineConfigurationProperty

class CfnWorkGroupPropsMixin.EngineConfigurationProperty(*, additional_configs=None, classifications=None, coordinator_dpu_size=None, default_executor_dpu_size=None, max_concurrent_dpus=None, spark_properties=None)

Bases: object

The 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.

If not specified, Athena uses default values (Default value for min is 4 and for max is Minimum of 124 and allocated DPUs).

To specify DPU values for PC queries the WG containing EngineConfiguration should have the following values: The name of the Classifications should be athena-query-engine-properties , with the only allowed properties as max-dpu-count and min-dpu-count .

Parameters:

  • additional_configs (Union[Mapping[str, str], IResolvable, None]) – Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.

  • classifications (Union[IResolvable, Sequence[Union[IResolvable, ClassificationProperty, Dict[str, Any]]], None]) – The configuration classifications that can be specified for the engine.

  • coordinator_dpu_size (Union[int, float, None]) – The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session. The default is 1.

  • default_executor_dpu_size (Union[int, float, None]) – The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena. The default is 1.

  • max_concurrent_dpus (Union[int, float, None]) – The maximum number of DPUs that can run concurrently.

  • spark_properties (Union[Mapping[str, str], IResolvable, None]) – Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_athena import mixins as athena_mixins

engine_configuration_property = athena_mixins.CfnWorkGroupPropsMixin.EngineConfigurationProperty(
    additional_configs={
        "additional_configs_key": "additionalConfigs"
    },
    classifications=[athena_mixins.CfnWorkGroupPropsMixin.ClassificationProperty(
        name="name",
        properties={
            "properties_key": "properties"
        }
    )],
    coordinator_dpu_size=123,
    default_executor_dpu_size=123,
    max_concurrent_dpus=123,
    spark_properties={
        "spark_properties_key": "sparkProperties"
    }
)

Attributes

additional_configs

Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs.

To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineconfiguration.html#cfn-athena-workgroup-engineconfiguration-additionalconfigs

classifications

The configuration classifications that can be specified for the engine.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineconfiguration.html#cfn-athena-workgroup-engineconfiguration-classifications

coordinator_dpu_size

The number of DPUs to use for the coordinator.

A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session. The default is 1.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineconfiguration.html#cfn-athena-workgroup-engineconfiguration-coordinatordpusize

default_executor_dpu_size

The default number of DPUs to use for executors.

An executor is the smallest unit of compute that a notebook session can request from Athena. The default is 1.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineconfiguration.html#cfn-athena-workgroup-engineconfiguration-defaultexecutordpusize

max_concurrent_dpus

The maximum number of DPUs that can run concurrently.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineconfiguration.html#cfn-athena-workgroup-engineconfiguration-maxconcurrentdpus

spark_properties

Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineconfiguration.html#cfn-athena-workgroup-engineconfiguration-sparkproperties

EngineVersionProperty

class CfnWorkGroupPropsMixin.EngineVersionProperty(*, effective_engine_version=None, selected_engine_version=None)

Bases: object

The Athena engine version for running queries, or the PySpark engine version for running sessions.

Parameters:

  • effective_engine_version (Optional[str]) – Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.

  • selected_engine_version (Optional[str]) – The engine version requested by the user. Possible values are determined by the output of ListEngineVersions , including AUTO. The default is AUTO.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineversion.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_athena import mixins as athena_mixins

engine_version_property = athena_mixins.CfnWorkGroupPropsMixin.EngineVersionProperty(
    effective_engine_version="effectiveEngineVersion",
    selected_engine_version="selectedEngineVersion"
)

Attributes

effective_engine_version

Read only.

The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineversion.html#cfn-athena-workgroup-engineversion-effectiveengineversion

selected_engine_version

The engine version requested by the user.

Possible values are determined by the output of ListEngineVersions , including AUTO. The default is AUTO.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-engineversion.html#cfn-athena-workgroup-engineversion-selectedengineversion

ManagedLoggingConfigurationProperty

class CfnWorkGroupPropsMixin.ManagedLoggingConfigurationProperty(*, enabled=None, kms_key=None)

Bases: object

Configuration settings for delivering logs to Amazon S3 buckets.

Parameters:

  • enabled (Union[bool, IResolvable, None]) – Enables mamanged log persistence.

  • kms_key (Optional[str]) – The KMS key ARN to encrypt the logs stored in managed log persistence.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-managedloggingconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_athena import mixins as athena_mixins

managed_logging_configuration_property = athena_mixins.CfnWorkGroupPropsMixin.ManagedLoggingConfigurationProperty(
    enabled=False,
    kms_key="kmsKey"
)

Attributes

enabled

Enables mamanged log persistence.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-managedloggingconfiguration.html#cfn-athena-workgroup-managedloggingconfiguration-enabled

kms_key

The KMS key ARN to encrypt the logs stored in managed log persistence.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-managedloggingconfiguration.html#cfn-athena-workgroup-managedloggingconfiguration-kmskey

ManagedQueryResultsConfigurationProperty

class CfnWorkGroupPropsMixin.ManagedQueryResultsConfigurationProperty(*, enabled=None, encryption_configuration=None)

Bases: object

The configuration for storing results in Athena owned storage, which includes whether this feature is enabled;

whether encryption configuration, if any, is used for encrypting query results.

Parameters:

  • enabled (Union[bool, IResolvable, None]) – If set to true, allows you to store query results in Athena owned storage. If set to false, workgroup member stores query results in location specified under ResultConfiguration$OutputLocation . The default is false. A workgroup cannot have the ResultConfiguration$OutputLocation parameter when you set this field to true.

  • encryption_configuration (Union[IResolvable, ManagedStorageEncryptionConfigurationProperty, Dict[str, Any], None]) – If you encrypt query and calculation results in Athena owned storage, this field indicates the encryption option (for example, SSE_KMS or CSE_KMS) and key information.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-managedqueryresultsconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_athena import mixins as athena_mixins

managed_query_results_configuration_property = athena_mixins.CfnWorkGroupPropsMixin.ManagedQueryResultsConfigurationProperty(
    enabled=False,
    encryption_configuration=athena_mixins.CfnWorkGroupPropsMixin.ManagedStorageEncryptionConfigurationProperty(
        kms_key="kmsKey"
    )
)

Attributes

enabled

If set to true, allows you to store query results in Athena owned storage.

If set to false, workgroup member stores query results in location specified under ResultConfiguration$OutputLocation . The default is false. A workgroup cannot have the ResultConfiguration$OutputLocation parameter when you set this field to true.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-managedqueryresultsconfiguration.html#cfn-athena-workgroup-managedqueryresultsconfiguration-enabled

encryption_configuration

If you encrypt query and calculation results in Athena owned storage, this field indicates the encryption option (for example, SSE_KMS or CSE_KMS) and key information.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-managedqueryresultsconfiguration.html#cfn-athena-workgroup-managedqueryresultsconfiguration-encryptionconfiguration

ManagedStorageEncryptionConfigurationProperty

class CfnWorkGroupPropsMixin.ManagedStorageEncryptionConfigurationProperty(*, kms_key=None)

Bases: object

Indicates the encryption configuration for Athena Managed Storage.

If not setting this field, Managed Storage will encrypt the query results with Athena’s encryption key

Parameters:

kms_key (Optional[str]) – For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-managedstorageencryptionconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_athena import mixins as athena_mixins

managed_storage_encryption_configuration_property = athena_mixins.CfnWorkGroupPropsMixin.ManagedStorageEncryptionConfigurationProperty(
    kms_key="kmsKey"
)

Attributes

kms_key

For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-managedstorageencryptionconfiguration.html#cfn-athena-workgroup-managedstorageencryptionconfiguration-kmskey

MonitoringConfigurationProperty

class CfnWorkGroupPropsMixin.MonitoringConfigurationProperty(*, cloud_watch_logging_configuration=None, managed_logging_configuration=None, s3_logging_configuration=None)

Bases: object

Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-monitoringconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_athena import mixins as athena_mixins

monitoring_configuration_property = athena_mixins.CfnWorkGroupPropsMixin.MonitoringConfigurationProperty(
    cloud_watch_logging_configuration=athena_mixins.CfnWorkGroupPropsMixin.CloudWatchLoggingConfigurationProperty(
        enabled=False,
        log_group="logGroup",
        log_stream_name_prefix="logStreamNamePrefix",
        log_types={
            "log_types_key": ["logTypes"]
        }
    ),
    managed_logging_configuration=athena_mixins.CfnWorkGroupPropsMixin.ManagedLoggingConfigurationProperty(
        enabled=False,
        kms_key="kmsKey"
    ),
    s3_logging_configuration=athena_mixins.CfnWorkGroupPropsMixin.S3LoggingConfigurationProperty(
        enabled=False,
        kms_key="kmsKey",
        log_location="logLocation"
    )
)

Attributes

cloud_watch_logging_configuration

Configuration settings for delivering logs to Amazon CloudWatch log groups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-monitoringconfiguration.html#cfn-athena-workgroup-monitoringconfiguration-cloudwatchloggingconfiguration

managed_logging_configuration

Configuration settings for managed log persistence.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-monitoringconfiguration.html#cfn-athena-workgroup-monitoringconfiguration-managedloggingconfiguration

s3_logging_configuration

Configuration settings for delivering logs to Amazon S3 buckets.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-monitoringconfiguration.html#cfn-athena-workgroup-monitoringconfiguration-s3loggingconfiguration

ResultConfigurationProperty

class CfnWorkGroupPropsMixin.ResultConfigurationProperty(*, acl_configuration=None, encryption_configuration=None, expected_bucket_owner=None, output_location=None)

Bases: object

The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results.

These are known as “client-side settings”. If workgroup settings override client-side settings, then the query uses the workgroup settings.

Parameters:

  • acl_configuration (Union[IResolvable, AclConfigurationProperty, Dict[str, Any], None]) – Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL . This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See EnforceWorkGroupConfiguration .

  • encryption_configuration (Union[IResolvable, EncryptionConfigurationProperty, Dict[str, Any], None]) – If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS ) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See EnforceWorkGroupConfiguration and Override client-side settings .

  • expected_bucket_owner (Optional[str]) – The account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration:OutputLocation . If set, Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See EnforceWorkGroupConfiguration .

  • output_location (Optional[str]) – The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/ . To run a query, you must specify the query results location using either a client-side setting for individual queries or a location specified by the workgroup. If workgroup settings override client-side settings, then the query uses the location specified for the workgroup. If no query location is set, Athena issues an error. For more information, see Work with query results and recent queries and EnforceWorkGroupConfiguration .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_athena import mixins as athena_mixins

result_configuration_property = athena_mixins.CfnWorkGroupPropsMixin.ResultConfigurationProperty(
    acl_configuration=athena_mixins.CfnWorkGroupPropsMixin.AclConfigurationProperty(
        s3_acl_option="s3AclOption"
    ),
    encryption_configuration=athena_mixins.CfnWorkGroupPropsMixin.EncryptionConfigurationProperty(
        encryption_option="encryptionOption",
        kms_key="kmsKey"
    ),
    expected_bucket_owner="expectedBucketOwner",
    output_location="outputLocation"
)

Attributes

acl_configuration

Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results.

Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL . This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See EnforceWorkGroupConfiguration .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfiguration.html#cfn-athena-workgroup-resultconfiguration-aclconfiguration

encryption_configuration

If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS ) and key information.

This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See EnforceWorkGroupConfiguration and Override client-side settings .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfiguration.html#cfn-athena-workgroup-resultconfiguration-encryptionconfiguration

expected_bucket_owner

The account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration:OutputLocation .

If set, Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.

This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See EnforceWorkGroupConfiguration .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfiguration.html#cfn-athena-workgroup-resultconfiguration-expectedbucketowner

output_location

The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/ .

To run a query, you must specify the query results location using either a client-side setting for individual queries or a location specified by the workgroup. If workgroup settings override client-side settings, then the query uses the location specified for the workgroup. If no query location is set, Athena issues an error. For more information, see Work with query results and recent queries and EnforceWorkGroupConfiguration .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfiguration.html#cfn-athena-workgroup-resultconfiguration-outputlocation

ResultConfigurationUpdatesProperty

class CfnWorkGroupPropsMixin.ResultConfigurationUpdatesProperty(*, acl_configuration=None, encryption_configuration=None, expected_bucket_owner=None, output_location=None, remove_acl_configuration=None, remove_encryption_configuration=None, remove_expected_bucket_owner=None, remove_output_location=None)

Bases: object

The information about the updates in the query results, such as output location and encryption configuration for the query results.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfigurationupdates.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_athena import mixins as athena_mixins

result_configuration_updates_property = athena_mixins.CfnWorkGroupPropsMixin.ResultConfigurationUpdatesProperty(
    acl_configuration=athena_mixins.CfnWorkGroupPropsMixin.AclConfigurationProperty(
        s3_acl_option="s3AclOption"
    ),
    encryption_configuration=athena_mixins.CfnWorkGroupPropsMixin.EncryptionConfigurationProperty(
        encryption_option="encryptionOption",
        kms_key="kmsKey"
    ),
    expected_bucket_owner="expectedBucketOwner",
    output_location="outputLocation",
    remove_acl_configuration=False,
    remove_encryption_configuration=False,
    remove_expected_bucket_owner=False,
    remove_output_location=False
)

Attributes

acl_configuration

The ACL configuration for the query results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfigurationupdates.html#cfn-athena-workgroup-resultconfigurationupdates-aclconfiguration

encryption_configuration

The encryption configuration for the query results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfigurationupdates.html#cfn-athena-workgroup-resultconfigurationupdates-encryptionconfiguration

expected_bucket_owner

The AWS account ID that you expect to be the owner of the Amazon S3 bucket specified by ` <https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-athena-workgroup-resultconfiguration.html#cfn-athena-workgroup-resultconfiguration-outputlocation>`_ . If set, Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner AWS account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.

If workgroup settings override client-side settings, then the query uses the ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See ` <https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-enforceworkgroupconfiguration>`_ and Workgroup Settings Override Client-Side Settings .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfigurationupdates.html#cfn-athena-workgroup-resultconfigurationupdates-expectedbucketowner

output_location

The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/ .

For more information, see Query Results If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The “workgroup settings override” is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See EnforceWorkGroupConfiguration .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfigurationupdates.html#cfn-athena-workgroup-resultconfigurationupdates-outputlocation

remove_acl_configuration

If set to true , indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null.

If set to false or not set, and a value is present in the AclConfiguration of ResultConfigurationUpdates , the AclConfiguration in the workgroup’s ResultConfiguration is updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfigurationupdates.html#cfn-athena-workgroup-resultconfigurationupdates-removeaclconfiguration

remove_encryption_configuration

If set to “true”, indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null.

If set to “false” or not set, and a value is present in the EncryptionConfiguration in ResultConfigurationUpdates (the client-side setting), the EncryptionConfiguration in the workgroup’s ResultConfiguration will be updated with the new value. For more information, see Override Client-Side Settings .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfigurationupdates.html#cfn-athena-workgroup-resultconfigurationupdates-removeencryptionconfiguration

remove_expected_bucket_owner

If set to “true”, removes the AWS account ID previously specified for ` <https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-athena-workgroup-resultconfiguration.html#cfn-athena-workgroup-resultconfiguration-expectedbucketowner>`_ . If set to “false” or not set, and a value is present in the ExpectedBucketOwner in ResultConfigurationUpdates (the client-side setting), the ExpectedBucketOwner in the workgroup’s ResultConfiguration is updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfigurationupdates.html#cfn-athena-workgroup-resultconfigurationupdates-removeexpectedbucketowner

remove_output_location

If set to “true”, indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null.

If set to “false” or not set, and a value is present in the OutputLocation in ResultConfigurationUpdates (the client-side setting), the OutputLocation in the workgroup’s ResultConfiguration will be updated with the new value. For more information, see Override Client-Side Settings .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-resultconfigurationupdates.html#cfn-athena-workgroup-resultconfigurationupdates-removeoutputlocation

S3LoggingConfigurationProperty

class CfnWorkGroupPropsMixin.S3LoggingConfigurationProperty(*, enabled=None, kms_key=None, log_location=None)

Bases: object

Configuration settings for delivering logs to Amazon S3 buckets.

Parameters:

  • enabled (Union[bool, IResolvable, None]) – Enables S3 log delivery.

  • kms_key (Optional[str]) – The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.

  • log_location (Optional[str]) – The Amazon S3 destination URI for log publishing.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-s3loggingconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_athena import mixins as athena_mixins

s3_logging_configuration_property = athena_mixins.CfnWorkGroupPropsMixin.S3LoggingConfigurationProperty(
    enabled=False,
    kms_key="kmsKey",
    log_location="logLocation"
)

Attributes

enabled

Enables S3 log delivery.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-s3loggingconfiguration.html#cfn-athena-workgroup-s3loggingconfiguration-enabled

kms_key

The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-s3loggingconfiguration.html#cfn-athena-workgroup-s3loggingconfiguration-kmskey

log_location

The Amazon S3 destination URI for log publishing.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-s3loggingconfiguration.html#cfn-athena-workgroup-s3loggingconfiguration-loglocation

WorkGroupConfigurationProperty

class CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty(*, additional_configuration=None, bytes_scanned_cutoff_per_query=None, customer_content_encryption_configuration=None, enforce_work_group_configuration=None, engine_configuration=None, engine_version=None, execution_role=None, managed_query_results_configuration=None, monitoring_configuration=None, publish_cloud_watch_metrics_enabled=None, requester_pays_enabled=None, result_configuration=None)

Bases: object

The 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.

The EnforceWorkGroupConfiguration option determines whether workgroup settings override client-side query settings.

Parameters:

  • additional_configuration (Optional[str]) – Specifies a user defined JSON string that is passed to the session engine.

  • bytes_scanned_cutoff_per_query (Union[int, float, None]) – The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. No default is defined. .. epigraph:: This property currently supports integer types. Support for long values is planned.

  • customer_content_encryption_configuration (Union[IResolvable, CustomerContentEncryptionConfigurationProperty, Dict[str, Any], None]) – Specifies the KMS key that is used to encrypt the user’s data stores in Athena. This setting does not apply to Athena SQL workgroups.

  • enforce_work_group_configuration (Union[bool, IResolvable, None]) –

    If set to “true”, the settings for the workgroup override client-side settings. If set to “false”, client-side settings are used. For more information, see Override client-side settings .

  • engine_configuration (Union[IResolvable, EngineConfigurationProperty, Dict[str, Any], None]) – The engine configuration for running queries.

  • engine_version (Union[IResolvable, EngineVersionProperty, Dict[str, Any], None]) – The engine version that all queries running on the workgroup use.

  • execution_role (Optional[str]) – Role used to access user resources in an Athena for Apache Spark session. This property applies only to Spark-enabled workgroups in Athena.

  • managed_query_results_configuration (Union[IResolvable, ManagedQueryResultsConfigurationProperty, Dict[str, Any], None]) – The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.

  • monitoring_configuration (Union[IResolvable, MonitoringConfigurationProperty, Dict[str, Any], None]) – Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

  • publish_cloud_watch_metrics_enabled (Union[bool, IResolvable, None]) – Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

  • requester_pays_enabled (Union[bool, IResolvable, None]) – If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide .

  • result_configuration (Union[IResolvable, ResultConfigurationProperty, Dict[str, Any], None]) –

    Specifies the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. For more information, see Work with query results and recent queries .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_athena import mixins as athena_mixins

work_group_configuration_property = athena_mixins.CfnWorkGroupPropsMixin.WorkGroupConfigurationProperty(
    additional_configuration="additionalConfiguration",
    bytes_scanned_cutoff_per_query=123,
    customer_content_encryption_configuration=athena_mixins.CfnWorkGroupPropsMixin.CustomerContentEncryptionConfigurationProperty(
        kms_key="kmsKey"
    ),
    enforce_work_group_configuration=False,
    engine_configuration=athena_mixins.CfnWorkGroupPropsMixin.EngineConfigurationProperty(
        additional_configs={
            "additional_configs_key": "additionalConfigs"
        },
        classifications=[athena_mixins.CfnWorkGroupPropsMixin.ClassificationProperty(
            name="name",
            properties={
                "properties_key": "properties"
            }
        )],
        coordinator_dpu_size=123,
        default_executor_dpu_size=123,
        max_concurrent_dpus=123,
        spark_properties={
            "spark_properties_key": "sparkProperties"
        }
    ),
    engine_version=athena_mixins.CfnWorkGroupPropsMixin.EngineVersionProperty(
        effective_engine_version="effectiveEngineVersion",
        selected_engine_version="selectedEngineVersion"
    ),
    execution_role="executionRole",
    managed_query_results_configuration=athena_mixins.CfnWorkGroupPropsMixin.ManagedQueryResultsConfigurationProperty(
        enabled=False,
        encryption_configuration=athena_mixins.CfnWorkGroupPropsMixin.ManagedStorageEncryptionConfigurationProperty(
            kms_key="kmsKey"
        )
    ),
    monitoring_configuration=athena_mixins.CfnWorkGroupPropsMixin.MonitoringConfigurationProperty(
        cloud_watch_logging_configuration=athena_mixins.CfnWorkGroupPropsMixin.CloudWatchLoggingConfigurationProperty(
            enabled=False,
            log_group="logGroup",
            log_stream_name_prefix="logStreamNamePrefix",
            log_types={
                "log_types_key": ["logTypes"]
            }
        ),
        managed_logging_configuration=athena_mixins.CfnWorkGroupPropsMixin.ManagedLoggingConfigurationProperty(
            enabled=False,
            kms_key="kmsKey"
        ),
        s3_logging_configuration=athena_mixins.CfnWorkGroupPropsMixin.S3LoggingConfigurationProperty(
            enabled=False,
            kms_key="kmsKey",
            log_location="logLocation"
        )
    ),
    publish_cloud_watch_metrics_enabled=False,
    requester_pays_enabled=False,
    result_configuration=athena_mixins.CfnWorkGroupPropsMixin.ResultConfigurationProperty(
        acl_configuration=athena_mixins.CfnWorkGroupPropsMixin.AclConfigurationProperty(
            s3_acl_option="s3AclOption"
        ),
        encryption_configuration=athena_mixins.CfnWorkGroupPropsMixin.EncryptionConfigurationProperty(
            encryption_option="encryptionOption",
            kms_key="kmsKey"
        ),
        expected_bucket_owner="expectedBucketOwner",
        output_location="outputLocation"
    )
)

Attributes

additional_configuration

Specifies a user defined JSON string that is passed to the session engine.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-additionalconfiguration

bytes_scanned_cutoff_per_query

The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

No default is defined. .. epigraph:

This property currently supports integer types. Support for long values is planned.
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-bytesscannedcutoffperquery

customer_content_encryption_configuration

Specifies the KMS key that is used to encrypt the user’s data stores in Athena.

This setting does not apply to Athena SQL workgroups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-customercontentencryptionconfiguration

enforce_work_group_configuration

If set to “true”, the settings for the workgroup override client-side settings.

If set to “false”, client-side settings are used. For more information, see Override client-side settings .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-enforceworkgroupconfiguration

engine_configuration

The engine configuration for running queries.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-engineconfiguration

engine_version

The engine version that all queries running on the workgroup use.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-engineversion

execution_role

Role used to access user resources in an Athena for Apache Spark session.

This property applies only to Spark-enabled workgroups in Athena.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-executionrole

managed_query_results_configuration

The configuration for storing results in Athena owned storage, which includes whether this feature is enabled;

whether encryption configuration, if any, is used for encrypting query results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-managedqueryresultsconfiguration

monitoring_configuration

Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-monitoringconfiguration

publish_cloud_watch_metrics_enabled

Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-publishcloudwatchmetricsenabled

requester_pays_enabled

If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries.

If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-requesterpaysenabled

result_configuration

Specifies the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results.

For more information, see Work with query results and recent queries .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfiguration.html#cfn-athena-workgroup-workgroupconfiguration-resultconfiguration

WorkGroupConfigurationUpdatesProperty

class CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty(*, additional_configuration=None, bytes_scanned_cutoff_per_query=None, customer_content_encryption_configuration=None, enforce_work_group_configuration=None, engine_configuration=None, engine_version=None, execution_role=None, managed_query_results_configuration=None, monitoring_configuration=None, publish_cloud_watch_metrics_enabled=None, remove_bytes_scanned_cutoff_per_query=None, remove_customer_content_encryption_configuration=None, requester_pays_enabled=None, result_configuration_updates=None)

Bases: object

The 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.

Parameters:

  • additional_configuration (Optional[str]) – Additional Configuration that are passed to Athena Spark Calculations running in this workgroup.

  • bytes_scanned_cutoff_per_query (Union[int, float, None]) – The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

  • customer_content_encryption_configuration (Union[IResolvable, CustomerContentEncryptionConfigurationProperty, Dict[str, Any], None]) – Indicates the KMS key for encrypting notebook content.

  • enforce_work_group_configuration (Union[bool, IResolvable, None]) – If set to “true”, the settings for the workgroup override client-side settings. If set to “false”, client-side settings are used

  • engine_configuration (Union[IResolvable, EngineConfigurationProperty, Dict[str, Any], None]) – The engine configuration for running queries.

  • engine_version (Union[IResolvable, EngineVersionProperty, Dict[str, Any], None]) – The Athena engine version for running queries.

  • execution_role (Optional[str]) – The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.

  • managed_query_results_configuration (Union[IResolvable, ManagedQueryResultsConfigurationProperty, Dict[str, Any], None]) – The configuration for the managed query results and encryption option. ResultConfiguration and ManagedQueryResultsConfiguration cannot be set at the same time

  • monitoring_configuration (Union[IResolvable, MonitoringConfigurationProperty, Dict[str, Any], None]) – Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

  • publish_cloud_watch_metrics_enabled (Union[bool, IResolvable, None]) – Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

  • remove_bytes_scanned_cutoff_per_query (Union[bool, IResolvable, None]) – Indicates that the data usage control limit per query is removed.

  • remove_customer_content_encryption_configuration (Union[bool, IResolvable, None])

  • requester_pays_enabled (Union[bool, IResolvable, None]) – If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error.

  • result_configuration_updates (Union[IResolvable, ResultConfigurationUpdatesProperty, Dict[str, Any], None]) – The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_athena import mixins as athena_mixins

work_group_configuration_updates_property = athena_mixins.CfnWorkGroupPropsMixin.WorkGroupConfigurationUpdatesProperty(
    additional_configuration="additionalConfiguration",
    bytes_scanned_cutoff_per_query=123,
    customer_content_encryption_configuration=athena_mixins.CfnWorkGroupPropsMixin.CustomerContentEncryptionConfigurationProperty(
        kms_key="kmsKey"
    ),
    enforce_work_group_configuration=False,
    engine_configuration=athena_mixins.CfnWorkGroupPropsMixin.EngineConfigurationProperty(
        additional_configs={
            "additional_configs_key": "additionalConfigs"
        },
        classifications=[athena_mixins.CfnWorkGroupPropsMixin.ClassificationProperty(
            name="name",
            properties={
                "properties_key": "properties"
            }
        )],
        coordinator_dpu_size=123,
        default_executor_dpu_size=123,
        max_concurrent_dpus=123,
        spark_properties={
            "spark_properties_key": "sparkProperties"
        }
    ),
    engine_version=athena_mixins.CfnWorkGroupPropsMixin.EngineVersionProperty(
        effective_engine_version="effectiveEngineVersion",
        selected_engine_version="selectedEngineVersion"
    ),
    execution_role="executionRole",
    managed_query_results_configuration=athena_mixins.CfnWorkGroupPropsMixin.ManagedQueryResultsConfigurationProperty(
        enabled=False,
        encryption_configuration=athena_mixins.CfnWorkGroupPropsMixin.ManagedStorageEncryptionConfigurationProperty(
            kms_key="kmsKey"
        )
    ),
    monitoring_configuration=athena_mixins.CfnWorkGroupPropsMixin.MonitoringConfigurationProperty(
        cloud_watch_logging_configuration=athena_mixins.CfnWorkGroupPropsMixin.CloudWatchLoggingConfigurationProperty(
            enabled=False,
            log_group="logGroup",
            log_stream_name_prefix="logStreamNamePrefix",
            log_types={
                "log_types_key": ["logTypes"]
            }
        ),
        managed_logging_configuration=athena_mixins.CfnWorkGroupPropsMixin.ManagedLoggingConfigurationProperty(
            enabled=False,
            kms_key="kmsKey"
        ),
        s3_logging_configuration=athena_mixins.CfnWorkGroupPropsMixin.S3LoggingConfigurationProperty(
            enabled=False,
            kms_key="kmsKey",
            log_location="logLocation"
        )
    ),
    publish_cloud_watch_metrics_enabled=False,
    remove_bytes_scanned_cutoff_per_query=False,
    remove_customer_content_encryption_configuration=False,
    requester_pays_enabled=False,
    result_configuration_updates=athena_mixins.CfnWorkGroupPropsMixin.ResultConfigurationUpdatesProperty(
        acl_configuration=athena_mixins.CfnWorkGroupPropsMixin.AclConfigurationProperty(
            s3_acl_option="s3AclOption"
        ),
        encryption_configuration=athena_mixins.CfnWorkGroupPropsMixin.EncryptionConfigurationProperty(
            encryption_option="encryptionOption",
            kms_key="kmsKey"
        ),
        expected_bucket_owner="expectedBucketOwner",
        output_location="outputLocation",
        remove_acl_configuration=False,
        remove_encryption_configuration=False,
        remove_expected_bucket_owner=False,
        remove_output_location=False
    )
)

Attributes

additional_configuration

Additional Configuration that are passed to Athena Spark Calculations running in this workgroup.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html#cfn-athena-workgroup-workgroupconfigurationupdates-additionalconfiguration

bytes_scanned_cutoff_per_query

The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html#cfn-athena-workgroup-workgroupconfigurationupdates-bytesscannedcutoffperquery

customer_content_encryption_configuration

Indicates the KMS key for encrypting notebook content.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html#cfn-athena-workgroup-workgroupconfigurationupdates-customercontentencryptionconfiguration

enforce_work_group_configuration

If set to “true”, the settings for the workgroup override client-side settings.

If set to “false”, client-side settings are used

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html#cfn-athena-workgroup-workgroupconfigurationupdates-enforceworkgroupconfiguration

engine_configuration

The engine configuration for running queries.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html#cfn-athena-workgroup-workgroupconfigurationupdates-engineconfiguration

engine_version

The Athena engine version for running queries.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html#cfn-athena-workgroup-workgroupconfigurationupdates-engineversion

execution_role

The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups.

This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html#cfn-athena-workgroup-workgroupconfigurationupdates-executionrole

managed_query_results_configuration

The configuration for the managed query results and encryption option.

ResultConfiguration and ManagedQueryResultsConfiguration cannot be set at the same time

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html#cfn-athena-workgroup-workgroupconfigurationupdates-managedqueryresultsconfiguration

monitoring_configuration

Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html#cfn-athena-workgroup-workgroupconfigurationupdates-monitoringconfiguration

publish_cloud_watch_metrics_enabled

Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html#cfn-athena-workgroup-workgroupconfigurationupdates-publishcloudwatchmetricsenabled

remove_bytes_scanned_cutoff_per_query

Indicates that the data usage control limit per query is removed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html#cfn-athena-workgroup-workgroupconfigurationupdates-removebytesscannedcutoffperquery

remove_customer_content_encryption_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html#cfn-athena-workgroup-workgroupconfigurationupdates-removecustomercontentencryptionconfiguration

Type:

see

requester_pays_enabled

If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries.

If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html#cfn-athena-workgroup-workgroupconfigurationupdates-requesterpaysenabled

result_configuration_updates

The result configuration information about the queries in this workgroup that will be updated.

Includes the updated results location and an updated option for encrypting query results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-workgroup-workgroupconfigurationupdates.html#cfn-athena-workgroup-workgroupconfigurationupdates-resultconfigurationupdates