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

Class SageMakerCreateTrainingJobProps.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.tasks.SageMakerCreateTrainingJobProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SageMakerCreateTrainingJobProps>

Enclosing interface:

SageMakerCreateTrainingJobProps

@Stability(Stable)
public static final class SageMakerCreateTrainingJobProps.Builder
extends Object
implements software.amazon.jsii.Builder<SageMakerCreateTrainingJobProps>

A builder for SageMakerCreateTrainingJobProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SageMakerCreateTrainingJobProps.Builder	algorithmSpecification(AlgorithmSpecification algorithmSpecification)	Sets the value of SageMakerCreateTrainingJobProps.getAlgorithmSpecification()
SageMakerCreateTrainingJobProps	build()	Builds the configured instance.
SageMakerCreateTrainingJobProps.Builder	comment(String comment)	Sets the value of TaskStateBaseProps.getComment()
SageMakerCreateTrainingJobProps.Builder	enableNetworkIsolation(Boolean enableNetworkIsolation)	Sets the value of SageMakerCreateTrainingJobProps.getEnableNetworkIsolation()
SageMakerCreateTrainingJobProps.Builder	environment(Map<String,String> environment)	Sets the value of SageMakerCreateTrainingJobProps.getEnvironment()
SageMakerCreateTrainingJobProps.Builder	heartbeat(Duration heartbeat)	Sets the value of TaskStateBaseProps.getHeartbeat()
SageMakerCreateTrainingJobProps.Builder	hyperparameters(Map<String,? extends Object> hyperparameters)	Sets the value of SageMakerCreateTrainingJobProps.getHyperparameters()
SageMakerCreateTrainingJobProps.Builder	inputDataConfig(List<? extends Channel> inputDataConfig)	Sets the value of SageMakerCreateTrainingJobProps.getInputDataConfig()
SageMakerCreateTrainingJobProps.Builder	inputPath(String inputPath)	Sets the value of TaskStateBaseProps.getInputPath()
SageMakerCreateTrainingJobProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseProps.getIntegrationPattern()
SageMakerCreateTrainingJobProps.Builder	outputDataConfig(OutputDataConfig outputDataConfig)	Sets the value of SageMakerCreateTrainingJobProps.getOutputDataConfig()
SageMakerCreateTrainingJobProps.Builder	outputPath(String outputPath)	Sets the value of TaskStateBaseProps.getOutputPath()
SageMakerCreateTrainingJobProps.Builder	resourceConfig(ResourceConfig resourceConfig)	Sets the value of SageMakerCreateTrainingJobProps.getResourceConfig()
SageMakerCreateTrainingJobProps.Builder	resultPath(String resultPath)	Sets the value of TaskStateBaseProps.getResultPath()
SageMakerCreateTrainingJobProps.Builder	resultSelector(Map<String,? extends Object> resultSelector)	Sets the value of TaskStateBaseProps.getResultSelector()
SageMakerCreateTrainingJobProps.Builder	role(IRole role)	Sets the value of SageMakerCreateTrainingJobProps.getRole()
SageMakerCreateTrainingJobProps.Builder	stoppingCondition(StoppingCondition stoppingCondition)	Sets the value of SageMakerCreateTrainingJobProps.getStoppingCondition()
SageMakerCreateTrainingJobProps.Builder	tags(Map<String,String> tags)	Sets the value of SageMakerCreateTrainingJobProps.getTags()
SageMakerCreateTrainingJobProps.Builder	timeout(Duration timeout)	Sets the value of TaskStateBaseProps.getTimeout()
SageMakerCreateTrainingJobProps.Builder	trainingJobName(String trainingJobName)	Sets the value of SageMakerCreateTrainingJobProps.getTrainingJobName()
SageMakerCreateTrainingJobProps.Builder	vpcConfig(VpcConfig vpcConfig)	Sets the value of SageMakerCreateTrainingJobProps.getVpcConfig()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

algorithmSpecification

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder algorithmSpecification(AlgorithmSpecification algorithmSpecification)

Sets the value of SageMakerCreateTrainingJobProps.getAlgorithmSpecification()

Parameters:

algorithmSpecification - Identifies the training algorithm to use. This parameter is required.

Returns:

this

inputDataConfig

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder inputDataConfig(List<? extends Channel> inputDataConfig)

Sets the value of SageMakerCreateTrainingJobProps.getInputDataConfig()

Parameters:

inputDataConfig - Describes the various datasets (e.g. train, validation, test) and the Amazon S3 location where stored. This parameter is required.

