/******************************************************************************* * 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 { /// /// Creates an EBS volume that can be attached to an instance in the same Availability /// Zone. /// /// /// /// You can create a new empty volume or restore a volume from an EBS snapshot. Any Amazon /// Web Services Marketplace product codes from the snapshot are propagated to the volume. /// /// You can create encrypted volumes. Encrypted volumes must be attached to instances /// that support Amazon EBS encryption. Volumes that are created from encrypted snapshots /// are also automatically encrypted. For more information, see Amazon /// EBS encryption in the Amazon Elastic Compute Cloud User Guide. /// /// You can tag your volumes during creation. For more information, see Tag /// your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide. /// /// For more information, see Create /// an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide. /// /// [Cmdlet("New", "EC2Volume", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.EC2.Model.Volume")] [AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) CreateVolume API operation.", Operation = new[] {"CreateVolume"}, SelectReturnType = typeof(Amazon.EC2.Model.CreateVolumeResponse))] [AWSCmdletOutput("Amazon.EC2.Model.Volume or Amazon.EC2.Model.CreateVolumeResponse", "This cmdlet returns an Amazon.EC2.Model.Volume object.", "The service call response (type Amazon.EC2.Model.CreateVolumeResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewEC2VolumeCmdlet : AmazonEC2ClientCmdlet, IExecutor { #region Parameter AvailabilityZone /// /// /// The ID of the Availability Zone in which to create the volume. For example, us-east-1a. /// /// #if !MODULAR [System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String AvailabilityZone { get; set; } #endregion #region Parameter Encrypted /// /// /// Indicates whether the volume should be encrypted. The effect of setting the encryption /// state to true depends on the volume origin (new or from a snapshot), /// starting encryption state, ownership, and whether encryption by default is enabled. /// For more information, see Encryption /// by default in the Amazon Elastic Compute Cloud User Guide.Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS /// encryption. For more information, see Supported /// instance types. /// /// [System.Management.Automation.Parameter(Position = 4, ValueFromPipelineByPropertyName = true)] public System.Boolean? Encrypted { get; set; } #endregion #region Parameter Iops /// /// /// The number of I/O operations per second (IOPS). For gp3, io1, /// and io2 volumes, this represents the number of IOPS that are provisioned /// for the volume. For gp2 volumes, this represents the baseline performance /// of the volume and the rate at which the volume accumulates I/O credits for bursting.The following are the supported values for each volume type:io1 and io2 volumes support up to 64,000 IOPS only on Instances /// built on the Nitro System. Other instance families support performance up to 32,000 /// IOPS.This parameter is required for io1 and io2 volumes. The /// default for gp3 volumes is 3,000 IOPS. This parameter is not supported /// for gp2, st1, sc1, or standard /// volumes. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? Iops { 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 MultiAttachEnabled /// /// /// Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you /// can attach the volume to up to 16 Instances /// built on the Nitro System 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 OutpostArn /// /// /// The Amazon Resource Name (ARN) of the Outpost. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String OutpostArn { get; set; } #endregion #region Parameter Size /// /// /// The size of the volume, in GiBs. You must specify either a snapshot ID or a volume /// size. If you specify a snapshot, the default is the snapshot size. You can specify /// a volume size that is equal to or larger than the snapshot size.The following are the supported volumes sizes for each volume type: /// /// [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)] public System.Int32? Size { get; set; } #endregion #region Parameter SnapshotId /// /// /// The snapshot from which to create the volume. You must specify either a snapshot ID /// or a volume size. /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] public System.String SnapshotId { get; set; } #endregion #region Parameter TagSpecification /// /// /// The tags to apply to the volume during creation. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("TagSpecifications")] public Amazon.EC2.Model.TagSpecification[] TagSpecification { get; set; } #endregion #region Parameter Throughput /// /// /// The throughput to provision for a volume, with a maximum of 1,000 MiB/s.This parameter is valid only for gp3 volumes.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 VolumeType /// /// /// The volume type. This parameter can be one of the following values:Throughput Optimized HDD (st1) and Cold HDD (sc1) volumes /// can't be used as boot volumes.For more information, see Amazon /// EBS volume types in the Amazon Elastic Compute Cloud User Guide.Default: gp2 /// /// [System.Management.Automation.Parameter(Position = 3, ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.EC2.VolumeType")] public Amazon.EC2.VolumeType VolumeType { get; set; } #endregion #region Parameter ClientToken /// /// /// Unique, case-sensitive identifier that you provide to ensure the idempotency of the /// request. For more information, see Ensure /// Idempotency. /// /// [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 'Volume'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.CreateVolumeResponse). /// Specifying the name of a property of type Amazon.EC2.Model.CreateVolumeResponse 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; } = "Volume"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the SnapshotId parameter. /// The -PassThru parameter is deprecated, use -Select '^SnapshotId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^SnapshotId' 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.SnapshotId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-EC2Volume (CreateVolume)")) { 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.SnapshotId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AvailabilityZone = this.AvailabilityZone; #if MODULAR if (this.AvailabilityZone == null && ParameterWasBound(nameof(this.AvailabilityZone))) { WriteWarning("You are passing $null as a value for parameter AvailabilityZone 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.ClientToken = this.ClientToken; context.Encrypted = this.Encrypted; context.Iops = this.Iops; context.KmsKeyId = this.KmsKeyId; context.MultiAttachEnabled = this.MultiAttachEnabled; context.OutpostArn = this.OutpostArn; context.Size = this.Size; context.SnapshotId = this.SnapshotId; if (this.TagSpecification != null) { context.TagSpecification = new List(this.TagSpecification); } context.Throughput = this.Throughput; 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.CreateVolumeRequest(); if (cmdletContext.AvailabilityZone != null) { request.AvailabilityZone = cmdletContext.AvailabilityZone; } if (cmdletContext.ClientToken != null) { request.ClientToken = cmdletContext.ClientToken; } if (cmdletContext.Encrypted != null) { request.Encrypted = cmdletContext.Encrypted.Value; } if (cmdletContext.Iops != null) { request.Iops = cmdletContext.Iops.Value; } if (cmdletContext.KmsKeyId != null) { request.KmsKeyId = cmdletContext.KmsKeyId; } if (cmdletContext.MultiAttachEnabled != null) { request.MultiAttachEnabled = cmdletContext.MultiAttachEnabled.Value; } if (cmdletContext.OutpostArn != null) { request.OutpostArn = cmdletContext.OutpostArn; } if (cmdletContext.Size != null) { request.Size = cmdletContext.Size.Value; } if (cmdletContext.SnapshotId != null) { request.SnapshotId = cmdletContext.SnapshotId; } if (cmdletContext.TagSpecification != null) { request.TagSpecifications = cmdletContext.TagSpecification; } if (cmdletContext.Throughput != null) { request.Throughput = cmdletContext.Throughput.Value; } 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.CreateVolumeResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.CreateVolumeRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "CreateVolume"); try { #if DESKTOP return client.CreateVolume(request); #elif CORECLR return client.CreateVolumeAsync(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 AvailabilityZone { get; set; } public System.String ClientToken { get; set; } public System.Boolean? Encrypted { get; set; } public System.Int32? Iops { get; set; } public System.String KmsKeyId { get; set; } public System.Boolean? MultiAttachEnabled { get; set; } public System.String OutpostArn { get; set; } public System.Int32? Size { get; set; } public System.String SnapshotId { get; set; } public List TagSpecification { get; set; } public System.Int32? Throughput { get; set; } public Amazon.EC2.VolumeType VolumeType { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Volume; } } }