CfnSessionProps

class aws_cdk.aws_athena.CfnSessionProps(*, engine_configuration, work_group, execution_role=None)

Bases: object

Properties for defining a CfnSession.

Parameters:

  • engine_configuration (Union[IResolvable, EngineConfigurationProperty, Dict[str, Any]]) – Contains engine data processing unit (DPU) configuration settings.

  • work_group (str) – The workgroup to which the session belongs.

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-session.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_session_props = athena.CfnSessionProps(
    engine_configuration=athena.CfnSession.EngineConfigurationProperty(
        max_concurrent_dpus=123,

        # the properties below are optional
        additional_configs={
            "additional_configs_key": "additionalConfigs"
        },
        coordinator_dpu_size=123,
        default_executor_dpu_size=123,
        spark_properties={
            "spark_properties_key": "sparkProperties"
        }
    ),
    work_group="workGroup",

    # the properties below are optional
    execution_role="executionRole"
)

Attributes

engine_configuration

Contains engine data processing unit (DPU) configuration settings.

See:

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

execution_role

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

See:

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

work_group

The workgroup to which the session belongs.

See:

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