SageMakerCreateTrainingJob
Class representing the SageMaker Create Training Job task.
Import
import { SageMakerCreateTrainingJob } from 'aws-cdk-lib/aws-stepfunctions-tasks';Or use the module namespace:
import * as stepfunctions_tasks from 'aws-cdk-lib/aws-stepfunctions-tasks';
// stepfunctions_tasks.SageMakerCreateTrainingJobProperties
Configuration passed to the constructor as SageMakerCreateTrainingJobProps.
algorithmSpecificationRequiredAlgorithmSpecificationIdentifies the training algorithm to use.
outputDataConfigRequiredOutputDataConfigIdentifies the Amazon S3 location where you want Amazon SageMaker to save the results of model training.
trainingJobNameRequiredstringTraining Job Name.
enableNetworkIsolationOptionalbooleanIsolates the training container. No inbound or outbound network calls can be made to or from the training container.
Default: false
environmentOptional{ [key: string]: string }Environment variables to set in the Docker container.
Default: - No environment variables
hyperparametersOptional{ [key: string]: any }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
Default: - No hyperparameters
inputDataConfigOptionalChannel[]Describes the various datasets (e.g. train, validation, test) and the Amazon S3 location where stored.
Default: - No inputDataConfig
resourceConfigOptionalResourceConfigSpecifies the resources, ML compute instances, and ML storage volumes to deploy for model training.
Default: - 1 instance of EC2 `M4.XLarge` with `10GB` volume
roleOptionalIRoleRole 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
Default: - a role will be created.
stoppingConditionOptionalStoppingConditionSets a time limit for training.
Default: - max runtime of 1 hour
tagsOptional{ [key: string]: string }Tags to be applied to the train job.
Default: - No tags
vpcConfigOptionalVpcConfigSpecifies the VPC that you want your training job to connect to.
Default: - No VPC
2 properties inherited from TaskStateBaseProps
resultPathOptionalinherited from TaskStateBasePropsstringJSONPath 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.
Default: $
resultSelectorOptionalinherited from TaskStateBaseProps{ [key: string]: any }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.
Default: - None
3 properties inherited from StateBaseProps
commentOptionalinherited from StateBasePropsstringA comment describing this state.
Default: No comment
queryLanguageOptionalinherited from StateBasePropsQueryLanguageThe name of the query language used by the state. If the state does not contain a `queryLanguage` field, then it will use the query language specified in the top-level `queryLanguage` field.
Default: - JSONPath
stateNameOptionalinherited from StateBasePropsstringOptional name for this state.
Default: - The construct ID will be used as state name
6 properties inherited from TaskStateBaseOptions
credentialsOptionalinherited from TaskStateBaseOptionsCredentialsCredentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations.
Default: - None (Task is executed using the State Machine's execution role)
heartbeatOptionalDeprecatedinherited from TaskStateBaseOptionsDurationTimeout for the heartbeat.
Default: - None
Deprecated: use `heartbeatTimeout`
heartbeatTimeoutOptionalinherited from TaskStateBaseOptionsTimeoutTimeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
integrationPatternOptionalinherited from TaskStateBaseOptionsIntegrationPatternAWS 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.
Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks.
`IntegrationPattern.RUN_JOB` for the following exceptions:
`BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.
taskTimeoutOptionalinherited from TaskStateBaseOptionsTimeoutTimeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
timeoutOptionalDeprecatedinherited from TaskStateBaseOptionsDurationTimeout for the task.
Default: - None
Deprecated: use `taskTimeout`
1 property inherited from AssignableStateOptions
assignOptionalinherited from AssignableStateOptions{ [key: string]: any }Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps.
Default: - Not assign variables
2 properties inherited from JsonPathCommonOptions
inputPathOptionalinherited from JsonPathCommonOptionsstringJSONPath 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 {}.
Default: $
outputPathOptionalinherited from JsonPathCommonOptionsstringJSONPath 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 {}.
Default: $
1 property inherited from JsonataCommonOptions
outputsOptionalinherited from JsonataCommonOptionsanyUsed 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.
Default: - $states.result or $states.errorOutput
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-stepfunctions-tasks