/******************************************************************************* * 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.Imagebuilder; using Amazon.Imagebuilder.Model; namespace Amazon.PowerShell.Cmdlets.EC2IB { /// /// When you export your virtual machine (VM) from its virtualization environment, that /// process creates a set of one or more disk container files that act as snapshots of /// your VM’s environment, settings, and data. The Amazon EC2 API ImportImage /// action uses those files to import your VM and create an AMI. To import using the CLI /// command, see import-image /// You can reference the task ID from the VM import to pull in the AMI that the import /// created as the base image for your Image Builder recipe. /// /// [Cmdlet("Import", "EC2IBVmImage", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the EC2 Image Builder ImportVmImage API operation.", Operation = new[] {"ImportVmImage"}, SelectReturnType = typeof(Amazon.Imagebuilder.Model.ImportVmImageResponse))] [AWSCmdletOutput("System.String or Amazon.Imagebuilder.Model.ImportVmImageResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.Imagebuilder.Model.ImportVmImageResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class ImportEC2IBVmImageCmdlet : AmazonImagebuilderClientCmdlet, IExecutor { #region Parameter Description /// /// /// The description for the base image that is created by the import process. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Description { get; set; } #endregion #region Parameter Name /// /// /// The name of the base image that is created by the import process. /// /// #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 Name { get; set; } #endregion #region Parameter OsVersion /// /// /// The operating system version for the imported VM. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String OsVersion { get; set; } #endregion #region Parameter Platform /// /// /// The operating system platform for the imported VM. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [AWSConstantClassSource("Amazon.Imagebuilder.Platform")] public Amazon.Imagebuilder.Platform Platform { get; set; } #endregion #region Parameter SemanticVersion /// /// /// The semantic version to attach to the base image that was created during the import /// process. This version follows the semantic version syntax.The semantic version has four nodes: <major>.<minor>.<patch>/<build>. /// You can assign values for the first three, and can filter on all of them.Assignment: For the first three nodes you can assign any positive integer /// value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. /// Image Builder automatically assigns the build number to the fourth node.Patterns: You can use any numeric pattern that adheres to the assignment requirements /// for the nodes that you can assign. For example, you might choose a software version /// pattern, such as 1.0.0, or a date, such as 2021.01.01. /// /// #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 SemanticVersion { get; set; } #endregion #region Parameter Tag /// /// /// Tags that are attached to the import resources. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public System.Collections.Hashtable Tag { get; set; } #endregion #region Parameter VmImportTaskId /// /// /// The importTaskId (API) or ImportTaskId (CLI) from the Amazon /// EC2 VM import process. Image Builder retrieves information from the import process /// to pull in the AMI that is created from the VM source as the base image for your recipe. /// /// #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 VmImportTaskId { get; set; } #endregion #region Parameter ClientToken /// /// /// Unique, case-sensitive identifier you provide to ensure idempotency of the request. /// For more information, see Ensuring /// idempotency in the Amazon EC2 API Reference. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ClientToken { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'ImageArn'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Imagebuilder.Model.ImportVmImageResponse). /// Specifying the name of a property of type Amazon.Imagebuilder.Model.ImportVmImageResponse 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; } = "ImageArn"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the VmImportTaskId parameter. /// The -PassThru parameter is deprecated, use -Select '^VmImportTaskId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^VmImportTaskId' 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.VmImportTaskId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Import-EC2IBVmImage (ImportVmImage)")) { 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.VmImportTaskId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ClientToken = this.ClientToken; context.Description = this.Description; context.Name = this.Name; #if MODULAR if (this.Name == null && ParameterWasBound(nameof(this.Name))) { WriteWarning("You are passing $null as a value for parameter Name 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.OsVersion = this.OsVersion; context.Platform = this.Platform; #if MODULAR if (this.Platform == null && ParameterWasBound(nameof(this.Platform))) { WriteWarning("You are passing $null as a value for parameter Platform 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.SemanticVersion = this.SemanticVersion; #if MODULAR if (this.SemanticVersion == null && ParameterWasBound(nameof(this.SemanticVersion))) { WriteWarning("You are passing $null as a value for parameter SemanticVersion 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 Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.Tag.Keys) { context.Tag.Add((String)hashKey, (String)(this.Tag[hashKey])); } } context.VmImportTaskId = this.VmImportTaskId; #if MODULAR if (this.VmImportTaskId == null && ParameterWasBound(nameof(this.VmImportTaskId))) { WriteWarning("You are passing $null as a value for parameter VmImportTaskId 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.Imagebuilder.Model.ImportVmImageRequest(); if (cmdletContext.ClientToken != null) { request.ClientToken = cmdletContext.ClientToken; } if (cmdletContext.Description != null) { request.Description = cmdletContext.Description; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } if (cmdletContext.OsVersion != null) { request.OsVersion = cmdletContext.OsVersion; } if (cmdletContext.Platform != null) { request.Platform = cmdletContext.Platform; } if (cmdletContext.SemanticVersion != null) { request.SemanticVersion = cmdletContext.SemanticVersion; } if (cmdletContext.Tag != null) { request.Tags = cmdletContext.Tag; } if (cmdletContext.VmImportTaskId != null) { request.VmImportTaskId = cmdletContext.VmImportTaskId; } 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.Imagebuilder.Model.ImportVmImageResponse CallAWSServiceOperation(IAmazonImagebuilder client, Amazon.Imagebuilder.Model.ImportVmImageRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "EC2 Image Builder", "ImportVmImage"); try { #if DESKTOP return client.ImportVmImage(request); #elif CORECLR return client.ImportVmImageAsync(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 ClientToken { get; set; } public System.String Description { get; set; } public System.String Name { get; set; } public System.String OsVersion { get; set; } public Amazon.Imagebuilder.Platform Platform { get; set; } public System.String SemanticVersion { get; set; } public Dictionary Tag { get; set; } public System.String VmImportTaskId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.ImageArn; } } }