Class: AWSCDK::StepFunctionsTasks::SageMakerCreateModelJsonataProps

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

Overview

Properties for creating an Amazon SageMaker model using JSONata.

See Also:

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, model_name:, primary_container:, containers: nil, enable_network_isolation: nil, role: nil, subnet_selection: nil, tags: nil, vpc: nil) ⇒ SageMakerCreateModelJsonataProps

Returns a new instance of SageMakerCreateModelJsonataProps.

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.

  • model_name (String) —

    The name of the new model.

  • primary_container (AWSCDK::StepFunctionsTasks::IContainerDefinition) —

    The definition of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.

  • containers (Array<AWSCDK::StepFunctionsTasks::IContainerDefinition>, nil) (defaults to: nil) —

    Specifies the containers in the inference pipeline.

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

    Isolates the model container.

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

    An execution role that you can pass in a CreateModel API request.

  • subnet_selection (AWSCDK::EC2::SubnetSelection, nil) (defaults to: nil) —

    The subnets of the VPC to which the hosted model is connected (Note this parameter is only used when VPC is provided).

  • tags (AWSCDK::StepFunctions::TaskInput, nil) (defaults to: nil) —

    Tags to be applied to the model.

  • vpc (AWSCDK::EC2::IVPC, nil) (defaults to: nil) —

    The VPC that is accessible by the hosted model.



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

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, model_name:, primary_container:, containers: nil, enable_network_isolation: nil, role: nil, subnet_selection: nil, tags: nil, vpc: 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?
  @model_name = model_name
  Jsii::Type.check_type(@model_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelName")
  @primary_container = primary_container
  Jsii::Type.check_type(@primary_container, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5JQ29udGFpbmVyRGVmaW5pdGlvbiJ9")), "primaryContainer")
  @containers = containers
  Jsii::Type.check_type(@containers, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zX3Rhc2tzLklDb250YWluZXJEZWZpbml0aW9uIn0sImtpbmQiOiJhcnJheSJ9fQ==")), "containers") unless @containers.nil?
  @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?
  @role = role
  Jsii::Type.check_type(@role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "role") unless @role.nil?
  @subnet_selection = subnet_selection.is_a?(Hash) ? ::AWSCDK::EC2::SubnetSelection.new(**subnet_selection.transform_keys(&:to_sym)) : subnet_selection
  Jsii::Type.check_type(@subnet_selection, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLlN1Ym5ldFNlbGVjdGlvbiJ9")), "subnetSelection") unless @subnet_selection.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UYXNrSW5wdXQifQ==")), "tags") unless @tags.nil?
  @vpc = vpc
  Jsii::Type.check_type(@vpc, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLklWcGMifQ==")), "vpc") unless @vpc.nil?
end

Instance Attribute Details

#assign ⇒ Hash{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:



140
141
142
 
# File 'step_functions_tasks/sage_maker_create_model_jsonata_props.rb', line 140

def assign
  @assign
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


73
74
75
 
# File 'step_functions_tasks/sage_maker_create_model_jsonata_props.rb', line 73

def comment
  @comment
end

#containers ⇒ Array<AWSCDK::StepFunctionsTasks::IContainerDefinition>? (readonly)

Note:

Default: - None

Specifies the containers in the inference pipeline.

Returns:



165
166
167
 
# File 'step_functions_tasks/sage_maker_create_model_jsonata_props.rb', line 165

def containers
  @containers
end

#credentials ⇒ AWSCDK::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.

Returns:

See Also:



94
95
96
 
# File 'step_functions_tasks/sage_maker_create_model_jsonata_props.rb', line 94

def credentials
  @credentials
end

#enable_network_isolation ⇒ Boolean? (readonly)

Note:

Default: false

Isolates the model container.

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

Returns:

  • (Boolean, nil) 


172
173
174
 
# File 'step_functions_tasks/sage_maker_create_model_jsonata_props.rb', line 172

def enable_network_isolation
  @enable_network_isolation
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



100
101
102
 
# File 'step_functions_tasks/sage_maker_create_model_jsonata_props.rb', line 100

def heartbeat
  @heartbeat
end

#heartbeat_timeout ⇒ AWSCDK::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

Returns:



108
109
110
 
# File 'step_functions_tasks/sage_maker_create_model_jsonata_props.rb', line 108

def heartbeat_timeout
  @heartbeat_timeout
end

#integration_pattern ⇒ AWSCDK::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.

Returns:

See Also:



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

def integration_pattern
  @integration_pattern
end

#model_name ⇒ String (readonly)

The name of the new model.

Returns:

  • (String) 


156
157
158
 
# File 'step_functions_tasks/sage_maker_create_model_jsonata_props.rb', line 156

def model_name
  @model_name
end

#outputs ⇒ Object? (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.

Returns:

  • (Object, nil)

See Also:



152
153
154
 
# File 'step_functions_tasks/sage_maker_create_model_jsonata_props.rb', line 152

def outputs
  @outputs
end

#primary_container ⇒ AWSCDK::StepFunctionsTasks::IContainerDefinition (readonly)

The definition of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.

Returns:



160
161
162
 
# File 'step_functions_tasks/sage_maker_create_model_jsonata_props.rb', line 160

def primary_container
  @primary_container
end

#query_language ⇒ AWSCDK::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.

Returns:



81
82
83
 
# File 'step_functions_tasks/sage_maker_create_model_jsonata_props.rb', line 81

def query_language
  @query_language
end

#role ⇒ AWSCDK::IAM::IRole? (readonly)

Note:

Default: - a role will be created.

An execution role that you can pass in a CreateModel API request.

Returns:



177
178
179
 
# File 'step_functions_tasks/sage_maker_create_model_jsonata_props.rb', line 177

def role
  @role
end

#state_name ⇒ String? (readonly)

Note:

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

Optional name for this state.

Returns:

  • (String, nil) 


86
87
88
 
# File 'step_functions_tasks/sage_maker_create_model_jsonata_props.rb', line 86

def state_name
  @state_name
end

#subnet_selection ⇒ AWSCDK::EC2::SubnetSelection? (readonly)

Note:

Default: - Private Subnets are selected

The subnets of the VPC to which the hosted model is connected (Note this parameter is only used when VPC is provided).

Returns:



182
183
184
 
# File 'step_functions_tasks/sage_maker_create_model_jsonata_props.rb', line 182

def subnet_selection
  @subnet_selection
end

#tags ⇒ AWSCDK::StepFunctions::TaskInput? (readonly)

Note:

Default: - No tags

Tags to be applied to the model.

Returns:



187
188
189
 
# File 'step_functions_tasks/sage_maker_create_model_jsonata_props.rb', line 187

def tags
  @tags
end

#task_timeout ⇒ AWSCDK::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

Returns:



126
127
128
 
# File 'step_functions_tasks/sage_maker_create_model_jsonata_props.rb', line 126

def task_timeout
  @task_timeout
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



132
133
134
 
# File 'step_functions_tasks/sage_maker_create_model_jsonata_props.rb', line 132

def timeout
  @timeout
end

#vpc ⇒ AWSCDK::EC2::IVPC? (readonly)

Note:

Default: - None

The VPC that is accessible by the hosted model.

Returns:



192
193
194
 
# File 'step_functions_tasks/sage_maker_create_model_jsonata_props.rb', line 192

def vpc
  @vpc
end

Class Method Details

.jsii_properties ⇒ Object 



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'step_functions_tasks/sage_maker_create_model_jsonata_props.rb', line 194

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",
    :model_name => "modelName",
    :primary_container => "primaryContainer",
    :containers => "containers",
    :enable_network_isolation => "enableNetworkIsolation",
    :role => "role",
    :subnet_selection => "subnetSelection",
    :tags => "tags",
    :vpc => "vpc",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'step_functions_tasks/sage_maker_create_model_jsonata_props.rb', line 218

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,
    "modelName" => @model_name,
    "primaryContainer" => @primary_container,
    "containers" => @containers,
    "enableNetworkIsolation" => @enable_network_isolation,
    "role" => @role,
    "subnetSelection" => @subnet_selection,
    "tags" => @tags,
    "vpc" => @vpc,
  })
  result.compact
end