Class: AWSCDK::StepFunctionsTasks::SageMakerCreateTrainingJobJsonataProps

Inherits:
AWSCDK::StepFunctions::TaskStateJsonataBaseProps
  • Object
show all
Defined in:
step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb

Overview

Properties for creating an Amazon SageMaker training job using JSONata.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(comment: nil, query_language: nil, state_name: nil, credentials: nil, heartbeat: nil, heartbeat_timeout: nil, integration_pattern: nil, task_timeout: nil, timeout: nil, assign: nil, outputs: nil, algorithm_specification:, output_data_config:, training_job_name:, enable_network_isolation: nil, environment: nil, hyperparameters: nil, input_data_config: nil, resource_config: nil, role: nil, stopping_condition: nil, tags: nil, vpc_config: nil) ⇒ SageMakerCreateTrainingJobJsonataProps

Returns a new instance of SageMakerCreateTrainingJobJsonataProps.

Parameters:

  • comment (String, nil) (defaults to: nil)

    A comment describing this state.

  • query_language (AWSCDK::StepFunctions::QueryLanguage, nil) (defaults to: nil)

    The name of the query language used by the state.

  • state_name (String, nil) (defaults to: nil)

    Optional name for this state.

  • credentials (AWSCDK::StepFunctions::Credentials, nil) (defaults to: nil)

    Credentials for an IAM Role that the State Machine assumes for executing the task.

  • heartbeat (AWSCDK::Duration, nil) (defaults to: nil)

    Timeout for the heartbeat.

  • heartbeat_timeout (AWSCDK::StepFunctions::Timeout, nil) (defaults to: nil)

    Timeout for the heartbeat.

  • integration_pattern (AWSCDK::StepFunctions::IntegrationPattern, nil) (defaults to: nil)

    AWS Step Functions integrates with services directly in the Amazon States Language.

  • task_timeout (AWSCDK::StepFunctions::Timeout, nil) (defaults to: nil)

    Timeout for the task.

  • timeout (AWSCDK::Duration, nil) (defaults to: nil)

    Timeout for the task.

  • assign (Hash{String => Object}, nil) (defaults to: nil)

    Workflow variables to store in this step.

  • outputs (Object, nil) (defaults to: nil)

    Used to specify and transform output from the state.

  • algorithm_specification (AWSCDK::StepFunctionsTasks::AlgorithmSpecification)

    Identifies the training algorithm to use.

  • output_data_config (AWSCDK::StepFunctionsTasks::OutputDataConfig)

    Identifies the Amazon S3 location where you want Amazon SageMaker to save the results of model training.

  • training_job_name (String)

    Training Job Name.

  • enable_network_isolation (Boolean, nil) (defaults to: nil)

    Isolates the training container.

  • environment (Hash{String => String}, nil) (defaults to: nil)

    Environment variables to set in the Docker container.

  • hyperparameters (Hash{String => Object}, nil) (defaults to: nil)

    Algorithm-specific parameters that influence the quality of the model.

  • input_data_config (Array<AWSCDK::StepFunctionsTasks::Channel>, nil) (defaults to: nil)

    Describes the various datasets (e.g. train, validation, test) and the Amazon S3 location where stored.

  • resource_config (AWSCDK::StepFunctionsTasks::ResourceConfig, nil) (defaults to: nil)

    Specifies the resources, ML compute instances, and ML storage volumes to deploy for model training.

  • role (AWSCDK::IAM::IRole, nil) (defaults to: nil)

    Role for the Training Job.

  • stopping_condition (AWSCDK::StepFunctionsTasks::StoppingCondition, nil) (defaults to: nil)

    Sets a time limit for training.

  • tags (Hash{String => String}, nil) (defaults to: nil)

    Tags to be applied to the train job.

  • vpc_config (AWSCDK::StepFunctionsTasks::VPCConfig, nil) (defaults to: nil)

    Specifies the VPC that you want your training job to connect to.



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
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 30

