/*******************************************************************************
* 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
{
///
/// Describes one or more of the Reserved Instances that you purchased.
///
///
///
/// For more information about Reserved Instances, see Reserved
/// Instances in the Amazon EC2 User Guide.
///
///
[Cmdlet("Get", "EC2ReservedInstance")]
[OutputType("Amazon.EC2.Model.ReservedInstances")]
[AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) DescribeReservedInstances API operation.", Operation = new[] {"DescribeReservedInstances"}, SelectReturnType = typeof(Amazon.EC2.Model.DescribeReservedInstancesResponse))]
[AWSCmdletOutput("Amazon.EC2.Model.ReservedInstances or Amazon.EC2.Model.DescribeReservedInstancesResponse",
"This cmdlet returns a collection of Amazon.EC2.Model.ReservedInstances objects.",
"The service call response (type Amazon.EC2.Model.DescribeReservedInstancesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetEC2ReservedInstanceCmdlet : AmazonEC2ClientCmdlet, IExecutor
{
#region Parameter Filter
///
///
/// One or more filters.availability-zone
- The Availability Zone where the Reserved Instance
/// can be used.duration
- The duration of the Reserved Instance (one year or three
/// years), in seconds (31536000
| 94608000
).end
- The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).fixed-price
- The purchase price of the Reserved Instance (for example,
/// 9800.0).instance-type
- The instance type that is covered by the reservation.scope
- The scope of the Reserved Instance (Region
or Availability
/// Zone
).product-description
- The Reserved Instance product platform description
/// (Linux/UNIX
| Linux with SQL Server Standard
| Linux
/// with SQL Server Web
| Linux with SQL Server Enterprise
| SUSE
/// Linux
| Red Hat Enterprise Linux
| Red Hat Enterprise Linux
/// with HA
| Windows
| Windows with SQL Server Standard
/// | Windows with SQL Server Web
| Windows with SQL Server Enterprise
).reserved-instances-id
- The ID of the Reserved Instance.start
- The time at which the Reserved Instance purchase request was
/// placed (for example, 2014-08-07T11:54:42.000Z).state
- The state of the Reserved Instance (payment-pending
/// | active
| payment-failed
| retired
).tag:<key>
- The key/value combination of a tag assigned to the
/// resource. Use the tag key in the filter name and the tag value as the filter value.
/// For example, to find all resources that have a tag with the key Owner
/// and the value TeamA
, specify tag:Owner
for the filter name
/// and TeamA
for the filter value.tag-key
- The key of a tag assigned to the resource. Use this filter
/// to find all resources assigned a tag with a specific key, regardless of the tag value.usage-price
- The usage price of the Reserved Instance, per hour (for
/// example, 0.84).
///
///
[System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)]
[Alias("Filters")]
public Amazon.EC2.Model.Filter[] Filter { get; set; }
#endregion
#region Parameter OfferingClass
///
///
/// Describes whether the Reserved Instance is Standard or Convertible.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.EC2.OfferingClassType")]
public Amazon.EC2.OfferingClassType OfferingClass { get; set; }
#endregion
#region Parameter OfferingType
///
///
/// The Reserved Instance offering type. If you are using tools that predate the 2011-11-01
/// API version, you only have access to the Medium Utilization
Reserved
/// Instance offering type.
///
///
[System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.EC2.OfferingTypeValues")]
public Amazon.EC2.OfferingTypeValues OfferingType { get; set; }
#endregion
#region Parameter ReservedInstancesId
///
///
/// One or more Reserved Instance IDs.Default: Describes all your Reserved Instances, or only those otherwise specified.
///
///
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
[Alias("ReservedInstancesIds")]
public System.String[] ReservedInstancesId { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'ReservedInstances'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.DescribeReservedInstancesResponse).
/// Specifying the name of a property of type Amazon.EC2.Model.DescribeReservedInstancesResponse 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; } = "ReservedInstances";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the ReservedInstancesId parameter.
/// The -PassThru parameter is deprecated, use -Select '^ReservedInstancesId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ReservedInstancesId' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
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.ReservedInstancesId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (this.Filter != null)
{
context.Filter = new List(this.Filter);
}
context.OfferingClass = this.OfferingClass;
context.OfferingType = this.OfferingType;
if (this.ReservedInstancesId != null)
{
context.ReservedInstancesId = new List(this.ReservedInstancesId);
}
// 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.DescribeReservedInstancesRequest();
if (cmdletContext.Filter != null)
{
request.Filters = cmdletContext.Filter;
}
if (cmdletContext.OfferingClass != null)
{
request.OfferingClass = cmdletContext.OfferingClass;
}
if (cmdletContext.OfferingType != null)
{
request.OfferingType = cmdletContext.OfferingType;
}
if (cmdletContext.ReservedInstancesId != null)
{
request.ReservedInstancesIds = cmdletContext.ReservedInstancesId;
}
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.DescribeReservedInstancesResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.DescribeReservedInstancesRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "DescribeReservedInstances");
try
{
#if DESKTOP
return client.DescribeReservedInstances(request);
#elif CORECLR
return client.DescribeReservedInstancesAsync(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 List Filter { get; set; }
public Amazon.EC2.OfferingClassType OfferingClass { get; set; }
public Amazon.EC2.OfferingTypeValues OfferingType { get; set; }
public List ReservedInstancesId { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.ReservedInstances;
}
}
}