View a markdown version of this page

AWS::ARCRegionSwitch::Plan GlobalAuroraConfiguration - AWS CloudFormation
SyntaxProperties

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

AWS::ARCRegionSwitch::Plan GlobalAuroraConfiguration

Configuration for Amazon Aurora global databases used in a Region switch plan.

Syntax

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

JSON

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

Properties

Behavior

The default behavior for the Aurora global database execution block. Valid values:

  • switchoverOnly - Calls SwitchoverGlobalCluster for a zero-data-loss switchover during graceful execution.

  • failover - Calls FailoverGlobalCluster with AllowDataLoss set to true. This operation might cause data loss, including during graceful execution.

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 global database.

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 global database.

Required: Yes

Type: String

Update requires: No interruption

TimeoutMinutes

The timeout value specified for the configuration.

Required: No

Type: Number

Minimum: 1

Update requires: No interruption

Ungraceful

The behavior to use when the plan runs in ungraceful mode. If you omit this value, Region switch uses the value of behavior.

Required: No

Type: GlobalAuroraUngraceful

Update requires: No interruption