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
-
Method Summary
Modifier and TypeMethodDescriptionalgorithmSpecification
(AlgorithmSpecification algorithmSpecification) Sets the value ofSageMakerCreateTrainingJobProps.getAlgorithmSpecification()
build()
Builds the configured instance.Sets the value ofTaskStateBaseProps.getComment()
credentials
(Credentials credentials) Sets the value ofTaskStateBaseProps.getCredentials()
enableNetworkIsolation
(Boolean enableNetworkIsolation) Sets the value ofSageMakerCreateTrainingJobProps.getEnableNetworkIsolation()
environment
(Map<String, String> environment) Sets the value ofSageMakerCreateTrainingJobProps.getEnvironment()
Deprecated.use `heartbeatTimeout`heartbeatTimeout
(Timeout heartbeatTimeout) Sets the value ofTaskStateBaseProps.getHeartbeatTimeout()
hyperparameters
(Map<String, ? extends Object> hyperparameters) Sets the value ofSageMakerCreateTrainingJobProps.getHyperparameters()
inputDataConfig
(List<? extends Channel> inputDataConfig) Sets the value ofSageMakerCreateTrainingJobProps.getInputDataConfig()
Sets the value ofTaskStateBaseProps.getInputPath()
integrationPattern
(IntegrationPattern integrationPattern) Sets the value ofTaskStateBaseProps.getIntegrationPattern()
outputDataConfig
(OutputDataConfig outputDataConfig) Sets the value ofSageMakerCreateTrainingJobProps.getOutputDataConfig()
outputPath
(String outputPath) Sets the value ofTaskStateBaseProps.getOutputPath()
resourceConfig
(ResourceConfig resourceConfig) Sets the value ofSageMakerCreateTrainingJobProps.getResourceConfig()
resultPath
(String resultPath) Sets the value ofTaskStateBaseProps.getResultPath()
resultSelector
(Map<String, ? extends Object> resultSelector) Sets the value ofTaskStateBaseProps.getResultSelector()
Sets the value ofSageMakerCreateTrainingJobProps.getRole()
Sets the value ofTaskStateBaseProps.getStateName()
stoppingCondition
(StoppingCondition stoppingCondition) Sets the value ofSageMakerCreateTrainingJobProps.getStoppingCondition()
Sets the value ofSageMakerCreateTrainingJobProps.getTags()
taskTimeout
(Timeout taskTimeout) Sets the value ofTaskStateBaseProps.getTaskTimeout()
Deprecated.use `taskTimeout`trainingJobName
(String trainingJobName) Sets the value ofSageMakerCreateTrainingJobProps.getTrainingJobName()
Sets the value ofSageMakerCreateTrainingJobProps.getVpcConfig()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
algorithmSpecification
@Stability(Stable) public SageMakerCreateTrainingJobProps.Builder algorithmSpecification(AlgorithmSpecification algorithmSpecification) Sets the value ofSageMakerCreateTrainingJobProps.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 ofSageMakerCreateTrainingJobProps.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 ofSageMakerCreateTrainingJobProps.getTrainingJobName()
- Parameters:
trainingJobName
- Training Job Name. This parameter is required.- Returns:
this
-
enableNetworkIsolation
@Stability(Stable) public SageMakerCreateTrainingJobProps.Builder enableNetworkIsolation(Boolean enableNetworkIsolation) Sets the value ofSageMakerCreateTrainingJobProps.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 ofSageMakerCreateTrainingJobProps.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 ofSageMakerCreateTrainingJobProps.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 ofSageMakerCreateTrainingJobProps.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 ofSageMakerCreateTrainingJobProps.getResourceConfig()
- Parameters:
resourceConfig
- Specifies the resources, ML compute instances, and ML storage volumes to deploy for model training.- Returns:
this
-
role
Sets the value ofSageMakerCreateTrainingJobProps.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 ofSageMakerCreateTrainingJobProps.getStoppingCondition()
- Parameters:
stoppingCondition
- Sets a time limit for training.- Returns:
this
-
tags
Sets the value ofSageMakerCreateTrainingJobProps.getTags()
- Parameters:
tags
- Tags to be applied to the train job.- Returns:
this
-
vpcConfig
Sets the value ofSageMakerCreateTrainingJobProps.getVpcConfig()
- Parameters:
vpcConfig
- Specifies the VPC that you want your training job to connect to.- Returns:
this
-
comment
Sets the value ofTaskStateBaseProps.getComment()
- Parameters:
comment
- An optional description for this state.- Returns:
this
-
credentials
@Stability(Stable) public SageMakerCreateTrainingJobProps.Builder credentials(Credentials credentials) Sets the value ofTaskStateBaseProps.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 ofTaskStateBaseProps.getHeartbeat()
- Parameters:
heartbeat
- Timeout for the heartbeat.- Returns:
this
-
heartbeatTimeout
@Stability(Stable) public SageMakerCreateTrainingJobProps.Builder heartbeatTimeout(Timeout heartbeatTimeout) Sets the value ofTaskStateBaseProps.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
-
inputPath
Sets the value ofTaskStateBaseProps.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 ofTaskStateBaseProps.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
-
outputPath
Sets the value ofTaskStateBaseProps.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
Sets the value ofTaskStateBaseProps.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 ofTaskStateBaseProps.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
-
stateName
Sets the value ofTaskStateBaseProps.getStateName()
- Parameters:
stateName
- Optional name for this state.- Returns:
this
-
taskTimeout
Sets the value ofTaskStateBaseProps.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 ofTaskStateBaseProps.getTimeout()
- Parameters:
timeout
- Timeout for the task.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<SageMakerCreateTrainingJobProps>
- Returns:
- a new instance of
SageMakerCreateTrainingJobProps
- Throws:
NullPointerException
- if any required attribute was not provided
-