Class: AWSCDK::Glue::CfnJob

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSGlue::IJobRef
Defined in:
glue/cfn_job.rb

Overview

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.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnJob

Create a new AWS::Glue::Job.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::Glue::CfnJobProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'glue/cfn_job.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Glue::CfnJobProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ2x1ZS5DZm5Kb2JQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_job(resource) ⇒ String

Parameters:

Returns:

  • (String) 


95
96
97
98
 
# File 'glue/cfn_job.rb', line 95

def self.arn_for_job(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19nbHVlLklKb2JSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_glue.CfnJob", "arnForJob", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


215
216
217
 
# File 'glue/cfn_job.rb', line 215

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_glue.CfnJob", "CFN_RESOURCE_TYPE_NAME")
end

.from_job_name(scope, id, job_name) ⇒ AWSCDK::Interfaces::AWSGlue::IJobRef

Creates a new IJobRef from a jobName.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • job_name (String)

Returns:



106
107
108
109
110
111
 
# File 'glue/cfn_job.rb', line 106

def self.from_job_name(scope, id, job_name)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(job_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jobName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_glue.CfnJob", "fromJobName", [scope, id, job_name])
end

.is_cfn_job(x) ⇒ Boolean

Checks whether the given object is a CfnJob.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


117
118
119
120
 
# File 'glue/cfn_job.rb', line 117

def self.is_cfn_job(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_glue.CfnJob", "isCfnJob", [x])
end

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'glue/cfn_job.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :job_ref => { kind: :property, name: "jobRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :command => { kind: :property, name: "command", is_optional: false },
    :default_arguments => { kind: :property, name: "defaultArguments", is_optional: false },
    :non_overridable_arguments => { kind: :property, name: "nonOverridableArguments", is_optional: false },
    :role => { kind: :property, name: "role", is_optional: false },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: false },
    :allocated_capacity => { kind: :property, name: "allocatedCapacity", is_optional: true },
    :connections => { kind: :property, name: "connections", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :execution_class => { kind: :property, name: "executionClass", is_optional: true },
    :execution_property => { kind: :property, name: "executionProperty", is_optional: true },
    :glue_version => { kind: :property, name: "glueVersion", is_optional: true },
    :job_mode => { kind: :property, name: "jobMode", is_optional: true },
    :job_run_queuing_enabled => { kind: :property, name: "jobRunQueuingEnabled", is_optional: true },
    :log_uri => { kind: :property, name: "logUri", is_optional: true },
    :maintenance_window => { kind: :property, name: "maintenanceWindow", is_optional: true },
    :max_capacity => { kind: :property, name: "maxCapacity", is_optional: true },
    :max_retries => { kind: :property, name: "maxRetries", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :notification_property => { kind: :property, name: "notificationProperty", is_optional: true },
    :number_of_workers => { kind: :property, name: "numberOfWorkers", is_optional: true },
    :security_configuration => { kind: :property, name: "securityConfiguration", is_optional: true },
    :timeout => { kind: :property, name: "timeout", is_optional: true },
    :worker_type => { kind: :property, name: "workerType", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



553
554
555
556
 
# File 'glue/cfn_job.rb', line 553

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

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:



565
566
567
568
 
# File 'glue/cfn_job.rb', line 565

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

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

Parameters:



575
576
577
578
 
# File 'glue/cfn_job.rb', line 575

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



586
587
588
589
590
 
# File 'glue/cfn_job.rb', line 586

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override 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,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

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

The value argument to add_override 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 (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


643
644
645
646
647
 
# File 'glue/cfn_job.rb', line 643

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

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

Parameters:

  • property_path (String) —

    The path to the property.



653
654
655
656
 
# File 'glue/cfn_job.rb', line 653

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

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

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



665
666
667
668
669
 
# File 'glue/cfn_job.rb', line 665

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#allocated_capacity ⇒ Numeric?

This parameter is no longer supported.

Use MaxCapacity instead.

Returns:

  • (Numeric, nil) 


299
300
301
 
# File 'glue/cfn_job.rb', line 299

def allocated_capacity()
  jsii_get_property("allocatedCapacity")
end

#allocated_capacity=(value) ⇒ Object 



303
304
305
306
 
# File 'glue/cfn_job.rb', line 303

def allocated_capacity=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "allocatedCapacity") unless value.nil?
  jsii_set_property("allocatedCapacity", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



678
679
680
681
 
# File 'glue/cfn_job.rb', line 678

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



700
701
702
703
704
705
 
# File 'glue/cfn_job.rb', line 700

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



168
169
170
 
# File 'glue/cfn_job.rb', line 168

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


173
174
175
 
# File 'glue/cfn_job.rb', line 173

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


709
710
711
712
 
# File 'glue/cfn_job.rb', line 709

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


178
179
180
 
# File 'glue/cfn_job.rb', line 178

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


185
186
187
 
# File 'glue/cfn_job.rb', line 185

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#command ⇒ AWSCDK::IResolvable, AWSCDK::Glue::CfnJob::JobCommandProperty

The code that executes a job.

Returns:



236
237
238
 
# File 'glue/cfn_job.rb', line 236

def command()
  jsii_get_property("command")
end

#command=(value) ⇒ Object 



240
241
242
243
244
 
# File 'glue/cfn_job.rb', line 240

def command=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Glue::CfnJob::JobCommandProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nbHVlLkNmbkpvYi5Kb2JDb21tYW5kUHJvcGVydHkifV19fQ==")), "command")
  jsii_set_property("command", value)
end

#connections ⇒ AWSCDK::IResolvable, ...

The connections used for this job.

Returns:



311
312
313
 
# File 'glue/cfn_job.rb', line 311

def connections()
  jsii_get_property("connections")
end

#connections=(value) ⇒ Object 



315
316
317
318
319
 
# File 'glue/cfn_job.rb', line 315

def connections=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Glue::CfnJob::ConnectionsListProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nbHVlLkNmbkpvYi5Db25uZWN0aW9uc0xpc3RQcm9wZXJ0eSJ9XX19")), "connections") unless value.nil?
  jsii_set_property("connections", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


130
131
132
 
# File 'glue/cfn_job.rb', line 130

def creation_stack()
  jsii_get_property("creationStack")
end

#default_arguments ⇒ Object

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

Returns:

  • (Object) 


249
250
251
 
# File 'glue/cfn_job.rb', line 249

def default_arguments()
  jsii_get_property("defaultArguments")
end

#default_arguments=(value) ⇒ Object 



253
254
255
256
 
# File 'glue/cfn_job.rb', line 253

def default_arguments=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "defaultArguments")
  jsii_set_property("defaultArguments", value)
end

#description ⇒ String?

A description of the job.

Returns:

  • (String, nil) 


324
325
326
 
# File 'glue/cfn_job.rb', line 324

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



328
329
330
331
 
# File 'glue/cfn_job.rb', line 328

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



190
191
192
 
# File 'glue/cfn_job.rb', line 190

def env()
  jsii_get_property("env")
end

#execution_class ⇒ String?

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

Returns:

  • (String, nil) 


336
337
338
 
# File 'glue/cfn_job.rb', line 336

def execution_class()
  jsii_get_property("executionClass")
end

#execution_class=(value) ⇒ Object 



340
341
342
343
 
# File 'glue/cfn_job.rb', line 340

def execution_class=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "executionClass") unless value.nil?
  jsii_set_property("executionClass", value)
end

#execution_property ⇒ AWSCDK::IResolvable, ...

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

Returns:



348
349
350
 
# File 'glue/cfn_job.rb', line 348

def execution_property()
  jsii_get_property("executionProperty")
end

#execution_property=(value) ⇒ Object 



352
353
354
355
356
 
# File 'glue/cfn_job.rb', line 352

def execution_property=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Glue::CfnJob::ExecutionPropertyProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nbHVlLkNmbkpvYi5FeGVjdXRpb25Qcm9wZXJ0eVByb3BlcnR5In1dfX0=")), "executionProperty") unless value.nil?
  jsii_set_property("executionProperty", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

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:

Returns:



722
723
724
725
726
 
# File 'glue/cfn_job.rb', line 722

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



733
734
735
736
 
# File 'glue/cfn_job.rb', line 733

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#glue_version ⇒ String?

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

Returns:

  • (String, nil) 


361
362
363
 
# File 'glue/cfn_job.rb', line 361

def glue_version()
  jsii_get_property("glueVersion")
end

#glue_version=(value) ⇒ Object 



365
366
367
368
 
# File 'glue/cfn_job.rb', line 365

def glue_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "glueVersion") unless value.nil?
  jsii_set_property("glueVersion", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



803
804
805
806
 
# File 'glue/cfn_job.rb', line 803

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#job_mode ⇒ String?

A mode that describes how a job was created.

Valid values are:.

Returns:

  • (String, nil) 


375
376
377
 
# File 'glue/cfn_job.rb', line 375

def job_mode()
  jsii_get_property("jobMode")
end

#job_mode=(value) ⇒ Object 



379
380
381
382
 
# File 'glue/cfn_job.rb', line 379

def job_mode=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jobMode") unless value.nil?
  jsii_set_property("jobMode", value)
end

#job_ref ⇒ AWSCDK::Interfaces::AWSGlue::JobReference

A reference to a Job resource.

Returns:



222
223
224
 
# File 'glue/cfn_job.rb', line 222

def job_ref()
  jsii_get_property("jobRef")
end

#job_run_queuing_enabled ⇒ Boolean, ...

Specifies whether job run queuing is enabled for the job runs for this job.

Returns:



387
388
389
 
# File 'glue/cfn_job.rb', line 387

def job_run_queuing_enabled()
  jsii_get_property("jobRunQueuingEnabled")
end

#job_run_queuing_enabled=(value) ⇒ Object 



391
392
393
394
 
# File 'glue/cfn_job.rb', line 391

def job_run_queuing_enabled=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "jobRunQueuingEnabled") unless value.nil?
  jsii_set_property("jobRunQueuingEnabled", value)
end

#log_uri ⇒ String?

This field is reserved for future use.

Returns:

  • (String, nil) 


399
400
401
 
# File 'glue/cfn_job.rb', line 399

def log_uri()
  jsii_get_property("logUri")
end

#log_uri=(value) ⇒ Object 



403
404
405
406
 
# File 'glue/cfn_job.rb', line 403

def log_uri=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "logUri") unless value.nil?
  jsii_set_property("logUri", value)
end

#logical_id ⇒ 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 override_logical_id(new_logical_id).

Returns:

  • (String) 


142
143
144
 
# File 'glue/cfn_job.rb', line 142

def logical_id()
  jsii_get_property("logicalId")
end

#maintenance_window ⇒ String?

This field specifies a day of the week and hour for a maintenance window for streaming jobs.

Returns:

  • (String, nil) 


411
412
413
 
# File 'glue/cfn_job.rb', line 411

def maintenance_window()
  jsii_get_property("maintenanceWindow")
end

#maintenance_window=(value) ⇒ Object 



415
416
417
418
 
# File 'glue/cfn_job.rb', line 415

def maintenance_window=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "maintenanceWindow") unless value.nil?
  jsii_set_property("maintenanceWindow", value)
end

#max_capacity ⇒ Numeric?

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

Returns:

  • (Numeric, nil) 


423
424
425
 
# File 'glue/cfn_job.rb', line 423

def max_capacity()
  jsii_get_property("maxCapacity")
end

#max_capacity=(value) ⇒ Object 



427
428
429
430
 
# File 'glue/cfn_job.rb', line 427

def max_capacity=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxCapacity") unless value.nil?
  jsii_set_property("maxCapacity", value)
end

#max_retries ⇒ Numeric?

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

Returns:

  • (Numeric, nil) 


435
436
437
 
# File 'glue/cfn_job.rb', line 435

def max_retries()
  jsii_get_property("maxRetries")
end

#max_retries=(value) ⇒ Object 



439
440
441
442
 
# File 'glue/cfn_job.rb', line 439

def max_retries=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxRetries") unless value.nil?
  jsii_set_property("maxRetries", value)
end

#name ⇒ String?

The name you assign to this job definition.

Returns:

  • (String, nil) 


447
448
449
 
# File 'glue/cfn_job.rb', line 447

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



451
452
453
454
 
# File 'glue/cfn_job.rb', line 451

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless value.nil?
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


125
126
127
 
# File 'glue/cfn_job.rb', line 125

def node()
  jsii_get_property("node")
end

#non_overridable_arguments ⇒ Object

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

Returns:

  • (Object) 


261
262
263
 
# File 'glue/cfn_job.rb', line 261

def non_overridable_arguments()
  jsii_get_property("nonOverridableArguments")
end

#non_overridable_arguments=(value) ⇒ Object 



265
266
267
268
 
# File 'glue/cfn_job.rb', line 265

def non_overridable_arguments=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "nonOverridableArguments")
  jsii_set_property("nonOverridableArguments", value)
end

#notification_property ⇒ AWSCDK::IResolvable, ...

Specifies configuration properties of a notification.

Returns:



459
460
461
 
# File 'glue/cfn_job.rb', line 459

def notification_property()
  jsii_get_property("notificationProperty")
end

#notification_property=(value) ⇒ Object 



463
464
465
466
467
 
# File 'glue/cfn_job.rb', line 463

def notification_property=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Glue::CfnJob::NotificationPropertyProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nbHVlLkNmbkpvYi5Ob3RpZmljYXRpb25Qcm9wZXJ0eVByb3BlcnR5In1dfX0=")), "notificationProperty") unless value.nil?
  jsii_set_property("notificationProperty", value)
end

#number_of_workers ⇒ Numeric?

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

Returns:

  • (Numeric, nil) 


472
473
474
 
# File 'glue/cfn_job.rb', line 472

def number_of_workers()
  jsii_get_property("numberOfWorkers")
end

#number_of_workers=(value) ⇒ Object 



476
477
478
479
 
# File 'glue/cfn_job.rb', line 476

def number_of_workers=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "numberOfWorkers") unless value.nil?
  jsii_set_property("numberOfWorkers", value)
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



744
745
746
 
# File 'glue/cfn_job.rb', line 744

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



751
752
753
 
# File 'glue/cfn_job.rb', line 751

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

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

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



544
545
546
547
 
# File 'glue/cfn_job.rb', line 544

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ 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 }).

