Class: AWSCDK::Sagemaker::CfnProcessingJobProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sagemaker/cfn_processing_job_props.rb

Overview

Properties for defining a CfnProcessingJob.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app_specification:, processing_resources:, role_arn:, environment: nil, experiment_config: nil, network_config: nil, processing_inputs: nil, processing_job_name: nil, processing_output_config: nil, stopping_condition: nil, tags: nil) ⇒ CfnProcessingJobProps

Returns a new instance of CfnProcessingJobProps.

Parameters:



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'sagemaker/cfn_processing_job_props.rb', line 20

def initialize(app_specification:, processing_resources:, role_arn:, environment: nil, experiment_config: nil, network_config: nil, processing_inputs: nil, processing_job_name: nil, processing_output_config: nil, stopping_condition: nil, tags: nil)
  @app_specification = app_specification.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnProcessingJob::AppSpecificationProperty.new(**app_specification.transform_keys(&:to_sym)) : app_specification
  Jsii::Type.check_type(@app_specification, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuUHJvY2Vzc2luZ0pvYi5BcHBTcGVjaWZpY2F0aW9uUHJvcGVydHkifV19fQ==")), "appSpecification")
  @processing_resources = processing_resources.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnProcessingJob::ProcessingResourcesProperty.new(**processing_resources.transform_keys(&:to_sym)) : processing_resources
  Jsii::Type.check_type(@processing_resources, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuUHJvY2Vzc2luZ0pvYi5Qcm9jZXNzaW5nUmVzb3VyY2VzUHJvcGVydHkifV19fQ==")), "processingResources")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @environment = environment
  Jsii::Type.check_type(@environment, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "environment") unless @environment.nil?
  @experiment_config = experiment_config.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnProcessingJob::ExperimentConfigProperty.new(**experiment_config.transform_keys(&:to_sym)) : experiment_config
  Jsii::Type.check_type(@experiment_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuUHJvY2Vzc2luZ0pvYi5FeHBlcmltZW50Q29uZmlnUHJvcGVydHkifV19fQ==")), "experimentConfig") unless @experiment_config.nil?
  @network_config = network_config.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnProcessingJob::NetworkConfigProperty.new(**network_config.transform_keys(&:to_sym)) : network_config
  Jsii::Type.check_type(@network_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuUHJvY2Vzc2luZ0pvYi5OZXR3b3JrQ29uZmlnUHJvcGVydHkifV19fQ==")), "networkConfig") unless @network_config.nil?
  @processing_inputs = processing_inputs
  Jsii::Type.check_type(@processing_inputs, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmblByb2Nlc3NpbmdKb2IuUHJvY2Vzc2luZ0lucHV0c09iamVjdFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "processingInputs") unless @processing_inputs.nil?
  @processing_job_name = processing_job_name
  Jsii::Type.check_type(@processing_job_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "processingJobName") unless @processing_job_name.nil?
  @processing_output_config = processing_output_config.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnProcessingJob::ProcessingOutputConfigProperty.new(**processing_output_config.transform_keys(&:to_sym)) : processing_output_config
  Jsii::Type.check_type(@processing_output_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuUHJvY2Vzc2luZ0pvYi5Qcm9jZXNzaW5nT3V0cHV0Q29uZmlnUHJvcGVydHkifV19fQ==")), "processingOutputConfig") unless @processing_output_config.nil?
  @stopping_condition = stopping_condition.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnProcessingJob::StoppingConditionProperty.new(**stopping_condition.transform_keys(&:to_sym)) : stopping_condition
  Jsii::Type.check_type(@stopping_condition, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuUHJvY2Vzc2luZ0pvYi5TdG9wcGluZ0NvbmRpdGlvblByb3BlcnR5In1dfX0=")), "stoppingCondition") unless @stopping_condition.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#app_specification ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnProcessingJob::AppSpecificationProperty (readonly)

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

Returns:

See Also:



49
50
51
 
# File 'sagemaker/cfn_processing_job_props.rb', line 49

def app_specification
  @app_specification
end

#environment ⇒ AWSCDK::IResolvable, ... (readonly)

Sets the environment variables in the Docker container.

Returns:

See Also:



66
67
68
 
# File 'sagemaker/cfn_processing_job_props.rb', line 66

def environment
  @environment
end

#experiment_config ⇒ AWSCDK::IResolvable, ... (readonly)

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

Specified when you call the CreateProcessingJob API.

Returns:

See Also:



73
74
75
 
# File 'sagemaker/cfn_processing_job_props.rb', line 73

def experiment_config
  @experiment_config
end

#network_config ⇒ AWSCDK::IResolvable, ... (readonly)

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:

See Also:



78
79
80
 
# File 'sagemaker/cfn_processing_job_props.rb', line 78

def network_config
  @network_config
end

#processing_inputs ⇒ AWSCDK::IResolvable, ... (readonly)

List of input configurations for the processing job.

Returns:

See Also:



83
84
85
 
# File 'sagemaker/cfn_processing_job_props.rb', line 83

def processing_inputs
  @processing_inputs
end

#processing_job_name ⇒ String? (readonly)

The name of the processing job.

If you don't provide a job name, then a unique name is automatically created for the job.

Returns:

  • (String, nil)

See Also:



90
91
92
 
# File 'sagemaker/cfn_processing_job_props.rb', line 90

def processing_job_name
  @processing_job_name
end

#processing_output_config ⇒ AWSCDK::IResolvable, ... (readonly)

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

TargetDevice and TargetPlatform are mutually exclusive, so you need to choose one between the two to specify your target device or platform. If you cannot find your device you want to use from the TargetDevice list, use TargetPlatform to describe the platform of your edge device and CompilerOptions if there are specific settings that are required or recommended to use for particular TargetPlatform.

Returns:

See Also:



97
98
99
 
# File 'sagemaker/cfn_processing_job_props.rb', line 97

def processing_output_config
  @processing_output_config
end

#processing_resources ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnProcessingJob::ProcessingResourcesProperty (readonly)

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

In distributed training, you specify more than one instance.

Returns:

See Also:



56
57
58
 
# File 'sagemaker/cfn_processing_job_props.rb', line 56

def processing_resources
  @processing_resources
end

#role_arn ⇒ String (readonly)

The ARN of the role used to create the processing job.

Returns:

  • (String)

See Also:



61
62
63
 
# File 'sagemaker/cfn_processing_job_props.rb', line 61

def role_arn
  @role_arn
end

#stopping_condition ⇒ AWSCDK::IResolvable, ... (readonly)

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

After the condition is met, the processing job is stopped.

Returns:

See Also:



104
105
106
 
# File 'sagemaker/cfn_processing_job_props.rb', line 104

def stopping_condition
  @stopping_condition
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

An array of key-value pairs.

For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .

Returns:

See Also:



111
112
113
 
# File 'sagemaker/cfn_processing_job_props.rb', line 111

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'sagemaker/cfn_processing_job_props.rb', line 113

def self.jsii_properties
  {
    :app_specification => "appSpecification",
    :processing_resources => "processingResources",
    :role_arn => "roleArn",
    :environment => "environment",
    :experiment_config => "experimentConfig",
    :network_config => "networkConfig",
    :processing_inputs => "processingInputs",
    :processing_job_name => "processingJobName",
    :processing_output_config => "processingOutputConfig",
    :stopping_condition => "stoppingCondition",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'sagemaker/cfn_processing_job_props.rb', line 129

def to_jsii
  result = {}
  result.merge!({
    "appSpecification" => @app_specification,
    "processingResources" => @processing_resources,
    "roleArn" => @role_arn,
    "environment" => @environment,
    "experimentConfig" => @experiment_config,
    "networkConfig" => @network_config,
    "processingInputs" => @processing_inputs,
    "processingJobName" => @processing_job_name,
    "processingOutputConfig" => @processing_output_config,
    "stoppingCondition" => @stopping_condition,
    "tags" => @tags,
  })
  result.compact
end