def initialize(comment: nil, query_language: nil, state_name: nil, credentials: nil, heartbeat: nil, heartbeat_timeout: nil, integration_pattern: nil, task_timeout: nil, timeout: nil, assign: nil, outputs: nil, algorithm_specification:, output_data_config:, training_job_name:, enable_network_isolation: nil, environment: nil, hyperparameters: nil, input_data_config: nil, resource_config: nil, role: nil, stopping_condition: nil, tags: nil, vpc_config: nil)
  @comment = comment
  Jsii::Type.check_type(@comment, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "comment") unless @comment.nil?
  @query_language = query_language
  Jsii::Type.check_type(@query_language, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5RdWVyeUxhbmd1YWdlIn0=")), "queryLanguage") unless @query_language.nil?
  @state_name = state_name
  Jsii::Type.check_type(@state_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stateName") unless @state_name.nil?
  @credentials = credentials.is_a?(Hash) ? ::AWSCDK::StepFunctions::Credentials.new(**credentials.transform_keys(&:to_sym)) : credentials
  Jsii::Type.check_type(@credentials, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5DcmVkZW50aWFscyJ9")), "credentials") unless @credentials.nil?
  @heartbeat = heartbeat
  Jsii::Type.check_type(@heartbeat, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "heartbeat") unless @heartbeat.nil?
  @heartbeat_timeout = heartbeat_timeout
  Jsii::Type.check_type(@heartbeat_timeout, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UaW1lb3V0In0=")), "heartbeatTimeout") unless @heartbeat_timeout.nil?
  @integration_pattern = integration_pattern
  Jsii::Type.check_type(@integration_pattern, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5JbnRlZ3JhdGlvblBhdHRlcm4ifQ==")), "integrationPattern") unless @integration_pattern.nil?
  @task_timeout = task_timeout
  Jsii::Type.check_type(@task_timeout, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UaW1lb3V0In0=")), "taskTimeout") unless @task_timeout.nil?
  @timeout = timeout
  Jsii::Type.check_type(@timeout, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "timeout") unless @timeout.nil?
  @assign = assign
  Jsii::Type.check_type(@assign, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "assign") unless @assign.nil?
  @outputs = outputs
  Jsii::Type.check_type(@outputs, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "outputs") unless @outputs.nil?
  @algorithm_specification = algorithm_specification.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::AlgorithmSpecification.new(**algorithm_specification.transform_keys(&:to_sym)) : algorithm_specification
  Jsii::Type.check_type(@algorithm_specification, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5BbGdvcml0aG1TcGVjaWZpY2F0aW9uIn0=")), "algorithmSpecification")
  @output_data_config = output_data_config.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::OutputDataConfig.new(**output_data_config.transform_keys(&:to_sym)) : output_data_config
  Jsii::Type.check_type(@output_data_config, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5PdXRwdXREYXRhQ29uZmlnIn0=")), "outputDataConfig")
  @training_job_name = training_job_name
  Jsii::Type.check_type(@training_job_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "trainingJobName")
  @enable_network_isolation = enable_network_isolation
  Jsii::Type.check_type(@enable_network_isolation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "enableNetworkIsolation") unless @enable_network_isolation.nil?
  @environment = environment
  Jsii::Type.check_type(@environment, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "environment") unless @environment.nil?
  @hyperparameters = hyperparameters
  Jsii::Type.check_type(@hyperparameters, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "hyperparameters") unless @hyperparameters.nil?
  @input_data_config = input_data_config.is_a?(Array) ? input_data_config.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::Channel.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : input_data_config
  Jsii::Type.check_type(@input_data_config, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zX3Rhc2tzLkNoYW5uZWwifSwia2luZCI6ImFycmF5In19")), "inputDataConfig") unless @input_data_config.nil?
  @resource_config = resource_config.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::ResourceConfig.new(**resource_config.transform_keys(&:to_sym)) : resource_config
  Jsii::Type.check_type(@resource_config, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5SZXNvdXJjZUNvbmZpZyJ9")), "resourceConfig") unless @resource_config.nil?
  @role = role
  Jsii::Type.check_type(@role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "role") unless @role.nil?
  @stopping_condition = stopping_condition.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::StoppingCondition.new(**stopping_condition.transform_keys(&:to_sym)) : stopping_condition
  Jsii::Type.check_type(@stopping_condition, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5TdG9wcGluZ0NvbmRpdGlvbiJ9")), "stoppingCondition") unless @stopping_condition.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
  @vpc_config = vpc_config.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::VPCConfig.new(**vpc_config.transform_keys(&:to_sym)) : vpc_config
  Jsii::Type.check_type(@vpc_config, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5WcGNDb25maWcifQ==")), "vpcConfig") unless @vpc_config.nil?
end

Instance Attribute Details

#algorithm_specificationAWSCDK::StepFunctionsTasks::AlgorithmSpecification (readonly)

Identifies the training algorithm to use.



166
167
168
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 166

def algorithm_specification
  @algorithm_specification
end

#assignHash{String => Object}? (readonly)

Note:

Default: - Not assign variables

Workflow variables to store in this step.

Using workflow variables, you can store data in a step and retrieve that data in future steps.

Returns:

  • (Hash{String => Object}, nil)

See Also:



150
151
152
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 150

def assign
  @assign
end

#commentString? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil)


83
84
85
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 83

def comment
  @comment
end

#credentialsAWSCDK::StepFunctions::Credentials? (readonly)

Note:

Default: - None (Task is executed using the State Machine's execution role)

Credentials for an IAM Role that the State Machine assumes for executing the task.

This enables cross-account resource invocations.



104
105
106
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 104

def credentials
  @credentials
end

#enable_network_isolationBoolean? (readonly)

Note:

Default: false

Isolates the training container.

No inbound or outbound network calls can be made to or from the training container.

Returns:

  • (Boolean, nil)


181
182
183
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 181

def enable_network_isolation
  @enable_network_isolation
end

#environmentHash{String => String}? (readonly)

Note:

Default: - No environment variables

Environment variables to set in the Docker container.

Returns:

  • (Hash{String => String}, nil)


186
187
188
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 186

def environment
  @environment
end

#heartbeatAWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



110
111
112
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 110

def heartbeat
  @heartbeat
end

#heartbeat_timeoutAWSCDK::StepFunctions::Timeout? (readonly)

Note:

Default: - None

Timeout for the heartbeat.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface



118
119
120
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 118

def heartbeat_timeout
  @heartbeat_timeout
end

#hyperparametersHash{String => Object}? (readonly)

Note:

Default: - No hyperparameters

Algorithm-specific parameters that influence the quality of the model.

Set hyperparameters before you start the learning process. For a list of hyperparameters provided by Amazon SageMaker

Returns:

  • (Hash{String => Object}, nil)

See Also:



195
196
197
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 195

def hyperparameters
  @hyperparameters
end

#input_data_configArray<AWSCDK::StepFunctionsTasks::Channel>? (readonly)

Note:

Default: - No inputDataConfig

Describes the various datasets (e.g. train, validation, test) and the Amazon S3 location where stored.

Returns:



200
201
202
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 200

def input_data_config
  @input_data_config
end

#integration_patternAWSCDK::StepFunctions::IntegrationPattern? (readonly)

Note:

Default: - IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.



128
129
130
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 128

def integration_pattern
  @integration_pattern
end

#output_data_configAWSCDK::StepFunctionsTasks::OutputDataConfig (readonly)

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results of model training.



170
171
172
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 170

def output_data_config
  @output_data_config
end

#outputsObject? (readonly)

Note:

Default: - $states.result or $states.errorOutput

Used to specify and transform output from the state.

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by % characters. Output also accepts a JSONata expression directly.



162
163
164
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 162

def outputs
  @outputs
end

#query_languageAWSCDK::StepFunctions::QueryLanguage? (readonly)

Note:

Default: - JSONPath

The name of the query language used by the state.

If the state does not contain a query_language field, then it will use the query language specified in the top-level query_language field.



91
92
93
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 91

def query_language
  @query_language
end

#resource_configAWSCDK::StepFunctionsTasks::ResourceConfig? (readonly)

Note:

Default: - 1 instance of EC2 M4.XLarge with 10GB volume

Specifies the resources, ML compute instances, and ML storage volumes to deploy for model training.



205
206
207
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 205

def resource_config
  @resource_config
end

#roleAWSCDK::IAM::IRole? (readonly)

Note:

Default: - a role will be created.

Role for the Training Job.

The role must be granted all necessary permissions for the SageMaker training job to be able to operate.

See https://docs.aws.amazon.com/fr_fr/sagemaker/latest/dg/sagemaker-roles.html#sagemaker-roles-createtrainingjob-perms

Returns:



215
216
217
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 215

def role
  @role
end

#state_nameString? (readonly)

Note:

Default: - The construct ID will be used as state name

Optional name for this state.

Returns:

  • (String, nil)


96
97
98
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 96

def state_name
  @state_name
end

#stopping_conditionAWSCDK::StepFunctionsTasks::StoppingCondition? (readonly)

Note:

Default: - max runtime of 1 hour

Sets a time limit for training.



220
221
222
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 220

def stopping_condition
  @stopping_condition
end

#tagsHash{String => String}? (readonly)

Note:

Default: - No tags

Tags to be applied to the train job.

Returns:

  • (Hash{String => String}, nil)


225
226
227
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 225

def tags
  @tags
end

#task_timeoutAWSCDK::StepFunctions::Timeout? (readonly)

Note:

Default: - None

Timeout for the task.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface



136
137
138
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 136

def task_timeout
  @task_timeout
end

#timeoutAWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



142
143
144
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 142

def timeout
  @timeout
end

#training_job_nameString (readonly)

Training Job Name.

Returns:

  • (String)


174
175
176
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 174

def training_job_name
  @training_job_name
end

#vpc_configAWSCDK::StepFunctionsTasks::VPCConfig? (readonly)

Note:

Default: - No VPC

Specifies the VPC that you want your training job to connect to.



230
231
232
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 230

def vpc_config
  @vpc_config
end

Class Method Details

.jsii_propertiesObject



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 232

def self.jsii_properties
  {
    :comment => "comment",
    :query_language => "queryLanguage",
    :state_name => "stateName",
    :credentials => "credentials",
    :heartbeat => "heartbeat",
    :heartbeat_timeout => "heartbeatTimeout",
    :integration_pattern => "integrationPattern",
    :task_timeout => "taskTimeout",
    :timeout => "timeout",
    :assign => "assign",
    :outputs => "outputs",
    :algorithm_specification => "algorithmSpecification",
    :output_data_config => "outputDataConfig",
    :training_job_name => "trainingJobName",
    :enable_network_isolation => "enableNetworkIsolation",
    :environment => "environment",
    :hyperparameters => "hyperparameters",
    :input_data_config => "inputDataConfig",
    :resource_config => "resourceConfig",
    :role => "role",
    :stopping_condition => "stoppingCondition",
    :tags => "tags",
    :vpc_config => "vpcConfig",
  }
end

Instance Method Details

#to_jsiiObject



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
# File 'step_functions_tasks/sage_maker_create_training_job_jsonata_props.rb', line 260

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "comment" => @comment,
    "queryLanguage" => @query_language,
    "stateName" => @state_name,
    "credentials" => @credentials,
    "heartbeat" => @heartbeat,
    "heartbeatTimeout" => @heartbeat_timeout,
    "integrationPattern" => @integration_pattern,
    "taskTimeout" => @task_timeout,
    "timeout" => @timeout,
    "assign" => @assign,
    "outputs" => @outputs,
    "algorithmSpecification" => @algorithm_specification,
    "outputDataConfig" => @output_data_config,
    "trainingJobName" => @training_job_name,
    "enableNetworkIsolation" => @enable_network_isolation,
    "environment" => @environment,
    "hyperparameters" => @hyperparameters,
    "inputDataConfig" => @input_data_config,
    "resourceConfig" => @resource_config,
    "role" => @role,
    "stoppingCondition" => @stopping_condition,
    "tags" => @tags,
    "vpcConfig" => @vpc_config,
  })
  result.compact
end