Liquibase Parameters for Amazon DynamoDB

You can control the way Liquibase behaves when running commands on your Amazon DynamoDB database by setting Liquibase parameters. For example, you can use them to configure timeout values and data billing settings.

For a list of general Liquibase parameters, see Liquibase Parameters.

For more information about Amazon DynamoDB, see Liquibase Amazon DynamoDB Extension Overview. For a getting started tutorial, see Using Liquibase with Amazon DynamoDB.

List of parameters

Note: Syntax for each parameter is specified in kebab-case (CLI and flow file), camelCase (properties file and JAVA_OPTS), and MACRO_CASE (environment variable).

Tip: For best results, specify all commands and parameters in the --kebab-case format in the CLI. If your preference is camelCase, it also works in the CLI.

Name (--cli, {flow-file}, propertiesFile, ENV_VAR) Type Description 
--dynamodb-tracking-tables-billing-mode
globalArgs: {dynamodb-tracking-tables-billing-mode: "val"}
liquibase.dynamodb.trackingTables.billingMode
LIQUIBASE_DYNAMODB_TRACKING_TABLES_BILLING_MODE

Read more: --dynamodb-tracking-tables-billing-mode

 String

Initial billing mode for Liquibase tracking tables (DBCL and DBCLL). This controls how you pay for database read/write operations and capacity. Valid values: PROVISIONED and PAY_PER_REQUEST. Default: PAY_PER_REQUEST. See also: BillingModeSummary.

Note: If you want to change the billing mode of the tracking tables after you create them, you must instead use the updateDynamoTable Change Type.

 
--dynamodb-tracking-tables-provisioned-throughput-read-capacity-units
globalArgs: {dynamodb-tracking-tables-provisioned-throughput-read-capacity-units: "val"}
liquibase.dynamodb.trackingTables.provisionedThroughput.readCapacityUnits
LIQUIBASE_DYNAMODB_TRACKING_TABLES_PROVISIONED_THROUGHPUT_READ_CAPACITY_UNITS

Read more: --dynamodb-tracking-tables-provisioned-throughput-read-capacity-units

 Integer

Specifies how many readCapacityUnits to initially use for the PROVISIONED billing mode for Liquibase tracking tables (DBCL and DBCLL). Ignored for the PAY_PER_REQUEST billing mode. Default: 10. See also: Read/write capacity mode.

Note: If you want to change the provisioned throughput values of the tracking tables after you create them, you must instead use the updateDynamoTable or updateTableProvisionedThroughput Change Type.

 

 
--dynamodb-tracking-tables-provisioned-throughput-write-capacity-units
globalArgs: {dynamodb-tracking-tables-provisioned-throughput-write-capacity-units: "val"}
liquibase.dynamodb.trackingTables.provisionedThroughput.writeCapacityUnits
LIQUIBASE_DYNAMODB_TRACKING_TABLES_PROVISIONED_THROUGHPUT_WRITE_CAPACITY_UNITS

Read more: --dynamodb-tracking-tables-provisioned-throughput-write-capacity-units

 Integer

Specifies how many writeCapacityUnits to initially use for the PROVISIONED billing mode for Liquibase tracking tables (DBCL and DBCLL). Ignored for the PAY_PER_REQUEST billing mode. Default: 10. See also: Read/write capacity mode.

Note: If you want to change the provisioned throughput values of the tracking tables after you create them, you must instead use the updateDynamoTable or updateTableProvisionedThroughput Change Type.

 

 
--dynamodb-waiters-enabled
globalArgs: {dynamodb-waiters-enabled: "val"}
liquibase.dynamodb.waiters.enabled
LIQUIBASE_DYNAMODB_WAITERS_ENABLED

Read more: --dynamodb-waiters-enabled

 Boolean

