/*******************************************************************************
* 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
{
///
/// Modifies a Capacity Reservation Fleet.
///
///
///
/// When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet
/// automatically creates new Capacity Reservations, or modifies or cancels existing Capacity
/// Reservations in the Fleet to meet the new total target capacity. When you modify the
/// end date for the Fleet, the end dates for all of the individual Capacity Reservations
/// in the Fleet are updated accordingly.
///
///
[Cmdlet("Edit", "EC2CapacityReservationFleet", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.Boolean")]
[AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) ModifyCapacityReservationFleet API operation.", Operation = new[] {"ModifyCapacityReservationFleet"}, SelectReturnType = typeof(Amazon.EC2.Model.ModifyCapacityReservationFleetResponse))]
[AWSCmdletOutput("System.Boolean or Amazon.EC2.Model.ModifyCapacityReservationFleetResponse",
"This cmdlet returns a System.Boolean object.",
"The service call response (type Amazon.EC2.Model.ModifyCapacityReservationFleetResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class EditEC2CapacityReservationFleetCmdlet : AmazonEC2ClientCmdlet, IExecutor
{
#region Parameter CapacityReservationFleetId
///
///
/// The ID of the Capacity Reservation Fleet to modify.
///
///
#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 CapacityReservationFleetId { get; set; }
#endregion
#region Parameter EndDate
///
///
/// The date and time at which the Capacity Reservation Fleet expires. When the Capacity
/// Reservation Fleet expires, its state changes to expired
and all of the
/// Capacity Reservations in the Fleet expire.The Capacity Reservation Fleet expires within an hour after the specified time. For
/// example, if you specify 5/31/2019
, 13:30:55
, the Capacity
/// Reservation Fleet is guaranteed to expire between 13:30:55
and 14:30:55
/// on 5/31/2019
.You can't specify EndDate and RemoveEndDate in the same request.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.DateTime? EndDate { get; set; }
#endregion
#region Parameter RemoveEndDate
///
///
/// Indicates whether to remove the end date from the Capacity Reservation Fleet. If you
/// remove the end date, the Capacity Reservation Fleet does not expire and it remains
/// active until you explicitly cancel it using the CancelCapacityReservationFleet
/// action.You can't specify RemoveEndDate and EndDate in the same request.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? RemoveEndDate { get; set; }
#endregion
#region Parameter TotalTargetCapacity
///
///
/// The total number of capacity units to be reserved by the Capacity Reservation Fleet.
/// This value, together with the instance type weights that you assign to each instance
/// type used by the Fleet determine the number of instances for which the Fleet reserves
/// capacity. Both values are based on units that make sense for your workload. For more
/// information, see Total
/// target capacity in the Amazon EC2 User Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? TotalTargetCapacity { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'Return'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.ModifyCapacityReservationFleetResponse).
/// Specifying the name of a property of type Amazon.EC2.Model.ModifyCapacityReservationFleetResponse 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; } = "Return";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the CapacityReservationFleetId parameter.
/// The -PassThru parameter is deprecated, use -Select '^CapacityReservationFleetId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^CapacityReservationFleetId' 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.CapacityReservationFleetId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Edit-EC2CapacityReservationFleet (ModifyCapacityReservationFleet)"))
{
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.CapacityReservationFleetId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.CapacityReservationFleetId = this.CapacityReservationFleetId;
#if MODULAR
if (this.CapacityReservationFleetId == null && ParameterWasBound(nameof(this.CapacityReservationFleetId)))
{
WriteWarning("You are passing $null as a value for parameter CapacityReservationFleetId 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.EndDate = this.EndDate;
context.RemoveEndDate = this.RemoveEndDate;
context.TotalTargetCapacity = this.TotalTargetCapacity;
// 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.ModifyCapacityReservationFleetRequest();
if (cmdletContext.CapacityReservationFleetId != null)
{
request.CapacityReservationFleetId = cmdletContext.CapacityReservationFleetId;
}
if (cmdletContext.EndDate != null)
{
request.EndDate = cmdletContext.EndDate.Value;
}
if (cmdletContext.RemoveEndDate != null)
{
request.RemoveEndDate = cmdletContext.RemoveEndDate.Value;
}
if (cmdletContext.TotalTargetCapacity != null)
{
request.TotalTargetCapacity = cmdletContext.TotalTargetCapacity.Value;
}
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.ModifyCapacityReservationFleetResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.ModifyCapacityReservationFleetRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "ModifyCapacityReservationFleet");
try
{
#if DESKTOP
return client.ModifyCapacityReservationFleet(request);
#elif CORECLR
return client.ModifyCapacityReservationFleetAsync(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 CapacityReservationFleetId { get; set; }
public System.DateTime? EndDate { get; set; }
public System.Boolean? RemoveEndDate { get; set; }
public System.Int32? TotalTargetCapacity { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.Return;
}
}
}