CfnJob

class aws_cdk.aws_glue.CfnJob(scope, id, *, command, role, allocated_capacity=None, connections=None, default_arguments=None, description=None, execution_property=None, glue_version=None, log_uri=None, max_capacity=None, max_retries=None, name=None, notification_property=None, number_of_workers=None, security_configuration=None, tags=None, timeout=None, worker_type=None)

Bases: aws_cdk.core.CfnResource

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.

CloudformationResource

AWS::Glue::Job

Link

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

ExampleMetadata

fixture=_generated

Example:

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

# default_arguments: Any
# tags: Any

cfn_job = glue.CfnJob(self, "MyCfnJob",
    command=glue.CfnJob.JobCommandProperty(
        name="name",
        python_version="pythonVersion",
        script_location="scriptLocation"
    ),
    role="role",

    # the properties below are optional
    allocated_capacity=123,
    connections=glue.CfnJob.ConnectionsListProperty(
        connections=["connections"]
    ),
    default_arguments=default_arguments,
    description="description",
    execution_property=glue.CfnJob.ExecutionPropertyProperty(
        max_concurrent_runs=123
    ),
    glue_version="glueVersion",
    log_uri="logUri",
    max_capacity=123,
    max_retries=123,
    name="name",
    notification_property=glue.CfnJob.NotificationPropertyProperty(
        notify_delay_after=123
    ),
    number_of_workers=123,
    security_configuration="securityConfiguration",
    tags=tags,
    timeout=123,
    worker_type="workerType"
)

Create a new AWS::Glue::Job.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • command (Union[IResolvable, JobCommandProperty, Dict[str, Any]]) – The code that executes a job.

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

  • allocated_capacity (Union[int, float, None]) – The number of capacity units that are allocated to this job.

  • connections (Union[IResolvable, ConnectionsListProperty, Dict[str, Any], None]) – The connections used for this job.

  • default_arguments (Optional[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 .

  • description (Optional[str]) – A description of the job.

  • execution_property (Union[IResolvable, ExecutionPropertyProperty, Dict[str, Any], None]) – The maximum number of concurrent runs that are allowed for this job.

  • glue_version (Optional[str]) – 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.

  • log_uri (Optional[str]) – This field is reserved for future use.

  • max_capacity (Union[int, float, None]) – 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.

  • max_retries (Union[int, float, None]) – The maximum number of times to retry this job after a JobRun fails.

  • name (Optional[str]) – The name you assign to this job definition.

  • notification_property (Union[IResolvable, NotificationPropertyProperty, Dict[str, Any], None]) – Specifies configuration properties of a notification.

  • number_of_workers (Union[int, float, None]) – 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 .

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

  • tags (Optional[Any]) – The tags to use with this job.

  • timeout (Union[int, float, None]) – 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).

  • worker_type (Optional[str]) – 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

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.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

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.

Return type

None

add_override(path, 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:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"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.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

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

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

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

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

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).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

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.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

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.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

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

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Glue::Job'
allocated_capacity

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

Link

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

Return type

Union[int, float, None]

cfn_options

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

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

command

The code that executes a job.

Link

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

Return type

Union[IResolvable, JobCommandProperty]

connections

The connections used for this job.

Link

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

Return type

Union[IResolvable, ConnectionsListProperty, None]

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

default_arguments

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 .

Link

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

Return type

Any

description

A description of the job.

Link

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

Return type

Optional[str]

execution_property

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

Link

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

Return type

Union[IResolvable, ExecutionPropertyProperty, None]

glue_version

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.

Link

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

Return type

Optional[str]

log_uri

This field is reserved for future use.

Link

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

Return type

Optional[str]

logical_id

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).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

max_capacity

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.

Link

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

Return type

Union[int, float, None]

max_retries

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

Link

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

Return type

Union[int, float, None]

name

The name you assign to this job definition.

Link

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

Return type

