/******************************************************************************* * 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.EC2; using Amazon.EC2.Model; namespace Amazon.PowerShell.Cmdlets.EC2 { /// /// Imports a disk into an EBS snapshot. /// /// /// /// For more information, see Importing /// a disk as a snapshot using VM Import/Export in the VM Import/Export User Guide. /// /// [Cmdlet("Import", "EC2Snapshot", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.EC2.Model.ImportSnapshotResponse")] [AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) ImportSnapshot API operation.", Operation = new[] {"ImportSnapshot"}, SelectReturnType = typeof(Amazon.EC2.Model.ImportSnapshotResponse))] [AWSCmdletOutput("Amazon.EC2.Model.ImportSnapshotResponse", "This cmdlet returns an Amazon.EC2.Model.ImportSnapshotResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class ImportEC2SnapshotCmdlet : AmazonEC2ClientCmdlet, IExecutor { protected override bool IsSensitiveRequest { get; set; } = true; protected override bool IsSensitiveResponse { get; set; } = true; #region Parameter ClientData_Comment /// /// /// A user-defined comment about the disk upload. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ClientData_Comment { get; set; } #endregion #region Parameter Description /// /// /// The description string for the import snapshot task. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Description { get; set; } #endregion #region Parameter DiskContainer_Description /// /// /// The description of the disk image being imported. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String DiskContainer_Description { get; set; } #endregion #region Parameter Encrypted /// /// /// Specifies whether the destination snapshot of the imported image should be encrypted. /// The default KMS key for EBS is used unless you specify a non-default KMS key using /// KmsKeyId. For more information, see Amazon /// EBS Encryption in the Amazon Elastic Compute Cloud User Guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? Encrypted { get; set; } #endregion #region Parameter DiskContainer_Format /// /// /// The format of the disk image being imported.Valid values: VHD | VMDK | RAW /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String DiskContainer_Format { get; set; } #endregion #region Parameter KmsKeyId /// /// /// An identifier for the symmetric KMS key to use when creating the encrypted snapshot. /// This parameter is only required if you want to use a non-default KMS key; if this /// parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId /// is specified, the Encrypted flag must also be set. The KMS key identifier may be provided in any of the following formats: Amazon Web Services parses KmsKeyId asynchronously, meaning that the /// action you call may appear to complete even though you provided an invalid identifier. /// This action will eventually report failure. The specified KMS key must exist in the Region that the snapshot is being copied to.Amazon EBS does not support asymmetric KMS keys. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String KmsKeyId { get; set; } #endregion #region Parameter RoleName /// /// /// The name of the role to use when not using the default role, 'vmimport'. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String RoleName { get; set; } #endregion #region Parameter DiskContainer_S3Bucket /// /// /// The name of the Amazon S3 bucket where the disk image is located. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("DiskContainer_UserBucket_S3Bucket")] public System.String DiskContainer_S3Bucket { get; set; } #endregion #region Parameter DiskContainer_S3Key /// /// /// The file name of the disk image. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("DiskContainer_UserBucket_S3Key")] public System.String DiskContainer_S3Key { get; set; } #endregion #region Parameter TagSpecification /// /// /// The tags to apply to the import snapshot task during creation. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("TagSpecifications")] public Amazon.EC2.Model.TagSpecification[] TagSpecification { get; set; } #endregion #region Parameter ClientData_UtcUploadEnd /// /// /// The time that the disk upload ends. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.DateTime? ClientData_UtcUploadEnd { get; set; } #endregion #region Parameter ClientData_UploadSize /// /// /// The size of the uploaded disk image, in GiB. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Double? ClientData_UploadSize { get; set; } #endregion #region Parameter ClientData_UtcUploadStart /// /// /// The time that the disk upload starts. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.DateTime? ClientData_UtcUploadStart { get; set; } #endregion #region Parameter DiskContainer_Url /// /// /// The URL to the Amazon S3-based disk image being imported. It can either be a https /// URL (https://..) or an Amazon S3 URL (s3://..). /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String DiskContainer_Url { get; set; } #endregion #region Parameter ClientToken /// /// /// Token to enable idempotency for VM import requests. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ClientToken { get; set; } #endregion #region Parameter ClientData_UploadEnd /// /// /// This property is deprecated. Setting this property results in non-UTC DateTimes not /// being marshalled correctly. Use UploadEndUtc instead. Setting either UploadEnd or /// UploadEndUtc results in both UploadEnd and UploadEndUtc being assigned, the latest /// assignment to either one of the two property is reflected in the value of both. UploadEnd /// is provided for backwards compatibility only and assigning a non-Utc DateTime to it /// results in the wrong timestamp being passed to the service.The time that the disk upload ends. /// /// This parameter is deprecated. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [System.ObsoleteAttribute("This parameter is deprecated and may result in the wrong timestamp being passed to the service, use ClientData_UtcUploadEnd instead.")] public System.DateTime? ClientData_UploadEnd { get; set; } #endregion #region Parameter ClientData_UploadStart /// /// /// This property is deprecated. Setting this property results in non-UTC DateTimes not /// being marshalled correctly. Use UploadStartUtc instead. Setting either UploadStart /// or UploadStartUtc results in both UploadStart and UploadStartUtc being assigned, the /// latest assignment to either one of the two property is reflected in the value of both. /// UploadStart is provided for backwards compatibility only and assigning a non-Utc DateTime /// to it results in the wrong timestamp being passed to the service.The time that the disk upload starts. /// /// This parameter is deprecated. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [System.ObsoleteAttribute("This parameter is deprecated and may result in the wrong timestamp being passed to the service, use ClientData_UtcUploadStart instead.")] public System.DateTime? ClientData_UploadStart { 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.EC2.Model.ImportSnapshotResponse). /// Specifying the name of a property of type Amazon.EC2.Model.ImportSnapshotResponse 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 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.RoleName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Import-EC2Snapshot (ImportSnapshot)")) { return; } var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); } context.ClientData_Comment = this.ClientData_Comment; context.ClientData_UtcUploadEnd = this.ClientData_UtcUploadEnd; context.ClientData_UploadSize = this.ClientData_UploadSize; context.ClientData_UtcUploadStart = this.ClientData_UtcUploadStart; #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ClientData_UploadEnd = this.ClientData_UploadEnd; #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ClientData_UploadStart = this.ClientData_UploadStart; #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ClientToken = this.ClientToken; context.Description = this.Description; context.DiskContainer_Description = this.DiskContainer_Description; context.DiskContainer_Format = this.DiskContainer_Format; context.DiskContainer_Url = this.DiskContainer_Url; context.DiskContainer_S3Bucket = this.DiskContainer_S3Bucket; context.DiskContainer_S3Key = this.DiskContainer_S3Key; context.Encrypted = this.Encrypted; context.KmsKeyId = this.KmsKeyId; context.RoleName = this.RoleName; if (this.TagSpecification != null) { context.TagSpecification = new List(this.TagSpecification); } // 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.EC2.Model.ImportSnapshotRequest(); // populate ClientData var requestClientDataIsNull = true; request.ClientData = new Amazon.EC2.Model.ClientData(); System.String requestClientData_clientData_Comment = null; if (cmdletContext.ClientData_Comment != null) { requestClientData_clientData_Comment = cmdletContext.ClientData_Comment; } if (requestClientData_clientData_Comment != null) { request.ClientData.Comment = requestClientData_clientData_Comment; requestClientDataIsNull = false; } System.DateTime? requestClientData_clientData_UtcUploadEnd = null; if (cmdletContext.ClientData_UtcUploadEnd != null) { requestClientData_clientData_UtcUploadEnd = cmdletContext.ClientData_UtcUploadEnd.Value; } if (requestClientData_clientData_UtcUploadEnd != null) { request.ClientData.UploadEndUtc = requestClientData_clientData_UtcUploadEnd.Value; requestClientDataIsNull = false; } System.Double? requestClientData_clientData_UploadSize = null; if (cmdletContext.ClientData_UploadSize != null) { requestClientData_clientData_UploadSize = cmdletContext.ClientData_UploadSize.Value; } if (requestClientData_clientData_UploadSize != null) { request.ClientData.UploadSize = requestClientData_clientData_UploadSize.Value; requestClientDataIsNull = false; } System.DateTime? requestClientData_clientData_UtcUploadStart = null; if (cmdletContext.ClientData_UtcUploadStart != null) { requestClientData_clientData_UtcUploadStart = cmdletContext.ClientData_UtcUploadStart.Value; } if (requestClientData_clientData_UtcUploadStart != null) { request.ClientData.UploadStartUtc = requestClientData_clientData_UtcUploadStart.Value; requestClientDataIsNull = false; } #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute System.DateTime? requestClientData_clientData_UploadEnd = null; if (cmdletContext.ClientData_UploadEnd != null) { if (cmdletContext.ClientData_UtcUploadEnd != null) { throw new System.ArgumentException("Parameters ClientData_UploadEnd and ClientData_UtcUploadEnd are mutually exclusive.", nameof(this.ClientData_UploadEnd)); } requestClientData_clientData_UploadEnd = cmdletContext.ClientData_UploadEnd.Value; } if (requestClientData_clientData_UploadEnd != null) { request.ClientData.UploadEnd = requestClientData_clientData_UploadEnd.Value; requestClientDataIsNull = false; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute System.DateTime? requestClientData_clientData_UploadStart = null; if (cmdletContext.ClientData_UploadStart != null) { if (cmdletContext.ClientData_UtcUploadStart != null) { throw new System.ArgumentException("Parameters ClientData_UploadStart and ClientData_UtcUploadStart are mutually exclusive.", nameof(this.ClientData_UploadStart)); } requestClientData_clientData_UploadStart = cmdletContext.ClientData_UploadStart.Value; } if (requestClientData_clientData_UploadStart != null) { request.ClientData.UploadStart = requestClientData_clientData_UploadStart.Value; requestClientDataIsNull = false; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute // determine if request.ClientData should be set to null if (requestClientDataIsNull) { request.ClientData = null; } if (cmdletContext.ClientToken != null) { request.ClientToken = cmdletContext.ClientToken; } if (cmdletContext.Description != null) { request.Description = cmdletContext.Description; } // populate DiskContainer var requestDiskContainerIsNull = true; request.DiskContainer = new Amazon.EC2.Model.SnapshotDiskContainer(); System.String requestDiskContainer_diskContainer_Description = null; if (cmdletContext.DiskContainer_Description != null) { requestDiskContainer_diskContainer_Description = cmdletContext.DiskContainer_Description; } if (requestDiskContainer_diskContainer_Description != null) { request.DiskContainer.Description = requestDiskContainer_diskContainer_Description; requestDiskContainerIsNull = false; } System.String requestDiskContainer_diskContainer_Format = null; if (cmdletContext.DiskContainer_Format != null) { requestDiskContainer_diskContainer_Format = cmdletContext.DiskContainer_Format; } if (requestDiskContainer_diskContainer_Format != null) { request.DiskContainer.Format = requestDiskContainer_diskContainer_Format; requestDiskContainerIsNull = false; } System.String requestDiskContainer_diskContainer_Url = null; if (cmdletContext.DiskContainer_Url != null) { requestDiskContainer_diskContainer_Url = cmdletContext.DiskContainer_Url; } if (requestDiskContainer_diskContainer_Url != null) { request.DiskContainer.Url = requestDiskContainer_diskContainer_Url; requestDiskContainerIsNull = false; } Amazon.EC2.Model.UserBucket requestDiskContainer_diskContainer_UserBucket = null; // populate UserBucket var requestDiskContainer_diskContainer_UserBucketIsNull = true; requestDiskContainer_diskContainer_UserBucket = new Amazon.EC2.Model.UserBucket(); System.String requestDiskContainer_diskContainer_UserBucket_diskContainer_S3Bucket = null; if (cmdletContext.DiskContainer_S3Bucket != null) { requestDiskContainer_diskContainer_UserBucket_diskContainer_S3Bucket = cmdletContext.DiskContainer_S3Bucket; } if (requestDiskContainer_diskContainer_UserBucket_diskContainer_S3Bucket != null) { requestDiskContainer_diskContainer_UserBucket.S3Bucket = requestDiskContainer_diskContainer_UserBucket_diskContainer_S3Bucket; requestDiskContainer_diskContainer_UserBucketIsNull = false; } System.String requestDiskContainer_diskContainer_UserBucket_diskContainer_S3Key = null; if (cmdletContext.DiskContainer_S3Key != null) { requestDiskContainer_diskContainer_UserBucket_diskContainer_S3Key = cmdletContext.DiskContainer_S3Key; } if (requestDiskContainer_diskContainer_UserBucket_diskContainer_S3Key != null) { requestDiskContainer_diskContainer_UserBucket.S3Key = requestDiskContainer_diskContainer_UserBucket_diskContainer_S3Key; requestDiskContainer_diskContainer_UserBucketIsNull = false; } // determine if requestDiskContainer_diskContainer_UserBucket should be set to null if (requestDiskContainer_diskContainer_UserBucketIsNull) { requestDiskContainer_diskContainer_UserBucket = null; } if (requestDiskContainer_diskContainer_UserBucket != null) { request.DiskContainer.UserBucket = requestDiskContainer_diskContainer_UserBucket; requestDiskContainerIsNull = false; } // determine if request.DiskContainer should be set to null if (requestDiskContainerIsNull) { request.DiskContainer = null; } if (cmdletContext.Encrypted != null) { request.Encrypted = cmdletContext.Encrypted.Value; } if (cmdletContext.KmsKeyId != null) { request.KmsKeyId = cmdletContext.KmsKeyId; } if (cmdletContext.RoleName != null) { request.RoleName = cmdletContext.RoleName; } if (cmdletContext.TagSpecification != null) { request.TagSpecifications = cmdletContext.TagSpecification; } 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.EC2.Model.ImportSnapshotResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.ImportSnapshotRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "ImportSnapshot"); try { #if DESKTOP return client.ImportSnapshot(request); #elif CORECLR return client.ImportSnapshotAsync(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 ClientData_Comment { get; set; } public System.DateTime? ClientData_UtcUploadEnd { get; set; } public System.Double? ClientData_UploadSize { get; set; } public System.DateTime? ClientData_UtcUploadStart { get; set; } [System.ObsoleteAttribute] public System.DateTime? ClientData_UploadEnd { get; set; } [System.ObsoleteAttribute] public System.DateTime? ClientData_UploadStart { get; set; } public System.String ClientToken { get; set; } public System.String Description { get; set; } public System.String DiskContainer_Description { get; set; } public System.String DiskContainer_Format { get; set; } public System.String DiskContainer_Url { get; set; } public System.String DiskContainer_S3Bucket { get; set; } public System.String DiskContainer_S3Key { get; set; } public System.Boolean? Encrypted { get; set; } public System.String KmsKeyId { get; set; } public System.String RoleName { get; set; } public List TagSpecification { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }