sfn/aws.sdk.kotlin.services.sfn.model/TestStateRequest/Builder

Builder

Properties

A JSON string representing a valid Context object for the state under test. This field may only be specified if a mock is specified in the same request.

definition

var definition: String?

The Amazon States Language (ASL) definition of the state or state machine.

input

var input: String?

A string that contains the JSON input data for the state.

inspectionLevel

var inspectionLevel: InspectionLevel?

Determines the values to return when a state is tested. You can specify one of the following types:

mock

var mock: MockInput?

Defines a mocked result or error for the state under test.

revealSecrets

var revealSecrets: Boolean?

Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query parameters, and body. Step Functions doesn't omit any information included in the state definition or the HTTP response.

roleArn

var roleArn: String?

The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.

stateConfiguration

var stateConfiguration: TestStateConfiguration?

Contains configurations for the state under test.

stateName

var stateName: String?

Denotes the particular state within a state machine definition to be tested. If this field is specified, the definition must contain a fully-formed state machine definition.

variables

var variables: String?

JSON object literal that sets variables used in the state under test. Object keys are the variable names and values are the variable values.

Functions

mock

fun mock(block: MockInput.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.sfn.model.MockInput inside the given block

stateConfiguration

fun stateConfiguration(block: TestStateConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.sfn.model.TestStateConfiguration inside the given block