View a markdown version of this page

AWS::RDS::Deployment - Amazon CloudFormation
SyntaxPropertiesReturn values
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::RDS::Deployment

Creates a blue/green deployment.

A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment, and it stays in sync with the current production environment.

You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch over the environments to promote the green environment to be the new production environment. The switchover typically takes under a minute.

For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

Syntax

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

JSON

{
  "Type" : "AWS::RDS::Deployment",
  "Properties" : {
      "BlueGreenDeploymentName" : String,
      "Source" : String,
      "Tags" : [ Tag, ... ],
      "TargetAllocatedStorage" : Integer,
      "TargetDBClusterParameterGroupName" : String,
      "TargetDBInstanceClass" : String,
      "TargetDBParameterGroupName" : String,
      "TargetEngineVersion" : String,
      "TargetIops" : Integer,
      "TargetStorageThroughput" : Integer,
      "TargetStorageType" : String,
      "UpgradeTargetStorageConfig" : Boolean
    }
}

Properties

BlueGreenDeploymentName

The user-supplied name of the blue/green deployment.

Required: Yes

Type: String

Pattern: ^[a-zA-Z](?:-?[a-zA-Z0-9]+)*$

Minimum: 1

Maximum: 60

Update requires: Replacement

Source

The source database for the blue/green deployment.

Before switchover, the source database is the production database in the blue environment.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 2048

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: No interruption

TargetAllocatedStorage

Property description not available.

Required: No

Type: Integer

Update requires: Replacement

TargetDBClusterParameterGroupName

Property description not available.

Required: No

Type: String

Pattern: ^[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\.\.)[0-9A-Za-z-.]*[^-]$

Minimum: 1

Maximum: 255

Update requires: Replacement

TargetDBInstanceClass

Property description not available.

Required: No

Type: String

Pattern: ^db\.[0-9a-z]{2,6}\.[0-9a-z]{4,9}$

Minimum: 5

Maximum: 20

Update requires: Replacement

TargetDBParameterGroupName

Property description not available.

Required: No

Type: String

Pattern: ^[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\.\.)[0-9A-Za-z-.]*[^-]$

Minimum: 1

Maximum: 255

Update requires: Replacement

TargetEngineVersion

Property description not available.

Required: No

Type: String

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

Minimum: 1

Maximum: 64

Update requires: Replacement

TargetIops

Property description not available.

Required: No

Type: Integer

Update requires: Replacement

TargetStorageThroughput

Property description not available.

Required: No

Type: Integer

Update requires: Replacement

TargetStorageType

Property description not available.

Required: No

Type: String

Update requires: Replacement

UpgradeTargetStorageConfig

Property description not available.

Required: No

Type: Boolean

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

BlueGreenDeploymentIdentifier

The unique identifier of the blue/green deployment.

CreateTime

The time when the blue/green deployment was created, in Universal Coordinated Time (UTC).

Status

The status of the blue/green deployment.

Valid Values:

  • PROVISIONING - Resources are being created in the green environment.

  • AVAILABLE - Resources are available in the green environment.

  • SWITCHOVER_IN_PROGRESS - The deployment is being switched from the blue environment to the green environment.

  • SWITCHOVER_COMPLETED - Switchover from the blue environment to the green environment is complete.

  • INVALID_CONFIGURATION - Resources in the green environment are invalid, so switchover isn't possible.

  • SWITCHOVER_FAILED - Switchover was attempted but failed.

  • DELETING - The blue/green deployment is being deleted.

SwitchoverDetails

The details about each source and target resource in the blue/green deployment.

Target

The target database for the blue/green deployment.

Before switchover, the target database is the clone database in the green environment.

Tasks

Either tasks to be performed or tasks that have been completed on the target database before switchover.