Skip to content
v2.275.0

CfnSessionProps Struct ​

Properties for defining a CfnSession.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_glue as glue } from 'aws-cdk-lib';
const cfnSessionProps: glue.CfnSessionProps = {
  command: {
    name: 'name',
    pythonVersion: 'pythonVersion',
  },
  id: 'id',
  role: 'role',

  // the properties below are optional
  connections: {
    connections: ['connections'],
  },
  defaultArguments: {
    defaultArgumentsKey: 'defaultArguments',
  },
  description: 'description',
  glueVersion: 'glueVersion',
  idleTimeout: 123,
  maxCapacity: 123,
  numberOfWorkers: 123,
  requestOrigin: 'requestOrigin',
  securityConfiguration: 'securityConfiguration',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  timeout: 123,
  workerType: 'workerType',
};

Properties ​

commandIResolvable | CfnSession.SessionCommandPropertycommandtyping.Union[IResolvable, SessionCommandProperty]commandIResolvableCommandIResolvableCommandinterface{}required#
The SessionCommand that runs the job.
connectionsoptionalIResolvable | CfnSession.ConnectionsListPropertyconnectionsoptionaltyping.Union[IResolvable, ConnectionsListProperty]connectionsoptionalIResolvableConnectionsoptionalIResolvableConnectionsoptionalinterface{}#
Specifies the connections used by the session.
defaultArgumentsoptionalIResolvable | { [key: string]: string }default_argumentsoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]defaultArgumentsoptionalIResolvableDefaultArgumentsoptionalIResolvableDefaultArgumentsoptionalinterface{}#
A map array of key-value pairs.

Max is 75 pairs.

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the session.
glueVersionoptionalstringglue_versionoptionalstrglueVersionoptionalStringGlueVersionoptionalstringGlueVersionoptional*string#
The Glue version determines the versions of Apache Spark and Python that Glue supports.

The GlueVersion must be greater than 2.0.

idstringidstridStringIdstringId*stringrequired#
The ID of the session.
idleTimeoutoptionalnumberidle_timeoutoptionalint | floatidleTimeoutoptionalNumberIdleTimeoutoptionaldoubleIdleTimeoutoptional*float64#
The number of minutes when idle before session times out.

Default is the value of Timeout.

maxCapacityoptionalnumbermax_capacityoptionalint | floatmaxCapacityoptionalNumberMaxCapacityoptionaldoubleMaxCapacityoptional*float64#
The number of Glue data processing units (DPUs) that can be allocated when the job runs.
numberOfWorkersoptionalnumbernumber_of_workersoptionalint | floatnumberOfWorkersoptionalNumberNumberOfWorkersoptionaldoubleNumberOfWorkersoptional*float64#
The number of workers of a defined WorkerType to use for the session.
requestOriginoptionalstringrequest_originoptionalstrrequestOriginoptionalStringRequestOriginoptionalstringRequestOriginoptional*string#
The origin of the request.
rolestringrolestrroleStringRolestringRole*stringrequired#
The IAM Role ARN.
securityConfigurationoptionalstringsecurity_configurationoptionalstrsecurityConfigurationoptionalStringSecurityConfigurationoptionalstringSecurityConfigurationoptional*string#
The name of the SecurityConfiguration structure to be used with the session.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags belonging to the session.
timeoutoptionalnumbertimeoutoptionalint | floattimeoutoptionalNumberTimeoutoptionaldoubleTimeoutoptional*float64#
The number of minutes before session times out.
workerTypeoptionalstringworker_typeoptionalstrworkerTypeoptionalStringWorkerTypeoptionalstringWorkerTypeoptional*string#
The type of predefined worker that is allocated when a session runs.