Class: AWSCDK::DataBrew::CfnJob

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

Overview

Specifies a new DataBrew job.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnJob

Create a new AWS::DataBrew::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::DataBrew::CfnJobProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'data_brew/cfn_job.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::DataBrew::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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGF0YWJyZXcuQ2ZuSm9iUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


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

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

.is_cfn_job(x) ⇒ Boolean

Checks whether the given object is a CfnJob.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


92
93
94
95
 
# File 'data_brew/cfn_job.rb', line 92

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_databrew.CfnJob", "isCfnJob", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
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
 
# File 'data_brew/cfn_job.rb', line 26

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 },
    :name => { kind: :property, name: "name", is_optional: false },
    :role_arn => { kind: :property, name: "roleArn", is_optional: false },
    :type => { kind: :property, name: "type", is_optional: false },
    :database_outputs => { kind: :property, name: "databaseOutputs", is_optional: true },
    :data_catalog_outputs => { kind: :property, name: "dataCatalogOutputs", is_optional: true },
    :dataset_name => { kind: :property, name: "datasetName", is_optional: true },
    :encryption_key_arn => { kind: :property, name: "encryptionKeyArn", is_optional: true },
    :encryption_mode => { kind: :property, name: "encryptionMode", is_optional: true },
    :job_sample => { kind: :property, name: "jobSample", is_optional: true },
    :log_subscription => { kind: :property, name: "logSubscription", is_optional: true },
    :max_capacity => { kind: :property, name: "maxCapacity", is_optional: true },
    :max_retries => { kind: :property, name: "maxRetries", is_optional: true },
    :output_location => { kind: :property, name: "outputLocation", is_optional: true },
    :outputs => { kind: :property, name: "outputs", is_optional: true },
    :profile_configuration => { kind: :property, name: "profileConfiguration", is_optional: true },
    :project_name => { kind: :property, name: "projectName", is_optional: true },
    :recipe => { kind: :property, name: "recipe", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :timeout => { kind: :property, name: "timeout", is_optional: true },
    :validation_configurations => { kind: :property, name: "validationConfigurations", 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.



489
490
491
492
 
# File 'data_brew/cfn_job.rb', line 489

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:



501
502
503
504
 
# File 'data_brew/cfn_job.rb', line 501

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:



511
512
513
514
 
# File 'data_brew/cfn_job.rb', line 511

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:



522
523
524
525
526
 
# File 'data_brew/cfn_job.rb', line 522

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.


579
580
581
582
583
 
# File 'data_brew/cfn_job.rb', line 579

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.



589
590
591
592
 
# File 'data_brew/cfn_job.rb', line 589

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.



601
602
603
604
605
 
# File 'data_brew/cfn_job.rb', line 601

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

#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:



614
615
616
617
 
# File 'data_brew/cfn_job.rb', line 614

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:



636
637
638
639
640
641
 
# File 'data_brew/cfn_job.rb', line 636

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:



143
144
145
 
# File 'data_brew/cfn_job.rb', line 143

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


148
149
150
 
# File 'data_brew/cfn_job.rb', line 148

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


645
646
647
648
 
# File 'data_brew/cfn_job.rb', line 645

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


153
154
155
 
# File 'data_brew/cfn_job.rb', line 153

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


160
161
162
 
# File 'data_brew/cfn_job.rb', line 160

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


105
106
107
 
# File 'data_brew/cfn_job.rb', line 105

def creation_stack()
  jsii_get_property("creationStack")
end

#data_catalog_outputs ⇒ AWSCDK::IResolvable, ...

One or more artifacts that represent the AWS Glue Data Catalog output from running the job.

Returns:



259
260
261
 
# File 'data_brew/cfn_job.rb', line 259

def data_catalog_outputs()
  jsii_get_property("dataCatalogOutputs")
end

#data_catalog_outputs=(value) ⇒ Object 



263
264
265
266
 
# File 'data_brew/cfn_job.rb', line 263

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

#database_outputs ⇒ AWSCDK::IResolvable, ...

Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

Returns:



247
248
249
 
# File 'data_brew/cfn_job.rb', line 247

def database_outputs()
  jsii_get_property("databaseOutputs")
end

#database_outputs=(value) ⇒ Object 



251
252
253
254
 
# File 'data_brew/cfn_job.rb', line 251

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

#dataset_name ⇒ String?

A dataset that the job is to process.

Returns:

  • (String, nil) 


271
272
273
 
# File 'data_brew/cfn_job.rb', line 271

def dataset_name()
  jsii_get_property("datasetName")
end

#dataset_name=(value) ⇒ Object 



275
276
277
278
 
# File 'data_brew/cfn_job.rb', line 275

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

#encryption_key_arn ⇒ String?

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output.

Returns:

  • (String, nil) 


283
284
285
 
# File 'data_brew/cfn_job.rb', line 283

def encryption_key_arn()
  jsii_get_property("encryptionKeyArn")
end

#encryption_key_arn=(value) ⇒ Object 



287
288
289
290
 
# File 'data_brew/cfn_job.rb', line 287

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

#encryption_mode ⇒ String?

The encryption mode for the job, which can be one of the following:.

Returns:

  • (String, nil) 


295
296
297
 
# File 'data_brew/cfn_job.rb', line 295

def encryption_mode()
  jsii_get_property("encryptionMode")
end

#encryption_mode=(value) ⇒ Object 



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

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



165
166
167
 
# File 'data_brew/cfn_job.rb', line 165

def env()
  jsii_get_property("env")
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:



658
659
660
661
662
 
# File 'data_brew/cfn_job.rb', line 658

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:



669
670
671
672
 
# File 'data_brew/cfn_job.rb', line 669

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



739
740
741
742
 
# File 'data_brew/cfn_job.rb', line 739

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

#job_ref ⇒ AWSCDK::Interfaces::AWSDatabrew::JobReference

A reference to a Job resource.

Returns:



197
198
199
 
# File 'data_brew/cfn_job.rb', line 197

def job_ref()
  jsii_get_property("jobRef")
end

#job_sample ⇒ AWSCDK::IResolvable, ...

A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.

Returns:



307
308
309
 
# File 'data_brew/cfn_job.rb', line 307

def job_sample()
  jsii_get_property("jobSample")
end

#job_sample=(value) ⇒ Object 



311
312
313
314
315
 
# File 'data_brew/cfn_job.rb', line 311

def job_sample=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DataBrew::CfnJob::JobSampleProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhYnJldy5DZm5Kb2IuSm9iU2FtcGxlUHJvcGVydHkifV19fQ==")), "jobSample") unless value.nil?
  jsii_set_property("jobSample", value)
end

#log_subscription ⇒ String?

The current status of Amazon CloudWatch logging for the job.

Returns:

  • (String, nil) 


320
321
322
 
# File 'data_brew/cfn_job.rb', line 320

def log_subscription()
  jsii_get_property("logSubscription")
end

#log_subscription=(value) ⇒ Object 



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

def log_subscription=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "logSubscription") unless value.nil?
  jsii_set_property("logSubscription", 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) 


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

def logical_id()
  jsii_get_property("logicalId")
end

#max_capacity ⇒ Numeric?

The maximum number of nodes that can be consumed when the job processes data.

Returns:

  • (Numeric, nil) 


332
333
334
 
# File 'data_brew/cfn_job.rb', line 332

def max_capacity()
  jsii_get_property("maxCapacity")
end

#max_capacity=(value) ⇒ Object 



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

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 the job after a job run fails.

Returns:

  • (Numeric, nil) 


344
345
346
 
# File 'data_brew/cfn_job.rb', line 344

def max_retries()
  jsii_get_property("maxRetries")
end

#max_retries=(value) ⇒ Object 



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

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 unique name of the job.

Returns:

  • (String) 


211
212
213
 
# File 'data_brew/cfn_job.rb', line 211

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



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

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


100
101
102
 
# File 'data_brew/cfn_job.rb', line 100

def node()
  jsii_get_property("node")
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:



680
681
682
 
# File 'data_brew/cfn_job.rb', line 680

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:



687
688
689
 
# File 'data_brew/cfn_job.rb', line 687

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

#output_location ⇒ AWSCDK::IResolvable, ...

The location in Amazon S3 where the job writes its output.

Returns:



356
357
358
 
# File 'data_brew/cfn_job.rb', line 356

def output_location()
  jsii_get_property("outputLocation")
end

#output_location=(value) ⇒ Object 



360
361
362
363
364
 
# File 'data_brew/cfn_job.rb', line 360

def output_location=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DataBrew::CfnJob::OutputLocationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhYnJldy5DZm5Kb2IuT3V0cHV0TG9jYXRpb25Qcm9wZXJ0eSJ9XX19")), "outputLocation") unless value.nil?
  jsii_set_property("outputLocation", value)
end

#outputs ⇒ AWSCDK::IResolvable, ...

One or more artifacts that represent output from running the job.

Returns:



369
370
371
 
# File 'data_brew/cfn_job.rb', line 369

def outputs()
  jsii_get_property("outputs")
end

#outputs=(value) ⇒ Object 



373
374
375
376
 
# File 'data_brew/cfn_job.rb', line 373

def outputs=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGF0YWJyZXcuQ2ZuSm9iLk91dHB1dFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "outputs") unless value.nil?
  jsii_set_property("outputs", value)
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.



