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

Class BedrockInvokeModel.Builder

java.lang.Object
software.amazon.awscdk.services.stepfunctions.tasks.BedrockInvokeModel.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<BedrockInvokeModel>
Enclosing class:
BedrockInvokeModel
@Stability(Stable) public static final class BedrockInvokeModel.Builder extends Object implements software.amazon.jsii.Builder<BedrockInvokeModel>
A fluent builder for BedrockInvokeModel.

  • Method Details

    • create

      @Stability(Stable) public static BedrockInvokeModel.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - Descriptive identifier for this chainable. This parameter is required.
      Returns:
      a new instance of BedrockInvokeModel.Builder.

    • comment

      @Stability(Stable) public BedrockInvokeModel.Builder comment(String comment)
      A comment describing this state.

      Default: No comment

      Parameters:
      comment - A comment describing this state. This parameter is required.
      Returns:
      this

    • queryLanguage

      @Stability(Stable) public BedrockInvokeModel.Builder queryLanguage(QueryLanguage 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.

      Default: - JSONPath

      Parameters:
      queryLanguage - The name of the query language used by the state. This parameter is required.
      Returns:
      this

    • stateName

      @Stability(Stable) public BedrockInvokeModel.Builder stateName(String stateName)
      Optional name for this state.

      Default: - The construct ID will be used as state name

      Parameters:
      stateName - Optional name for this state. This parameter is required.
      Returns:
      this

    • credentials

      @Stability(Stable) public BedrockInvokeModel.Builder credentials(Credentials credentials)
      Credentials for an IAM Role that the State Machine assumes for executing the task.

      This enables cross-account resource invocations.

      Default: - None (Task is executed using the State Machine's execution role)

      Parameters:
      credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This parameter is required.
      Returns:
      this
      See Also:

    • heartbeat

      @Stability(Deprecated) @Deprecated public BedrockInvokeModel.Builder heartbeat(Duration heartbeat)
      Deprecated.
      use heartbeatTimeout
      (deprecated) Timeout for the heartbeat.

      Default: - None

      Parameters:
      heartbeat - Timeout for the heartbeat. This parameter is required.
      Returns:
      this

    • heartbeatTimeout

      @Stability(Stable) public BedrockInvokeModel.Builder heartbeatTimeout(Timeout heartbeatTimeout)
      Timeout for the heartbeat.

      [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

      Default: - None

      Parameters:
      heartbeatTimeout - Timeout for the heartbeat. This parameter is required.
      Returns:
      this

    • integrationPattern

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

      Depending on the AWS Service, the Service Integration Pattern availability will vary.

      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:

    • taskTimeout

      @Stability(Stable) public BedrockInvokeModel.Builder taskTimeout(Timeout taskTimeout)
      Timeout for the task.

      [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

      Default: - None

      Parameters:
      taskTimeout - Timeout for the task. This parameter is required.
      Returns:
      this

    • timeout

      @Stability(Deprecated) @Deprecated public BedrockInvokeModel.Builder timeout(Duration timeout)
      Deprecated.
      use taskTimeout
      (deprecated) Timeout for the task.

      Default: - None

      Parameters:
      timeout - Timeout for the task. This parameter is required.
      Returns:
      this

    • assign

      @Stability(Stable) public BedrockInvokeModel.Builder assign(Map<String,? extends Object> 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.

      Default: - Not assign variables

      Parameters:
      assign - Workflow variables to store in this step. This parameter is required.
      Returns:
      this
      See Also:

    • inputPath

      @Stability(Stable) public BedrockInvokeModel.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: $

      Parameters:
      inputPath - JSONPath expression to select part of the state to be the input to this state. This parameter is required.
      Returns:
      this

    • outputPath

      @Stability(Stable) public BedrockInvokeModel.Builder outputPath(String 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 {}.

      Default: $

      Parameters:
      outputPath - JSONPath expression to select part of the state to be the output to this state. This parameter is required.
      Returns:
      this

    • outputs

      @Stability(Stable) public BedrockInvokeModel.Builder outputs(Object 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.

      Default: - $states.result or $states.errorOutput

      Parameters:
      outputs - Used to specify and transform output from the state. This parameter is required.
      Returns:
      this
      See Also:

    • resultPath

      @Stability(Stable) public BedrockInvokeModel.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: $

      Parameters:
      resultPath - JSONPath expression to indicate where to inject the state's output. This parameter is required.
      Returns:
      this

    • resultSelector

      @Stability(Stable) public BedrockInvokeModel.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:

    • model

      @Stability(Stable) public BedrockInvokeModel.Builder model(IModel model)
      The Bedrock model that the task will invoke.

      Parameters:
      model - The Bedrock model that the task will invoke. This parameter is required.
      Returns:
      this
      See Also:

    • accept

      @Stability(Stable) public BedrockInvokeModel.Builder accept(String accept)
      The desired MIME type of the inference body in the response.

      Default: 'application/json'

      Parameters:
      accept - The desired MIME type of the inference body in the response. This parameter is required.
      Returns:
      this
      See Also:

    • body

      @Stability(Stable) public BedrockInvokeModel.Builder body(TaskInput 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.

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

      Parameters:
      body - The input data for the Bedrock model invocation. This parameter is required.
      Returns:
      this
      See Also:

    • contentType

      @Stability(Deprecated) @Deprecated public BedrockInvokeModel.Builder contentType(String contentType)
      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'

      Parameters:
      contentType - The MIME type of the input data in the request. This parameter is required.
      Returns:
      this
      See Also:

    • guardrail

      @Stability(Stable) public BedrockInvokeModel.Builder guardrail(Guardrail guardrail)
      The guardrail is applied to the invocation.

      Default: - No guardrail is applied to the invocation.

      Parameters:
      guardrail - The guardrail is applied to the invocation. This parameter is required.
      Returns:
      this

    • input

      @Stability(Stable) public BedrockInvokeModel.Builder input(BedrockInvokeModelInputProps input)
      The source location to retrieve the input data from.

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

      Parameters:
      input - The source location to retrieve the input data from. This parameter is required.
      Returns:
      this

    • output

      @Stability(Stable) public BedrockInvokeModel.Builder output(BedrockInvokeModelOutputProps 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.

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

      Parameters:
      output - The destination location where the API response is written. This parameter is required.
      Returns:
      this

    • traceEnabled

      @Stability(Stable) public BedrockInvokeModel.Builder traceEnabled(Boolean traceEnabled)
      Specifies whether to enable or disable the Bedrock trace.

      Default: - Trace is not enabled for the invocation.

      Parameters:
      traceEnabled - Specifies whether to enable or disable the Bedrock trace. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public BedrockInvokeModel build()
      Specified by:
      build in interface software.amazon.jsii.Builder<BedrockInvokeModel>
      Returns:
      a newly built instance of BedrockInvokeModel.