Show / Hide Table of Contents

Class CfnSession

Resource Type definition for AWS::Glue::Session.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnSession
Implements
IInspectable
ISessionRef
IConstruct
IDependable
IEnvironmentAware
ITaggableV2
Inherited Members
CfnResource.IsCfnResource(object)
CfnResource.AddDeletionOverride(string)
CfnResource.AddDependency(CfnResource)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(string, object)
CfnResource.AddOverride(string, object)
CfnResource.AddPropertyDeletionOverride(string)
CfnResource.AddPropertyOverride(string, object)
CfnResource.AddResourceDependency(CfnResource, string)
CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)
CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)
CfnResource.CfnPropertyName(string)
CfnResource.GetAtt(string, ResolutionTypeHint?)
CfnResource.GetMetadata(string)
CfnResource.ObtainDependencies()
CfnResource.RemoveDependency(CfnResource)
CfnResource.RemoveResourceDependency(CfnResource)
CfnResource.ReplaceDependency(CfnResource, CfnResource)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.Env
CfnResource.UpdatedProperites
CfnResource.UpdatedProperties
CfnRefElement.Ref
CfnElement.IsCfnElement(object)
CfnElement.OverrideLogicalId(string)
CfnElement.With(params IMixin[])
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Namespace: Amazon.CDK.AWS.Glue
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnSession : CfnResource, IInspectable, ISessionRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Syntax (vb)
Public Class CfnSession Inherits CfnResource Implements IInspectable, ISessionRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

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 cfnSession = new CfnSession(this, "MyCfnSession", 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

Constructors

CfnSession(Construct, string, ICfnSessionProps)

Create a new AWS::Glue::Session.

Properties

AttrArn

The Amazon Resource Name (ARN) of the session.

AttrCreatedOn

The time and date when the session was created.

AttrProgress

The code execution progress of the session.

AttrStatus

The session status.

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CdkTagManager

Tag Manager which manages the tags for this resource.

CfnProperties

Resource Type definition for AWS::Glue::Session.

CfnPropertyNames

Resource Type definition for AWS::Glue::Session.

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.

SessionRef

A reference to a Session resource.

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.

Methods

ArnForSession(ISessionRef)

Resource Type definition for AWS::Glue::Session.

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

IsCfnSession(object)

Checks whether the given object is a CfnSession.

RenderProperties(IDictionary<string, object>)

Resource Type definition for AWS::Glue::Session.

Constructors

CfnSession(Construct, string, ICfnSessionProps)

Create a new AWS::Glue::Session.

public CfnSession(Construct scope, string id, ICfnSessionProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnSessionProps

Resource properties.

Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name (ARN) of the session.

public virtual string AttrArn { get; }
Property Value

string

Remarks

CloudformationAttribute: Arn

AttrCreatedOn

The time and date when the session was created.

public virtual string AttrCreatedOn { get; }
Property Value

string

Remarks

CloudformationAttribute: CreatedOn

AttrProgress

The code execution progress of the session.

public virtual IResolvable AttrProgress { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: Progress

AttrStatus

The session status.

public virtual string AttrStatus { get; }
Property Value

string

Remarks

CloudformationAttribute: Status

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

ExampleMetadata: fixture=_generated

CfnProperties

Resource Type definition for AWS::Glue::Session.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
CfnResource.CfnProperties
Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

ExampleMetadata: fixture=_generated

CfnPropertyNames

Resource Type definition for AWS::Glue::Session.

protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value

IDictionary<string, string>

Overrides
CfnResource.CfnPropertyNames
Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

ExampleMetadata: fixture=_generated

Command

The SessionCommand that runs the job.

public virtual object Command { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnSession.ISessionCommandProperty

Connections

Specifies the connections used by the session.

public virtual object? Connections { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnSession.IConnectionsListProperty

DefaultArguments

A map array of key-value pairs.

public virtual object? DefaultArguments { get; set; }
Property Value

object

Remarks

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

Description

The description of the session.

public virtual string? Description { get; set; }
Property Value

string

Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

ExampleMetadata: fixture=_generated

GlueVersion

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

public virtual string? GlueVersion { get; set; }
Property Value

string

Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

ExampleMetadata: fixture=_generated

Id

The ID of the session.

public virtual string Id { get; set; }
Property Value

string

Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

ExampleMetadata: fixture=_generated

IdleTimeout

The number of minutes when idle before session times out.

public virtual double? IdleTimeout { get; set; }
Property Value

double?

Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

ExampleMetadata: fixture=_generated

MaxCapacity

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

public virtual double? MaxCapacity { get; set; }
Property Value

double?

Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

ExampleMetadata: fixture=_generated

NumberOfWorkers

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

public virtual double? NumberOfWorkers { get; set; }
Property Value

double?

Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

ExampleMetadata: fixture=_generated

RequestOrigin

The origin of the request.

public virtual string? RequestOrigin { get; set; }
Property Value

string

Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

ExampleMetadata: fixture=_generated

Role

The IAM Role ARN.

public virtual string Role { get; set; }
Property Value

string

Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

ExampleMetadata: fixture=_generated

SecurityConfiguration

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

public virtual string? SecurityConfiguration { get; set; }
Property Value

string

Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

ExampleMetadata: fixture=_generated

SessionRef

A reference to a Session resource.

public virtual ISessionReference SessionRef { get; }
Property Value

ISessionReference

Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

ExampleMetadata: fixture=_generated

Tags

The tags belonging to the session.

public virtual ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

ExampleMetadata: fixture=_generated

Timeout

The number of minutes before session times out.

public virtual double? Timeout { get; set; }
Property Value

double?

Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

ExampleMetadata: fixture=_generated

WorkerType

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

public virtual string? WorkerType { get; set; }
Property Value

string

Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

ExampleMetadata: fixture=_generated

Methods

ArnForSession(ISessionRef)

Resource Type definition for AWS::Glue::Session.

public static string ArnForSession(ISessionRef resource)
Parameters
resource ISessionRef
Returns

string

Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

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 cfnSession = new CfnSession(this, "MyCfnSession", 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"
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

ExampleMetadata: fixture=_generated

IsCfnSession(object)

Checks whether the given object is a CfnSession.

public static bool IsCfnSession(object x)
Parameters
x object
Returns

bool

Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Resource Type definition for AWS::Glue::Session.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
CfnResource.RenderProperties(IDictionary<string, object>)
Remarks

Sessions provide an on-demand, serverless Apache Spark runtime environment for building, testing, and running data preparation and analytics applications.

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

CloudformationResource: AWS::Glue::Session

ExampleMetadata: fixture=_generated

Implements

IInspectable
ISessionRef
Constructs.IConstruct
Constructs.IDependable
IEnvironmentAware
ITaggableV2
Back to top Generated by DocFX