Specifies whether to enable or disable the DynamoDbWaiter for all Liquibase DynamoDB operations. When true, Liquibase waits for DynamoDB operations in a changeset to be fully complete before moving onto the next changeset. When false, Liquibase moves onto the next changeset while the first one may still be in a pending state, potentially saving time. When false, Liquibase also suppresses all other --dynamodb-waiter-* parameters. Default: true. See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.

Warning: If you set this parameter to false, you risk unexpected behavior. You must ensure that any changesets you deploy do not try to access objects that are in a pending state.

 
--dynamodb-waiters-fail-on-timeout
globalArgs: {dynamodb-waiters-fail-on-timeout: "val"}
liquibase.dynamodb.waiters.failOnTimeout
LIQUIBASE_DYNAMODB_WAITERS_FAIL_ON_TIMEOUT

Read more: --dynamodb-waiters-fail-on-timeout

 Boolean

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. If true, Liquibase returns 1 when the waiter times out. If false, Liquibase returns 0 when the waiter times out. Default: true. See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.

 
--dynamodb-waiters-log-notification-enabled
globalArgs: {dynamodb-waiters-log-notification-enabled: "val"}
liquibase.dynamodb.waiters.log.notification.enabled
LIQUIBASE_DYNAMODB_WAITERS_LOG_NOTIFICATION_ENABLED

Read more: --dynamodb-waiters-log-notification-enabled

 Boolean

Specifies whether Liquibase sends you periodic status notifications while the DynamoDbWaiter polls resources in your database. Default: true.

 
--dynamodb-waiters-log-notification-interval
globalArgs: {dynamodb-waiters-log-notification-interval: "val"}
liquibase.dynamodb.waiters.log.notification.interval
LIQUIBASE_DYNAMODB_WAITERS_LOG_NOTIFICATION_INTERVAL

Read more: --dynamodb-waiters-log-notification-interval

 Integer

Specifies the interval in milliseconds for Liquibase to wait between sending status notifications while the DynamoDbWaiter polls resources in your database. Default: 4000.

 
--dynamodb-waiter-create-fixed-delay-backoff-strategy-duration
globalArgs: {dynamodb-waiter-create-fixed-delay-backoff-strategy-duration: "val"}
liquibase.dynamodb.waiter.create.fixedDelayBackoffStrategy.duration
LIQUIBASE_DYNAMODB_WAITER_CREATE_FIXED_DELAY_BACKOFF_STRATEGY_DURATION

Read more: --dynamodb-waiter-create-fixed-delay-backoff-strategy-duration

 Integer

Number of seconds for the DynamoDbWaiter to wait before trying to poll your table again (between attempts). This interval is used between calls to verify that the table is created and operable. Default: 20. See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.

 
--dynamodb-waiter-create-max-attempts
globalArgs: {dynamodb-waiter-create-max-attempts: "val"}
liquibase.dynamodb.waiter.create.maxAttempts
LIQUIBASE_DYNAMODB_WAITER_CREATE_MAX_ATTEMPTS

Read more: --dynamodb-waiter-create-max-attempts

 Integer

Maximum number of attempts for the DynamoDbWaiter. The waiter repeatedly polls your table to see if it is created and operable. When the waiter exceeds this number of attempts, it enters a failure state. Default: 25. See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.

 
--dynamodb-waiter-create-total-timeout
globalArgs: {dynamodb-waiter-create-total-timeout: "val"}
liquibase.dynamodb.waiter.create.totalTimeout
LIQUIBASE_DYNAMODB_WAITER_CREATE_TOTAL_TIMEOUT

Read more: --dynamodb-waiter-create-total-timeout

 Integer

