1.204.0

class CfnJob (construct)

LanguageType name
.NETAmazon.CDK.AWS.Glue.CfnJob
Javasoftware.amazon.awscdk.services.glue.CfnJob
Pythonaws_cdk.aws_glue.CfnJob
TypeScript @aws-cdk/aws-glue » CfnJob

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::Glue::Job.

The AWS::Glue::Job resource specifies an AWS Glue job in the data catalog. For more information, see Adding Jobs in AWS Glue and Job Structure in the AWS Glue Developer Guide.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as glue from '@aws-cdk/aws-glue';

declare const defaultArguments: any;
declare const nonOverridableArguments: any;
declare const tags: any;
const cfnJob = new glue.CfnJob(this, 'MyCfnJob', {
  command: {
    name: 'name',
    pythonVersion: 'pythonVersion',
    runtime: 'runtime',
    scriptLocation: 'scriptLocation',
  },
  role: 'role',

  // the properties below are optional
  allocatedCapacity: 123,
  connections: {
    connections: ['connections'],
  },
  defaultArguments: defaultArguments,
  description: 'description',
  executionClass: 'executionClass',
  executionProperty: {
    maxConcurrentRuns: 123,
  },
  glueVersion: 'glueVersion',
  logUri: 'logUri',
  maxCapacity: 123,
  maxRetries: 123,
  name: 'name',
  nonOverridableArguments: nonOverridableArguments,
  notificationProperty: {
    notifyDelayAfter: 123,
  },
  numberOfWorkers: 123,
  securityConfiguration: 'securityConfiguration',
  tags: tags,
  timeout: 123,
  workerType: 'workerType',
});

Initializer

