/******************************************************************************* * 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 { /// /// Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can /// copy a snapshot within the same Region, from one Region to another, or from a Region /// to an Outpost. You can't copy a snapshot from an Outpost to a Region, from one Outpost /// to another, or within the same Outpost. /// /// /// /// You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). /// /// When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. /// Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for /// the snapshot copy operation. By default, encrypted snapshot copies use the default /// Key Management Service (KMS) KMS key; however, you can specify a different KMS key. /// To copy an encrypted snapshot that has been shared from another account, you must /// have permissions for the KMS key used to encrypt the snapshot. /// /// Snapshots copied to an Outpost are encrypted by default using the default encryption /// key for the Region, or a different key that you specify in the request using KmsKeyId. /// Outposts do not support unencrypted snapshots. For more information, /// Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud /// User Guide. /// /// Snapshots created by copying another snapshot have an arbitrary volume ID that should /// not be used for any purpose. /// /// For more information, see Copy /// an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide. /// /// [Cmdlet("Copy", "EC2Snapshot", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) CopySnapshot API operation.", Operation = new[] {"CopySnapshot"}, SelectReturnType = typeof(Amazon.EC2.Model.CopySnapshotResponse))] [AWSCmdletOutput("System.String or Amazon.EC2.Model.CopySnapshotResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.EC2.Model.CopySnapshotResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class CopyEC2SnapshotCmdlet : AmazonEC2ClientCmdlet, IExecutor { #region Parameter Description /// /// /// A description for the EBS snapshot. /// /// [System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true)] public System.String Description { get; set; } #endregion #region Parameter DestinationOutpostArn /// /// /// The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only /// specify this parameter when copying a snapshot from an Amazon Web Services Region /// to an Outpost. The snapshot must be in the Region for the destination Outpost. You /// cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or /// within the same Outpost.For more information, see /// Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon /// Elastic Compute Cloud User Guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String DestinationOutpostArn { get; set; } #endregion #region Parameter DestinationRegion /// /// /// The destination Region to use in the PresignedUrl parameter of a snapshot /// copy operation. This parameter is only valid for specifying the destination Region /// in a PresignedUrl parameter, where it is required.The snapshot copy is sent to the regional endpoint that you sent the HTTP request /// to (for example, ec2.us-east-1.amazonaws.com). With the CLI, this is /// specified using the --region parameter or the default Region in your /// Amazon Web Services configuration file. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String DestinationRegion { get; set; } #endregion #region Parameter Encrypted /// /// /// To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, /// enable encryption using this parameter. Otherwise, omit this parameter. Encrypted /// snapshots are encrypted, even if you omit this parameter and encryption by default /// is not enabled. You cannot set this parameter to false. 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 KmsKeyId /// /// /// The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. /// If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId /// is specified, the encrypted state must be true.You can specify the KMS key using any of the following:Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify /// an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually /// fails. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String KmsKeyId { get; set; } #endregion #region Parameter SourceRegion /// /// /// The ID of the Region that contains the snapshot to be copied. /// /// #if !MODULAR [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String SourceRegion { get; set; } #endregion #region Parameter SourceSnapshotId /// /// /// The ID of the EBS snapshot to copy. /// /// #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 SourceSnapshotId { get; set; } #endregion #region Parameter TagSpecification /// /// /// The tags to apply to the new snapshot. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("TagSpecifications")] public Amazon.EC2.Model.TagSpecification[] TagSpecification { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'SnapshotId'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.CopySnapshotResponse). /// Specifying the name of a property of type Amazon.EC2.Model.CopySnapshotResponse 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; } = "SnapshotId"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the SourceSnapshotId parameter. /// The -PassThru parameter is deprecated, use -Select '^SourceSnapshotId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^SourceSnapshotId' 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.SourceSnapshotId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Copy-EC2Snapshot (CopySnapshot)")) { 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.SourceSnapshotId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.Description = this.Description; context.DestinationOutpostArn = this.DestinationOutpostArn; context.DestinationRegion = this.DestinationRegion; context.Encrypted = this.Encrypted; context.KmsKeyId = this.KmsKeyId; context.SourceRegion = this.SourceRegion; #if MODULAR if (this.SourceRegion == null && ParameterWasBound(nameof(this.SourceRegion))) { WriteWarning("You are passing $null as a value for parameter SourceRegion 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.SourceSnapshotId = this.SourceSnapshotId; #if MODULAR if (this.SourceSnapshotId == null && ParameterWasBound(nameof(this.SourceSnapshotId))) { WriteWarning("You are passing $null as a value for parameter SourceSnapshotId 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.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.CopySnapshotRequest(); if (cmdletContext.Description != null) { request.Description = cmdletContext.Description; } if (cmdletContext.DestinationOutpostArn != null) { request.DestinationOutpostArn = cmdletContext.DestinationOutpostArn; } if (cmdletContext.DestinationRegion != null) { request.DestinationRegion = cmdletContext.DestinationRegion; } if (cmdletContext.Encrypted != null) { request.Encrypted = cmdletContext.Encrypted.Value; } if (cmdletContext.KmsKeyId != null) { request.KmsKeyId = cmdletContext.KmsKeyId; } if (cmdletContext.SourceRegion != null) { request.SourceRegion = cmdletContext.SourceRegion; } if (cmdletContext.SourceSnapshotId != null) { request.SourceSnapshotId = cmdletContext.SourceSnapshotId; } 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.CopySnapshotResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.CopySnapshotRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "CopySnapshot"); try { #if DESKTOP return client.CopySnapshot(request); #elif CORECLR return client.CopySnapshotAsync(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 Description { get; set; } public System.String DestinationOutpostArn { get; set; } public System.String DestinationRegion { get; set; } public System.Boolean? Encrypted { get; set; } public System.String KmsKeyId { get; set; } public System.String SourceRegion { get; set; } public System.String SourceSnapshotId { get; set; } public List TagSpecification { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.SnapshotId; } } }