Show / Hide Table of Contents

Interface ICfnSessionProps

Properties for defining a CfnSession.

Namespace: Amazon.CDK.AWS.Glue
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnSessionProps
Syntax (vb)
Public Interface ICfnSessionProps
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Glue;

             var cfnSessionProps = new CfnSessionProps {
                 Command = new SessionCommandProperty {
                     Name = "name",
                     PythonVersion = "pythonVersion"
                 },
                 Id = "id",
                 Role = "role",

                 // the properties below are optional
                 Connections = new ConnectionsListProperty {
                     Connections = new [] { "connections" }
                 },
                 DefaultArguments = new Dictionary<string, string> {
                     { "defaultArgumentsKey", "defaultArguments" }
                 },
                 Description = "description",
                 GlueVersion = "glueVersion",
                 IdleTimeout = 123,
                 MaxCapacity = 123,
                 NumberOfWorkers = 123,
                 RequestOrigin = "requestOrigin",
                 SecurityConfiguration = "securityConfiguration",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Timeout = 123,
                 WorkerType = "workerType"
             };

Synopsis

Properties

Command

The SessionCommand that runs the job.

Connections

Specifies the connections used by the session.

DefaultArguments

A map array of key-value pairs.

Description

The description of the session.

GlueVersion

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

Id

The ID of the session.

IdleTimeout

The number of minutes when idle before session times out.

MaxCapacity

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

NumberOfWorkers

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

RequestOrigin

The origin of the request.

Role

The IAM Role ARN.

SecurityConfiguration

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

Tags

The tags belonging to the session.

Timeout

The number of minutes before session times out.

WorkerType

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

Properties

Command

The SessionCommand that runs the job.

object Command { get; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnSession.ISessionCommandProperty

Connections

Specifies the connections used by the session.

object? Connections { get; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnSession.IConnectionsListProperty

DefaultArguments

A map array of key-value pairs.

object? DefaultArguments { get; }
Property Value

object

Remarks

Max is 75 pairs.

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

Type union: either IResolvable or Dictionary<string, string>

Description

The description of the session.

string? Description { get; }
Property Value

string

Remarks

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

GlueVersion

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

string? GlueVersion { get; }
Property Value

string

Remarks

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.

string Id { get; }
Property Value

string

Remarks

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

IdleTimeout

The number of minutes when idle before session times out.

double? IdleTimeout { get; }
Property Value

double?

Remarks

Default is the value of Timeout.

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

MaxCapacity

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

double? MaxCapacity { get; }
Property Value

double?

Remarks

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

NumberOfWorkers

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

double? NumberOfWorkers { get; }
Property Value

double?

Remarks

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

RequestOrigin

The origin of the request.

string? RequestOrigin { get; }
Property Value

string

Remarks

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

Role

The IAM Role ARN.

string Role { get; }
Property Value

string

Remarks

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

SecurityConfiguration

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

string? SecurityConfiguration { get; }
Property Value

string

Remarks

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.

ICfnTag[]? Tags { get; }
Property Value

ICfnTag[]

Remarks

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.

double? Timeout { get; }
Property Value

double?

Remarks

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

WorkerType

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

string? WorkerType { get; }
Property Value

string

Remarks

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

Back to top Generated by DocFX