/******************************************************************************* * 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.RedshiftServerless; using Amazon.RedshiftServerless.Model; namespace Amazon.PowerShell.Cmdlets.RSS { /// /// Restores a namespace from a snapshot. /// [Cmdlet("Restore", "RSSFromSnapshot", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.RedshiftServerless.Model.RestoreFromSnapshotResponse")] [AWSCmdlet("Calls the Redshift Serverless RestoreFromSnapshot API operation.", Operation = new[] {"RestoreFromSnapshot"}, SelectReturnType = typeof(Amazon.RedshiftServerless.Model.RestoreFromSnapshotResponse))] [AWSCmdletOutput("Amazon.RedshiftServerless.Model.RestoreFromSnapshotResponse", "This cmdlet returns an Amazon.RedshiftServerless.Model.RestoreFromSnapshotResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class RestoreRSSFromSnapshotCmdlet : AmazonRedshiftServerlessClientCmdlet, IExecutor { protected override bool IsSensitiveResponse { get; set; } = true; #region Parameter NamespaceName /// /// /// The name of the namespace to restore the snapshot to. /// /// #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 NamespaceName { get; set; } #endregion #region Parameter OwnerAccount /// /// /// The Amazon Web Services account that owns the snapshot. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String OwnerAccount { get; set; } #endregion #region Parameter SnapshotArn /// /// /// The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring /// from Amazon Redshift Serverless to a provisioned cluster. Must not be specified at /// the same time as snapshotName.The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<snapshot_identifier>. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String SnapshotArn { get; set; } #endregion #region Parameter SnapshotName /// /// /// The name of the snapshot to restore from. Must not be specified at the same time as /// snapshotArn. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String SnapshotName { get; set; } #endregion #region Parameter WorkgroupName /// /// /// The name of the workgroup used to restore the snapshot. /// /// #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 WorkgroupName { 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.RedshiftServerless.Model.RestoreFromSnapshotResponse). /// Specifying the name of a property of type Amazon.RedshiftServerless.Model.RestoreFromSnapshotResponse 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 NamespaceName parameter. /// The -PassThru parameter is deprecated, use -Select '^NamespaceName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^NamespaceName' 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.NamespaceName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Restore-RSSFromSnapshot (RestoreFromSnapshot)")) { 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.NamespaceName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.NamespaceName = this.NamespaceName; #if MODULAR if (this.NamespaceName == null && ParameterWasBound(nameof(this.NamespaceName))) { WriteWarning("You are passing $null as a value for parameter NamespaceName 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.OwnerAccount = this.OwnerAccount; context.SnapshotArn = this.SnapshotArn; context.SnapshotName = this.SnapshotName; context.WorkgroupName = this.WorkgroupName; #if MODULAR if (this.WorkgroupName == null && ParameterWasBound(nameof(this.WorkgroupName))) { WriteWarning("You are passing $null as a value for parameter WorkgroupName 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.RedshiftServerless.Model.RestoreFromSnapshotRequest(); if (cmdletContext.NamespaceName != null) { request.NamespaceName = cmdletContext.NamespaceName; } if (cmdletContext.OwnerAccount != null) { request.OwnerAccount = cmdletContext.OwnerAccount; } if (cmdletContext.SnapshotArn != null) { request.SnapshotArn = cmdletContext.SnapshotArn; } if (cmdletContext.SnapshotName != null) { request.SnapshotName = cmdletContext.SnapshotName; } if (cmdletContext.WorkgroupName != null) { request.WorkgroupName = cmdletContext.WorkgroupName; } 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.RedshiftServerless.Model.RestoreFromSnapshotResponse CallAWSServiceOperation(IAmazonRedshiftServerless client, Amazon.RedshiftServerless.Model.RestoreFromSnapshotRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Redshift Serverless", "RestoreFromSnapshot"); try { #if DESKTOP return client.RestoreFromSnapshot(request); #elif CORECLR return client.RestoreFromSnapshotAsync(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 NamespaceName { get; set; } public System.String OwnerAccount { get; set; } public System.String SnapshotArn { get; set; } public System.String SnapshotName { get; set; } public System.String WorkgroupName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }