CfnWorkGroupProps

class aws_cdk.aws_athena.CfnWorkGroupProps(*, name, description=None, recursive_delete_option=None, state=None, tags=None, work_group_configuration=None, work_group_configuration_updates=None)

Bases: object

Properties for defining a CfnWorkGroup.

Parameters:

name (str) – The workgroup name.
description (Optional[str]) – The workgroup description.
recursive_delete_option (Union[bool, IResolvable, None]) – The option to delete a workgroup and its contents even if the workgroup contains any named queries. The default is false.
state (Optional[str]) – The state of the workgroup: ENABLED or DISABLED.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags (key-value pairs) to associate with this resource.
work_group_configuration (Union[IResolvable, WorkGroupConfigurationProperty, Dict[str, Any], None]) – 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.
work_group_configuration_updates (Union[IResolvable, WorkGroupConfigurationUpdatesProperty, Dict[str, Any], None]) – (deprecated) 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.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 import aws_athena as athena

cfn_work_group_props = athena.CfnWorkGroupProps(
    name="name",

    # the properties below are optional
    description="description",
    recursive_delete_option=False,
    state="state",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    work_group_configuration=athena.CfnWorkGroup.WorkGroupConfigurationProperty(
        additional_configuration="additionalConfiguration",
        bytes_scanned_cutoff_per_query=123,
        customer_content_encryption_configuration=athena.CfnWorkGroup.CustomerContentEncryptionConfigurationProperty(
            kms_key="kmsKey"
        ),
        enforce_work_group_configuration=False,
        engine_version=athena.CfnWorkGroup.EngineVersionProperty(
            effective_engine_version="effectiveEngineVersion",
            selected_engine_version="selectedEngineVersion"
        ),
        execution_role="executionRole",
        publish_cloud_watch_metrics_enabled=False,
        requester_pays_enabled=False,
        result_configuration=athena.CfnWorkGroup.ResultConfigurationProperty(
            acl_configuration=athena.CfnWorkGroup.AclConfigurationProperty(
                s3_acl_option="s3AclOption"
            ),
            encryption_configuration=athena.CfnWorkGroup.EncryptionConfigurationProperty(
                encryption_option="encryptionOption",

                # the properties below are optional
                kms_key="kmsKey"
            ),
            expected_bucket_owner="expectedBucketOwner",
            output_location="outputLocation"
        )
    ),
    work_group_configuration_updates=athena.CfnWorkGroup.WorkGroupConfigurationUpdatesProperty(
        additional_configuration="additionalConfiguration",
        bytes_scanned_cutoff_per_query=123,
        customer_content_encryption_configuration=athena.CfnWorkGroup.CustomerContentEncryptionConfigurationProperty(
            kms_key="kmsKey"
        ),
        enforce_work_group_configuration=False,
        engine_version=athena.CfnWorkGroup.EngineVersionProperty(
            effective_engine_version="effectiveEngineVersion",
            selected_engine_version="selectedEngineVersion"
        ),
        execution_role="executionRole",
        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.CfnWorkGroup.ResultConfigurationUpdatesProperty(
            acl_configuration=athena.CfnWorkGroup.AclConfigurationProperty(
                s3_acl_option="s3AclOption"
            ),
            encryption_configuration=athena.CfnWorkGroup.EncryptionConfigurationProperty(
                encryption_option="encryptionOption",

                # the properties below are optional
                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

description

The workgroup description.

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

name

The workgroup name.

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

recursive_delete_option

The option to delete a workgroup and its contents even if the workgroup contains any named queries.

The default is false.

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

state

ENABLED or DISABLED.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-state
Type:: The state of the workgroup

tags

The tags (key-value pairs) to associate with this resource.

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

work_group_configuration

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.

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

work_group_configuration_updates

(deprecated) 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.

Deprecated:: this property has been deprecated
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-workgroup.html#cfn-athena-workgroup-workgroupconfigurationupdates
Stability:: deprecated