/******************************************************************************* * 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 { /// /// Converts a recovery point to a snapshot. For more information about recovery points /// and snapshots, see Working /// with snapshots and recovery points. /// [Cmdlet("Convert", "RSSRecoveryPointToSnapshot", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.RedshiftServerless.Model.Snapshot")] [AWSCmdlet("Calls the Redshift Serverless ConvertRecoveryPointToSnapshot API operation.", Operation = new[] {"ConvertRecoveryPointToSnapshot"}, SelectReturnType = typeof(Amazon.RedshiftServerless.Model.ConvertRecoveryPointToSnapshotResponse))] [AWSCmdletOutput("Amazon.RedshiftServerless.Model.Snapshot or Amazon.RedshiftServerless.Model.ConvertRecoveryPointToSnapshotResponse", "This cmdlet returns an Amazon.RedshiftServerless.Model.Snapshot object.", "The service call response (type Amazon.RedshiftServerless.Model.ConvertRecoveryPointToSnapshotResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class ConvertRSSRecoveryPointToSnapshotCmdlet : AmazonRedshiftServerlessClientCmdlet, IExecutor { #region Parameter RecoveryPointId /// /// /// The unique identifier of the recovery point. /// /// #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 RecoveryPointId { get; set; } #endregion #region Parameter RetentionPeriod /// /// /// How long to retain the snapshot. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? RetentionPeriod { get; set; } #endregion #region Parameter SnapshotName /// /// /// The name of 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 SnapshotName { get; set; } #endregion #region Parameter Tag /// /// /// An array of Tag /// objects to associate with the created snapshot. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public Amazon.RedshiftServerless.Model.Tag[] Tag { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Snapshot'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RedshiftServerless.Model.ConvertRecoveryPointToSnapshotResponse). /// Specifying the name of a property of type Amazon.RedshiftServerless.Model.ConvertRecoveryPointToSnapshotResponse 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; } = "Snapshot"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the RecoveryPointId parameter. /// The -PassThru parameter is deprecated, use -Select '^RecoveryPointId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^RecoveryPointId' 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.RecoveryPointId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Convert-RSSRecoveryPointToSnapshot (ConvertRecoveryPointToSnapshot)")) { 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.RecoveryPointId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.RecoveryPointId = this.RecoveryPointId; #if MODULAR if (this.RecoveryPointId == null && ParameterWasBound(nameof(this.RecoveryPointId))) { WriteWarning("You are passing $null as a value for parameter RecoveryPointId 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.RetentionPeriod = this.RetentionPeriod; context.SnapshotName = this.SnapshotName; #if MODULAR if (this.SnapshotName == null && ParameterWasBound(nameof(this.SnapshotName))) { WriteWarning("You are passing $null as a value for parameter SnapshotName 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); } // 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.ConvertRecoveryPointToSnapshotRequest(); if (cmdletContext.RecoveryPointId != null) { request.RecoveryPointId = cmdletContext.RecoveryPointId; } if (cmdletContext.RetentionPeriod != null) { request.RetentionPeriod = cmdletContext.RetentionPeriod.Value; } if (cmdletContext.SnapshotName != null) { request.SnapshotName = cmdletContext.SnapshotName; } if (cmdletContext.Tag != null) { request.Tags = cmdletContext.Tag; } 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.ConvertRecoveryPointToSnapshotResponse CallAWSServiceOperation(IAmazonRedshiftServerless client, Amazon.RedshiftServerless.Model.ConvertRecoveryPointToSnapshotRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Redshift Serverless", "ConvertRecoveryPointToSnapshot"); try { #if DESKTOP return client.ConvertRecoveryPointToSnapshot(request); #elif CORECLR return client.ConvertRecoveryPointToSnapshotAsync(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 RecoveryPointId { get; set; } public System.Int32? RetentionPeriod { get; set; } public System.String SnapshotName { get; set; } public List Tag { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Snapshot; } } }