/******************************************************************************* * 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.RDS; using Amazon.RDS.Model; namespace Amazon.PowerShell.Cmdlets.RDS { /// /// Returns information about reserved DB instances for this account, or about a specified /// reserved DB instance.

This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. ///
[Cmdlet("Get", "RDSReservedDBInstance")] [OutputType("Amazon.RDS.Model.ReservedDBInstance")] [AWSCmdlet("Calls the Amazon Relational Database Service DescribeReservedDBInstances API operation.", Operation = new[] {"DescribeReservedDBInstances"}, SelectReturnType = typeof(Amazon.RDS.Model.DescribeReservedDBInstancesResponse))] [AWSCmdletOutput("Amazon.RDS.Model.ReservedDBInstance or Amazon.RDS.Model.DescribeReservedDBInstancesResponse", "This cmdlet returns a collection of Amazon.RDS.Model.ReservedDBInstance objects.", "The service call response (type Amazon.RDS.Model.DescribeReservedDBInstancesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetRDSReservedDBInstanceCmdlet : AmazonRDSClientCmdlet, IExecutor { #region Parameter DBInstanceClass /// /// /// The DB instance class filter value. Specify this parameter to show only those reservations /// matching the specified DB instances class. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String DBInstanceClass { get; set; } #endregion #region Parameter Duration /// /// /// The duration filter value, specified in years or seconds. Specify this parameter to /// show only reservations for this duration.Valid Values: 1 | 3 | 31536000 | 94608000 /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Duration { get; set; } #endregion #region Parameter Filter /// /// /// This parameter isn't currently supported. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Filters")] public Amazon.RDS.Model.Filter[] Filter { get; set; } #endregion #region Parameter LeaseId /// /// /// The lease identifier filter value. Specify this parameter to show only the reservation /// that matches the specified lease ID.Amazon Web Services Support might request the lease ID for an issue related to a reserved /// DB instance. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String LeaseId { get; set; } #endregion #region Parameter MultiAZ /// /// /// A value that indicates whether to show only those reservations that support Multi-AZ. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? MultiAZ { get; set; } #endregion #region Parameter OfferingType /// /// /// The offering type filter value. Specify this parameter to show only the available /// offerings matching the specified offering type.Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront" /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String OfferingType { get; set; } #endregion #region Parameter ProductDescription /// /// /// The product description filter value. Specify this parameter to show only those reservations /// matching the specified product description. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ProductDescription { get; set; } #endregion #region Parameter ReservedDBInstanceId /// /// /// The reserved DB instance identifier filter value. Specify this parameter to show only /// the reservation that matches the specified reservation ID. /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] public System.String ReservedDBInstanceId { get; set; } #endregion #region Parameter ReservedDBInstancesOfferingId /// /// /// The offering identifier filter value. Specify this parameter to show only purchased /// reservations matching the specified offering identifier. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ReservedDBInstancesOfferingId { get; set; } #endregion #region Parameter Marker /// /// /// An optional pagination token provided by a previous request. If this parameter is /// specified, the response includes only records beyond the marker, up to the value specified /// by MaxRecords. /// /// ///
Note: This parameter is only used if you are manually controlling output pagination of the service API call. ///
In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. ///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("NextToken")] public System.String Marker { get; set; } #endregion #region Parameter MaxRecord /// /// /// The maximum number of records to include in the response. If more than the MaxRecords /// value is available, a pagination token called a marker is included in the response /// so you can retrieve the remaining results.Default: 100Constraints: Minimum 20, maximum 100. /// /// ///
Note: In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. ///
In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. ///
Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. ///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxItems","MaxRecords")] public int? MaxRecord { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'ReservedDBInstances'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RDS.Model.DescribeReservedDBInstancesResponse). /// Specifying the name of a property of type Amazon.RDS.Model.DescribeReservedDBInstancesResponse 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; } = "ReservedDBInstances"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the ReservedDBInstanceId parameter. /// The -PassThru parameter is deprecated, use -Select '^ReservedDBInstanceId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ReservedDBInstanceId' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion #region Parameter NoAutoIteration /// /// By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple /// service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker /// as the start point. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter NoAutoIteration { 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.ReservedDBInstanceId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.DBInstanceClass = this.DBInstanceClass; context.Duration = this.Duration; if (this.Filter != null) { context.Filter = new List(this.Filter); } context.LeaseId = this.LeaseId; context.Marker = this.Marker; context.MaxRecord = this.MaxRecord; #if !MODULAR if (ParameterWasBound(nameof(this.MaxRecord)) && this.MaxRecord.HasValue) { WriteWarning("AWSPowerShell and AWSPowerShell.NetCore use the MaxRecord parameter to limit the total number of items returned by the cmdlet." + " This behavior is obsolete and will be removed in a future version of these modules. Pipe the output of this cmdlet into Select-Object -First to terminate" + " retrieving data pages early and control the number of items returned. AWS.Tools already implements the new behavior of simply passing MaxRecord" + " to the service to specify how many items should be returned by each service call."); } #endif context.MultiAZ = this.MultiAZ; context.OfferingType = this.OfferingType; context.ProductDescription = this.ProductDescription; context.ReservedDBInstanceId = this.ReservedDBInstanceId; context.ReservedDBInstancesOfferingId = this.ReservedDBInstancesOfferingId; // allow further manipulation of loaded context prior to processing PostExecutionContextLoad(context); var output = Execute(context) as CmdletOutput; ProcessOutput(output); } #region IExecutor Members #if MODULAR public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent; #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute // create request and set iteration invariants var request = new Amazon.RDS.Model.DescribeReservedDBInstancesRequest(); if (cmdletContext.DBInstanceClass != null) { request.DBInstanceClass = cmdletContext.DBInstanceClass; } if (cmdletContext.Duration != null) { request.Duration = cmdletContext.Duration; } if (cmdletContext.Filter != null) { request.Filters = cmdletContext.Filter; } if (cmdletContext.LeaseId != null) { request.LeaseId = cmdletContext.LeaseId; } if (cmdletContext.MaxRecord != null) { request.MaxRecords = AutoIterationHelpers.ConvertEmitLimitToServiceTypeInt32(cmdletContext.MaxRecord.Value); } if (cmdletContext.MultiAZ != null) { request.MultiAZ = cmdletContext.MultiAZ.Value; } if (cmdletContext.OfferingType != null) { request.OfferingType = cmdletContext.OfferingType; } if (cmdletContext.ProductDescription != null) { request.ProductDescription = cmdletContext.ProductDescription; } if (cmdletContext.ReservedDBInstanceId != null) { request.ReservedDBInstanceId = cmdletContext.ReservedDBInstanceId; } if (cmdletContext.ReservedDBInstancesOfferingId != null) { request.ReservedDBInstancesOfferingId = cmdletContext.ReservedDBInstancesOfferingId; } // Initialize loop variant and commence piping var _nextToken = cmdletContext.Marker; var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.Marker)); var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); do { request.Marker = _nextToken; CmdletOutput output; try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; if (!useParameterSelect) { pipelineOutput = cmdletContext.Select(response, this); } output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; _nextToken = response.Marker; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } ProcessOutput(output); } while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken)); if (useParameterSelect) { WriteObject(cmdletContext.Select(null, this)); } return null; } #else public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent; // create request and set iteration invariants var request = new Amazon.RDS.Model.DescribeReservedDBInstancesRequest(); if (cmdletContext.DBInstanceClass != null) { request.DBInstanceClass = cmdletContext.DBInstanceClass; } if (cmdletContext.Duration != null) { request.Duration = cmdletContext.Duration; } if (cmdletContext.Filter != null) { request.Filters = cmdletContext.Filter; } if (cmdletContext.LeaseId != null) { request.LeaseId = cmdletContext.LeaseId; } if (cmdletContext.MultiAZ != null) { request.MultiAZ = cmdletContext.MultiAZ.Value; } if (cmdletContext.OfferingType != null) { request.OfferingType = cmdletContext.OfferingType; } if (cmdletContext.ProductDescription != null) { request.ProductDescription = cmdletContext.ProductDescription; } if (cmdletContext.ReservedDBInstanceId != null) { request.ReservedDBInstanceId = cmdletContext.ReservedDBInstanceId; } if (cmdletContext.ReservedDBInstancesOfferingId != null) { request.ReservedDBInstancesOfferingId = cmdletContext.ReservedDBInstancesOfferingId; } // Initialize loop variants and commence piping System.String _nextToken = null; int? _emitLimit = null; int _retrievedSoFar = 0; if (AutoIterationHelpers.HasValue(cmdletContext.Marker)) { _nextToken = cmdletContext.Marker; } if (cmdletContext.MaxRecord.HasValue) { _emitLimit = cmdletContext.MaxRecord; } var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.Marker)); var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); do { request.Marker = _nextToken; if (_emitLimit.HasValue) { request.MaxRecords = AutoIterationHelpers.ConvertEmitLimitToInt32(_emitLimit.Value); } CmdletOutput output; try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; if (!useParameterSelect) { pipelineOutput = cmdletContext.Select(response, this); } output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; int _receivedThisCall = response.ReservedDBInstances.Count; _nextToken = response.Marker; _retrievedSoFar += _receivedThisCall; if (_emitLimit.HasValue) { _emitLimit -= _receivedThisCall; } } catch (Exception e) { if (_retrievedSoFar == 0 || !_emitLimit.HasValue) { output = new CmdletOutput { ErrorResponse = e }; } else { break; } } ProcessOutput(output); } while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken) && (!_emitLimit.HasValue || _emitLimit.Value >= 1)); if (useParameterSelect) { WriteObject(cmdletContext.Select(null, this)); } return null; } #endif public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.RDS.Model.DescribeReservedDBInstancesResponse CallAWSServiceOperation(IAmazonRDS client, Amazon.RDS.Model.DescribeReservedDBInstancesRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Relational Database Service", "DescribeReservedDBInstances"); try { #if DESKTOP return client.DescribeReservedDBInstances(request); #elif CORECLR return client.DescribeReservedDBInstancesAsync(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 DBInstanceClass { get; set; } public System.String Duration { get; set; } public List Filter { get; set; } public System.String LeaseId { get; set; } public System.String Marker { get; set; } public int? MaxRecord { get; set; } public System.Boolean? MultiAZ { get; set; } public System.String OfferingType { get; set; } public System.String ProductDescription { get; set; } public System.String ReservedDBInstanceId { get; set; } public System.String ReservedDBInstancesOfferingId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.ReservedDBInstances; } } }