Total number of seconds for the DynamoDbWaiter to wait for the table to be created and operable. If the waiter sees that the table is in the correct state, the operation finishes and Liquibase moves onto the next changeset, no matter how much time has passed. If the waiter reaches the maximum timeout, Liquibase throws an error. Default: null (disabled). See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.

 
--dynamodb-waiter-delete-fixed-delay-backoff-strategy-duration
globalArgs: {dynamodb-waiter-delete-fixed-delay-backoff-strategy-duration: "val"}
liquibase.dynamodb.waiter.delete.fixedDelayBackoffStrategy.duration
LIQUIBASE_DYNAMODB_WAITER_DELETE_FIXED_DELAY_BACKOFF_STRATEGY_DURATION

Read more: --dynamodb-waiter-delete-fixed-delay-backoff-strategy-duration

 Integer

Number of seconds for the DynamoDbWaiter to wait before trying to poll your table again (between attempts). This interval is used between calls to verify that the table is deleted. Default: 20. See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.

 
--dynamodb-waiter-delete-max-attempts
globalArgs: {dynamodb-waiter-delete-max-attempts: "val"}
liquibase.dynamodb.waiter.delete.maxAttempts
LIQUIBASE_DYNAMODB_WAITER_DELETE_MAX_ATTEMPTS

Read more: --dynamodb-waiter-delete-max-attempts

 Integer

Maximum number of attempts for the DynamoDbWaiter. The waiter repeatedly polls your table to see if it is deleted. When the waiter exceeds this number of attempts, it enters a failure state. Default: 25. See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.

 
--dynamodb-waiter-delete-total-timeout
globalArgs: {dynamodb-waiter-delete-total-timeout: "val"}
liquibase.dynamodb.waiter.delete.totalTimeout
LIQUIBASE_DYNAMODB_WAITER_DELETE_TOTAL_TIMEOUT

Read more: --dynamodb-waiter-delete-total-timeout

 Integer

Total number of seconds for the DynamoDbWaiter to wait for the table to be deleted. If the waiter sees that the table is in the correct state, the operation finishes and Liquibase moves onto the next changeset, no matter how much time has passed. If the waiter reaches the maximum timeout, Liquibase throws an error. Default: null (disabled). See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.

 
--dynamodb-waiter-update-fixed-delay-backoff-strategy-duration
globalArgs: {dynamodb-waiter-update-fixed-delay-backoff-strategy-duration: "val"}
liquibase.dynamodb.waiter.update.fixedDelayBackoffStrategyDuration
LIQUIBASE_DYNAMODB_WAITER_UPDATE_FIXED_DELAY_BACKOFF_STRATEGY_DURATION

Read more: --dynamodb-waiter-update-fixed-delay-backoff-strategy-duration

 Integer

Number of seconds for the DynamoDbWaiter to wait before trying to poll your table again (between attempts). This interval is used between calls to verify that the table is updated and operable. Default: 20. See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.

 
--dynamodb-waiter-update-max-attempts
globalArgs: {dynamodb-waiter-update-max-attempts: "val"}
liquibase.dynamodb.waiter.update.maxAttempts
LIQUIBASE_DYNAMODB_WAITER_UPDATE_MAX_ATTEMPTS

Read more: --dynamodb-waiter-update-max-attempts

 Integer

Maximum number of attempts for the DynamoDbWaiter. The waiter repeatedly polls your table to see if it is updated and operable. When the waiter exceeds this number of attempts, it enters a failure state. Default: 25. See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.

 
--dynamodb-waiter-update-total-timeout
globalArgs: {dynamodb-waiter-update-total-timeout: "val"}
liquibase.dynamodb.waiter.update.totalTimeout
LIQUIBASE_DYNAMODB_WAITER_UPDATE_TOTAL_TIMEOUT

Read more: --dynamodb-waiter-update-total-timeout

 Integer

Total number of seconds for the DynamoDbWaiter to wait for the table to be updated and operable. If the waiter sees that the table is in the correct state, the operation finishes and Liquibase moves onto the next changeset, no matter how much time has passed. If the waiter reaches the maximum timeout, Liquibase throws an error. Default: null (disabled). See also: Poll for resource states in the AWS SDK for Java 2.x: Waiters.