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

Class SageMakerCreateModel

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.stepfunctions.State

software.amazon.awscdk.services.stepfunctions.TaskStateBase

software.amazon.awscdk.services.stepfunctions.tasks.SageMakerCreateModel

All Implemented Interfaces:

IConstruct, IDependable, IConnectable, IGrantable, IChainable, INextable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:48.186Z")
@Stability(Stable)
public class SageMakerCreateModel
extends TaskStateBase
implements IGrantable, IConnectable

A Step Functions Task to create a 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	Class	Description
static final class	SageMakerCreateModel.Builder	A fluent builder for SageMakerCreateModel.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.IChainable

IChainable.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IConnectable

IConnectable.Jsii$Default, IConnectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IGrantable

IGrantable.Jsii$Default, IGrantable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.INextable

INextable.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SageMakerCreateModel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	SageMakerCreateModel(software.amazon.jsii.JsiiObjectRef objRef)
	SageMakerCreateModel(software.constructs.Construct scope, String id, SageMakerCreateModelProps props)

Method Summary

Modifier and Type	Method	Description
void	addSecurityGroup(ISecurityGroup securityGroup)	Add the security group to all instances via the launch configuration security groups array.
Connections	getConnections()	Allows specify security group connections for instances of this fleet.
IPrincipal	getGrantPrincipal()	The principal to grant permissions to.
IRole	getRole()	The execution role for the Sagemaker Create Model API.
protected TaskMetricsConfig	getTaskMetrics()
protected List<PolicyStatement>	getTaskPolicies()

Methods inherited from class software.amazon.awscdk.services.stepfunctions.TaskStateBase

addCatch, addCatch, addRetry, addRetry, getEndStates, metric, metric, metricFailed, metricFailed, metricHeartbeatTimedOut, metricHeartbeatTimedOut, metricRunTime, metricRunTime, metricScheduled, metricScheduled, metricScheduleTime, metricScheduleTime, metricStarted, metricStarted, metricSucceeded, metricSucceeded, metricTime, metricTime, metricTimedOut, metricTimedOut, next, toStateJson, whenBoundToGraph

Methods inherited from class software.amazon.awscdk.services.stepfunctions.State

addBranch, addChoice, addIterator, addPrefix, bindToGraph, filterNextables, findReachableEndStates, findReachableEndStates, findReachableStates, findReachableStates, getBranches, getComment, getDefaultChoice, getId, getInputPath, getIteration, getOutputPath, getParameters, getResultPath, getResultSelector, getStartState, getStateId, makeDefault, makeNext, prefixStates, renderBranches, renderChoices, renderInputOutput, renderIterator, renderNextEnd, renderResultSelector, renderRetryCatch, setDefaultChoice, setIteration

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

SageMakerCreateModel

protected SageMakerCreateModel(software.amazon.jsii.JsiiObjectRef objRef)

SageMakerCreateModel

protected SageMakerCreateModel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

SageMakerCreateModel

@Stability(Stable)
public SageMakerCreateModel(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 SageMakerCreateModelProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

addSecurityGroup

@Stability(Stable)
public void addSecurityGroup(@NotNull
 ISecurityGroup securityGroup)

Add the security group to all instances via the launch configuration security groups array.

Parameters:

securityGroup - : The security group to add. This parameter is required.

getConnections

@Stability(Stable)
@NotNull
public Connections getConnections()

Allows specify security group connections for instances of this fleet.

Specified by:

getConnections in interface IConnectable

getGrantPrincipal

@Stability(Stable)
@NotNull
public IPrincipal getGrantPrincipal()

The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

getRole

@Stability(Stable)
@NotNull
public IRole getRole()

The execution role for the Sagemaker Create Model API.

getTaskMetrics

@Stability(Stable)
@Nullable
protected TaskMetricsConfig getTaskMetrics()

Specified by:

getTaskMetrics in class TaskStateBase

getTaskPolicies

@Stability(Stable)
@Nullable
protected List<PolicyStatement> getTaskPolicies()

Specified by:

getTaskPolicies in class TaskStateBase