@aws-cdk_integ-tests-alpha.WaiterStateMachineOptions

interface WaiterStateMachineOptions ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.IntegTests.Alpha.WaiterStateMachineOptions
Gogithub.com/aws/aws-cdk-go/awscdkintegtestsalpha/v2#WaiterStateMachineOptions
Javasoftware.amazon.awscdk.integtests.alpha.WaiterStateMachineOptions
Pythonaws_cdk.integ_tests_alpha.WaiterStateMachineOptions
TypeScript (source)@aws-cdk/integ-tests-alpha ยป WaiterStateMachineOptions

Options for creating a WaiterStateMachine.

Example

declare const testCase: IntegTest;
declare const start: IApiCall;

const describe = testCase.assertions.awsApiCall('StepFunctions', 'describeExecution', {
  executionArn: start.getAttString('executionArn'),
}).expect(ExpectedResult.objectLike({
  status: 'SUCCEEDED',
})).waitForAssertions({
  totalTimeout: Duration.minutes(5),
  interval: Duration.seconds(15),
  backoffRate: 3,
});

Properties

NameTypeDescription
backoffRate?๐Ÿ”นnumberBackoff between attempts.
interval?๐Ÿ”นDurationThe interval (number of seconds) to wait between attempts.
totalTimeout?๐Ÿ”นDurationThe total time that the state machine will wait for a successful response.

backoffRate?๐Ÿ”น

Type: number (optional, default: 1 (no backoff))

Backoff between attempts.

This is the multiplier by which the retry interval increases after each retry attempt.

By default there is no backoff. Each retry will wait the amount of time specified by interval.


interval?๐Ÿ”น

Type: Duration (optional, default: Duration.seconds(5))

The interval (number of seconds) to wait between attempts.


totalTimeout?๐Ÿ”น

Type: Duration (optional, default: Duration.minutes(30))

The total time that the state machine will wait for a successful response.