/*******************************************************************************
* 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
{
/// <summary>
/// Purchase a reservation with configurations that match those of your Dedicated Host.
/// You must have active Dedicated Hosts in your account before you purchase a reservation.
/// This action results in the specified reservation being purchased and charged to your
/// account.
/// </summary>
[Cmdlet("New", "EC2HostReservation", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.EC2.Model.PurchaseHostReservationResponse")]
[AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) PurchaseHostReservation API operation.", Operation = new[] {"PurchaseHostReservation"}, SelectReturnType = typeof(Amazon.EC2.Model.PurchaseHostReservationResponse))]
[AWSCmdletOutput("Amazon.EC2.Model.PurchaseHostReservationResponse",
"This cmdlet returns an Amazon.EC2.Model.PurchaseHostReservationResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewEC2HostReservationCmdlet : AmazonEC2ClientCmdlet, IExecutor
{
#region Parameter CurrencyCode
/// <summary>
/// <para>
/// <para>The currency in which the <code>totalUpfrontPrice</code>, <code>LimitPrice</code>,
/// and <code>totalHourlyPrice</code> amounts are specified. At this time, the only supported
/// currency is <code>USD</code>.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.EC2.CurrencyCodeValues")]
public Amazon.EC2.CurrencyCodeValues CurrencyCode { get; set; }
#endregion
#region Parameter HostIdSet
/// <summary>
/// <para>
/// <para>The IDs of the Dedicated Hosts with which the reservation will be associated.</para>
/// </para>
/// </summary>
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyCollection]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String[] HostIdSet { get; set; }
#endregion
#region Parameter LimitPrice
/// <summary>
/// <para>
/// <para>The specified limit is checked against the total upfront cost of the reservation (calculated
/// as the offering's upfront cost multiplied by the host count). If the total upfront
/// cost is greater than the specified price limit, the request fails. This is used to
/// ensure that the purchase does not exceed the expected upfront cost of the purchase.
/// At this time, the only supported currency is <code>USD</code>. For example, to indicate
/// a limit price of USD 100, specify 100.00.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String LimitPrice { get; set; }
#endregion
#region Parameter OfferingId
/// <summary>
/// <para>
/// <para>The ID of the offering.</para>
/// </para>
/// </summary>
#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 OfferingId { get; set; }
#endregion
#region Parameter TagSpecification
/// <summary>
/// <para>
/// <para>The tags to apply to the Dedicated Host Reservation during purchase.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("TagSpecifications")]
public Amazon.EC2.Model.TagSpecification[] TagSpecification { get; set; }
#endregion
#region Parameter ClientToken
/// <summary>
/// <para>
/// <para>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
/// request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring
/// Idempotency</a>.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ClientToken { get; set; }
#endregion
#region Parameter Select
/// <summary>
/// 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.PurchaseHostReservationResponse).
/// Specifying the name of a property of type Amazon.EC2.Model.PurchaseHostReservationResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "*";
#endregion
#region Parameter PassThru
/// <summary>
/// Changes the cmdlet behavior to return the value passed to the OfferingId parameter.
/// The -PassThru parameter is deprecated, use -Select '^OfferingId' instead. This parameter will be removed in a future version.
/// </summary>
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^OfferingId' 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
/// <summary>
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
/// </summary>
[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.OfferingId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-EC2HostReservation (PurchaseHostReservation)"))
{
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<Amazon.EC2.Model.PurchaseHostReservationResponse, NewEC2HostReservationCmdlet>(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.OfferingId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.ClientToken = this.ClientToken;
context.CurrencyCode = this.CurrencyCode;
if (this.HostIdSet != null)
{
context.HostIdSet = new List<System.String>(this.HostIdSet);
}
#if MODULAR
if (this.HostIdSet == null && ParameterWasBound(nameof(this.HostIdSet)))
{
WriteWarning("You are passing $null as a value for parameter HostIdSet 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.LimitPrice = this.LimitPrice;
context.OfferingId = this.OfferingId;
#if MODULAR
if (this.OfferingId == null && ParameterWasBound(nameof(this.OfferingId)))
{
WriteWarning("You are passing $null as a value for parameter OfferingId 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<Amazon.EC2.Model.TagSpecification>(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.PurchaseHostReservationRequest();
if (cmdletContext.ClientToken != null)
{
request.ClientToken = cmdletContext.ClientToken;
}
if (cmdletContext.CurrencyCode != null)
{
request.CurrencyCode = cmdletContext.CurrencyCode;
}
if (cmdletContext.HostIdSet != null)
{
request.HostIdSet = cmdletContext.HostIdSet;
}
if (cmdletContext.LimitPrice != null)
{
request.LimitPrice = cmdletContext.LimitPrice;
}
if (cmdletContext.OfferingId != null)
{
request.OfferingId = cmdletContext.OfferingId;
}
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.PurchaseHostReservationResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.PurchaseHostReservationRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "PurchaseHostReservation");
try
{
#if DESKTOP
return client.PurchaseHostReservation(request);
#elif CORECLR
return client.PurchaseHostReservationAsync(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 ClientToken { get; set; }
public Amazon.EC2.CurrencyCodeValues CurrencyCode { get; set; }
public List<System.String> HostIdSet { get; set; }
public System.String LimitPrice { get; set; }
public System.String OfferingId { get; set; }
public List<Amazon.EC2.Model.TagSpecification> TagSpecification { get; set; }
public System.Func<Amazon.EC2.Model.PurchaseHostReservationResponse, NewEC2HostReservationCmdlet, object> Select { get; set; } =
(response, cmdlet) => response;
}
}
}