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

Interface BedrockInvokeModelProps

All Superinterfaces:

AssignableStateOptions, software.amazon.jsii.JsiiSerializable, JsonataCommonOptions, JsonPathCommonOptions, StateBaseProps, TaskStateBaseOptions, TaskStateBaseProps

All Known Implementing Classes:

BedrockInvokeModelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-06-03T14:45:00.455Z")
@Stability(Stable)
public interface BedrockInvokeModelProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

Properties for invoking a Bedrock Model.

Example:

 import software.amazon.awscdk.services.bedrock.*;
 FoundationModel model = FoundationModel.fromFoundationModelId(this, "Model", FoundationModelIdentifier.AMAZON_TITAN_TEXT_G1_EXPRESS_V1);
 BedrockInvokeModel task = BedrockInvokeModel.Builder.create(this, "Prompt Model")
         .model(model)
         .body(TaskInput.fromObject(Map.of(
                 "inputText", "Generate a list of five first names.",
                 "textGenerationConfig", Map.of(
                         "maxTokenCount", 100,
                         "temperature", 1))))
         .resultSelector(Map.of(
                 "names", JsonPath.stringAt("$.Body.results[0].outputText")))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	BedrockInvokeModelProps.Builder	A builder for BedrockInvokeModelProps
static final class	BedrockInvokeModelProps.Jsii$Proxy	An implementation for BedrockInvokeModelProps

Method Summary

Modifier and Type	Method	Description
static BedrockInvokeModelProps.Builder	builder()
default String	getAccept()	The desired MIME type of the inference body in the response.
default TaskInput	getBody()	The input data for the Bedrock model invocation.
default String	getContentType()	Deprecated. This property does not require configuration because the only acceptable value is 'application/json'.
default Guardrail	getGuardrail()	The guardrail is applied to the invocation.
default BedrockInvokeModelInputProps	getInput()	The source location to retrieve the input data from.
IModel	getModel()	The Bedrock model that the task will invoke.
default BedrockInvokeModelOutputProps	getOutput()	The destination location where the API response is written.
default Boolean	getTraceEnabled()	Specifies whether to enable or disable the Bedrock trace.

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.AssignableStateOptions

getAssign

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonataCommonOptions

getOutputs

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonPathCommonOptions

getInputPath, getOutputPath

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.StateBaseProps

getComment, getQueryLanguage, getStateName

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseOptions

getCredentials, getHeartbeat, getHeartbeatTimeout, getIntegrationPattern, getTaskTimeout, getTimeout

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps

getResultPath, getResultSelector

Method Details

getModel

@Stability(Stable)
@NotNull
IModel getModel()

The Bedrock model that the task will invoke.

See Also:

• https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html

getAccept

@Stability(Stable)
@Nullable
default String getAccept()

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

Default: 'application/json'

See Also:

• https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModel.html

getBody

@Stability(Stable)
@Nullable
default TaskInput getBody()

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.

Default: - Input data is retrieved from the location specified in the `input` field

See Also:

• https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html

getContentType

@Stability(Deprecated)
@Deprecated
@Nullable
default String getContentType()

Deprecated.

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

(deprecated) The MIME type of the input data in the request.

Default: 'application/json'

See Also:

• https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModel.html

getGuardrail

@Stability(Stable)
@Nullable
default Guardrail getGuardrail()

The guardrail is applied to the invocation.

Default: - No guardrail is applied to the invocation.

getInput

@Stability(Stable)
@Nullable
default BedrockInvokeModelInputProps getInput()

The source location to retrieve the input data from.

Default: - Input data is retrieved from the `body` field

getOutput

@Stability(Stable)
@Nullable
default BedrockInvokeModelOutputProps getOutput()

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.

Default: - The API response body is returned in the result.

getTraceEnabled

@Stability(Stable)
@Nullable
default Boolean getTraceEnabled()

Specifies whether to enable or disable the Bedrock trace.

Default: - Trace is not enabled for the invocation.

builder

@Stability(Stable)
static BedrockInvokeModelProps.Builder builder()

Returns:

a BedrockInvokeModelProps.Builder of BedrockInvokeModelProps