AWS::RDS::Deployment

RDS Deployment

Resource Type definition for AWS::RDS::Deployment. Creates and manages an Amazon RDS Blue/Green Deployment.

Properties

12 configurable properties. 2 required. Click a row to see details.

Filter:
PropertyTypeFlags
BlueGreenDeploymentName
string
RequiredCreate-only
Source
string
RequiredCreate-only
Tags
Array<Tag>
TargetAllocatedStorage
integer
Create-onlyWrite-only
TargetDBClusterParameterGroupName
string
Create-onlyWrite-only
TargetDBInstanceClass
string
Create-onlyWrite-only
TargetDBParameterGroupName
string
Create-onlyWrite-only
TargetEngineVersion
string
Create-onlyWrite-only
TargetIops
integer
Create-onlyWrite-only
TargetStorageThroughput
integer
Create-onlyWrite-only
TargetStorageType
string
Create-onlyWrite-only
UpgradeTargetStorageConfig
boolean
Create-onlyWrite-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
ArnstringThe Amazon Resource Name (ARN) of the Blue/Green Deployment.
BlueGreenDeploymentIdentifierstringThe system-generated identifier of the Blue/Green Deployment.
CreateTimestringThe time when the Blue/Green Deployment was created in UTC.
StatusstringThe status of the Blue/Green Deployment.
SwitchoverDetailsArray<SwitchoverDetail>The source and target member mappings in the Blue/Green Deployment.
TargetstringThe ARN of the target database in the green environment.
TasksArray<DeploymentTask>The provisioning tasks for the Blue/Green Deployment.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::RDS::Deployment

Resources:
  MyResource:
    Type: AWS::RDS::Deployment
    Properties:
      BlueGreenDeploymentName: "my-bluegreendeploymentname"
      Source: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

rds:CreateBlueGreenDeploymentrds:DescribeBlueGreenDeploymentsrds:AddTagsToResourcerds:CreateDBInstanceReadReplicards:CreateDBClusterrds:CreateDBInstancerds:CreateDBClusterEndpointrds:CreateGlobalClusteriam:PassRole

read

rds:DescribeBlueGreenDeploymentsrds:ListTagsForResource

update

rds:DescribeBlueGreenDeploymentsrds:AddTagsToResourcerds:RemoveTagsFromResourcerds:ListTagsForResource

delete

rds:DescribeBlueGreenDeploymentsrds:DeleteBlueGreenDeploymentrds:DeleteDBInstancerds:DeleteDBClusterrds:DeleteDBClusterEndpointrds:DeleteGlobalClusterrds:PromoteReadReplicards:PromoteReadReplicaDBClusterrds:RemoveFromGlobalClusterrds:ListTagsForResource

list

rds:DescribeBlueGreenDeployments

Get the RDS Cheat Sheet

Everything you need to know about RDS on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceRDS
Properties19
Required2
TaggingSupported
Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

BlueGreenDeploymentNameSourceTargetEngineVersionTargetDBParameterGroupNameTargetDBClusterParameterGroupNameTargetDBInstanceClassUpgradeTargetStorageConfigTargetIopsTargetStorageTypeTargetAllocatedStorageTargetStorageThroughput

Related Resources

External Links