AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Relational Database Service CreateBlueGreenDeployment API operation.

Syntax

New-RDSBlueGreenDeployment
-BlueGreenDeploymentName <String>
-Source <String>
-Tag <Tag[]>
-TargetAllocatedStorage <Int32>
-TargetDBClusterParameterGroupName <String>
-TargetDBInstanceClass <String>
-TargetDBParameterGroupName <String>
-TargetEngineVersion <String>
-TargetIops <Int32>
-TargetStorageThroughput <Int32>
-TargetStorageType <String>
-UpgradeTargetStorageConfig <Boolean>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonRDSConfig>

Description

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.

Parameters

-BlueGreenDeploymentName <String>
The name of the blue/green deployment.Constraints:
  • Can't be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonRDSConfig>
Amazon.PowerShell.Cmdlets.RDS.AmazonRDSClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'BlueGreenDeployment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RDS.Model.CreateBlueGreenDeploymentResponse). Specifying the name of a property of type Amazon.RDS.Model.CreateBlueGreenDeploymentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Source <String>
The Amazon Resource Name (ARN) of the source production database.Specify the database that you want to clone. The blue/green deployment creates this database in the green environment. You can make updates to the database in the green environment, such as an engine version upgrade. When you are ready, you can switch the database in the green environment to be the production database.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
Tags to assign to the blue/green deployment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TargetAllocatedStorage <Int32>
The amount of storage in gibibytes (GiB) to allocate for the green DB instance. You can choose to increase or decrease the allocated storage on the green DB instance.This setting doesn't apply to Amazon Aurora blue/green deployments.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TargetDBClusterParameterGroupName <String>
The DB cluster parameter group associated with the Aurora DB cluster in the green environment.To test parameter changes, specify a DB cluster parameter group that is different from the one associated with the source DB cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TargetDBInstanceClass <String>
Specify the DB instance class for the databases in the green environment.This parameter only applies to RDS DB instances, because DB instances within an Aurora DB cluster can have multiple different instance classes. If you're creating a blue/green deployment from an Aurora DB cluster, don't specify this parameter. After the green environment is created, you can individually modify the instance classes of the DB instances within the green DB cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TargetDBParameterGroupName <String>
The DB parameter group associated with the DB instance in the green environment.To test parameter changes, specify a DB parameter group that is different from the one associated with the source DB instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TargetEngineVersion <String>
The engine version of the database in the green environment.Specify the engine version to upgrade to in the green environment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TargetIops <Int32>
The amount of Provisioned IOPS (input/output operations per second) to allocate for the green DB instance. For information about valid IOPS values, see Amazon RDS DB instance storage in the Amazon RDS User Guide.This setting doesn't apply to Amazon Aurora blue/green deployments.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TargetStorageThroughput <Int32>
The storage throughput value for the green DB instance.This setting applies only to the gp3 storage type.This setting doesn't apply to Amazon Aurora blue/green deployments.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TargetStorageType <String>
The storage type to associate with the green DB instance.Valid Values: gp2 | gp3 | io1 | io2This setting doesn't apply to Amazon Aurora blue/green deployments.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UpgradeTargetStorageConfig <Boolean>
Whether to upgrade the storage file system configuration on the green database. This option migrates the green DB instance from the older 32-bit file system to the preferred configuration. For more information, see Upgrading the storage file system for a DB instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.RDS.Model.BlueGreenDeployment or Amazon.RDS.Model.CreateBlueGreenDeploymentResponse
This cmdlet returns an Amazon.RDS.Model.BlueGreenDeployment object. The service call response (type Amazon.RDS.Model.CreateBlueGreenDeploymentResponse) can be returned by specifying '-Select *'.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z