CfnSessionProps

class aws_cdk.aws_glue.CfnSessionProps(*, command, id, role, connections=None, default_arguments=None, description=None, glue_version=None, idle_timeout=None, max_capacity=None, number_of_workers=None, request_origin=None, security_configuration=None, tags=None, timeout=None, worker_type=None)

Bases: object

Properties for defining a CfnSession.

Parameters:
  • command (Union[IResolvable, SessionCommandProperty, Dict[str, Any]]) – The SessionCommand that runs the job.

  • id (str) – The ID of the session.

  • role (str) – The IAM Role ARN.

  • connections (Union[IResolvable, ConnectionsListProperty, Dict[str, Any], None]) – Specifies the connections used by the session.

  • default_arguments (Union[IResolvable, Mapping[str, str], None]) – A map array of key-value pairs. Max is 75 pairs.

  • description (Optional[str]) – The description of the session.

  • glue_version (Optional[str]) – The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.

  • idle_timeout (Union[int, float, None]) – The number of minutes when idle before session times out. Default is the value of Timeout.

  • max_capacity (Union[int, float, None]) – The number of Glue data processing units (DPUs) that can be allocated when the job runs.

  • number_of_workers (Union[int, float, None]) – The number of workers of a defined WorkerType to use for the session.

  • request_origin (Optional[str]) – The origin of the request.

  • security_configuration (Optional[str]) – The name of the SecurityConfiguration structure to be used with the session.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags belonging to the session.

  • timeout (Union[int, float, None]) – The number of minutes before session times out.

  • worker_type (Optional[str]) – The type of predefined worker that is allocated when a session runs.

See:

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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_glue as glue

cfn_session_props = glue.CfnSessionProps(
    command=glue.CfnSession.SessionCommandProperty(
        name="name",
        python_version="pythonVersion"
    ),
    id="id",
    role="role",

    # the properties below are optional
    connections=glue.CfnSession.ConnectionsListProperty(
        connections=["connections"]
    ),
    default_arguments={
        "default_arguments_key": "defaultArguments"
    },
    description="description",
    glue_version="glueVersion",
    idle_timeout=123,
    max_capacity=123,
    number_of_workers=123,
    request_origin="requestOrigin",
    security_configuration="securityConfiguration",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    timeout=123,
    worker_type="workerType"
)

Attributes

command

The SessionCommand that runs the job.

See:

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

connections

Specifies the connections used by the session.

See:

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

default_arguments

A map array of key-value pairs.

Max is 75 pairs.

See:

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

description

The description of the session.

See:

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

glue_version

The Glue version determines the versions of Apache Spark and Python that Glue supports.

The GlueVersion must be greater than 2.0.

See:

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

id

The ID of the session.

See:

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

idle_timeout

The number of minutes when idle before session times out.

Default is the value of Timeout.

See:

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

max_capacity

The number of Glue data processing units (DPUs) that can be allocated when the job runs.

See:

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

number_of_workers

The number of workers of a defined WorkerType to use for the session.

See:

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

request_origin

The origin of the request.

See:

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

role

The IAM Role ARN.

See:

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

security_configuration

The name of the SecurityConfiguration structure to be used with the session.

See:

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

tags

The tags belonging to the session.

See:

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

timeout

The number of minutes before session times out.

See:

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

worker_type

The type of predefined worker that is allocated when a session runs.

See:

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