/*******************************************************************************
* Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use
* this file except in compliance with the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file.
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
* *****************************************************************************
*
* AWS Tools for Windows (TM) PowerShell (TM)
*
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using System.Text;
using Amazon.PowerShell.Common;
using Amazon.Runtime;
using Amazon.RDS;
using Amazon.RDS.Model;
namespace Amazon.PowerShell.Cmdlets.RDS
{
///
/// 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. The staging environment stays in
/// sync with the current production environment using logical replication.
///
/// 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.
///
///
[Cmdlet("New", "RDSBlueGreenDeployment", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.RDS.Model.BlueGreenDeployment")]
[AWSCmdlet("Calls the Amazon Relational Database Service CreateBlueGreenDeployment API operation.", Operation = new[] {"CreateBlueGreenDeployment"}, SelectReturnType = typeof(Amazon.RDS.Model.CreateBlueGreenDeploymentResponse))]
[AWSCmdletOutput("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 also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewRDSBlueGreenDeploymentCmdlet : AmazonRDSClientCmdlet, IExecutor
{
#region Parameter BlueGreenDeploymentName
///
///
/// 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.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String BlueGreenDeploymentName { get; set; }
#endregion
#region Parameter Source
///
///
/// 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.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String Source { get; set; }
#endregion
#region Parameter Tag
///
///
/// Tags to assign to the blue/green deployment.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public Amazon.RDS.Model.Tag[] Tag { get; set; }
#endregion
#region Parameter TargetDBClusterParameterGroupName
///
///
/// 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.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String TargetDBClusterParameterGroupName { get; set; }
#endregion
#region Parameter TargetDBParameterGroupName
///
///
/// 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.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String TargetDBParameterGroupName { get; set; }
#endregion
#region Parameter TargetEngineVersion
///
///
/// The engine version of the database in the green environment.Specify the engine version to upgrade to in the green environment.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String TargetEngineVersion { get; set; }
#endregion
#region Parameter Select
///
/// 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.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "BlueGreenDeployment";
#endregion
#region Parameter Force
///
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter Force { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.BlueGreenDeploymentName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-RDSBlueGreenDeployment (CreateBlueGreenDeployment)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
}
context.BlueGreenDeploymentName = this.BlueGreenDeploymentName;
#if MODULAR
if (this.BlueGreenDeploymentName == null && ParameterWasBound(nameof(this.BlueGreenDeploymentName)))
{
WriteWarning("You are passing $null as a value for parameter BlueGreenDeploymentName which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.Source = this.Source;
#if MODULAR
if (this.Source == null && ParameterWasBound(nameof(this.Source)))
{
WriteWarning("You are passing $null as a value for parameter Source which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
if (this.Tag != null)
{
context.Tag = new List(this.Tag);
}
context.TargetDBClusterParameterGroupName = this.TargetDBClusterParameterGroupName;
context.TargetDBParameterGroupName = this.TargetDBParameterGroupName;
context.TargetEngineVersion = this.TargetEngineVersion;
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.RDS.Model.CreateBlueGreenDeploymentRequest();
if (cmdletContext.BlueGreenDeploymentName != null)
{
request.BlueGreenDeploymentName = cmdletContext.BlueGreenDeploymentName;
}
if (cmdletContext.Source != null)
{
request.Source = cmdletContext.Source;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
if (cmdletContext.TargetDBClusterParameterGroupName != null)
{
request.TargetDBClusterParameterGroupName = cmdletContext.TargetDBClusterParameterGroupName;
}
if (cmdletContext.TargetDBParameterGroupName != null)
{
request.TargetDBParameterGroupName = cmdletContext.TargetDBParameterGroupName;
}
if (cmdletContext.TargetEngineVersion != null)
{
request.TargetEngineVersion = cmdletContext.TargetEngineVersion;
}
CmdletOutput output;
// issue call
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
pipelineOutput = cmdletContext.Select(response, this);
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
return output;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.RDS.Model.CreateBlueGreenDeploymentResponse CallAWSServiceOperation(IAmazonRDS client, Amazon.RDS.Model.CreateBlueGreenDeploymentRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Relational Database Service", "CreateBlueGreenDeployment");
try
{
#if DESKTOP
return client.CreateBlueGreenDeployment(request);
#elif CORECLR
return client.CreateBlueGreenDeploymentAsync(request).GetAwaiter().GetResult();
#else
#error "Unknown build edition"
#endif
}
catch (AmazonServiceException exc)
{
var webException = exc.InnerException as System.Net.WebException;
if (webException != null)
{
throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
}
throw;
}
}
#endregion
internal partial class CmdletContext : ExecutorContext
{
public System.String BlueGreenDeploymentName { get; set; }
public System.String Source { get; set; }
public List Tag { get; set; }
public System.String TargetDBClusterParameterGroupName { get; set; }
public System.String TargetDBParameterGroupName { get; set; }
public System.String TargetEngineVersion { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.BlueGreenDeployment;
}
}
}