new CfnJob(scope: Construct, id: string, props: CfnJobProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnJobProps — - resource properties.

Create a new AWS::Glue::Job.

Construct Props

NameTypeDescription
commandIResolvable | JobCommandPropertyThe code that executes a job.
rolestringThe name or Amazon Resource Name (ARN) of the IAM role associated with this job.
allocatedCapacity?numberThis parameter is no longer supported. Use MaxCapacity instead.
connections?IResolvable | ConnectionsListPropertyThe connections used for this job.
defaultArguments?anyThe default arguments for this job, specified as name-value pairs.
description?stringA description of the job.
executionClass?stringIndicates whether the job is run with a standard or flexible execution class.
executionProperty?IResolvable | ExecutionPropertyPropertyThe maximum number of concurrent runs that are allowed for this job.
glueVersion?stringGlue version determines the versions of Apache Spark and Python that AWS Glue supports.
logUri?stringThis field is reserved for future use.
maxCapacity?numberThe number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.
maxRetries?numberThe maximum number of times to retry this job after a JobRun fails.
name?stringThe name you assign to this job definition.
nonOverridableArguments?anyNon-overridable arguments for this job, specified as name-value pairs.
notificationProperty?IResolvable | NotificationPropertyPropertySpecifies configuration properties of a notification.
numberOfWorkers?numberThe number of workers of a defined workerType that are allocated when a job runs.
securityConfiguration?stringThe name of the SecurityConfiguration structure to be used with this job.
tags?anyThe tags to use with this job.
timeout?numberThe job timeout in minutes.
workerType?stringThe type of predefined worker that is allocated when a job runs.

command

Type: IResolvable | JobCommandProperty

The code that executes a job.

role

Type: string

The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

allocatedCapacity?

Type: number (optional)

This parameter is no longer supported. Use MaxCapacity instead.

The number of capacity units that are allocated to this job.

connections?

Type: IResolvable | ConnectionsListProperty (optional)

The connections used for this job.

defaultArguments?

Type: any (optional)

The default arguments for this job, specified as name-value pairs.

You can specify arguments here that your own job-execution script consumes, in addition to arguments that AWS Glue itself consumes.

For information about how to specify and consume your own job arguments, see Calling AWS Glue APIs in Python in the AWS Glue Developer Guide .

For information about the key-value pairs that AWS Glue consumes to set up your job, see Special Parameters Used by AWS Glue in the AWS Glue Developer Guide .

description?

Type: string (optional)

A description of the job.

executionClass?

Type: string (optional)

Indicates whether the job is run with a standard or flexible execution class.

The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

Only jobs with AWS Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX . The flexible execution class is available for Spark jobs.

executionProperty?

Type: IResolvable | ExecutionPropertyProperty (optional)

The maximum number of concurrent runs that are allowed for this job.

glueVersion?

Type: string (optional)

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

The Python version indicates the version supported for jobs of type Spark.

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Jobs that are created without specifying a Glue version default to Glue 0.9.

logUri?

Type: string (optional)

This field is reserved for future use.

maxCapacity?

Type: number (optional)

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

A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.

Do not set Max Capacity if using WorkerType and NumberOfWorkers .

The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

  • When you specify a Python shell job ( JobCommand.Name ="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
  • When you specify an Apache Spark ETL job ( JobCommand.Name ="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

maxRetries?

Type: number (optional)

The maximum number of times to retry this job after a JobRun fails.

name?

Type: string (optional)

The name you assign to this job definition.

nonOverridableArguments?

Type: any (optional)

Non-overridable arguments for this job, specified as name-value pairs.

notificationProperty?

Type: IResolvable | NotificationPropertyProperty (optional)

Specifies configuration properties of a notification.

numberOfWorkers?

Type: number (optional)

The number of workers of a defined workerType that are allocated when a job runs.

The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .

securityConfiguration?

Type: string (optional)

The name of the SecurityConfiguration structure to be used with this job.

tags?

Type: any (optional)

The tags to use with this job.

timeout?

Type: number (optional)

The job timeout in minutes.

This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

workerType?

Type: string (optional)

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

Accepts a value of Standard, G.1X, or G.2X.

  • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
  • For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
  • For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

Properties

NameTypeDescription
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
commandIResolvable | JobCommandPropertyThe code that executes a job.
creationStackstring[]
defaultArgumentsanyThe default arguments for this job, specified as name-value pairs.
logicalIdstringThe logical ID for this CloudFormation stack element.
nodeConstructNodeThe construct tree node associated with this construct.
nonOverridableArgumentsanyNon-overridable arguments for this job, specified as name-value pairs.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
rolestringThe name or Amazon Resource Name (ARN) of the IAM role associated with this job.
stackStackThe stack in which this element is defined.
tagsTagManagerThe tags to use with this job.
allocatedCapacity?numberThis parameter is no longer supported. Use MaxCapacity instead.
connections?IResolvable | ConnectionsListPropertyThe connections used for this job.
description?stringA description of the job.
executionClass?stringIndicates whether the job is run with a standard or flexible execution class.
executionProperty?IResolvable | ExecutionPropertyPropertyThe maximum number of concurrent runs that are allowed for this job.
glueVersion?stringGlue version determines the versions of Apache Spark and Python that AWS Glue supports.
logUri?stringThis field is reserved for future use.
maxCapacity?numberThe number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.
maxRetries?numberThe maximum number of times to retry this job after a JobRun fails.
name?stringThe name you assign to this job definition.
notificationProperty?IResolvable | NotificationPropertyPropertySpecifies configuration properties of a notification.
numberOfWorkers?numberThe number of workers of a defined workerType that are allocated when a job runs.
securityConfiguration?stringThe name of the SecurityConfiguration structure to be used with this job.
timeout?numberThe job timeout in minutes.
workerType?stringThe type of predefined worker that is allocated when a job runs.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

command

Type: IResolvable | JobCommandProperty

The code that executes a job.

creationStack

Type: string[]

defaultArguments

Type: any

The default arguments for this job, specified as name-value pairs.

You can specify arguments here that your own job-execution script consumes, in addition to arguments that AWS Glue itself consumes.

For information about how to specify and consume your own job arguments, see Calling AWS Glue APIs in Python in the AWS Glue Developer Guide .

For information about the key-value pairs that AWS Glue consumes to set up your job, see Special Parameters Used by AWS Glue in the AWS Glue Developer Guide .

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: ConstructNode

The construct tree node associated with this construct.

nonOverridableArguments

Type: any

Non-overridable arguments for this job, specified as name-value pairs.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

role

Type: string

The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Type: TagManager

The tags to use with this job.

allocatedCapacity?

Type: number (optional)

This parameter is no longer supported. Use MaxCapacity instead.

The number of capacity units that are allocated to this job.

connections?

Type: IResolvable | ConnectionsListProperty (optional)

The connections used for this job.

description?

Type: string (optional)

A description of the job.

executionClass?

Type: string (optional)

Indicates whether the job is run with a standard or flexible execution class.

The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

Only jobs with AWS Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX . The flexible execution class is available for Spark jobs.

executionProperty?

Type: IResolvable | ExecutionPropertyProperty (optional)

The maximum number of concurrent runs that are allowed for this job.

glueVersion?

Type: string (optional)

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

The Python version indicates the version supported for jobs of type Spark.

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Jobs that are created without specifying a Glue version default to Glue 0.9.

logUri?

Type: string (optional)

This field is reserved for future use.

maxCapacity?

Type: number (optional)

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

A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.

Do not set Max Capacity if using WorkerType and NumberOfWorkers .

The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

  • When you specify a Python shell job ( JobCommand.Name ="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
  • When you specify an Apache Spark ETL job ( JobCommand.Name ="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

maxRetries?

Type: number (optional)

The maximum number of times to retry this job after a JobRun fails.

name?

Type: string (optional)

The name you assign to this job definition.

notificationProperty?

Type: IResolvable | NotificationPropertyProperty (optional)

Specifies configuration properties of a notification.

numberOfWorkers?

Type: number (optional)

The number of workers of a defined workerType that are allocated when a job runs.

The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .

securityConfiguration?

Type: string (optional)

The name of the SecurityConfiguration structure to be used with this job.

timeout?

Type: number (optional)

The job timeout in minutes.

This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

workerType?

Type: string (optional)

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

Accepts a value of Standard, G.1X, or G.2X.

  • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
  • For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
  • For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependsOn(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

  • attributeName string — The name of the attribute.

Returns

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }
← PreviousNext →