/******************************************************************************* * 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 a new Capacity Reservation with the specified attributes. /// /// /// /// Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances /// in a specific Availability Zone for any duration. This gives you the flexibility to /// selectively add capacity reservations and still get the Regional RI discounts for /// that usage. By creating Capacity Reservations, you ensure that you always have access /// to Amazon EC2 capacity when you need it, for as long as you need it. For more information, /// see Capacity /// Reservations in the Amazon EC2 User Guide. /// /// Your request to create a Capacity Reservation could fail if Amazon EC2 does not have /// sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 /// capacity constraints, either try again at a later time, try in a different Availability /// Zone, or request a smaller capacity reservation. If your application is flexible across /// instance types and sizes, try to create a Capacity Reservation with different instance /// attributes. /// /// Your request could also fail if the requested quantity exceeds your On-Demand Instance /// limit for the selected instance type. If your request fails due to limit constraints, /// increase your On-Demand Instance limit for the required instance type and try again. /// For more information about increasing your instance limits, see Amazon /// EC2 Service Quotas in the Amazon EC2 User Guide. /// /// [Cmdlet("Add", "EC2CapacityReservation", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.EC2.Model.CapacityReservation")] [AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) CreateCapacityReservation API operation.", Operation = new[] {"CreateCapacityReservation"}, SelectReturnType = typeof(Amazon.EC2.Model.CreateCapacityReservationResponse))] [AWSCmdletOutput("Amazon.EC2.Model.CapacityReservation or Amazon.EC2.Model.CreateCapacityReservationResponse", "This cmdlet returns an Amazon.EC2.Model.CapacityReservation object.", "The service call response (type Amazon.EC2.Model.CreateCapacityReservationResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class AddEC2CapacityReservationCmdlet : AmazonEC2ClientCmdlet, IExecutor { #region Parameter AvailabilityZone /// /// /// The Availability Zone in which to create the Capacity Reservation. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AvailabilityZone { get; set; } #endregion #region Parameter AvailabilityZoneId /// /// /// The ID of the Availability Zone in which to create the Capacity Reservation. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AvailabilityZoneId { get; set; } #endregion #region Parameter EbsOptimized /// /// /// Indicates whether the Capacity Reservation supports EBS-optimized instances. This /// optimization provides dedicated throughput to Amazon EBS and an optimized configuration /// stack to provide optimal I/O performance. This optimization isn't available with all /// instance types. Additional usage charges apply when using an EBS- optimized instance. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? EbsOptimized { get; set; } #endregion #region Parameter EndDate /// /// /// The date and time at which the Capacity Reservation expires. When a Capacity Reservation /// expires, the reserved capacity is released and you can no longer launch instances /// into it. The Capacity Reservation's state changes to expired when it /// reaches its end date and time.You must provide an EndDate value if EndDateType is limited. /// Omit EndDate if EndDateType is unlimited.If the EndDateType is limited, the Capacity Reservation /// is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, /// 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 /// on 5/31/2019. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.DateTime? EndDate { get; set; } #endregion #region Parameter EndDateType /// /// /// Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can /// have one of the following end types: /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.EC2.EndDateType")] public Amazon.EC2.EndDateType EndDateType { get; set; } #endregion #region Parameter EphemeralStorage /// /// /// Deprecated. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? EphemeralStorage { get; set; } #endregion #region Parameter InstanceCount /// /// /// The number of instances for which to reserve capacity.Valid range: 1 - 1000 /// /// #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] public System.Int32? InstanceCount { get; set; } #endregion #region Parameter InstanceMatchCriterion /// /// /// Indicates the type of instance launches that the Capacity Reservation accepts. The /// options include:Default: open /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("InstanceMatchCriteria")] [AWSConstantClassSource("Amazon.EC2.InstanceMatchCriteria")] public Amazon.EC2.InstanceMatchCriteria InstanceMatchCriterion { get; set; } #endregion #region Parameter InstancePlatform /// /// /// The type of operating system for which to reserve capacity. /// /// #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.EC2.CapacityReservationInstancePlatform")] public Amazon.EC2.CapacityReservationInstancePlatform InstancePlatform { get; set; } #endregion #region Parameter InstanceType /// /// /// The instance type for which to reserve capacity. For more information, see Instance /// types in the Amazon EC2 User Guide. /// /// #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 InstanceType { get; set; } #endregion #region Parameter OutpostArn /// /// /// The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String OutpostArn { get; set; } #endregion #region Parameter PlacementGroupArn /// /// /// The Amazon Resource Name (ARN) of the cluster placement group in which to create the /// Capacity Reservation. For more information, see /// Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String PlacementGroupArn { get; set; } #endregion #region Parameter TagSpecification /// /// /// The tags to apply to the Capacity Reservation during launch. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("TagSpecifications")] public Amazon.EC2.Model.TagSpecification[] TagSpecification { get; set; } #endregion #region Parameter Tenancy /// /// /// Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have /// one of the following tenancy settings: /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.EC2.CapacityReservationTenancy")] public Amazon.EC2.CapacityReservationTenancy Tenancy { 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 'CapacityReservation'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.CreateCapacityReservationResponse). /// Specifying the name of a property of type Amazon.EC2.Model.CreateCapacityReservationResponse 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; } = "CapacityReservation"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the InstanceType parameter. /// The -PassThru parameter is deprecated, use -Select '^InstanceType' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^InstanceType' 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.InstanceType), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Add-EC2CapacityReservation (CreateCapacityReservation)")) { 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.InstanceType; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AvailabilityZone = this.AvailabilityZone; context.AvailabilityZoneId = this.AvailabilityZoneId; context.ClientToken = this.ClientToken; context.EbsOptimized = this.EbsOptimized; context.EndDate = this.EndDate; context.EndDateType = this.EndDateType; context.EphemeralStorage = this.EphemeralStorage; context.InstanceCount = this.InstanceCount; #if MODULAR if (this.InstanceCount == null && ParameterWasBound(nameof(this.InstanceCount))) { WriteWarning("You are passing $null as a value for parameter InstanceCount 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.InstanceMatchCriterion = this.InstanceMatchCriterion; context.InstancePlatform = this.InstancePlatform; #if MODULAR if (this.InstancePlatform == null && ParameterWasBound(nameof(this.InstancePlatform))) { WriteWarning("You are passing $null as a value for parameter InstancePlatform 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.InstanceType = this.InstanceType; #if MODULAR if (this.InstanceType == null && ParameterWasBound(nameof(this.InstanceType))) { WriteWarning("You are passing $null as a value for parameter InstanceType 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.OutpostArn = this.OutpostArn; context.PlacementGroupArn = this.PlacementGroupArn; if (this.TagSpecification != null) { context.TagSpecification = new List(this.TagSpecification); } context.Tenancy = this.Tenancy; // 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.CreateCapacityReservationRequest(); if (cmdletContext.AvailabilityZone != null) { request.AvailabilityZone = cmdletContext.AvailabilityZone; } if (cmdletContext.AvailabilityZoneId != null) { request.AvailabilityZoneId = cmdletContext.AvailabilityZoneId; } if (cmdletContext.ClientToken != null) { request.ClientToken = cmdletContext.ClientToken; } if (cmdletContext.EbsOptimized != null) { request.EbsOptimized = cmdletContext.EbsOptimized.Value; } if (cmdletContext.EndDate != null) { request.EndDate = cmdletContext.EndDate.Value; } if (cmdletContext.EndDateType != null) { request.EndDateType = cmdletContext.EndDateType; } if (cmdletContext.EphemeralStorage != null) { request.EphemeralStorage = cmdletContext.EphemeralStorage.Value; } if (cmdletContext.InstanceCount != null) { request.InstanceCount = cmdletContext.InstanceCount.Value; } if (cmdletContext.InstanceMatchCriterion != null) { request.InstanceMatchCriteria = cmdletContext.InstanceMatchCriterion; } if (cmdletContext.InstancePlatform != null) { request.InstancePlatform = cmdletContext.InstancePlatform; } if (cmdletContext.InstanceType != null) { request.InstanceType = cmdletContext.InstanceType; } if (cmdletContext.OutpostArn != null) { request.OutpostArn = cmdletContext.OutpostArn; } if (cmdletContext.PlacementGroupArn != null) { request.PlacementGroupArn = cmdletContext.PlacementGroupArn; } if (cmdletContext.TagSpecification != null) { request.TagSpecifications = cmdletContext.TagSpecification; } if (cmdletContext.Tenancy != null) { request.Tenancy = cmdletContext.Tenancy; } 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.CreateCapacityReservationResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.CreateCapacityReservationRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "CreateCapacityReservation"); try { #if DESKTOP return client.CreateCapacityReservation(request); #elif CORECLR return client.CreateCapacityReservationAsync(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 AvailabilityZoneId { get; set; } public System.String ClientToken { get; set; } public System.Boolean? EbsOptimized { get; set; } public System.DateTime? EndDate { get; set; } public Amazon.EC2.EndDateType EndDateType { get; set; } public System.Boolean? EphemeralStorage { get; set; } public System.Int32? InstanceCount { get; set; } public Amazon.EC2.InstanceMatchCriteria InstanceMatchCriterion { get; set; } public Amazon.EC2.CapacityReservationInstancePlatform InstancePlatform { get; set; } public System.String InstanceType { get; set; } public System.String OutpostArn { get; set; } public System.String PlacementGroupArn { get; set; } public List TagSpecification { get; set; } public Amazon.EC2.CapacityReservationTenancy Tenancy { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.CapacityReservation; } } }