Optional[str]

node

The construct tree node associated with this construct.

Return type

ConstructNode

notification_property

Specifies configuration properties of a notification.

Link

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

Return type

Union[IResolvable, NotificationPropertyProperty, None]

number_of_workers

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 .

Link

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

Return type

Union[int, float, None]

ref

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 }).

Return type

str

role

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

Link

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

Return type

str

security_configuration

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

Link

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

Return type

Optional[str]

stack

The stack in which this element is defined.

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

Return type

Stack

tags

The tags to use with this job.

Link

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

Return type

TagManager

timeout

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).

Link

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

Return type

Union[int, float, None]

worker_type

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.

Link

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

Return type

Optional[str]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

ConnectionsListProperty

class CfnJob.ConnectionsListProperty(*, connections=None)

Bases: object

Specifies the connections used by a job.

Parameters

connections (Optional[Sequence[str]]) – A list of connections used by the job.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-connectionslist.html

ExampleMetadata

fixture=_generated

Example:

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

connections_list_property = glue.CfnJob.ConnectionsListProperty(
    connections=["connections"]
)

Attributes

connections

A list of connections used by the job.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-connectionslist.html#cfn-glue-job-connectionslist-connections

Return type

Optional[List[str]]

ExecutionPropertyProperty

class CfnJob.ExecutionPropertyProperty(*, max_concurrent_runs=None)

Bases: object

An execution property of a job.

Parameters

max_concurrent_runs (Union[int, float, None]) – The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-executionproperty.html

ExampleMetadata

fixture=_generated

Example:

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

execution_property_property = glue.CfnJob.ExecutionPropertyProperty(
    max_concurrent_runs=123
)

Attributes

max_concurrent_runs

The maximum number of concurrent runs allowed for the job.

The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-executionproperty.html#cfn-glue-job-executionproperty-maxconcurrentruns

Return type

Union[int, float, None]

JobCommandProperty

class CfnJob.JobCommandProperty(*, name=None, python_version=None, script_location=None)

Bases: object

Specifies code executed when a job is run.

Parameters
  • name (Optional[str]) – The name of the job command. For an Apache Spark ETL job, this must be glueetl . For a Python shell job, it must be pythonshell .

  • python_version (Optional[str]) – The Python version being used to execute a Python shell job. Allowed values are 2 or 3.

  • script_location (Optional[str]) – Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that executes a job (required).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-jobcommand.html

ExampleMetadata

fixture=_generated

Example:

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

job_command_property = glue.CfnJob.JobCommandProperty(
    name="name",
    python_version="pythonVersion",
    script_location="scriptLocation"
)

Attributes

name

The name of the job command.

For an Apache Spark ETL job, this must be glueetl . For a Python shell job, it must be pythonshell .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-jobcommand.html#cfn-glue-job-jobcommand-name

Return type

Optional[str]

python_version

The Python version being used to execute a Python shell job.

Allowed values are 2 or 3.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-jobcommand.html#cfn-glue-job-jobcommand-pythonversion

Return type

Optional[str]

script_location

Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that executes a job (required).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-jobcommand.html#cfn-glue-job-jobcommand-scriptlocation

Return type

Optional[str]

NotificationPropertyProperty

class CfnJob.NotificationPropertyProperty(*, notify_delay_after=None)

Bases: object

Specifies configuration properties of a notification.

Parameters

notify_delay_after (Union[int, float, None]) – After a job run starts, the number of minutes to wait before sending a job run delay notification.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-notificationproperty.html

ExampleMetadata

fixture=_generated

Example:

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

notification_property_property = glue.CfnJob.NotificationPropertyProperty(
    notify_delay_after=123
)

Attributes

notify_delay_after

After a job run starts, the number of minutes to wait before sending a job run delay notification.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-notificationproperty.html#cfn-glue-job-notificationproperty-notifydelayafter

Return type

Union[int, float, None]