/******************************************************************************* * 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.FSx; using Amazon.FSx.Model; namespace Amazon.PowerShell.Cmdlets.FSX { /// <summary> /// Copies an existing backup within the same Amazon Web Services account to another Amazon /// Web Services Region (cross-Region copy) or within the same Amazon Web Services Region /// (in-Region copy). You can have up to five backup copy requests in progress to a single /// destination Region per account. /// /// /// <para> /// You can use cross-Region backup copies for cross-Region disaster recovery. You can /// periodically take backups and copy them to another Region so that in the event of /// a disaster in the primary Region, you can restore from backup and recover availability /// quickly in the other Region. You can make cross-Region copies only within your Amazon /// Web Services partition. A partition is a grouping of Regions. Amazon Web Services /// currently has three partitions: <code>aws</code> (Standard Regions), <code>aws-cn</code> /// (China Regions), and <code>aws-us-gov</code> (Amazon Web Services GovCloud [US] Regions). /// </para><para> /// You can also use backup copies to clone your file dataset to another Region or within /// the same Region. /// </para><para> /// You can use the <code>SourceRegion</code> parameter to specify the Amazon Web Services /// Region from which the backup will be copied. For example, if you make the call from /// the <code>us-west-1</code> Region and want to copy a backup from the <code>us-east-2</code> /// Region, you specify <code>us-east-2</code> in the <code>SourceRegion</code> parameter /// to make a cross-Region copy. If you don't specify a Region, the backup copy is created /// in the same Region where the request is sent from (in-Region copy). /// </para><para> /// For more information about creating backup copies, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html#copy-backups"> /// Copying backups</a> in the <i>Amazon FSx for Windows User Guide</i>, <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html#copy-backups">Copying /// backups</a> in the <i>Amazon FSx for Lustre User Guide</i>, and <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/using-backups.html#copy-backups">Copying /// backups</a> in the <i>Amazon FSx for OpenZFS User Guide</i>. /// </para> /// </summary> [Cmdlet("Copy", "FSXBackup", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.FSx.Model.Backup")] [AWSCmdlet("Calls the Amazon FSx CopyBackup API operation.", Operation = new[] {"CopyBackup"}, SelectReturnType = typeof(Amazon.FSx.Model.CopyBackupResponse))] [AWSCmdletOutput("Amazon.FSx.Model.Backup or Amazon.FSx.Model.CopyBackupResponse", "This cmdlet returns an Amazon.FSx.Model.Backup object.", "The service call response (type Amazon.FSx.Model.CopyBackupResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class CopyFSXBackupCmdlet : AmazonFSxClientCmdlet, IExecutor { protected override bool IsSensitiveResponse { get; set; } = true; #region Parameter ClientRequestToken /// <summary> /// <para> /// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ClientRequestToken { get; set; } #endregion #region Parameter CopyTag /// <summary> /// <para> /// <para>A Boolean flag indicating whether tags from the source backup should be copied to /// the backup copy. This value defaults to <code>false</code>.</para><para>If you set <code>CopyTags</code> to <code>true</code> and the source backup has existing /// tags, you can use the <code>Tags</code> parameter to create new tags, provided that /// the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of /// tags are merged. If there are tag conflicts (for example, two tags with the same key /// but different values), the tags created with the <code>Tags</code> parameter take /// precedence.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("CopyTags")] public System.Boolean? CopyTag { get; set; } #endregion #region Parameter KmsKeyId /// <summary> /// <para> /// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String KmsKeyId { get; set; } #endregion #region Parameter SourceBackupId /// <summary> /// <para> /// <para>The ID of the source backup. Specifies the ID of the backup that's being copied.</para> /// </para> /// </summary> #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 SourceBackupId { get; set; } #endregion #region Parameter SourceRegion /// <summary> /// <para> /// <para>The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services /// Region from which the backup is being copied. The source and destination Regions must /// be in the same Amazon Web Services partition. If you don't specify a Region, <code>SourceRegion</code> /// defaults to the Region where the request is sent from (in-Region copy).</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String SourceRegion { get; set; } #endregion #region Parameter Tag /// <summary> /// <para> /// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public Amazon.FSx.Model.Tag[] Tag { get; set; } #endregion #region Parameter Select /// <summary> /// Use the -Select parameter to control the cmdlet output. The default value is 'Backup'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FSx.Model.CopyBackupResponse). /// Specifying the name of a property of type Amazon.FSx.Model.CopyBackupResponse will result in that property being returned. /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "Backup"; #endregion #region Parameter PassThru /// <summary> /// Changes the cmdlet behavior to return the value passed to the SourceBackupId parameter. /// The -PassThru parameter is deprecated, use -Select '^SourceBackupId' instead. This parameter will be removed in a future version. /// </summary> [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^SourceBackupId' 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 /// <summary> /// This parameter overrides confirmation prompts to force /// the cmdlet to continue its operation. This parameter should always /// be used with caution. /// </summary> [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.SourceBackupId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Copy-FSXBackup (CopyBackup)")) { 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<Amazon.FSx.Model.CopyBackupResponse, CopyFSXBackupCmdlet>(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.SourceBackupId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ClientRequestToken = this.ClientRequestToken; context.CopyTag = this.CopyTag; context.KmsKeyId = this.KmsKeyId; context.SourceBackupId = this.SourceBackupId; #if MODULAR if (this.SourceBackupId == null && ParameterWasBound(nameof(this.SourceBackupId))) { WriteWarning("You are passing $null as a value for parameter SourceBackupId 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.SourceRegion = this.SourceRegion; if (this.Tag != null) { context.Tag = new List<Amazon.FSx.Model.Tag>(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.FSx.Model.CopyBackupRequest(); if (cmdletContext.ClientRequestToken != null) { request.ClientRequestToken = cmdletContext.ClientRequestToken; } if (cmdletContext.CopyTag != null) { request.CopyTags = cmdletContext.CopyTag.Value; } if (cmdletContext.KmsKeyId != null) { request.KmsKeyId = cmdletContext.KmsKeyId; } if (cmdletContext.SourceBackupId != null) { request.SourceBackupId = cmdletContext.SourceBackupId; } if (cmdletContext.SourceRegion != null) { request.SourceRegion = cmdletContext.SourceRegion; } 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.FSx.Model.CopyBackupResponse CallAWSServiceOperation(IAmazonFSx client, Amazon.FSx.Model.CopyBackupRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon FSx", "CopyBackup"); try { #if DESKTOP return client.CopyBackup(request); #elif CORECLR return client.CopyBackupAsync(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 ClientRequestToken { get; set; } public System.Boolean? CopyTag { get; set; } public System.String KmsKeyId { get; set; } public System.String SourceBackupId { get; set; } public System.String SourceRegion { get; set; } public List<Amazon.FSx.Model.Tag> Tag { get; set; } public System.Func<Amazon.FSx.Model.CopyBackupResponse, CopyFSXBackupCmdlet, object> Select { get; set; } = (response, cmdlet) => response.Backup; } } }