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.Builder	assign(Map<String,? extends Object> assign)	Sets the value of AssignableStateOptions.getAssign()
SageMakerCreateTrainingJobProps	build()	Builds the configured instance.
SageMakerCreateTrainingJobProps.Builder	comment(String comment)	Sets the value of StateBaseProps.getComment()
SageMakerCreateTrainingJobProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseOptions.getCredentials()
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)	Deprecated. use `heartbeatTimeout`
SageMakerCreateTrainingJobProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()
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 JsonPathCommonOptions.getInputPath()
SageMakerCreateTrainingJobProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseOptions.getIntegrationPattern()
SageMakerCreateTrainingJobProps.Builder	outputDataConfig(OutputDataConfig outputDataConfig)	Sets the value of SageMakerCreateTrainingJobProps.getOutputDataConfig()
SageMakerCreateTrainingJobProps.Builder	outputPath(String outputPath)	Sets the value of JsonPathCommonOptions.getOutputPath()
SageMakerCreateTrainingJobProps.Builder	outputs(Object outputs)	Sets the value of JsonataCommonOptions.getOutputs()
SageMakerCreateTrainingJobProps.Builder	queryLanguage(QueryLanguage queryLanguage)	Sets the value of StateBaseProps.getQueryLanguage()
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	stateName(String stateName)	Sets the value of StateBaseProps.getStateName()
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	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseOptions.getTaskTimeout()
SageMakerCreateTrainingJobProps.Builder	timeout(Duration timeout)	Deprecated. use `taskTimeout`
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

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

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.

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

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

comment

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

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder queryLanguage(QueryLanguage queryLanguage)

Sets the value of StateBaseProps.getQueryLanguage()

Parameters:

queryLanguage - The name of the query language used by the state. If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

Returns:

this

stateName

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

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder credentials(Credentials credentials)

Sets the value of TaskStateBaseOptions.getCredentials()

Parameters:

credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations.

Returns:

this

heartbeat

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

Deprecated.

use `heartbeatTimeout`

Sets the value of TaskStateBaseOptions.getHeartbeat()

Parameters:

heartbeat - Timeout for the heartbeat.

Returns:

this

heartbeatTimeout

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder heartbeatTimeout(Timeout heartbeatTimeout)

Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()

Parameters:

heartbeatTimeout - Timeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

integrationPattern

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

Sets the value of TaskStateBaseOptions.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.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

Returns:

this

taskTimeout

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder taskTimeout(Timeout taskTimeout)

Sets the value of TaskStateBaseOptions.getTaskTimeout()

Parameters:

taskTimeout - Timeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

timeout

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

Deprecated.

use `taskTimeout`

Sets the value of TaskStateBaseOptions.getTimeout()

Parameters:

timeout - Timeout for the task.

Returns:

this

assign

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

Sets the value of AssignableStateOptions.getAssign()

Parameters:

assign - Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps.

Returns:

this

inputPath

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

Sets the value of JsonPathCommonOptions.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

outputPath

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

Sets the value of JsonPathCommonOptions.getOutputPath()

Parameters:

outputPath - JSONPath expression to select part of the state to be the output to this state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Returns:

this

outputs

@Stability(Stable)
public SageMakerCreateTrainingJobProps.Builder outputs(Object outputs)

Sets the value of JsonataCommonOptions.getOutputs()

Parameters:

outputs - Used to specify and transform output from the state. When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

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