CfnWorkGroupProps

class aws_cdk.aws_athena.CfnWorkGroupProps(*, name, description=None, recursive_delete_option=None, state=None, tags=None, work_group_configuration=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[CfnTag]]) – The tags (key-value pairs) to associate with this resource.

  • work_group_configuration (Union[IResolvable, WorkGroupConfigurationProperty, 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.

Link

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.
import aws_cdk.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(
        bytes_scanned_cutoff_per_query=123,
        enforce_work_group_configuration=False,
        engine_version=athena.CfnWorkGroup.EngineVersionProperty(
            effective_engine_version="effectiveEngineVersion",
            selected_engine_version="selectedEngineVersion"
        ),
        publish_cloud_watch_metrics_enabled=False,
        requester_pays_enabled=False,
        result_configuration=athena.CfnWorkGroup.ResultConfigurationProperty(
            encryption_configuration=athena.CfnWorkGroup.EncryptionConfigurationProperty(
                encryption_option="encryptionOption",

                # the properties below are optional
                kms_key="kmsKey"
            ),
            output_location="outputLocation"
        )
    )
)

Attributes

description

The workgroup description.

Link

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

Return type

Optional[str]

name

The workgroup name.

Link

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

Return type

str

recursive_delete_option

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

The default is false.

Link

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

Return type

Union[bool, IResolvable, None]

state

ENABLED or DISABLED.

Link

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

Type

The state of the workgroup

Return type

Optional[str]

tags

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

Link

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

Return type

Optional[List[CfnTag]]

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.

Link

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

Return type

Union[IResolvable, WorkGroupConfigurationProperty, None]