-
Notifications
You must be signed in to change notification settings - Fork 598
/
api_op_DescribeReservedCacheNodesOfferings.go
325 lines (287 loc) · 11.9 KB
/
api_op_DescribeReservedCacheNodesOfferings.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
// Code generated by smithy-go-codegen DO NOT EDIT.
package elasticache
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/elasticache/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists available reserved cache node offerings.
func (c *Client) DescribeReservedCacheNodesOfferings(ctx context.Context, params *DescribeReservedCacheNodesOfferingsInput, optFns ...func(*Options)) (*DescribeReservedCacheNodesOfferingsOutput, error) {
if params == nil {
params = &DescribeReservedCacheNodesOfferingsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeReservedCacheNodesOfferings", params, optFns, c.addOperationDescribeReservedCacheNodesOfferingsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeReservedCacheNodesOfferingsOutput)
out.ResultMetadata = metadata
return out, nil
}
// Represents the input of a DescribeReservedCacheNodesOfferings operation.
type DescribeReservedCacheNodesOfferingsInput struct {
// The cache node type filter value. Use this parameter to show only the available
// offerings 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: M6g node types: (available only for Redis engine version 5.0.6
// onward and for Memcached engine version 1.5.16 onward) cache.m6g.large,
// cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge,
// cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported
// Node Types
// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
// M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge,
// cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types:
// cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge,
// cache.m4.10xlarge T4g node types (available only for Redis engine version 5.0.6
// onward and for Memcached engine version 1.5.16 onward): cache.t4g.micro,
// cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small,
// cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small,
// cache.t2.medium
//
// * Previous generation: (not recommended) T1 node types:
// cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large,
// cache.m1.xlarge M3 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 with data tiering:
//
// * Current
// generation: R6gd node types (available only for Redis engine version 6.2
// onward). cache.r6gd.xlarge, cache.r6gd.2xlarge, cache.r6gd.4xlarge,
// cache.r6gd.8xlarge, cache.r6gd.12xlarge, cache.r6gd.16xlarge
//
// * Memory
// optimized:
//
// * Current generation: R6g node types (available only for Redis
// engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
// cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge,
// cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For region
// availability, see Supported Node Types
// (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
// R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge,
// cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 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.4xlarge R3 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.
CacheNodeType *string
// Duration filter value, specified in years or seconds. Use this parameter to show
// only reservations for a given duration. Valid Values: 1 | 3 | 31536000 |
// 94608000
Duration *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.
Marker *string
// 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: 100 Constraints: minimum
// 20; maximum 100.
MaxRecords *int32
// 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" |"All Upfront"|"Partial
// Upfront"| "No Upfront"
OfferingType *string
// The product description filter value. Use this parameter to show only the
// available offerings matching the specified product description.
ProductDescription *string
// The offering identifier filter value. Use this parameter to show only the
// available offering that matches the specified reservation identifier. Example:
// 438012d3-4052-4cc7-b2e3-8d3372e0e706
ReservedCacheNodesOfferingId *string
noSmithyDocumentSerde
}
// Represents the output of a DescribeReservedCacheNodesOfferings operation.
type DescribeReservedCacheNodesOfferingsOutput struct {
// Provides an identifier to allow retrieval of paginated results.
Marker *string
// A list of reserved cache node offerings. Each element in the list contains
// detailed information about one offering.
ReservedCacheNodesOfferings []types.ReservedCacheNodesOffering
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeReservedCacheNodesOfferingsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsquery_serializeOpDescribeReservedCacheNodesOfferings{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpDescribeReservedCacheNodesOfferings{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeReservedCacheNodesOfferings(options.Region), middleware.Before); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// DescribeReservedCacheNodesOfferingsAPIClient is a client that implements the
// DescribeReservedCacheNodesOfferings operation.
type DescribeReservedCacheNodesOfferingsAPIClient interface {
DescribeReservedCacheNodesOfferings(context.Context, *DescribeReservedCacheNodesOfferingsInput, ...func(*Options)) (*DescribeReservedCacheNodesOfferingsOutput, error)
}
var _ DescribeReservedCacheNodesOfferingsAPIClient = (*Client)(nil)
// DescribeReservedCacheNodesOfferingsPaginatorOptions is the paginator options for
// DescribeReservedCacheNodesOfferings
type DescribeReservedCacheNodesOfferingsPaginatorOptions struct {
// 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: 100 Constraints: minimum
// 20; maximum 100.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// DescribeReservedCacheNodesOfferingsPaginator is a paginator for
// DescribeReservedCacheNodesOfferings
type DescribeReservedCacheNodesOfferingsPaginator struct {
options DescribeReservedCacheNodesOfferingsPaginatorOptions
client DescribeReservedCacheNodesOfferingsAPIClient
params *DescribeReservedCacheNodesOfferingsInput
nextToken *string
firstPage bool
}
// NewDescribeReservedCacheNodesOfferingsPaginator returns a new
// DescribeReservedCacheNodesOfferingsPaginator
func NewDescribeReservedCacheNodesOfferingsPaginator(client DescribeReservedCacheNodesOfferingsAPIClient, params *DescribeReservedCacheNodesOfferingsInput, optFns ...func(*DescribeReservedCacheNodesOfferingsPaginatorOptions)) *DescribeReservedCacheNodesOfferingsPaginator {
if params == nil {
params = &DescribeReservedCacheNodesOfferingsInput{}
}
options := DescribeReservedCacheNodesOfferingsPaginatorOptions{}
if params.MaxRecords != nil {
options.Limit = *params.MaxRecords
}
for _, fn := range optFns {
fn(&options)
}
return &DescribeReservedCacheNodesOfferingsPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.Marker,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *DescribeReservedCacheNodesOfferingsPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next DescribeReservedCacheNodesOfferings page.
func (p *DescribeReservedCacheNodesOfferingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeReservedCacheNodesOfferingsOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.Marker = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxRecords = limit
result, err := p.client.DescribeReservedCacheNodesOfferings(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.Marker
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opDescribeReservedCacheNodesOfferings(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "elasticache",
OperationName: "DescribeReservedCacheNodesOfferings",
}
}