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

Class BedrockInvokeModelProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<BedrockInvokeModelProps>

Enclosing interface:

BedrockInvokeModelProps

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

A builder for BedrockInvokeModelProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BedrockInvokeModelProps.Builder	accept(String accept)	Sets the value of BedrockInvokeModelProps.getAccept()
BedrockInvokeModelProps.Builder	assign(Map<String,? extends Object> assign)	Sets the value of AssignableStateOptions.getAssign()
BedrockInvokeModelProps.Builder	body(TaskInput body)	Sets the value of BedrockInvokeModelProps.getBody()
BedrockInvokeModelProps	build()	Builds the configured instance.
BedrockInvokeModelProps.Builder	comment(String comment)	Sets the value of StateBaseProps.getComment()
BedrockInvokeModelProps.Builder	contentType(String contentType)	Deprecated. This property does not require configuration because the only acceptable value is 'application/json'.
BedrockInvokeModelProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseOptions.getCredentials()
BedrockInvokeModelProps.Builder	guardrail(Guardrail guardrail)	Sets the value of BedrockInvokeModelProps.getGuardrail()
BedrockInvokeModelProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
BedrockInvokeModelProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()
BedrockInvokeModelProps.Builder	input(BedrockInvokeModelInputProps input)	Sets the value of BedrockInvokeModelProps.getInput()
BedrockInvokeModelProps.Builder	inputPath(String inputPath)	Sets the value of JsonPathCommonOptions.getInputPath()
BedrockInvokeModelProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseOptions.getIntegrationPattern()
BedrockInvokeModelProps.Builder	model(IModel model)	Sets the value of BedrockInvokeModelProps.getModel()
BedrockInvokeModelProps.Builder	output(BedrockInvokeModelOutputProps output)	Sets the value of BedrockInvokeModelProps.getOutput()
BedrockInvokeModelProps.Builder	outputPath(String outputPath)	Sets the value of JsonPathCommonOptions.getOutputPath()
BedrockInvokeModelProps.Builder	outputs(Object outputs)	Sets the value of JsonataCommonOptions.getOutputs()
BedrockInvokeModelProps.Builder	queryLanguage(QueryLanguage queryLanguage)	Sets the value of StateBaseProps.getQueryLanguage()
BedrockInvokeModelProps.Builder	resultPath(String resultPath)	Sets the value of TaskStateBaseProps.getResultPath()
BedrockInvokeModelProps.Builder	resultSelector(Map<String,? extends Object> resultSelector)	Sets the value of TaskStateBaseProps.getResultSelector()
BedrockInvokeModelProps.Builder	stateName(String stateName)	Sets the value of StateBaseProps.getStateName()
BedrockInvokeModelProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseOptions.getTaskTimeout()
BedrockInvokeModelProps.Builder	timeout(Duration timeout)	Deprecated. use `taskTimeout`
BedrockInvokeModelProps.Builder	traceEnabled(Boolean traceEnabled)	Sets the value of BedrockInvokeModelProps.getTraceEnabled()

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

model

@Stability(Stable)
public BedrockInvokeModelProps.Builder model(IModel model)

Sets the value of BedrockInvokeModelProps.getModel()

Parameters:

model - The Bedrock model that the task will invoke. This parameter is required.

Returns:

this

accept

@Stability(Stable)
public BedrockInvokeModelProps.Builder accept(String accept)

Sets the value of BedrockInvokeModelProps.getAccept()

Parameters:

accept - The desired MIME type of the inference body in the response.

Returns:

this

body

@Stability(Stable)
public BedrockInvokeModelProps.Builder body(TaskInput body)

Sets the value of BedrockInvokeModelProps.getBody()

Parameters:

body - The input data for the Bedrock model invocation. The inference parameters contained in the body depend on the Bedrock model being used.

The body must be in the format specified in the contentType field. For example, if the content type is application/json, the body must be JSON formatted.

The body must be up to 256 KB in size. For input data that exceeds 256 KB, use input instead to retrieve the input data from S3.

You must specify either the body or the input field, but not both.

Returns:

this

contentType

@Stability(Deprecated)
@Deprecated
public BedrockInvokeModelProps.Builder contentType(String contentType)

Deprecated.

This property does not require configuration because the only acceptable value is 'application/json'.

Sets the value of BedrockInvokeModelProps.getContentType()

Parameters:

contentType - The MIME type of the input data in the request.

Returns:

this

guardrail

@Stability(Stable)
public BedrockInvokeModelProps.Builder guardrail(Guardrail guardrail)

Sets the value of BedrockInvokeModelProps.getGuardrail()

Parameters:

guardrail - The guardrail is applied to the invocation.

Returns:

this

input

@Stability(Stable)
public BedrockInvokeModelProps.Builder input(BedrockInvokeModelInputProps input)

Sets the value of BedrockInvokeModelProps.getInput()

Parameters:

input - The source location to retrieve the input data from.

Returns:

this

output

@Stability(Stable)
public BedrockInvokeModelProps.Builder output(BedrockInvokeModelOutputProps output)

Sets the value of BedrockInvokeModelProps.getOutput()

Parameters:

output - The destination location where the API response is written. If you specify this field, the API response body is replaced with a reference to the output location.

Returns:

this

traceEnabled

@Stability(Stable)
public BedrockInvokeModelProps.Builder traceEnabled(Boolean traceEnabled)

Sets the value of BedrockInvokeModelProps.getTraceEnabled()

Parameters:

traceEnabled - Specifies whether to enable or disable the Bedrock trace.

Returns:

this

resultPath

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

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

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

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of BedrockInvokeModelProps

Throws:

NullPointerException - if any required attribute was not provided