Class: AWSCDK::Sagemaker::CfnProcessingJob

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSSagemaker::IProcessingJobRef
Defined in:
sagemaker/cfn_processing_job.rb

Overview

An Amazon SageMaker processing job that is used to analyze data and evaluate models.

For more information, see Process Data and Evaluate Models .

Also, note the following details specific to processing jobs created using CloudFormation stacks:

  • When you delete a CloudFormation stack with a processing job resource, the processing job is stopped using the StopProcessingJob API but not deleted. Any tags associated with the processing job are deleted using the DeleteTags API.
  • If any part of your CloudFormation stack deployment fails and a rollback initiates, processing jobs with a specified ProcessingJobName value might cause the stack to become stuck in a failed state. This occurs because during a rollback, CloudFormation attempts to recreate the stack resources. Processing job names must be unique, so when CloudFormation attempts to recreate a processing job using the already defined name, this results in an AlreadyExists error. To prevent this, we recommend that you don't specify the optional ProcessingJobName property, thereby allowing SageMaker to auto-generate a unique name for your processing job. This ensures successful stack rollbacks when necessary. If you must use custom job names, you have to manually modify the ProcessingJobName and redeploy the stack to recover from a failed rollback.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnProcessingJob

Create a new AWS::SageMaker::ProcessingJob.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::Sagemaker::CfnProcessingJobProps) —

    Resource properties.



25
26
27
28
29
30
31
 
# File 'sagemaker/cfn_processing_job.rb', line 25

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

Class Method Details

.arn_for_processing_job(resource) ⇒ String

Parameters:

Returns:

  • (String) 


99
100
101
102
 
# File 'sagemaker/cfn_processing_job.rb', line 99