Returns:

this

outputDataConfig

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder outputDataConfig(OutputDataConfig outputDataConfig)

Sets the value of SageMakerCreateTrainingJobProps.getOutputDataConfig()

Parameters:

outputDataConfig - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results of model training. This parameter is required.

Returns:

this

trainingJobName

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder trainingJobName(String trainingJobName)

Sets the value of SageMakerCreateTrainingJobProps.getTrainingJobName()

Parameters:

trainingJobName - Training Job Name. This parameter is required.

Returns:

this

enableNetworkIsolation

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder enableNetworkIsolation(Boolean enableNetworkIsolation)

Sets the value of SageMakerCreateTrainingJobProps.getEnableNetworkIsolation()

Parameters:

enableNetworkIsolation - Isolates the training container. No inbound or outbound network calls can be made to or from the training container.

Returns:

this

environment

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder environment(Map<String,String> environment)

Sets the value of SageMakerCreateTrainingJobProps.getEnvironment()

Parameters:

environment - Environment variables to set in the Docker container.

Returns:

this

hyperparameters

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder hyperparameters(Map<String,? extends Object> hyperparameters)

Sets the value of SageMakerCreateTrainingJobProps.getHyperparameters()

Parameters:

hyperparameters - Algorithm-specific parameters that influence the quality of the model. Set hyperparameters before you start the learning process. For a list of hyperparameters provided by Amazon SageMaker

Returns:

this

resourceConfig

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder resourceConfig(ResourceConfig resourceConfig)

Sets the value of SageMakerCreateTrainingJobProps.getResourceConfig()

Parameters:

resourceConfig - Specifies the resources, ML compute instances, and ML storage volumes to deploy for model training.

Returns:

this

role

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder role(IRole role)

Sets the value of SageMakerCreateTrainingJobProps.getRole()

Parameters:

role - Role for the Training Job. The role must be granted all necessary permissions for the SageMaker training job to be able to operate.

See https://docs.aws.amazon.com/fr_fr/sagemaker/latest/dg/sagemaker-roles.html#sagemaker-roles-createtrainingjob-perms

Returns:

this

stoppingCondition

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder stoppingCondition(StoppingCondition stoppingCondition)

Sets the value of SageMakerCreateTrainingJobProps.getStoppingCondition()

Parameters:

stoppingCondition - Sets a time limit for training.

Returns:

this

tags

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder tags(Map<String,String> tags)

Sets the value of SageMakerCreateTrainingJobProps.getTags()

Parameters:

tags - Tags to be applied to the train job.

Returns:

this

vpcConfig

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder vpcConfig(VpcConfig vpcConfig)

Sets the value of SageMakerCreateTrainingJobProps.getVpcConfig()

Parameters:

vpcConfig - Specifies the VPC that you want your training job to connect to.

Returns:

this

comment

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder comment(String comment)

Sets the value of TaskStateBaseProps.getComment()

Parameters:

comment - An optional description for this state.

Returns:

this

heartbeat

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder heartbeat(Duration heartbeat)

Sets the value of TaskStateBaseProps.getHeartbeat()

Parameters:

heartbeat - Timeout for the heartbeat.

Returns:

this

inputPath

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder inputPath(String inputPath)

Sets the value of TaskStateBaseProps.getInputPath()

Parameters:

inputPath - 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 {}.

Returns:

this

integrationPattern

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder integrationPattern(IntegrationPattern integrationPattern)

Sets the value of TaskStateBaseProps.getIntegrationPattern()

Parameters:

integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns

Returns:

this

outputPath

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder outputPath(String outputPath)

Sets the value of TaskStateBaseProps.getOutputPath()

Parameters:

outputPath - 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 {}.

Returns:

this

resultPath

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder resultPath(String resultPath)

Sets the value of TaskStateBaseProps.getResultPath()

Parameters:

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

Returns:

this

resultSelector

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder resultSelector(Map<String,? extends Object> resultSelector)

Sets the value of TaskStateBaseProps.getResultSelector()

Parameters:

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

Returns:

this

timeout

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder timeout(Duration timeout)

Sets the value of TaskStateBaseProps.getTimeout()

Parameters:

timeout - Timeout for the state machine.

Returns:

this

build

@Stability(Stable)
public SageMakerCreateTrainingJobProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<SageMakerCreateTrainingJobProps>

Returns:

a new instance of SageMakerCreateTrainingJobProps

Throws:

NullPointerException - if any required attribute was not provided