software.amazon.awscdk.services.stepfunctions.tasks

Class SageMakerCreateTrainingJob

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.SageMakerCreateTrainingJob

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.72.0 (build 4b8828b)",
           date="2023-01-03T16:22:40.720Z")
 @Stability(value=Stable)
public class SageMakerCreateTrainingJob
extends TaskStateBase
implements IGrantable, IConnectable

Class representing the SageMaker Create Training Job task.

Example:

 SageMakerCreateTrainingJob.Builder.create(this, "TrainSagemaker")
         .trainingJobName(JsonPath.stringAt("$.JobName"))
         .algorithmSpecification(AlgorithmSpecification.builder()
                 .algorithmName("BlazingText")
                 .trainingInputMode(InputMode.FILE)
                 .build())
         .inputDataConfig(List.of(Channel.builder()
                 .channelName("train")
                 .dataSource(DataSource.builder()
                         .s3DataSource(S3DataSource.builder()
                                 .s3DataType(S3DataType.S3_PREFIX)
                                 .s3Location(S3Location.fromJsonExpression("$.S3Bucket"))
                                 .build())
                         .build())
                 .build()))
         .outputDataConfig(OutputDataConfig.builder()
                 .s3OutputLocation(S3Location.fromBucket(Bucket.fromBucketName(this, "Bucket", "mybucket"), "myoutputpath"))
                 .build())
         .resourceConfig(ResourceConfig.builder()
                 .instanceCount(1)
                 .instanceType(new InstanceType(JsonPath.stringAt("$.InstanceType")))
                 .volumeSize(Size.gibibytes(50))
                 .build()) // optional: default is 1 instance of EC2 `M4.XLarge` with `10GB` volume
         .stoppingCondition(StoppingCondition.builder()
                 .maxRuntime(Duration.hours(2))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SageMakerCreateTrainingJob.Builder A fluent builder for SageMakerCreateTrainingJob.

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.iam.IGrantable

IGrantable.Jsii$Default, IGrantable.Jsii$Proxy

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.services.stepfunctions.INextable

INextable.Jsii$Default

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

IChainable.Jsii$Default

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

IConstruct.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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 training job.
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 Detail

SageMakerCreateTrainingJob

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

SageMakerCreateTrainingJob

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

SageMakerCreateTrainingJob

@Stability(value=Stable)
public SageMakerCreateTrainingJob(@NotNull
                                                           software.constructs.Construct scope,
                                                           @NotNull
                                                           String id,
                                                           @NotNull
                                                           SageMakerCreateTrainingJobProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

addSecurityGroup

@Stability(value=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(value=Stable)
 @NotNull
public Connections getConnections()

Allows specify security group connections for instances of this fleet.

Specified by:

getConnections in interface IConnectable

getGrantPrincipal

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

The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

getRole

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

The execution role for the Sagemaker training job.

Only available after task has been added to a state machine.

getTaskMetrics

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

Specified by:

getTaskMetrics in class TaskStateBase

getTaskPolicies

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

Specified by:

getTaskPolicies in class TaskStateBase