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

Class SageMakerCreateTrainingJobJsonataProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<SageMakerCreateTrainingJobJsonataProps>

Enclosing interface:

SageMakerCreateTrainingJobJsonataProps

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

A builder for SageMakerCreateTrainingJobJsonataProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SageMakerCreateTrainingJobJsonataProps.Builder	algorithmSpecification(AlgorithmSpecification algorithmSpecification)	Sets the value of SageMakerCreateTrainingJobJsonataProps.getAlgorithmSpecification()
SageMakerCreateTrainingJobJsonataProps.Builder	assign(Map<String,? extends Object> assign)	Sets the value of AssignableStateOptions.getAssign()
SageMakerCreateTrainingJobJsonataProps	build()	Builds the configured instance.
SageMakerCreateTrainingJobJsonataProps.Builder	comment(String comment)	Sets the value of StateBaseProps.getComment()
SageMakerCreateTrainingJobJsonataProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseOptions.getCredentials()
SageMakerCreateTrainingJobJsonataProps.Builder	enableNetworkIsolation(Boolean enableNetworkIsolation)	Sets the value of SageMakerCreateTrainingJobJsonataProps.getEnableNetworkIsolation()
SageMakerCreateTrainingJobJsonataProps.Builder	environment(Map<String,String> environment)	Sets the value of SageMakerCreateTrainingJobJsonataProps.getEnvironment()
SageMakerCreateTrainingJobJsonataProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
SageMakerCreateTrainingJobJsonataProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()
SageMakerCreateTrainingJobJsonataProps.Builder	hyperparameters(Map<String,? extends Object> hyperparameters)	Sets the value of SageMakerCreateTrainingJobJsonataProps.getHyperparameters()
SageMakerCreateTrainingJobJsonataProps.Builder	inputDataConfig(List<? extends Channel> inputDataConfig)	Sets the value of SageMakerCreateTrainingJobJsonataProps.getInputDataConfig()
SageMakerCreateTrainingJobJsonataProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseOptions.getIntegrationPattern()
SageMakerCreateTrainingJobJsonataProps.Builder	outputDataConfig(OutputDataConfig outputDataConfig)	Sets the value of SageMakerCreateTrainingJobJsonataProps.getOutputDataConfig()
SageMakerCreateTrainingJobJsonataProps.Builder	outputs(Object outputs)	Sets the value of JsonataCommonOptions.getOutputs()
SageMakerCreateTrainingJobJsonataProps.Builder	queryLanguage(QueryLanguage queryLanguage)	Sets the value of StateBaseProps.getQueryLanguage()
SageMakerCreateTrainingJobJsonataProps.Builder	resourceConfig(ResourceConfig resourceConfig)	Sets the value of SageMakerCreateTrainingJobJsonataProps.getResourceConfig()
SageMakerCreateTrainingJobJsonataProps.Builder	role(IRole role)	Sets the value of SageMakerCreateTrainingJobJsonataProps.getRole()
SageMakerCreateTrainingJobJsonataProps.Builder	stateName(String stateName)	Sets the value of StateBaseProps.getStateName()
SageMakerCreateTrainingJobJsonataProps.Builder	stoppingCondition(StoppingCondition stoppingCondition)	Sets the value of SageMakerCreateTrainingJobJsonataProps.getStoppingCondition()
SageMakerCreateTrainingJobJsonataProps.Builder	tags(Map<String,String> tags)	Sets the value of SageMakerCreateTrainingJobJsonataProps.getTags()
SageMakerCreateTrainingJobJsonataProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseOptions.getTaskTimeout()
SageMakerCreateTrainingJobJsonataProps.Builder	timeout(Duration timeout)	Deprecated. use `taskTimeout`
SageMakerCreateTrainingJobJsonataProps.Builder	trainingJobName(String trainingJobName)	Sets the value of SageMakerCreateTrainingJobJsonataProps.getTrainingJobName()
SageMakerCreateTrainingJobJsonataProps.Builder	vpcConfig(VpcConfig vpcConfig)	Sets the value of SageMakerCreateTrainingJobJsonataProps.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 SageMakerCreateTrainingJobJsonataProps.Builder algorithmSpecification(AlgorithmSpecification algorithmSpecification)

Sets the value of SageMakerCreateTrainingJobJsonataProps.getAlgorithmSpecification()

Parameters:

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

Returns:

this

outputDataConfig

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

Sets the value of SageMakerCreateTrainingJobJsonataProps.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 SageMakerCreateTrainingJobJsonataProps.Builder trainingJobName(String trainingJobName)

Sets the value of SageMakerCreateTrainingJobJsonataProps.getTrainingJobName()

Parameters:

trainingJobName - Training Job Name. This parameter is required.

Returns:

this

enableNetworkIsolation

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

Sets the value of SageMakerCreateTrainingJobJsonataProps.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 SageMakerCreateTrainingJobJsonataProps.Builder environment(Map<String,String> environment)

Sets the value of SageMakerCreateTrainingJobJsonataProps.getEnvironment()

Parameters:

environment - Environment variables to set in the Docker container.

Returns:

this

hyperparameters

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

Sets the value of SageMakerCreateTrainingJobJsonataProps.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 SageMakerCreateTrainingJobJsonataProps.Builder inputDataConfig(List<? extends Channel> inputDataConfig)

Sets the value of SageMakerCreateTrainingJobJsonataProps.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 SageMakerCreateTrainingJobJsonataProps.Builder resourceConfig(ResourceConfig resourceConfig)

Sets the value of SageMakerCreateTrainingJobJsonataProps.getResourceConfig()

Parameters:

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

Returns:

this

role

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

Sets the value of SageMakerCreateTrainingJobJsonataProps.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 SageMakerCreateTrainingJobJsonataProps.Builder stoppingCondition(StoppingCondition stoppingCondition)

Sets the value of SageMakerCreateTrainingJobJsonataProps.getStoppingCondition()

Parameters:

stoppingCondition - Sets a time limit for training.

Returns:

this

tags

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

Sets the value of SageMakerCreateTrainingJobJsonataProps.getTags()

Parameters:

tags - Tags to be applied to the train job.

Returns:

this

vpcConfig

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

Sets the value of SageMakerCreateTrainingJobJsonataProps.getVpcConfig()

Parameters:

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

Returns:

this

comment

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

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

@Stability(Stable)
public SageMakerCreateTrainingJobJsonataProps.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 SageMakerCreateTrainingJobJsonataProps.Builder stateName(String stateName)

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

@Stability(Stable)
public SageMakerCreateTrainingJobJsonataProps.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 SageMakerCreateTrainingJobJsonataProps.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 SageMakerCreateTrainingJobJsonataProps.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 SageMakerCreateTrainingJobJsonataProps.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 SageMakerCreateTrainingJobJsonataProps.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 SageMakerCreateTrainingJobJsonataProps.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 SageMakerCreateTrainingJobJsonataProps.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

outputs

@Stability(Stable)
public SageMakerCreateTrainingJobJsonataProps.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 SageMakerCreateTrainingJobJsonataProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SageMakerCreateTrainingJobJsonataProps

Throws:

NullPointerException - if any required attribute was not provided