/*******************************************************************************
* 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.EC2;
using Amazon.EC2.Model;
namespace Amazon.PowerShell.Cmdlets.EC2
{
///
/// Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies
/// the restore period or restore type for a snapshot that was previously temporarily
/// restored.
///
///
///
/// For more information see
/// Restore an archived snapshot and
/// modify the restore period or restore type for a temporarily restored snapshot
/// in the Amazon Elastic Compute Cloud User Guide.
///
///
[Cmdlet("Restore", "EC2SnapshotTier", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.EC2.Model.RestoreSnapshotTierResponse")]
[AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) RestoreSnapshotTier API operation.", Operation = new[] {"RestoreSnapshotTier"}, SelectReturnType = typeof(Amazon.EC2.Model.RestoreSnapshotTierResponse))]
[AWSCmdletOutput("Amazon.EC2.Model.RestoreSnapshotTierResponse",
"This cmdlet returns an Amazon.EC2.Model.RestoreSnapshotTierResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class RestoreEC2SnapshotTierCmdlet : AmazonEC2ClientCmdlet, IExecutor
{
#region Parameter PermanentRestore
///
///
/// Indicates whether to permanently restore an archived snapshot. To permanently restore
/// an archived snapshot, specify true
and omit the RestoreSnapshotTierRequest$TemporaryRestoreDays
/// parameter.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? PermanentRestore { get; set; }
#endregion
#region Parameter SnapshotId
///
///
/// The ID of the snapshot 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 SnapshotId { get; set; }
#endregion
#region Parameter TemporaryRestoreDay
///
///
/// Specifies the number of days for which to temporarily restore an archived snapshot.
/// Required for temporary restores only. The snapshot will be automatically re-archived
/// after this period.To temporarily restore an archived snapshot, specify the number of days and omit the
/// PermanentRestore parameter or set it to false
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("TemporaryRestoreDays")]
public System.Int32? TemporaryRestoreDay { 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.EC2.Model.RestoreSnapshotTierResponse).
/// Specifying the name of a property of type Amazon.EC2.Model.RestoreSnapshotTierResponse 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 SnapshotId parameter.
/// The -PassThru parameter is deprecated, use -Select '^SnapshotId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^SnapshotId' 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.SnapshotId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Restore-EC2SnapshotTier (RestoreSnapshotTier)"))
{
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.SnapshotId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.PermanentRestore = this.PermanentRestore;
context.SnapshotId = this.SnapshotId;
#if MODULAR
if (this.SnapshotId == null && ParameterWasBound(nameof(this.SnapshotId)))
{
WriteWarning("You are passing $null as a value for parameter SnapshotId 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.TemporaryRestoreDay = this.TemporaryRestoreDay;
// 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.EC2.Model.RestoreSnapshotTierRequest();
if (cmdletContext.PermanentRestore != null)
{
request.PermanentRestore = cmdletContext.PermanentRestore.Value;
}
if (cmdletContext.SnapshotId != null)
{
request.SnapshotId = cmdletContext.SnapshotId;
}
if (cmdletContext.TemporaryRestoreDay != null)
{
request.TemporaryRestoreDays = cmdletContext.TemporaryRestoreDay.Value;
}
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.EC2.Model.RestoreSnapshotTierResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.RestoreSnapshotTierRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "RestoreSnapshotTier");
try
{
#if DESKTOP
return client.RestoreSnapshotTier(request);
#elif CORECLR
return client.RestoreSnapshotTierAsync(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.Boolean? PermanentRestore { get; set; }
public System.String SnapshotId { get; set; }
public System.Int32? TemporaryRestoreDay { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}