SageMakerCreateModel.Builder

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

Enclosing class:: SageMakerCreateModel

public static final class SageMakerCreateModel.Builder
extends java.lang.Object

A fluent builder for SageMakerCreateModel.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SageMakerCreateModel`	`build()`
`SageMakerCreateModel.Builder`	`comment(java.lang.String comment)` An optional description for this state.
`SageMakerCreateModel.Builder`	`containers(java.util.List<? extends IContainerDefinition> containers)` Specifies the containers in the inference pipeline.
`static SageMakerCreateModel.Builder`	`create(software.constructs.Construct scope, java.lang.String id)`
`SageMakerCreateModel.Builder`	`enableNetworkIsolation(java.lang.Boolean enableNetworkIsolation)` Isolates the model container.
`SageMakerCreateModel.Builder`	`heartbeat(Duration heartbeat)` Timeout for the heartbeat.
`SageMakerCreateModel.Builder`	`inputPath(java.lang.String inputPath)` JSONPath expression to select part of the state to be the input to this state.
`SageMakerCreateModel.Builder`	`integrationPattern(IntegrationPattern integrationPattern)` AWS Step Functions integrates with services directly in the Amazon States Language.
`SageMakerCreateModel.Builder`	`modelName(java.lang.String modelName)` The name of the new model.
`SageMakerCreateModel.Builder`	`outputPath(java.lang.String outputPath)` JSONPath expression to select select a portion of the state output to pass to the next state.
`SageMakerCreateModel.Builder`	`primaryContainer(IContainerDefinition primaryContainer)` The definition of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.
`SageMakerCreateModel.Builder`	`resultPath(java.lang.String resultPath)` JSONPath expression to indicate where to inject the state's output.
`SageMakerCreateModel.Builder`	`resultSelector(java.util.Map<java.lang.String,? extends java.lang.Object> resultSelector)` The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
`SageMakerCreateModel.Builder`	`role(IRole role)` An execution role that you can pass in a CreateModel API request.
`SageMakerCreateModel.Builder`	`subnetSelection(SubnetSelection subnetSelection)` The subnets of the VPC to which the hosted model is connected (Note this parameter is only used when VPC is provided).
`SageMakerCreateModel.Builder`	`tags(TaskInput tags)` Tags to be applied to the model.
`SageMakerCreateModel.Builder`	`timeout(Duration timeout)` Timeout for the state machine.
`SageMakerCreateModel.Builder`	`vpc(IVpc vpc)` The VPC that is accessible by the hosted model.

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

- Method Detail
  - create
```
public static SageMakerCreateModel.Builder create(software.constructs.Construct scope,
                                                  java.lang.String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of SageMakerCreateModel.Builder.
  - comment
```
public SageMakerCreateModel.Builder comment(java.lang.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
```
public SageMakerCreateModel.Builder heartbeat(Duration heartbeat)
```
    Timeout for the heartbeat.
    Default: - None
    
    Parameters:
    
    heartbeat - Timeout for the heartbeat. This parameter is required.
    
    Returns:
    
    this
  - inputPath
```
public SageMakerCreateModel.Builder inputPath(java.lang.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
```
public SageMakerCreateModel.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
```
public SageMakerCreateModel.Builder outputPath(java.lang.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
```
public SageMakerCreateModel.Builder resultPath(java.lang.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
```
public SageMakerCreateModel.Builder resultSelector(java.util.Map<java.lang.String,? extends java.lang.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
```
public SageMakerCreateModel.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
```
public SageMakerCreateModel.Builder modelName(java.lang.String modelName)
```
    The name of the new model.
    
    Parameters:
    
    modelName - The name of the new model. This parameter is required.
    
    Returns:
    
    this
  - primaryContainer
```
public SageMakerCreateModel.Builder primaryContainer(IContainerDefinition primaryContainer)
```
    The definition of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.
    
    Parameters:
    
    primaryContainer - The definition of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions. This parameter is required.
    
    Returns:
    
    this
  - containers
```
public SageMakerCreateModel.Builder containers(java.util.List<? extends IContainerDefinition> containers)
```
    Specifies the containers in the inference pipeline.
    Default: - None
    
    Parameters:
    
    containers - Specifies the containers in the inference pipeline. This parameter is required.
    
    Returns:
    
    this
  - enableNetworkIsolation
```
public SageMakerCreateModel.Builder enableNetworkIsolation(java.lang.Boolean enableNetworkIsolation)
```
    Isolates the model container.
    No inbound or outbound network calls can be made to or from the model container.
    Default: false
    
    Parameters:
    
    enableNetworkIsolation - Isolates the model container. This parameter is required.
    
    Returns:
    
    this
  - role
```
public SageMakerCreateModel.Builder role(IRole role)
```
    An execution role that you can pass in a CreateModel API request.
    Default: - a role will be created.
    
    Parameters:
    
    role - An execution role that you can pass in a CreateModel API request. This parameter is required.
    
    Returns:
    
    this
  - subnetSelection
```
public SageMakerCreateModel.Builder subnetSelection(SubnetSelection subnetSelection)
```
    The subnets of the VPC to which the hosted model is connected (Note this parameter is only used when VPC is provided).
    Default: - Private Subnets are selected
    
    Parameters:
    
    subnetSelection - The subnets of the VPC to which the hosted model is connected (Note this parameter is only used when VPC is provided). This parameter is required.
    
    Returns:
    
    this
  - tags
```
public SageMakerCreateModel.Builder tags(TaskInput tags)
```
    Tags to be applied to the model.
    Default: - No tags
    
    Parameters:
    
    tags - Tags to be applied to the model. This parameter is required.
    
    Returns:
    
    this
  - vpc
```
public SageMakerCreateModel.Builder vpc(IVpc vpc)
```
    The VPC that is accessible by the hosted model.
    Default: - None
    
    Parameters:
    
    vpc - The VPC that is accessible by the hosted model. This parameter is required.
    
    Returns:
    
    this
  - build
```
public SageMakerCreateModel build()
```

Class SageMakerCreateModel.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

comment

heartbeat

inputPath

integrationPattern

outputPath

resultPath

resultSelector

timeout

modelName

primaryContainer

containers

enableNetworkIsolation

role

subnetSelection

tags

vpc

build