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 ElastiCache DescribeReservedCacheNodes API operation.

Syntax

Get-ECReservedCacheNode
-ReservedCacheNodeId <String>
-ReservedCacheNodesOfferingId <String>
-CacheNodeType <String>
-Duration <String>
-OfferingType <String>
-ProductDescription <String>
-Marker <String>
-MaxRecord <Int32>
-Select <String>
-PassThru <SwitchParameter>
-NoAutoIteration <SwitchParameter>

Description

Returns information about reserved cache nodes for this account, or about a specified reserved cache node.

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

-CacheNodeType <String>
The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
  • General purpose:
    • Current generation: M5 node types:cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlargeM4 node types:cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlargeT2 node types:cache.t2.micro, cache.t2.small, cache.t2.medium
    • Previous generation: (not recommended)T1 node types:cache.t1.microM1 node types:cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlargeM3 node types:cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
  • Compute optimized:
    • Previous generation: (not recommended)C1 node types:cache.c1.xlarge
  • Memory optimized:
    • Current generation: R5 node types:cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlargeR4 node types:cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
    • Previous generation: (not recommended)M2 node types:cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlargeR3 node types:cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
  • All current generation instance types are created in Amazon VPC by default.
  • Redis append-only files (AOF) are not supported for T1 or T2 instances.
  • Redis Multi-AZ with automatic failover is not supported on T1 instances.
  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
Required?False
Position?3
Accept pipeline input?True (ByPropertyName)
-Duration <String>
The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.Valid Values: 1 | 3 | 31536000 | 94608000
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Marker <String>
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. 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 records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.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
-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. Use this parameter to show only the available offerings matching the specified offering type.Valid values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ReservedCacheNodeId parameter. The -PassThru parameter is deprecated, use -Select '^ReservedCacheNodeId' 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. Use this parameter to show only those reservations matching the specified product description.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReservedCacheNodeId <String>
The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ReservedCacheNodesOfferingId <String>
The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.
Required?False
Position?2
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ReservedCacheNodes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElastiCache.Model.DescribeReservedCacheNodesResponse). Specifying the name of a property of type Amazon.ElastiCache.Model.DescribeReservedCacheNodesResponse 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)
Aliases AK
-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 (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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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)
Aliases AWSProfilesLocation, 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)
Aliases AWSProfileName, StoredCredentials
-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 (ByPropertyName)
-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)
Aliases SecretAccessKey, SK
-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)
Aliases ST
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases RegionToCall
-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)

Inputs

System.String
You can pipe a String object to this cmdlet for the ReservedCacheNodeId parameter.

Outputs

Amazon.ElastiCache.Model.ReservedCacheNode or Amazon.ElastiCache.Model.DescribeReservedCacheNodesResponse
This cmdlet returns a collection of Amazon.ElastiCache.Model.ReservedCacheNode objects. The service call response (type Amazon.ElastiCache.Model.DescribeReservedCacheNodesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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