interface SageMakerCreateModelProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.StepFunctions.Tasks.SageMakerCreateModelProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#SageMakerCreateModelProps |
![]() | software.amazon.awscdk.services.stepfunctions.tasks.SageMakerCreateModelProps |
![]() | aws_cdk.aws_stepfunctions_tasks.SageMakerCreateModelProps |
![]() | aws-cdk-lib » aws_stepfunctions_tasks » SageMakerCreateModelProps |
Properties for creating an Amazon SageMaker model.
See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-sagemaker.html
Example
new tasks.SageMakerCreateModel(this, 'Sagemaker', {
modelName: 'MyModel',
primaryContainer: new tasks.ContainerDefinition({
image: tasks.DockerImage.fromJsonExpression(sfn.JsonPath.stringAt('$.Model.imageName')),
mode: tasks.Mode.SINGLE_MODEL,
modelS3Location: tasks.S3Location.fromJsonExpression('$.TrainingJob.ModelArtifacts.S3ModelArtifacts'),
}),
});
Properties
Name | Type | Description |
---|---|---|
model | string | The name of the new model. |
primary | IContainer | 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. |
assign? | { [string]: any } | Workflow variables to store in this step. |
comment? | string | A comment describing this state. |
containers? | IContainer [] | Specifies the containers in the inference pipeline. |
credentials? | Credentials | Credentials for an IAM Role that the State Machine assumes for executing the task. |
enable | boolean | Isolates the model container. |
heartbeat? | Duration | Timeout for the heartbeat. |
heartbeat | Timeout | Timeout for the heartbeat. |
input | string | JSONPath expression to select part of the state to be the input to this state. |
integration | Integration | AWS Step Functions integrates with services directly in the Amazon States Language. |
output | string | JSONPath expression to select part of the state to be the output to this state. |
outputs? | any | Used to specify and transform output from the state. |
query | Query | The name of the query language used by the state. |
result | string | JSONPath expression to indicate where to inject the state's output. |
result | { [string]: any } | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
role? | IRole | An execution role that you can pass in a CreateModel API request. |
state | string | Optional name for this state. |
subnet | Subnet | The subnets of the VPC to which the hosted model is connected (Note this parameter is only used when VPC is provided). |
tags? | Task | Tags to be applied to the model. |
task | Timeout | Timeout for the task. |
timeout? | Duration | Timeout for the task. |
vpc? | IVpc | The VPC that is accessible by the hosted model. |
modelName
Type:
string
The name of the new model.
primaryContainer
Type:
IContainer
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.
assign?
Type:
{ [string]: any }
(optional, 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.
comment?
Type:
string
(optional, default: No comment)
A comment describing this state.
containers?
Type:
IContainer
[]
(optional, default: None)
Specifies the containers in the inference pipeline.
credentials?
Type:
Credentials
(optional, 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.
enableNetworkIsolation?
Type:
boolean
(optional, default: false)
Isolates the model container.
No inbound or outbound network calls can be made to or from the model container.
heartbeat?
⚠️ Deprecated: use heartbeatTimeout
Type:
Duration
(optional, default: None)
Timeout for the heartbeat.
heartbeatTimeout?
Type:
Timeout
(optional, default: None)
Timeout for the heartbeat.
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
inputPath?
Type:
string
(optional, 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 {}.
integrationPattern?
Type:
Integration
(optional, 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.
outputPath?
Type:
string
(optional, 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 {}.
outputs?
Type:
any
(optional, 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.
queryLanguage?
Type:
Query
(optional, default: JSONPath)
The 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.
resultPath?
Type:
string
(optional, 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.
resultSelector?
Type:
{ [string]: any }
(optional, 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.
role?
Type:
IRole
(optional, default: a role will be created.)
An execution role that you can pass in a CreateModel API request.
stateName?
Type:
string
(optional, default: The construct ID will be used as state name)
Optional name for this state.
subnetSelection?
Type:
Subnet
(optional, 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).
tags?
Type:
Task
(optional, default: No tags)
Tags to be applied to the model.
taskTimeout?
Type:
Timeout
(optional, default: None)
Timeout for the task.
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
timeout?
⚠️ Deprecated: use taskTimeout
Type:
Duration
(optional, default: None)
Timeout for the task.
vpc?
Type:
IVpc
(optional, default: None)
The VPC that is accessible by the hosted model.