AWS::ARCRegionSwitch::Plan DocumentDbConfiguration - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::ARCRegionSwitch::Plan DocumentDbConfiguration

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

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Behavior" : ,
  "CrossAccountRole" : String,
  "DatabaseClusterArns" : [ String, ... ],
  "ExternalId" : String,
  "GlobalClusterIdentifier" : String,
  "TimeoutMinutes" : Number,
  "Ungraceful" : DocumentDbUngraceful
}

Properties

Behavior

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

Required: Yes

Type:

Update requires: No interruption

CrossAccountRole

The cross account role for the configuration.

Required: No

Type: String

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

Update requires: No interruption

DatabaseClusterArns

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

Required: Yes

Type: Array of String

Update requires: No interruption

ExternalId

The external ID (secret key) for the configuration.

Required: No

Type: String

Update requires: No interruption

GlobalClusterIdentifier

The global cluster identifier for a DocumentDB global cluster.

Required: Yes

Type: String

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

Update requires: No interruption

TimeoutMinutes

The timeout value specified for the configuration.

Required: No

Type: Number

Minimum: 1

Update requires: No interruption

Ungraceful

The settings for ungraceful execution.

Required: No

Type: DocumentDbUngraceful

Update requires: No interruption