/******************************************************************************* * 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 { /// /// You can modify several parameters of an existing EBS volume, including volume size, /// volume type, and IOPS capacity. If your EBS volume is attached to a current-generation /// EC2 instance type, you might be able to apply these changes without stopping the instance /// or detaching the volume from it. For more information about modifying EBS volumes, /// see Amazon /// EBS Elastic Volumes (Linux instances) or Amazon /// EBS Elastic Volumes (Windows instances). /// /// /// /// When you complete a resize operation on your volume, you need to extend the volume's /// file-system size to take advantage of the new storage capacity. For more information, /// see Extend /// a Linux file system or Extend /// a Windows file system. /// /// You can use CloudWatch Events to check the status of a modification to an EBS volume. /// For information about CloudWatch Events, see the Amazon /// CloudWatch Events User Guide. You can also track the status of a modification /// using DescribeVolumesModifications. For information about tracking status changes /// using either method, see Monitor /// the progress of volume modifications. /// /// With previous-generation instance types, resizing an EBS volume might require detaching /// and reattaching the volume or stopping and restarting the instance. /// /// After modifying a volume, you must wait at least six hours and ensure that the volume /// is in the in-use or available state before you can modify /// the same volume. This is sometimes referred to as a cooldown period. /// /// [Cmdlet("Edit", "EC2Volume", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.EC2.Model.VolumeModification")] [AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) ModifyVolume API operation.", Operation = new[] {"ModifyVolume"}, SelectReturnType = typeof(Amazon.EC2.Model.ModifyVolumeResponse))] [AWSCmdletOutput("Amazon.EC2.Model.VolumeModification or Amazon.EC2.Model.ModifyVolumeResponse", "This cmdlet returns an Amazon.EC2.Model.VolumeModification object.", "The service call response (type Amazon.EC2.Model.ModifyVolumeResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class EditEC2VolumeCmdlet : AmazonEC2ClientCmdlet, IExecutor { #region Parameter Iops /// /// /// The target IOPS rate of the volume. This parameter is valid only for gp3, /// io1, and io2 volumes.The following are the supported values for each volume type:Default: The existing value is retained if you keep the same volume type. If you change /// the volume type to io1, io2, or gp3, the default /// is 3,000. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? Iops { get; set; } #endregion #region Parameter MultiAttachEnabled /// /// /// Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you /// can attach the volume to up to 16 /// Nitro-based instances in the same Availability Zone. This parameter is supported /// with io1 and io2 volumes only. For more information, see /// /// Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? MultiAttachEnabled { get; set; } #endregion #region Parameter Size /// /// /// The target size of the volume, in GiB. The target volume size must be greater than /// or equal to the existing size of the volume.The following are the supported volumes sizes for each volume type:Default: The existing size is retained. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? Size { get; set; } #endregion #region Parameter Throughput /// /// /// The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 /// volumes. The maximum value is 1,000.Default: The existing value is retained if the source and target volume type is gp3. /// Otherwise, the default value is 125.Valid Range: Minimum value of 125. Maximum value of 1000. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? Throughput { get; set; } #endregion #region Parameter VolumeId /// /// /// The ID of the volume. /// /// #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 VolumeId { get; set; } #endregion #region Parameter VolumeType /// /// /// The target EBS volume type of the volume. For more information, see Amazon /// EBS volume types in the Amazon Elastic Compute Cloud User Guide.Default: The existing type is retained. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.EC2.VolumeType")] public Amazon.EC2.VolumeType VolumeType { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'VolumeModification'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.ModifyVolumeResponse). /// Specifying the name of a property of type Amazon.EC2.Model.ModifyVolumeResponse 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; } = "VolumeModification"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the VolumeId parameter. /// The -PassThru parameter is deprecated, use -Select '^VolumeId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^VolumeId' 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.VolumeId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Edit-EC2Volume (ModifyVolume)")) { 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.VolumeId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.Iops = this.Iops; context.MultiAttachEnabled = this.MultiAttachEnabled; context.Size = this.Size; context.Throughput = this.Throughput; context.VolumeId = this.VolumeId; #if MODULAR if (this.VolumeId == null && ParameterWasBound(nameof(this.VolumeId))) { WriteWarning("You are passing $null as a value for parameter VolumeId 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.VolumeType = this.VolumeType; // 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.ModifyVolumeRequest(); if (cmdletContext.Iops != null) { request.Iops = cmdletContext.Iops.Value; } if (cmdletContext.MultiAttachEnabled != null) { request.MultiAttachEnabled = cmdletContext.MultiAttachEnabled.Value; } if (cmdletContext.Size != null) { request.Size = cmdletContext.Size.Value; } if (cmdletContext.Throughput != null) { request.Throughput = cmdletContext.Throughput.Value; } if (cmdletContext.VolumeId != null) { request.VolumeId = cmdletContext.VolumeId; } if (cmdletContext.VolumeType != null) { request.VolumeType = cmdletContext.VolumeType; } 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.ModifyVolumeResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.ModifyVolumeRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "ModifyVolume"); try { #if DESKTOP return client.ModifyVolume(request); #elif CORECLR return client.ModifyVolumeAsync(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.Int32? Iops { get; set; } public System.Boolean? MultiAttachEnabled { get; set; } public System.Int32? Size { get; set; } public System.Int32? Throughput { get; set; } public System.String VolumeId { get; set; } public Amazon.EC2.VolumeType VolumeType { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.VolumeModification; } } }