480
481
482
483
 
# File 'data_brew/cfn_job.rb', line 480

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

#profile_configuration ⇒ AWSCDK::IResolvable, ...

Configuration for profile jobs.

Returns:



381
382
383
 
# File 'data_brew/cfn_job.rb', line 381

def profile_configuration()
  jsii_get_property("profileConfiguration")
end

#profile_configuration=(value) ⇒ Object 



385
386
387
388
389
 
# File 'data_brew/cfn_job.rb', line 385

def profile_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DataBrew::CfnJob::ProfileConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhYnJldy5DZm5Kb2IuUHJvZmlsZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "profileConfiguration") unless value.nil?
  jsii_set_property("profileConfiguration", value)
end

#project_name ⇒ String?

The name of the project that the job is associated with.

Returns:

  • (String, nil) 


394
395
396
 
# File 'data_brew/cfn_job.rb', line 394

def project_name()
  jsii_get_property("projectName")
end

#project_name=(value) ⇒ Object 



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

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

#recipe ⇒ AWSCDK::IResolvable, ...

A series of data transformation steps that the job runs.

Returns:



406
407
408
 
# File 'data_brew/cfn_job.rb', line 406

def recipe()
  jsii_get_property("recipe")
end

#recipe=(value) ⇒ Object 



