CfnSessionPropsMixin

class aws_cdk.cfn_property_mixins.aws_athena.CfnSessionPropsMixin(props, *, strategy=None)

Bases: Mixin

An Athena session is a Spark-based interactive environment for running calculations within a workgroup.

See:

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

CloudformationResource:

AWS::Athena::Session

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.cfn_property_mixins import aws_athena as athena
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_session_props_mixin = athena.CfnSessionPropsMixin(athena.CfnSessionMixinProps(
    engine_configuration=athena.CfnSessionPropsMixin.EngineConfigurationProperty(
        additional_configs={
            "additional_configs_key": "additionalConfigs"
        },
        coordinator_dpu_size=123,
        default_executor_dpu_size=123,
        max_concurrent_dpus=123,
        spark_properties={
            "spark_properties_key": "sparkProperties"
        }
    ),
    execution_role="executionRole",
    work_group="workGroup"
),
    strategy=merge_strategy
)

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

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

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

None

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['engineConfiguration', 'executionRole', 'workGroup']

Static Methods

classmethod is_mixin(x)

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.

EngineConfigurationProperty

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

Bases: object

Contains engine data processing unit (DPU) configuration settings.

Parameters:
  • additional_configs (Union[IResolvable, Mapping[str, str], None]) – Contains additional notebook engine parameter mappings.

  • coordinator_dpu_size (Union[int, float, None]) – The number of DPUs to use for the coordinator.

  • default_executor_dpu_size (Union[int, float, None]) – The default number of DPUs to use for executors.

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

  • spark_properties (Union[IResolvable, Mapping[str, str], None]) – Specifies custom jar files and Spark properties.

See:

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

engine_configuration_property = athena.CfnSessionPropsMixin.EngineConfigurationProperty(
    additional_configs={
        "additional_configs_key": "additionalConfigs"
    },
    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 parameter mappings.

See:

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

coordinator_dpu_size

The number of DPUs to use for the coordinator.

See:

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

default_executor_dpu_size

The default number of DPUs to use for executors.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-session-engineconfiguration.html#cfn-athena-session-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-session-engineconfiguration.html#cfn-athena-session-engineconfiguration-maxconcurrentdpus

spark_properties

Specifies custom jar files and Spark properties.

See:

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