# DocumentDbConfigurationProperty

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

- Source: Generated code
- Type last changed: v2.234.0 · 8 Jan 2026

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_arcregionswitch as arcregionswitch } from 'aws-cdk-lib';
const documentDbConfigurationProperty: arcregionswitch.CfnPlan.DocumentDbConfigurationProperty = {
  behavior: 'behavior',
  databaseClusterArns: ['databaseClusterArns'],
  globalClusterIdentifier: 'globalClusterIdentifier',

  // the properties below are optional
  crossAccountRole: 'crossAccountRole',
  externalId: 'externalId',
  timeoutMinutes: 123,
  ungraceful: {
    ungraceful: 'ungraceful',
  },
};
```

## Properties

- `behavior`: string (required) — The behavior for a global cluster, that is, only allow switchover or also allow failover.

- `crossAccountRole`: string — The cross account role for the configuration.

- `databaseClusterArns`: string[] (required) — The database cluster Amazon Resource Names (ARNs) for a DocumentDB global cluster.

- `externalId`: string — The external ID (secret key) for the configuration.

- `globalClusterIdentifier`: string (required) — The global cluster identifier for a DocumentDB global cluster.

- `timeoutMinutes`: number = 60 — The timeout value specified for the configuration.

- `ungraceful`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnPlan.DocumentDbUngracefulProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_arcregionswitch.CfnPlan.DocumentDbUngracefulProperty.html) — The settings for ungraceful execution.