Returns:

  • (String) 


161
162
163
 
# File 'glue/cfn_job.rb', line 161

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



762
763
764
765
 
# File 'glue/cfn_job.rb', line 762

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


769
770
771
772
 
# File 'glue/cfn_job.rb', line 769

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



779
780
781
782
783
 
# File 'glue/cfn_job.rb', line 779

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#role ⇒ String

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

Returns:

  • (String) 


273
274
275
 
# File 'glue/cfn_job.rb', line 273

def role()
  jsii_get_property("role")
end

#role=(value) ⇒ Object 



277
278
279
280
 
# File 'glue/cfn_job.rb', line 277

def role=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "role")
  jsii_set_property("role", value)
end

#security_configuration ⇒ String?

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

Returns:

  • (String, nil) 


484
485
486
 
# File 'glue/cfn_job.rb', line 484

def security_configuration()
  jsii_get_property("securityConfiguration")
end

#security_configuration=(value) ⇒ Object 



488
489
490
491
 
# File 'glue/cfn_job.rb', line 488

def security_configuration=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "securityConfiguration") unless value.nil?
  jsii_set_property("securityConfiguration", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



788
789
790
 
# File 'glue/cfn_job.rb', line 788

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



151
152
153
 
# File 'glue/cfn_job.rb', line 151

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



229
230
231
 
# File 'glue/cfn_job.rb', line 229

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Object

The tags to use with this job.

Returns:

  • (Object) 


285
286
287
 
# File 'glue/cfn_job.rb', line 285

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



289
290
291
292
 
# File 'glue/cfn_job.rb', line 289

def tags_raw=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "tagsRaw")
  jsii_set_property("tagsRaw", value)
end

#timeout ⇒ Numeric?

The job timeout in minutes.

Returns:

  • (Numeric, nil) 


496
497
498
 
# File 'glue/cfn_job.rb', line 496

def timeout()
  jsii_get_property("timeout")
end

#timeout=(value) ⇒ Object 



500
501
502
503
 
# File 'glue/cfn_job.rb', line 500

def timeout=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "timeout") unless value.nil?
  jsii_set_property("timeout", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



520
521
522
 
# File 'glue/cfn_job.rb', line 520

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


198
199
200
 
# File 'glue/cfn_job.rb', line 198

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


208
209
210
 
# File 'glue/cfn_job.rb', line 208

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


794
795
796
797
 
# File 'glue/cfn_job.rb', line 794

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


533
534
535
536
537
538
 
# File 'glue/cfn_job.rb', line 533

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end

#worker_type ⇒ String?

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

Returns:

  • (String, nil) 


508
509
510
 
# File 'glue/cfn_job.rb', line 508

def worker_type()
  jsii_get_property("workerType")
end

#worker_type=(value) ⇒ Object 



512
513
514
515
 
# File 'glue/cfn_job.rb', line 512

def worker_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workerType") unless value.nil?
  jsii_set_property("workerType", value)
end