Class: AWSCDK::StepFunctionsTasks::BedrockCreateModelCustomizationJobProps

Inherits:
AWSCDK::StepFunctions::TaskStateBaseProps
  • Object
show all
Defined in:
step_functions_tasks/bedrock_create_model_customization_job_props.rb

Overview

Properties for invoking a Bedrock Model.

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, input_path: nil, output_path: nil, outputs: nil, result_path: nil, result_selector: nil, base_model:, custom_model_name:, job_name:, output_data:, training_data:, client_request_token: nil, customization_type: nil, custom_model_kms_key: nil, custom_model_tags: nil, hyper_parameters: nil, job_tags: nil, role: nil, validation_data: nil, vpc_config: nil) ⇒ BedrockCreateModelCustomizationJobProps

Returns a new instance of BedrockCreateModelCustomizationJobProps.

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.

  • input_path (String, nil) (defaults to: nil) —

    JSONPath expression to select part of the state to be the input to this state.

  • output_path (String, nil) (defaults to: nil) —

    JSONPath expression to select part of the state to be the output to this state.

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

    Used to specify and transform output from the state.

  • result_path (String, nil) (defaults to: nil) —

    JSONPath expression to indicate where to inject the state's output.

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

    The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

  • base_model (AWSCDK::Bedrock::IModel) —

    The base model.

  • custom_model_name (String) —

    A name for the resulting custom model.

  • job_name (String) —

    A name for the fine-tuning job.

  • output_data (AWSCDK::StepFunctionsTasks::OutputBucketConfiguration) —

    The S3 bucket configuration where the output data is stored.

  • training_data (AWSCDK::StepFunctionsTasks::TrainingBucketConfiguration) —

    The S3 bucket configuration where the training data is stored.

  • client_request_token (String, nil) (defaults to: nil) —

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time.

  • customization_type (AWSCDK::StepFunctionsTasks::CustomizationType, nil) (defaults to: nil) —

    The customization type.

  • custom_model_kms_key (AWSCDK::KMS::IKey, nil) (defaults to: nil) —

    The custom model is encrypted at rest using this key.

  • custom_model_tags (Array<AWSCDK::StepFunctionsTasks::CustomModelTag>, nil) (defaults to: nil) —

    Tags to attach to the resulting custom model.

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

    Parameters related to tuning the model.

  • job_tags (Array<AWSCDK::StepFunctionsTasks::CustomModelTag>, nil) (defaults to: nil) —

    Tags to attach to the job.

  • role (AWSCDK::Interfaces::AWSIAM::IRoleRef, nil) (defaults to: nil) —

    The IAM role that Amazon Bedrock can assume to perform tasks on your behalf.

  • validation_data (Array<AWSCDK::StepFunctionsTasks::ValidationBucketConfiguration>, nil) (defaults to: nil) —

    The S3 bucket configuration where the validation data is stored.

  • vpc_config (AWSCDK::StepFunctionsTasks::IBedrockCreateModelCustomizationJobVPCConfig, nil) (defaults to: nil) —

    The VPC configuration.



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 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 36

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, input_path: nil, output_path: nil, outputs: nil, result_path: nil, result_selector: nil, base_model:, custom_model_name:, job_name:, output_data:, training_data:, client_request_token: nil, customization_type: nil, custom_model_kms_key: nil, custom_model_tags: nil, hyper_parameters: nil, job_tags: nil, role: nil, validation_data: 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?
  @input_path = input_path
  Jsii::Type.check_type(@input_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inputPath") unless @input_path.nil?
  @output_path = output_path
  Jsii::Type.check_type(@output_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputPath") unless @output_path.nil?
  @outputs = outputs
  Jsii::Type.check_type(@outputs, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "outputs") unless @outputs.nil?
  @result_path = result_path
  Jsii::Type.check_type(@result_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resultPath") unless @result_path.nil?
  @result_selector = result_selector
  Jsii::Type.check_type(@result_selector, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "resultSelector") unless @result_selector.nil?
  @base_model = base_model
  Jsii::Type.check_type(@base_model, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9jay5JTW9kZWwifQ==")), "baseModel")
  @custom_model_name = custom_model_name
  Jsii::Type.check_type(@custom_model_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customModelName")
  @job_name = job_name
  Jsii::Type.check_type(@job_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "jobName")
  @output_data = output_data.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::OutputBucketConfiguration.new(**output_data.transform_keys(&:to_sym)) : output_data
  Jsii::Type.check_type(@output_data, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5PdXRwdXRCdWNrZXRDb25maWd1cmF0aW9uIn0=")), "outputData")
  @training_data = training_data.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::TrainingBucketConfiguration.new(**training_data.transform_keys(&:to_sym)) : training_data
  Jsii::Type.check_type(@training_data, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5UcmFpbmluZ0J1Y2tldENvbmZpZ3VyYXRpb24ifQ==")), "trainingData")
  @client_request_token = client_request_token
  Jsii::Type.check_type(@client_request_token, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientRequestToken") unless @client_request_token.nil?
  @customization_type = customization_type
  Jsii::Type.check_type(@customization_type, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5DdXN0b21pemF0aW9uVHlwZSJ9")), "customizationType") unless @customization_type.nil?
  @custom_model_kms_key = custom_model_kms_key
  Jsii::Type.check_type(@custom_model_kms_key, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa21zLklLZXkifQ==")), "customModelKmsKey") unless @custom_model_kms_key.nil?
  @custom_model_tags = custom_model_tags.is_a?(Array) ? custom_model_tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::CustomModelTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : custom_model_tags
  Jsii::Type.check_type(@custom_model_tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zX3Rhc2tzLkN1c3RvbU1vZGVsVGFnIn0sImtpbmQiOiJhcnJheSJ9fQ==")), "customModelTags") unless @custom_model_tags.nil?
  @hyper_parameters = hyper_parameters
  Jsii::Type.check_type(@hyper_parameters, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "hyperParameters") unless @hyper_parameters.nil?
  @job_tags = job_tags.is_a?(Array) ? job_tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::CustomModelTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : job_tags
  Jsii::Type.check_type(@job_tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zX3Rhc2tzLkN1c3RvbU1vZGVsVGFnIn0sImtpbmQiOiJhcnJheSJ9fQ==")), "jobTags") unless @job_tags.nil?
  @role = role
  Jsii::Type.check_type(@role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pYW0uSVJvbGVSZWYifQ==")), "role") unless @role.nil?
  @validation_data = validation_data.is_a?(Array) ? validation_data.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::ValidationBucketConfiguration.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : validation_data
  Jsii::Type.check_type(@validation_data, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zX3Rhc2tzLlZhbGlkYXRpb25CdWNrZXRDb25maWd1cmF0aW9uIn0sImtpbmQiOiJhcnJheSJ9fQ==")), "validationData") unless @validation_data.nil?
  @vpc_config = vpc_config
  Jsii::Type.check_type(@vpc_config, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5JQmVkcm9ja0NyZWF0ZU1vZGVsQ3VzdG9taXphdGlvbkpvYlZwY0NvbmZpZyJ9")), "vpcConfig") unless @vpc_config.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:



168
169
170
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 168

def assign
  @assign
end

#base_model ⇒ AWSCDK::Bedrock::IModel (readonly)

The base model.

Returns:



217
218
219
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 217

def base_model
  @base_model
end

#client_request_token ⇒ String? (readonly)

Note:

Default: - no client request token

A unique, case-sensitive identifier to ensure that the API request completes no more than one time.

If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error.

The maximum length is 256 characters.

Returns:

  • (String, nil)

See Also:



249
250
251
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 249

def client_request_token
  @client_request_token
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


101
102
103
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 101

def comment
  @comment
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:



122
123
124
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 122

def credentials
  @credentials
end

#custom_model_kms_key ⇒ AWSCDK::KMS::IKey? (readonly)

Note:

Default: - encrypted with the AWS owned key

The custom model is encrypted at rest using this key.

Returns:

See Also:



260
261
262
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 260

def custom_model_kms_key
  @custom_model_kms_key
end

#custom_model_name ⇒ String (readonly)

A name for the resulting custom model.

The maximum length is 63 characters.

Returns:

  • (String) 


223
224
225
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 223

def custom_model_name
  @custom_model_name
end

#custom_model_tags ⇒ Array<AWSCDK::StepFunctionsTasks::CustomModelTag>? (readonly)

Note:

Default: - no tags

Tags to attach to the resulting custom model.

The maximum number of tags is 200.

Returns:



267
268
269
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 267

def custom_model_tags
  @custom_model_tags
end

#customization_type ⇒ AWSCDK::StepFunctionsTasks::CustomizationType? (readonly)

Note:

Default: FINE_TUNING

The customization type.

Returns:



254
255
256
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 254

def customization_type
  @customization_type
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



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

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:



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

def heartbeat_timeout
  @heartbeat_timeout
end

#hyper_parameters ⇒ Hash{String => String}? (readonly)

Note:

Default: - use default hyperparameters

Parameters related to tuning the model.

Returns:

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

See Also:



273
274
275
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 273

def hyper_parameters
  @hyper_parameters
end

#input_path ⇒ String? (readonly)

Note:

Default: $

JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Returns:

  • (String, nil) 


176
177
178
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 176

def input_path
  @input_path
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:



146
147
148
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 146

def integration_pattern
  @integration_pattern
end

#job_name ⇒ String (readonly)

A name for the fine-tuning job.

The maximum length is 63 characters.

Returns:

  • (String) 


229
230
231
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 229

def job_name
  @job_name
end

#job_tags ⇒ Array<AWSCDK::StepFunctionsTasks::CustomModelTag>? (readonly)

Note:

Default: - no tags

Tags to attach to the job.

The maximum number of tags is 200.

Returns:



280
281
282
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 280

def job_tags
  @job_tags
end

#output_data ⇒ AWSCDK::StepFunctionsTasks::OutputBucketConfiguration (readonly)

The S3 bucket configuration where the output data is stored.

Returns:

See Also:



234
235
236
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 234

def output_data
  @output_data
end

#output_path ⇒ String? (readonly)

Note:

Default: $

JSONPath expression to select part of the state to be the output to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Returns:

  • (String, nil) 


184
185
186
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 184

def output_path
  @output_path
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:



196
197
198
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 196

def outputs
  @outputs
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:



109
110
111
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 109

def query_language
  @query_language
end

#result_path ⇒ String? (readonly)

Note:

Default: $

JSONPath expression to indicate where to inject the state's output.

May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

Returns:

  • (String, nil) 


204
205
206
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 204

def result_path
  @result_path
end

#result_selector ⇒ Hash{String => Object}? (readonly)

Note:

Default: - None

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

Returns:

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

See Also:



213
214
215
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 213

def result_selector
  @result_selector
end

#role ⇒ AWSCDK::Interfaces::AWSIAM::IRoleRef? (readonly)

Note:

Default: - use auto generated role

The IAM role that Amazon Bedrock can assume to perform tasks on your behalf.

For example, during model training, Amazon Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission.

Returns:



289
290
291
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 289

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) 


114
115
116
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 114

def state_name
  @state_name
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:



154
155
156
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 154

def task_timeout
  @task_timeout
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



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

def timeout
  @timeout
end

#training_data ⇒ AWSCDK::StepFunctionsTasks::TrainingBucketConfiguration (readonly)

The S3 bucket configuration where the training data is stored.

Returns:

See Also:



239
240
241
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 239

def training_data
  @training_data
end

#validation_data ⇒ Array<AWSCDK::StepFunctionsTasks::ValidationBucketConfiguration>? (readonly)

Note:

Default: undefined - validate using a subset of the training data

The S3 bucket configuration where the validation data is stored.

If you don't provide a validation dataset, specify the evaluation percentage by the Evaluation percentage hyperparameter.

The maximum number is 10.

Returns:

See Also:



299
300
301
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 299

def validation_data
  @validation_data
end

#vpc_config ⇒ AWSCDK::StepFunctionsTasks::IBedrockCreateModelCustomizationJobVPCConfig? (readonly)

Note:

Default: - no VPC configuration

The VPC configuration.

Returns:



304
305
306
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 304

def vpc_config
  @vpc_config
end

Class Method Details

.jsii_properties ⇒ Object 



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 306

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",
    :input_path => "inputPath",
    :output_path => "outputPath",
    :outputs => "outputs",
    :result_path => "resultPath",
    :result_selector => "resultSelector",
    :base_model => "baseModel",
    :custom_model_name => "customModelName",
    :job_name => "jobName",
    :output_data => "outputData",
    :training_data => "trainingData",
    :client_request_token => "clientRequestToken",
    :customization_type => "customizationType",
    :custom_model_kms_key => "customModelKmsKey",
    :custom_model_tags => "customModelTags",
    :hyper_parameters => "hyperParameters",
    :job_tags => "jobTags",
    :role => "role",
    :validation_data => "validationData",
    :vpc_config => "vpcConfig",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'step_functions_tasks/bedrock_create_model_customization_job_props.rb', line 340

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,
    "inputPath" => @input_path,
    "outputPath" => @output_path,
    "outputs" => @outputs,
    "resultPath" => @result_path,
    "resultSelector" => @result_selector,
    "baseModel" => @base_model,
    "customModelName" => @custom_model_name,
    "jobName" => @job_name,
    "outputData" => @output_data,
    "trainingData" => @training_data,
    "clientRequestToken" => @client_request_token,
    "customizationType" => @customization_type,
    "customModelKmsKey" => @custom_model_kms_key,
    "customModelTags" => @custom_model_tags,
    "hyperParameters" => @hyper_parameters,
    "jobTags" => @job_tags,
    "role" => @role,
    "validationData" => @validation_data,
    "vpcConfig" => @vpc_config,
  })
  result.compact
end