AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Relational Database Service DescribeReservedDBInstances API operation.

Syntax

Get-RDSReservedDBInstance
-ReservedDBInstanceId <String>
-DBInstanceClass <String>
-Duration <String>
-Filter <Filter[]>
-LeaseId <String>
-MultiAZ <Boolean>
-OfferingType <String>
-ProductDescription <String>
-ReservedDBInstancesOfferingId <String>
-Marker <String>
-MaxRecord <Int32>
-Select <String>
-PassThru <SwitchParameter>
-NoAutoIteration <SwitchParameter>

Description

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.

Parameters

-DBInstanceClass <String>
The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Duration <String>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Filter <Filter[]>
This parameter isn't currently supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters
-LeaseId <String>
The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.AWS Support might request the lease ID for an issue related to a reserved DB instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Marker <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNextToken
-MaxRecord <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxItems, MaxRecords
-MultiAZ <Boolean>
A value that indicates whether to show only those reservations that support Multi-AZ.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NoAutoIteration <SwitchParameter>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OfferingType <String>
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"
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProductDescription <String>
The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReservedDBInstanceId <String>
The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ReservedDBInstancesOfferingId <String>
The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

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.

Supported Version

AWS Tools for PowerShell: 2.x.y.z