/*******************************************************************************
* 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.OpsWorksCM;
using Amazon.OpsWorksCM.Model;
namespace Amazon.PowerShell.Cmdlets.OWCM
{
///
/// Restores a backup to a server that is in a CONNECTION_LOST
, HEALTHY
,
/// RUNNING
, UNHEALTHY
, or TERMINATED
state. When
/// you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance
/// is configured. RestoreServer maintains the existing server endpoint, so configuration
/// management of the server's client devices (nodes) should continue to work.
///
///
///
/// Restoring from a backup is performed by creating a new EC2 instance. If restoration
/// is successful, and the server is in a HEALTHY
state, AWS OpsWorks CM
/// switches traffic over to the new instance. After restoration is finished, the old
/// EC2 instance is maintained in a Running
or Stopped
state,
/// but is eventually terminated.
///
/// This operation is asynchronous.
///
/// An InvalidStateException
is thrown when the server is not in a valid
/// state. A ResourceNotFoundException
is thrown when the server does not
/// exist. A ValidationException
is raised when parameters of the request
/// are not valid.
///
///
[Cmdlet("Restore", "OWCMServer", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.OpsWorksCM.Model.RestoreServerResponse")]
[AWSCmdlet("Calls the AWS OpsWorksCM RestoreServer API operation.", Operation = new[] {"RestoreServer"}, SelectReturnType = typeof(Amazon.OpsWorksCM.Model.RestoreServerResponse))]
[AWSCmdletOutput("Amazon.OpsWorksCM.Model.RestoreServerResponse",
"This cmdlet returns an Amazon.OpsWorksCM.Model.RestoreServerResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class RestoreOWCMServerCmdlet : AmazonOpsWorksCMClientCmdlet, IExecutor
{
protected override bool IsSensitiveResponse { get; set; } = true;
#region Parameter BackupId
///
///
/// The ID of the backup that you want to use to restore a server.
///
///
#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 BackupId { get; set; }
#endregion
#region Parameter InstanceType
///
///
/// The type of instance to restore. Valid values must be specified in the following
/// format: ^([cm][34]|t2).*
For example, m5.large
. Valid values
/// are m5.large
, r5.xlarge
, and r5.2xlarge
. If
/// you do not specify this parameter, RestoreServer uses the instance type from the specified
/// backup.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String InstanceType { get; set; }
#endregion
#region Parameter KeyPair
///
///
/// The name of the key pair to set on the new EC2 instance. This can be helpful if the
/// administrator no longer has the SSH key.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String KeyPair { get; set; }
#endregion
#region Parameter ServerName
///
///
/// The name of the server that you want to restore.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
#else
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String ServerName { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is '*'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorksCM.Model.RestoreServerResponse).
/// Specifying the name of a property of type Amazon.OpsWorksCM.Model.RestoreServerResponse 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; } = "*";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the ServerName parameter.
/// The -PassThru parameter is deprecated, use -Select '^ServerName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ServerName' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#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.ServerName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Restore-OWCMServer (RestoreServer)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
if (this.PassThru.IsPresent)
{
throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select));
}
}
else if (this.PassThru.IsPresent)
{
context.Select = (response, cmdlet) => this.ServerName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.BackupId = this.BackupId;
#if MODULAR
if (this.BackupId == null && ParameterWasBound(nameof(this.BackupId)))
{
WriteWarning("You are passing $null as a value for parameter BackupId 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.InstanceType = this.InstanceType;
context.KeyPair = this.KeyPair;
context.ServerName = this.ServerName;
#if MODULAR
if (this.ServerName == null && ParameterWasBound(nameof(this.ServerName)))
{
WriteWarning("You are passing $null as a value for parameter ServerName 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
// 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.OpsWorksCM.Model.RestoreServerRequest();
if (cmdletContext.BackupId != null)
{
request.BackupId = cmdletContext.BackupId;
}
if (cmdletContext.InstanceType != null)
{
request.InstanceType = cmdletContext.InstanceType;
}
if (cmdletContext.KeyPair != null)
{
request.KeyPair = cmdletContext.KeyPair;
}
if (cmdletContext.ServerName != null)
{
request.ServerName = cmdletContext.ServerName;
}
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.OpsWorksCM.Model.RestoreServerResponse CallAWSServiceOperation(IAmazonOpsWorksCM client, Amazon.OpsWorksCM.Model.RestoreServerRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS OpsWorksCM", "RestoreServer");
try
{
#if DESKTOP
return client.RestoreServer(request);
#elif CORECLR
return client.RestoreServerAsync(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 BackupId { get; set; }
public System.String InstanceType { get; set; }
public System.String KeyPair { get; set; }
public System.String ServerName { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}