DocumentDbConfiguration

Configuration for Amazon DocumentDB global clusters used in a Region switch plan.

behavior

The behavior for a global cluster, that is, only allow switchover or also allow failover.

Type: String

Valid Values: switchoverOnly | failover

Required: Yes

databaseClusterArns

The database cluster Amazon Resource Names (ARNs) for a DocumentDB global cluster.

Type: Array of strings

Pattern: arn:aws[a-zA-Z-]*:rds:[a-z0-9-]+:\d{12}:cluster:[a-zA-Z0-9][a-zA-Z0-9-_]{0,99}

Required: Yes

globalClusterIdentifier

The global cluster identifier for a DocumentDB global cluster.

Type: String

Pattern: [A-Za-z][0-9A-Za-z-:._]*

Required: Yes

crossAccountRole

The cross account role for the configuration.

Type: String

Pattern: arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+

Required: No

externalId

The external ID (secret key) for the configuration.

Type: String

Required: No

timeoutMinutes

The timeout value specified for the configuration.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

ungraceful

The settings for ungraceful execution.

Required: No

Contents