dynamodb-waiters-fail-on-timeout

--dynamodb-waiters-fail-on-timeout is a global Boolean parameter for the Liquibase DynamoDB extension. It specifies whether Liquibase fails if the DynamoDbWaiter times out while attempting to verify whether a resource like a table in your DynamoDB database is in a valid state. The default value is true.

Uses

When you ask Amazon DynamoDB to run an operation on a resource in your database, such as creating, updating, or deleting a table, DynamoDB calls a waiter class first. Waiters are AWS SDK objects that ensure consistency in distributed systems when DynamoDB doesn't perform operations instantly, but some code needs to wait until those operations are fully completed.

The waiter repeatedly checks whether the table is in the correct state (it "polls" the table). If the table is in the correct state (ACTIVE or non-existent), the waiter approves the operation. Otherwise, if the table status is CREATING, UPDATING, or DELETING, it tries polling again. The waiter repeats this indefinitely or until it times out. For more information, see Poll for resource states in the AWS SDK for Java 2.x: Waiters.

Note: Liquibase does not use Amazon DynamoDB waiters when you create, update, or delete indexes.

When you run Liquibase commands like update and rollback, Liquibase runs your changesets sequentially. For every change, it waits a default amount of time for DynamoDB to respond before moving onto the next changeset. The default waiter settings are appropriate for most situations. However, some operations may require custom waiter values to avoid errors or keep your CI/CD pipeline efficient.

You can customize the following behavior with Liquibase waiter parameters:

  • Enabled: whether the waiter makes any polling attempts
  • Interval: how long to wait between polling attempts
  • Attempts: how many times to attempt to poll the resource
  • Timeout: the total amount of time to spend polling
  • Exit code: whether Liquibase fails after a waiter timeout
  • Logs: whether Liquibase tells you about the status of the waiter, and how often to do so

The --dynamodb-waiters-fail-on-timeout parameter controls which exit code Liquibase returns if the waiter times out:

  • If you want Liquibase to treat a timeout like a significant error and stop running, leave the parameter at its default value of true. This way, Liquibase returns an exit code of 1.
  • If you want to be informed of a timeout but want Liquibase to continue running, set the parameter to false. This way, Liquibase returns an exit code of 0.

Syntax

You can set this parameter in the following ways:

Option Syntax
Liquibase properties file 
liquibase.dynamodb.waiters.failOnTimeout: <true|false>
Global flow file argument (example) 
stages:
  Default:
    actions:
      - type: liquibase
        command: update
        globalArgs: { dynamodb-waiters-fail-on-timeout: "<true|false>" }
Global CLI parameter 
liquibase
 --dynamodb-waiters-fail-on-timeout=<true|false> update
 --changelog-file=example-changelog.xml

JVM system property (JAVA_OPTS Environment Variable)

 
JAVA_OPTS=-Dliquibase.dynamodb.waiters.failOnTimeout=<true|false>
Liquibase Environment Variables 
LIQUIBASE_DYNAMODB_WAITERS_FAIL_ON_TIMEOUT=<true|false>

For more information, see Working with Command Parameters.

Related links