410
411
412
413
414
 
# File 'data_brew/cfn_job.rb', line 410

def recipe=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DataBrew::CfnJob::RecipeProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhYnJldy5DZm5Kb2IuUmVjaXBlUHJvcGVydHkifV19fQ==")), "recipe") unless value.nil?
  jsii_set_property("recipe", value)
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) 


136
137
138
 
# File 'data_brew/cfn_job.rb', line 136

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:



698
699
700
701
 
# File 'data_brew/cfn_job.rb', line 698

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


705
706
707
708
 
# File 'data_brew/cfn_job.rb', line 705

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:



715
716
717
718
719
 
# File 'data_brew/cfn_job.rb', line 715

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_arn ⇒ String

The Amazon Resource Name (ARN) of the role to be assumed for this job.

Returns:

  • (String) 


223
224
225
 
# File 'data_brew/cfn_job.rb', line 223

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



227
228
229
230
 
# File 'data_brew/cfn_job.rb', line 227

def role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  jsii_set_property("roleArn", 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.



724
725
726
 
# File 'data_brew/cfn_job.rb', line 724

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:



126
127
128
 
# File 'data_brew/cfn_job.rb', line 126

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



204
205
206
 
# File 'data_brew/cfn_job.rb', line 204

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Metadata tags that have been applied to the job.

Returns:



419
420
421
 
# File 'data_brew/cfn_job.rb', line 419

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



423
424
425
426
427
 
# File 'data_brew/cfn_job.rb', line 423

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#timeout ⇒ Numeric?

The job's timeout in minutes.

Returns:

  • (Numeric, nil) 


432
433
434
 
# File 'data_brew/cfn_job.rb', line 432

def timeout()
  jsii_get_property("timeout")
end

#timeout=(value) ⇒ Object 



436
437
438
439
 
# File 'data_brew/cfn_job.rb', line 436

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



456
457
458
 
# File 'data_brew/cfn_job.rb', line 456

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

#type ⇒ String

The job type of the job, which must be one of the following:.

Returns:

  • (String) 


235
236
237
 
# File 'data_brew/cfn_job.rb', line 235

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



239
240
241
242
 
# File 'data_brew/cfn_job.rb', line 239

def type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  jsii_set_property("type", value)
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}) 


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

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


183
184
185
 
# File 'data_brew/cfn_job.rb', line 183

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


730
731
732
733
 
# File 'data_brew/cfn_job.rb', line 730

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

#validation_configurations ⇒ AWSCDK::IResolvable, ...

List of validation configurations that are applied to the profile job.

Returns:



444
445
446
 
# File 'data_brew/cfn_job.rb', line 444

def validation_configurations()
  jsii_get_property("validationConfigurations")
end

#validation_configurations=(value) ⇒ Object 



448
449
450
451
 
# File 'data_brew/cfn_job.rb', line 448

def validation_configurations=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGF0YWJyZXcuQ2ZuSm9iLlZhbGlkYXRpb25Db25maWd1cmF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "validationConfigurations") unless value.nil?
  jsii_set_property("validationConfigurations", value)
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) 


469
470
471
472
473
474
 
# File 'data_brew/cfn_job.rb', line 469

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