SageMakerCreateTransformJob.Builder (software.amazon.awscdk:aws-cdk-lib 2.36.0 API)

java.lang.Object
- software.amazon.awscdk.services.stepfunctions.tasks.SageMakerCreateTransformJob.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SageMakerCreateTransformJob>

Enclosing class:

SageMakerCreateTransformJob
```
@Stability(value=Stable)
public static final class SageMakerCreateTransformJob.Builder
extends Object
implements software.amazon.jsii.Builder<SageMakerCreateTransformJob>
```
A fluent builder for SageMakerCreateTransformJob.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SageMakerCreateTransformJob.Builder`	`batchStrategy(BatchStrategy batchStrategy)` Number of records to include in a mini-batch for an HTTP inference request.
`SageMakerCreateTransformJob`	`build()`
`SageMakerCreateTransformJob.Builder`	`comment(String comment)` An optional description for this state.
`static SageMakerCreateTransformJob.Builder`	`create(software.constructs.Construct scope, String id)`
`SageMakerCreateTransformJob.Builder`	`environment(Map<String,String> environment)` Environment variables to set in the Docker container.
`SageMakerCreateTransformJob.Builder`	`heartbeat(Duration heartbeat)` Timeout for the heartbeat.
`SageMakerCreateTransformJob.Builder`	`inputPath(String inputPath)` JSONPath expression to select part of the state to be the input to this state.
`SageMakerCreateTransformJob.Builder`	`integrationPattern(IntegrationPattern integrationPattern)` AWS Step Functions integrates with services directly in the Amazon States Language.
`SageMakerCreateTransformJob.Builder`	`maxConcurrentTransforms(Number maxConcurrentTransforms)` Maximum number of parallel requests that can be sent to each instance in a transform job.
`SageMakerCreateTransformJob.Builder`	`maxPayload(Size maxPayload)` Maximum allowed size of the payload, in MB.
`SageMakerCreateTransformJob.Builder`	`modelClientOptions(ModelClientOptions modelClientOptions)` Configures the timeout and maximum number of retries for processing a transform job invocation.
`SageMakerCreateTransformJob.Builder`	`modelName(String modelName)` Name of the model that you want to use for the transform job.
`SageMakerCreateTransformJob.Builder`	`outputPath(String outputPath)` JSONPath expression to select select a portion of the state output to pass to the next state.
`SageMakerCreateTransformJob.Builder`	`resultPath(String resultPath)` JSONPath expression to indicate where to inject the state's output.
`SageMakerCreateTransformJob.Builder`	`resultSelector(Map<String,? extends Object> resultSelector)` The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
`SageMakerCreateTransformJob.Builder`	`role(IRole role)` Role for the Transform Job.
`SageMakerCreateTransformJob.Builder`	`tags(Map<String,String> tags)` Tags to be applied to the train job.
`SageMakerCreateTransformJob.Builder`	`timeout(Duration timeout)` Timeout for the state machine.
`SageMakerCreateTransformJob.Builder`	`transformInput(TransformInput transformInput)` Dataset to be transformed and the Amazon S3 location where it is stored.
`SageMakerCreateTransformJob.Builder`	`transformJobName(String transformJobName)` Transform Job Name.
`SageMakerCreateTransformJob.Builder`	`transformOutput(TransformOutput transformOutput)` S3 location where you want Amazon SageMaker to save the results from the transform job.
`SageMakerCreateTransformJob.Builder`	`transformResources(TransformResources transformResources)` ML compute instances for the transform job.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
@Stability(value=Stable)
public static SageMakerCreateTransformJob.Builder create(software.constructs.Construct scope,
                                                                                  String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of SageMakerCreateTransformJob.Builder.
  - comment
```
@Stability(value=Stable)
public SageMakerCreateTransformJob.Builder comment(String comment)
```
    An optional description for this state.
    Default: - No comment
    
    Parameters:
    
    comment - An optional description for this state. This parameter is required.
    
    Returns:
    
    this
  - heartbeat
```
@Stability(value=Stable)
public SageMakerCreateTransformJob.Builder heartbeat(Duration heartbeat)
```
    Timeout for the heartbeat.
    Default: - None
    
    Parameters:
    
    heartbeat - Timeout for the heartbeat. This parameter is required.
    
    Returns:
    
    this
  - inputPath
```
@Stability(value=Stable)
public SageMakerCreateTransformJob.Builder inputPath(String 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 {}.
    Default: - The entire task input (JSON path '$')
    
    Parameters:
    
    inputPath - JSONPath expression to select part of the state to be the input to this state. This parameter is required.
    
    Returns:
    
    this
  - integrationPattern
```
@Stability(value=Stable)
public SageMakerCreateTransformJob.Builder integrationPattern(IntegrationPattern integrationPattern)
```
    AWS Step Functions integrates with services directly in the Amazon States Language.
    You can control these AWS services using service integration patterns
    Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.
    
    Parameters:
    
    integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
  - outputPath
```
@Stability(value=Stable)
public SageMakerCreateTransformJob.Builder outputPath(String 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 {}.
    Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
    
    Parameters:
    
    outputPath - JSONPath expression to select select a portion of the state output to pass to the next state. This parameter is required.
    
    Returns:
    
    this
  - resultPath
```
@Stability(value=Stable)
public SageMakerCreateTransformJob.Builder resultPath(String 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.
    Default: - Replaces the entire input with the result (JSON path '$')
    
    Parameters:
    
    resultPath - JSONPath expression to indicate where to inject the state's output. This parameter is required.
    
    Returns:
    
    this
  - resultSelector
```
@Stability(value=Stable)
public SageMakerCreateTransformJob.Builder resultSelector(Map<String,? extends Object> 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.
    Default: - None
    
    Parameters:
    
    resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector
  - timeout
```
@Stability(value=Stable)
public SageMakerCreateTransformJob.Builder timeout(Duration timeout)
```
    Timeout for the state machine.
    Default: - None
    
    Parameters:
    
    timeout - Timeout for the state machine. This parameter is required.
    
    Returns:
    
    this
  - modelName
```
@Stability(value=Stable)
public SageMakerCreateTransformJob.Builder modelName(String modelName)
```
    Name of the model that you want to use for the transform job.
    
    Parameters:
    
    modelName - Name of the model that you want to use for the transform job. This parameter is required.
    
    Returns:
    
    this
  - transformInput
```
@Stability(value=Stable)
public SageMakerCreateTransformJob.Builder transformInput(TransformInput transformInput)
```
    Dataset to be transformed and the Amazon S3 location where it is stored.
    
    Parameters:
    
    transformInput - Dataset to be transformed and the Amazon S3 location where it is stored. This parameter is required.
    
    Returns:
    
    this
  - transformJobName
```
@Stability(value=Stable)
public SageMakerCreateTransformJob.Builder transformJobName(String transformJobName)
```
    Transform Job Name.
    
    Parameters:
    
    transformJobName - Transform Job Name. This parameter is required.
    
    Returns:
    
    this
  - transformOutput
```
@Stability(value=Stable)
public SageMakerCreateTransformJob.Builder transformOutput(TransformOutput transformOutput)
```
    S3 location where you want Amazon SageMaker to save the results from the transform job.
    
    Parameters:
    
    transformOutput - S3 location where you want Amazon SageMaker to save the results from the transform job. This parameter is required.
    
    Returns:
    
    this
  - batchStrategy
```
@Stability(value=Stable)
public SageMakerCreateTransformJob.Builder batchStrategy(BatchStrategy batchStrategy)
```
    Number of records to include in a mini-batch for an HTTP inference request.
    Default: - No batch strategy
    
    Parameters:
    
    batchStrategy - Number of records to include in a mini-batch for an HTTP inference request. This parameter is required.
    
    Returns:
    
    this
  - environment
```
@Stability(value=Stable)
public SageMakerCreateTransformJob.Builder environment(Map<String,String> environment)
```
    Environment variables to set in the Docker container.
    Default: - No environment variables
    
    Parameters:
    
    environment - Environment variables to set in the Docker container. This parameter is required.
    
    Returns:
    
    this
  - maxConcurrentTransforms
```
@Stability(value=Stable)
public SageMakerCreateTransformJob.Builder maxConcurrentTransforms(Number maxConcurrentTransforms)
```
    Maximum number of parallel requests that can be sent to each instance in a transform job.
    Default: - Amazon SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1.
    
    Parameters:
    
    maxConcurrentTransforms - Maximum number of parallel requests that can be sent to each instance in a transform job. This parameter is required.
    
    Returns:
    
    this
  - maxPayload
```
@Stability(value=Stable)
public SageMakerCreateTransformJob.Builder maxPayload(Size maxPayload)
```
    Maximum allowed size of the payload, in MB.
    Default: 6
    
    Parameters:
    
    maxPayload - Maximum allowed size of the payload, in MB. This parameter is required.
    
    Returns:
    
    this
  - modelClientOptions
```
@Stability(value=Stable)
public SageMakerCreateTransformJob.Builder modelClientOptions(ModelClientOptions modelClientOptions)
```
    Configures the timeout and maximum number of retries for processing a transform job invocation.
    Default: - 0 retries and 60 seconds of timeout
    
    Parameters:
    
    modelClientOptions - Configures the timeout and maximum number of retries for processing a transform job invocation. This parameter is required.
    
    Returns:
    
    this
  - role
```
@Stability(value=Stable)
public SageMakerCreateTransformJob.Builder role(IRole role)
```
    Role for the Transform Job.
    Default: - A role is created with `AmazonSageMakerFullAccess` managed policy
    
    Parameters:
    
    role - Role for the Transform Job. This parameter is required.
    
    Returns:
    
    this
  - tags
```
@Stability(value=Stable)
public SageMakerCreateTransformJob.Builder tags(Map<String,String> tags)
```
    Tags to be applied to the train job.
    Default: - No tags
    
    Parameters:
    
    tags - Tags to be applied to the train job. This parameter is required.
    
    Returns:
    
    this
  - transformResources
```
@Stability(value=Stable)
public SageMakerCreateTransformJob.Builder transformResources(TransformResources transformResources)
```
    ML compute instances for the transform job.
    Default: - 1 instance of type M4.XLarge
    
    Parameters:
    
    transformResources - ML compute instances for the transform job. This parameter is required.
    
    Returns:
    
    this
  - build
```
@Stability(value=Stable)
public SageMakerCreateTransformJob build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<SageMakerCreateTransformJob>

Class SageMakerCreateTransformJob.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

comment

heartbeat

inputPath

integrationPattern

outputPath

resultPath

resultSelector

timeout

modelName

transformInput

transformJobName

transformOutput

batchStrategy

environment

maxConcurrentTransforms

maxPayload

modelClientOptions

role

tags

transformResources

build