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

Class SageMakerCreateEndpointConfigProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<SageMakerCreateEndpointConfigProps>

Enclosing interface:

SageMakerCreateEndpointConfigProps

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

A builder for SageMakerCreateEndpointConfigProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SageMakerCreateEndpointConfigProps.Builder	assign(Map<String,? extends Object> assign)	Sets the value of AssignableStateOptions.getAssign()
SageMakerCreateEndpointConfigProps	build()	Builds the configured instance.
SageMakerCreateEndpointConfigProps.Builder	comment(String comment)	Sets the value of StateBaseProps.getComment()
SageMakerCreateEndpointConfigProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseOptions.getCredentials()
SageMakerCreateEndpointConfigProps.Builder	endpointConfigName(String endpointConfigName)	Sets the value of SageMakerCreateEndpointConfigProps.getEndpointConfigName()
SageMakerCreateEndpointConfigProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
SageMakerCreateEndpointConfigProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()
SageMakerCreateEndpointConfigProps.Builder	inputPath(String inputPath)	Sets the value of JsonPathCommonOptions.getInputPath()
SageMakerCreateEndpointConfigProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseOptions.getIntegrationPattern()
SageMakerCreateEndpointConfigProps.Builder	kmsKey(IKey kmsKey)	Sets the value of SageMakerCreateEndpointConfigProps.getKmsKey()
SageMakerCreateEndpointConfigProps.Builder	outputPath(String outputPath)	Sets the value of JsonPathCommonOptions.getOutputPath()
SageMakerCreateEndpointConfigProps.Builder	outputs(Object outputs)	Sets the value of JsonataCommonOptions.getOutputs()
SageMakerCreateEndpointConfigProps.Builder	productionVariants(List<? extends ProductionVariant> productionVariants)	Sets the value of SageMakerCreateEndpointConfigProps.getProductionVariants()
SageMakerCreateEndpointConfigProps.Builder	queryLanguage(QueryLanguage queryLanguage)	Sets the value of StateBaseProps.getQueryLanguage()
SageMakerCreateEndpointConfigProps.Builder	resultPath(String resultPath)	Sets the value of TaskStateBaseProps.getResultPath()
SageMakerCreateEndpointConfigProps.Builder	resultSelector(Map<String,? extends Object> resultSelector)	Sets the value of TaskStateBaseProps.getResultSelector()
SageMakerCreateEndpointConfigProps.Builder	stateName(String stateName)	Sets the value of StateBaseProps.getStateName()
SageMakerCreateEndpointConfigProps.Builder	tags(TaskInput tags)	Sets the value of SageMakerCreateEndpointConfigProps.getTags()
SageMakerCreateEndpointConfigProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseOptions.getTaskTimeout()
SageMakerCreateEndpointConfigProps.Builder	timeout(Duration timeout)	Deprecated. use `taskTimeout`

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

endpointConfigName

@Stability(Stable)
public SageMakerCreateEndpointConfigProps.Builder endpointConfigName(String endpointConfigName)

Sets the value of SageMakerCreateEndpointConfigProps.getEndpointConfigName()

Parameters:

endpointConfigName - The name of the endpoint configuration. This parameter is required.

Returns:

this

productionVariants

@Stability(Stable)
public SageMakerCreateEndpointConfigProps.Builder productionVariants(List<? extends ProductionVariant> productionVariants)

Sets the value of SageMakerCreateEndpointConfigProps.getProductionVariants()

Parameters:

productionVariants - An list of ProductionVariant objects, one for each model that you want to host at this endpoint. This parameter is required. Identifies a model that you want to host and the resources to deploy for hosting it. If you are deploying multiple models, tell Amazon SageMaker how to distribute traffic among the models by specifying variant weights.

Returns:

this

kmsKey

@Stability(Stable)
public SageMakerCreateEndpointConfigProps.Builder kmsKey(IKey kmsKey)

Sets the value of SageMakerCreateEndpointConfigProps.getKmsKey()

Parameters:

kmsKey - AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

Returns:

this

tags

@Stability(Stable)
public SageMakerCreateEndpointConfigProps.Builder tags(TaskInput tags)

Sets the value of SageMakerCreateEndpointConfigProps.getTags()

Parameters:

tags - Tags to be applied to the endpoint configuration.

Returns:

this

resultPath

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

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

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

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SageMakerCreateEndpointConfigProps

Throws:

NullPointerException - if any required attribute was not provided