def self.arn_for_processing_job(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zYWdlbWFrZXIuSVByb2Nlc3NpbmdKb2JSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sagemaker.CfnProcessingJob", "arnForProcessingJob", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


206
207
208
 
# File 'sagemaker/cfn_processing_job.rb', line 206

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

.is_cfn_processing_job(x) ⇒ Boolean

Checks whether the given object is a CfnProcessingJob.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


108
109
110
111
 
# File 'sagemaker/cfn_processing_job.rb', line 108

def self.is_cfn_processing_job(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sagemaker.CfnProcessingJob", "isCfnProcessingJob", [x])
end

.jsii_overridable_methods ⇒ Object 



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
92
93
94
95
 
# File 'sagemaker/cfn_processing_job.rb', line 33

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 },
    :attr_auto_ml_job_arn => { kind: :property, name: "attrAutoMlJobArn", is_optional: false },
    :attr_creation_time => { kind: :property, name: "attrCreationTime", is_optional: false },
    :attr_exit_message => { kind: :property, name: "attrExitMessage", is_optional: false },
    :attr_failure_reason => { kind: :property, name: "attrFailureReason", is_optional: false },
    :attr_last_modified_time => { kind: :property, name: "attrLastModifiedTime", is_optional: false },
    :attr_monitoring_schedule_arn => { kind: :property, name: "attrMonitoringScheduleArn", is_optional: false },
    :attr_processing_end_time => { kind: :property, name: "attrProcessingEndTime", is_optional: false },
    :attr_processing_job_arn => { kind: :property, name: "attrProcessingJobArn", is_optional: false },
    :attr_processing_job_status => { kind: :property, name: "attrProcessingJobStatus", is_optional: false },
    :attr_processing_start_time => { kind: :property, name: "attrProcessingStartTime", is_optional: false },
    :attr_training_job_arn => { kind: :property, name: "attrTrainingJobArn", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :processing_job_ref => { kind: :property, name: "processingJobRef", is_optional: false },
    :app_specification => { kind: :property, name: "appSpecification", is_optional: false },
    :processing_resources => { kind: :property, name: "processingResources", is_optional: false },
    :role_arn => { kind: :property, name: "roleArn", is_optional: false },
    :environment => { kind: :property, name: "environment", is_optional: true },
    :experiment_config => { kind: :property, name: "experimentConfig", is_optional: true },
    :network_config => { kind: :property, name: "networkConfig", is_optional: true },
    :processing_inputs => { kind: :property, name: "processingInputs", is_optional: true },
    :processing_job_name => { kind: :property, name: "processingJobName", is_optional: true },
    :processing_output_config => { kind: :property, name: "processingOutputConfig", is_optional: true },
    :stopping_condition => { kind: :property, name: "stoppingCondition", is_optional: true },
    :tags => { kind: :property, name: "tags", 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.



476
477
478
479
 
# File 'sagemaker/cfn_processing_job.rb', line 476

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:



488
489
490
491
 
# File 'sagemaker/cfn_processing_job.rb', line 488

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:



498
499
500
501
 
# File 'sagemaker/cfn_processing_job.rb', line 498

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:



509
510
511
512
513
 
# File 'sagemaker/cfn_processing_job.rb', line 509

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.


566
567
568
569
570
 
# File 'sagemaker/cfn_processing_job.rb', line 566

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.



576
577
578
579
 
# File 'sagemaker/cfn_processing_job.rb', line 576

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.



588
589
590
591
592
 
# File 'sagemaker/cfn_processing_job.rb', line 588

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

#app_specification ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnProcessingJob::AppSpecificationProperty

Configuration to run a processing job in a specified container image.

Returns:



304
305
306
 
# File 'sagemaker/cfn_processing_job.rb', line 304

def app_specification()
  jsii_get_property("appSpecification")
end

#app_specification=(value) ⇒ Object 



308
309
310
311
312
 
# File 'sagemaker/cfn_processing_job.rb', line 308

def app_specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnProcessingJob::AppSpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuUHJvY2Vzc2luZ0pvYi5BcHBTcGVjaWZpY2F0aW9uUHJvcGVydHkifV19fQ==")), "appSpecification")
  jsii_set_property("appSpecification", 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:



601
602
603
604
 
# File 'sagemaker/cfn_processing_job.rb', line 601

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:



623
624
625
626
627
628
 
# File 'sagemaker/cfn_processing_job.rb', line 623

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

#attr_auto_ml_job_arn ⇒ String

The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.

Returns:

  • (String) 


213
214
215
 
# File 'sagemaker/cfn_processing_job.rb', line 213

def attr_auto_ml_job_arn()
  jsii_get_property("attrAutoMlJobArn")
end

#attr_creation_time ⇒ String

The time the processing job was created.

Returns:

  • (String) 


220
221
222
 
# File 'sagemaker/cfn_processing_job.rb', line 220

def attr_creation_time()
  jsii_get_property("attrCreationTime")
end

#attr_exit_message ⇒ String

A string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

Returns:

  • (String) 


227
228
229
 
# File 'sagemaker/cfn_processing_job.rb', line 227

def attr_exit_message()
  jsii_get_property("attrExitMessage")
end

#attr_failure_reason ⇒ String

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

Returns:

  • (String) 


234
235
236
 
# File 'sagemaker/cfn_processing_job.rb', line 234

def attr_failure_reason()
  jsii_get_property("attrFailureReason")
end

#attr_last_modified_time ⇒ String

The time the processing job was last modified.

Returns:

  • (String) 


241
242
243
 
# File 'sagemaker/cfn_processing_job.rb', line 241

def attr_last_modified_time()
  jsii_get_property("attrLastModifiedTime")
end

#attr_monitoring_schedule_arn ⇒ String

The ARN of a monitoring schedule for an endpoint associated with this processing job.

Returns:

  • (String) 


248
249
250
 
# File 'sagemaker/cfn_processing_job.rb', line 248

def attr_monitoring_schedule_arn()
  jsii_get_property("attrMonitoringScheduleArn")
end

#attr_processing_end_time ⇒ String

The time that the processing job ended.

Returns:

  • (String) 


255
256
257
 
# File 'sagemaker/cfn_processing_job.rb', line 255

def attr_processing_end_time()
  jsii_get_property("attrProcessingEndTime")
end

#attr_processing_job_arn ⇒ String

The ARN of the processing job.

Returns:

  • (String) 


262
263
264
 
# File 'sagemaker/cfn_processing_job.rb', line 262

def attr_processing_job_arn()
  jsii_get_property("attrProcessingJobArn")
end

#attr_processing_job_status ⇒ String

The status of the processing job.

Returns:

  • (String) 


269
270
271
 
# File 'sagemaker/cfn_processing_job.rb', line 269

def attr_processing_job_status()
  jsii_get_property("attrProcessingJobStatus")
end

#attr_processing_start_time ⇒ String

The time that the processing job started.

Returns:

  • (String) 


276
277
278
 
# File 'sagemaker/cfn_processing_job.rb', line 276

def attr_processing_start_time()
  jsii_get_property("attrProcessingStartTime")
end

#attr_training_job_arn ⇒ String

The ARN of the training job associated with this processing job.

Returns:

  • (String) 


283
284
285
 
# File 'sagemaker/cfn_processing_job.rb', line 283

def attr_training_job_arn()
  jsii_get_property("attrTrainingJobArn")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



290
291
292
 
# File 'sagemaker/cfn_processing_job.rb', line 290

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



159
160
161
 
# File 'sagemaker/cfn_processing_job.rb', line 159

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


164
165
166
 
# File 'sagemaker/cfn_processing_job.rb', line 164

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


632
633
634
635
 
# File 'sagemaker/cfn_processing_job.rb', line 632

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


169
170
171
 
# File 'sagemaker/cfn_processing_job.rb', line 169

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


176
177
178
 
# File 'sagemaker/cfn_processing_job.rb', line 176

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


121
122
123
 
# File 'sagemaker/cfn_processing_job.rb', line 121

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



181
182
183
 
# File 'sagemaker/cfn_processing_job.rb', line 181

def env()
  jsii_get_property("env")
end

#environment ⇒ AWSCDK::IResolvable, ...

Sets the environment variables in the Docker container.

Returns:



342
343
344
 
# File 'sagemaker/cfn_processing_job.rb', line 342

def environment()
  jsii_get_property("environment")
end

#environment=(value) ⇒ Object 



346
347
348
349
 
# File 'sagemaker/cfn_processing_job.rb', line 346

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

#experiment_config ⇒ AWSCDK::IResolvable, ...

Associates a SageMaker job as a trial component with an experiment and trial.

Returns:



354
355
356
 
# File 'sagemaker/cfn_processing_job.rb', line 354

def experiment_config()
  jsii_get_property("experimentConfig")
end

#experiment_config=(value) ⇒ Object 



358
359
360
361
362
 
# File 'sagemaker/cfn_processing_job.rb', line 358

def experiment_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnProcessingJob::ExperimentConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuUHJvY2Vzc2luZ0pvYi5FeHBlcmltZW50Q29uZmlnUHJvcGVydHkifV19fQ==")), "experimentConfig") unless value.nil?
  jsii_set_property("experimentConfig", 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:



645
646
647
648
649
 
# File 'sagemaker/cfn_processing_job.rb', line 645

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:



656
657
658
659
 
# File 'sagemaker/cfn_processing_job.rb', line 656

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:



726
727
728
729
 
# File 'sagemaker/cfn_processing_job.rb', line 726

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


133
134
135
 
# File 'sagemaker/cfn_processing_job.rb', line 133

def logical_id()
  jsii_get_property("logicalId")
end

#network_config ⇒ AWSCDK::IResolvable, ...

Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.

Returns:



367
368
369
 
# File 'sagemaker/cfn_processing_job.rb', line 367

def network_config()
  jsii_get_property("networkConfig")
end

#network_config=(value) ⇒ Object 



371
372
373
374
375
 
# File 'sagemaker/cfn_processing_job.rb', line 371

def network_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnProcessingJob::NetworkConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuUHJvY2Vzc2luZ0pvYi5OZXR3b3JrQ29uZmlnUHJvcGVydHkifV19fQ==")), "networkConfig") unless value.nil?
  jsii_set_property("networkConfig", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


116
117
118
 
# File 'sagemaker/cfn_processing_job.rb', line 116

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:



667
668
669
 
# File 'sagemaker/cfn_processing_job.rb', line 667

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:



674
675
676
 
# File 'sagemaker/cfn_processing_job.rb', line 674

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.



467
468
469
470
 
# File 'sagemaker/cfn_processing_job.rb', line 467

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

#processing_inputs ⇒ AWSCDK::IResolvable, ...

List of input configurations for the processing job.

Returns:



380
381
382
 
# File 'sagemaker/cfn_processing_job.rb', line 380

def processing_inputs()
  jsii_get_property("processingInputs")
end

#processing_inputs=(value) ⇒ Object 



384
385
386
387
 
# File 'sagemaker/cfn_processing_job.rb', line 384

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

#processing_job_name ⇒ String?

The name of the processing job.

Returns:

  • (String, nil) 


392
393
394
 
# File 'sagemaker/cfn_processing_job.rb', line 392

def processing_job_name()
  jsii_get_property("processingJobName")
end

#processing_job_name=(value) ⇒ Object 



396
397
398
399
 
# File 'sagemaker/cfn_processing_job.rb', line 396

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

#processing_job_ref ⇒ AWSCDK::Interfaces::AWSSagemaker::ProcessingJobReference

A reference to a ProcessingJob resource.

Returns:



297
298
299
 
# File 'sagemaker/cfn_processing_job.rb', line 297

def processing_job_ref()
  jsii_get_property("processingJobRef")
end

#processing_output_config ⇒ AWSCDK::IResolvable, ...

Contains information about the output location for the compiled model and the target device that the model runs on.

Returns:



404
405
406
 
# File 'sagemaker/cfn_processing_job.rb', line 404

def processing_output_config()
  jsii_get_property("processingOutputConfig")
end

#processing_output_config=(value) ⇒ Object 



408
409
410
411
412
 
# File 'sagemaker/cfn_processing_job.rb', line 408

def processing_output_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnProcessingJob::ProcessingOutputConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuUHJvY2Vzc2luZ0pvYi5Qcm9jZXNzaW5nT3V0cHV0Q29uZmlnUHJvcGVydHkifV19fQ==")), "processingOutputConfig") unless value.nil?
  jsii_set_property("processingOutputConfig", value)
end

#processing_resources ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnProcessingJob::ProcessingResourcesProperty

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job.

Returns:



317
318
319
 
# File 'sagemaker/cfn_processing_job.rb', line 317

def processing_resources()
  jsii_get_property("processingResources")
end

#processing_resources=(value) ⇒ Object 



321
322
323
324
325
 
# File 'sagemaker/cfn_processing_job.rb', line 321

def processing_resources=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnProcessingJob::ProcessingResourcesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuUHJvY2Vzc2luZ0pvYi5Qcm9jZXNzaW5nUmVzb3VyY2VzUHJvcGVydHkifV19fQ==")), "processingResources")
  jsii_set_property("processingResources", 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) 


152
153
154
 
# File 'sagemaker/cfn_processing_job.rb', line 152

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:



685
686
687
688
 
# File 'sagemaker/cfn_processing_job.rb', line 685

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


692
693
694
695
 
# File 'sagemaker/cfn_processing_job.rb', line 692

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:



702
703
704
705
706
 
# File 'sagemaker/cfn_processing_job.rb', line 702

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 ARN of the role used to create the processing job.

Returns:

  • (String) 


330
331
332
 
# File 'sagemaker/cfn_processing_job.rb', line 330

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



334
335
336
337
 
# File 'sagemaker/cfn_processing_job.rb', line 334

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.



711
712
713
 
# File 'sagemaker/cfn_processing_job.rb', line 711

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:



142
143
144
 
# File 'sagemaker/cfn_processing_job.rb', line 142

def stack()
  jsii_get_property("stack")
end

#stopping_condition ⇒ AWSCDK::IResolvable, ...

Configures conditions under which the processing job should be stopped, such as how long the processing job has been running.

Returns:



417
418
419
 
# File 'sagemaker/cfn_processing_job.rb', line 417

def stopping_condition()
  jsii_get_property("stoppingCondition")
end

#stopping_condition=(value) ⇒ Object 



421
422
423
424
425
 
# File 'sagemaker/cfn_processing_job.rb', line 421

def stopping_condition=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnProcessingJob::StoppingConditionProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuUHJvY2Vzc2luZ0pvYi5TdG9wcGluZ0NvbmRpdGlvblByb3BlcnR5In1dfX0=")), "stoppingCondition") unless value.nil?
  jsii_set_property("stoppingCondition", value)
end

#tags ⇒ Array<AWSCDK::CfnTag>?

An array of key-value pairs.

Returns:



430
431
432
 
# File 'sagemaker/cfn_processing_job.rb', line 430

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



434
435
436
437
438
 
# File 'sagemaker/cfn_processing_job.rb', line 434

def tags=(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=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



443
444
445
 
# File 'sagemaker/cfn_processing_job.rb', line 443

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


189
190
191
 
# File 'sagemaker/cfn_processing_job.rb', line 189

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


199
200
201
 
# File 'sagemaker/cfn_processing_job.rb', line 199

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


717
718
719
720
 
# File 'sagemaker/cfn_processing_job.rb', line 717

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) 


456
457
458
459
460
461
 
# File 'sagemaker/cfn_processing_job.rb', line 456

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