Package software.amazon.awscdk.services.stepfunctions.tasks

Interface SageMakerCreateModelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

All Known Implementing Classes:

SageMakerCreateModelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:17.809Z")
@Stability(Stable)
public interface SageMakerCreateModelProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

Properties for creating an Amazon SageMaker model.

Example:

 SageMakerCreateModel.Builder.create(this, "Sagemaker")
         .modelName("MyModel")
         .primaryContainer(ContainerDefinition.Builder.create()
                 .image(DockerImage.fromJsonExpression(JsonPath.stringAt("$.Model.imageName")))
                 .mode(Mode.SINGLE_MODEL)
                 .modelS3Location(S3Location.fromJsonExpression("$.TrainingJob.ModelArtifacts.S3ModelArtifacts"))
                 .build())
         .build();
 

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/connect-sagemaker.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SageMakerCreateModelProps.Builder	A builder for SageMakerCreateModelProps
static final class	SageMakerCreateModelProps.Jsii$Proxy	An implementation for SageMakerCreateModelProps

Method Summary

Modifier and Type	Method	Description
static SageMakerCreateModelProps.Builder	builder()
default List<IContainerDefinition>	getContainers()	Specifies the containers in the inference pipeline.
default Boolean	getEnableNetworkIsolation()	Isolates the model container.
String	getModelName()	The name of the new model.
IContainerDefinition	getPrimaryContainer()	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.
default IRole	getRole()	An execution role that you can pass in a CreateModel API request.
default SubnetSelection	getSubnetSelection()	The subnets of the VPC to which the hosted model is connected (Note this parameter is only used when VPC is provided).
default TaskInput	getTags()	Tags to be applied to the model.
default IVpc	getVpc()	The VPC that is accessible by the hosted model.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps

getComment, getCredentials, getHeartbeat, getHeartbeatTimeout, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getStateName, getTaskTimeout, getTimeout

Method Details

getModelName

@Stability(Stable)
@NotNull
String getModelName()

The name of the new model.

getPrimaryContainer

@Stability(Stable)
@NotNull
IContainerDefinition getPrimaryContainer()

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.

getContainers

@Stability(Stable)
@Nullable
default List<IContainerDefinition> getContainers()

Specifies the containers in the inference pipeline.

Default: - None

getEnableNetworkIsolation

@Stability(Stable)
@Nullable
default Boolean getEnableNetworkIsolation()

Isolates the model container.

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

Default: false

getRole

@Stability(Stable)
@Nullable
default IRole getRole()

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

Default: - a role will be created.

getSubnetSelection

@Stability(Stable)
@Nullable
default SubnetSelection getSubnetSelection()

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

Default: - Private Subnets are selected

getTags

@Stability(Stable)
@Nullable
default TaskInput getTags()

Tags to be applied to the model.

Default: - No tags

getVpc

@Stability(Stable)
@Nullable
default IVpc getVpc()

The VPC that is accessible by the hosted model.

Default: - None

builder

@Stability(Stable)
static SageMakerCreateModelProps.Builder builder()

Returns:

a SageMakerCreateModelProps.Builder of SageMakerCreateModelProps