/******************************************************************************* * 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.WorkSpaces; using Amazon.WorkSpaces.Model; namespace Amazon.PowerShell.Cmdlets.WKS { /// /// Migrates a WorkSpace from one operating system or bundle type to another, while retaining /// the data on the user volume. /// /// /// /// The migration process recreates the WorkSpace by using a new root volume from the /// target bundle image and the user volume from the last available snapshot of the original /// WorkSpace. During migration, the original D:\Users\%USERNAME% user profile /// folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A /// new D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files /// in the old user profile are moved to the new user profile. /// /// For available migration scenarios, details about what happens during migration, and /// best practices, see Migrate /// a WorkSpace. /// /// [Cmdlet("Start", "WKSWorkspaceMigration", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.WorkSpaces.Model.MigrateWorkspaceResponse")] [AWSCmdlet("Calls the Amazon WorkSpaces MigrateWorkspace API operation.", Operation = new[] {"MigrateWorkspace"}, SelectReturnType = typeof(Amazon.WorkSpaces.Model.MigrateWorkspaceResponse))] [AWSCmdletOutput("Amazon.WorkSpaces.Model.MigrateWorkspaceResponse", "This cmdlet returns an Amazon.WorkSpaces.Model.MigrateWorkspaceResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class StartWKSWorkspaceMigrationCmdlet : AmazonWorkSpacesClientCmdlet, IExecutor { #region Parameter BundleId /// /// /// The identifier of the target bundle type to migrate the WorkSpace to. /// /// #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 BundleId { get; set; } #endregion #region Parameter SourceWorkspaceId /// /// /// The identifier of the WorkSpace to migrate from. /// /// #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 SourceWorkspaceId { 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.WorkSpaces.Model.MigrateWorkspaceResponse). /// Specifying the name of a property of type Amazon.WorkSpaces.Model.MigrateWorkspaceResponse 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 SourceWorkspaceId parameter. /// The -PassThru parameter is deprecated, use -Select '^SourceWorkspaceId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^SourceWorkspaceId' 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.SourceWorkspaceId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Start-WKSWorkspaceMigration (MigrateWorkspace)")) { 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.SourceWorkspaceId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.BundleId = this.BundleId; #if MODULAR if (this.BundleId == null && ParameterWasBound(nameof(this.BundleId))) { WriteWarning("You are passing $null as a value for parameter BundleId 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.SourceWorkspaceId = this.SourceWorkspaceId; #if MODULAR if (this.SourceWorkspaceId == null && ParameterWasBound(nameof(this.SourceWorkspaceId))) { WriteWarning("You are passing $null as a value for parameter SourceWorkspaceId 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.WorkSpaces.Model.MigrateWorkspaceRequest(); if (cmdletContext.BundleId != null) { request.BundleId = cmdletContext.BundleId; } if (cmdletContext.SourceWorkspaceId != null) { request.SourceWorkspaceId = cmdletContext.SourceWorkspaceId; } 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.WorkSpaces.Model.MigrateWorkspaceResponse CallAWSServiceOperation(IAmazonWorkSpaces client, Amazon.WorkSpaces.Model.MigrateWorkspaceRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon WorkSpaces", "MigrateWorkspace"); try { #if DESKTOP return client.MigrateWorkspace(request); #elif CORECLR return client.MigrateWorkspaceAsync(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 BundleId { get; set; } public System.String SourceWorkspaceId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }