aws-cdk-lib.aws_stepfunctions_tasks.SageMakerCreateModelProps

interface SageMakerCreateModelProps

LanguageType name
.NETAmazon.CDK.AWS.StepFunctions.Tasks.SageMakerCreateModelProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#SageMakerCreateModelProps
Javasoftware.amazon.awscdk.services.stepfunctions.tasks.SageMakerCreateModelProps
Pythonaws_cdk.aws_stepfunctions_tasks.SageMakerCreateModelProps
TypeScript (source)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

NameTypeDescription
modelNamestringThe name of the new model.
primaryContainerIContainerDefinitionThe 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.
comment?stringAn optional description for this state.
containers?IContainerDefinition[]Specifies the containers in the inference pipeline.
credentials?CredentialsCredentials for an IAM Role that the State Machine assumes for executing the task.
enableNetworkIsolation?booleanIsolates the model container.
heartbeat?⚠️DurationTimeout for the heartbeat.
heartbeatTimeout?TimeoutTimeout for the heartbeat.
inputPath?stringJSONPath expression to select part of the state to be the input to this state.
integrationPattern?IntegrationPatternAWS Step Functions integrates with services directly in the Amazon States Language.
outputPath?stringJSONPath expression to select select a portion of the state output to pass to the next state.
resultPath?stringJSONPath expression to indicate where to inject the state's output.
resultSelector?{ [string]: any }The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
role?IRoleAn execution role that you can pass in a CreateModel API request.
subnetSelection?SubnetSelectionThe subnets of the VPC to which the hosted model is connected (Note this parameter is only used when VPC is provided).
tags?TaskInputTags to be applied to the model.
taskTimeout?TimeoutTimeout for the task.
timeout?⚠️DurationTimeout for the task.
vpc?IVpcThe VPC that is accessible by the hosted model.

modelName

Type: string

The name of the new model.


primaryContainer

Type: 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.


comment?

Type: string (optional, default: No comment)

An optional description for this state.


containers?

Type: IContainerDefinition[] (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.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html


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: The entire task input (JSON path '$'))

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: IntegrationPattern (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

See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token


outputPath?

Type: string (optional, default: The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$'))

JSONPath expression to select select a portion of the state output to pass to the next state.

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


resultPath?

Type: string (optional, default: Replaces the entire input with the result (JSON path '$'))

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.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector


role?

Type: IRole (optional, default: a role will be created.)

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


subnetSelection?

Type: SubnetSelection (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: TaskInput (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.