-
Notifications
You must be signed in to change notification settings - Fork 597
/
api_op_CopyDBClusterSnapshot.go
363 lines (331 loc) · 15.9 KB
/
api_op_CopyDBClusterSnapshot.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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
// Code generated by smithy-go-codegen DO NOT EDIT.
package rds
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
presignedurlcust "github.com/aws/aws-sdk-go-v2/service/internal/presigned-url"
"github.com/aws/aws-sdk-go-v2/service/rds/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared
// manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the
// Amazon Resource Name (ARN) of the shared DB cluster snapshot. You can copy an
// encrypted DB cluster snapshot from another Amazon Web Services Region. In that
// case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot
// operation is the destination Amazon Web Services Region for the encrypted DB
// cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from
// another Amazon Web Services Region, you must provide the following values:
// - KmsKeyId - The Amazon Web Services Key Management System (Amazon Web
// Services KMS) key identifier for the key to use to encrypt the copy of the DB
// cluster snapshot in the destination Amazon Web Services Region.
// - TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the
// DB cluster snapshot in the destination Amazon Web Services Region.
// - SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for
// the encrypted DB cluster snapshot to be copied. This identifier must be in the
// ARN format for the source Amazon Web Services Region and is the same value as
// the SourceDBClusterSnapshotIdentifier in the presigned URL.
//
// To cancel the copy operation once it is in progress, delete the target DB
// cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB
// cluster snapshot is in "copying" status. For more information on copying
// encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region
// to another, see Copying a Snapshot (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html)
// in the Amazon Aurora User Guide. For more information on Amazon Aurora DB
// clusters, see What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)
// in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters,
// see Multi-AZ DB cluster deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)
// in the Amazon RDS User Guide.
func (c *Client) CopyDBClusterSnapshot(ctx context.Context, params *CopyDBClusterSnapshotInput, optFns ...func(*Options)) (*CopyDBClusterSnapshotOutput, error) {
if params == nil {
params = &CopyDBClusterSnapshotInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CopyDBClusterSnapshot", params, optFns, c.addOperationCopyDBClusterSnapshotMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CopyDBClusterSnapshotOutput)
out.ResultMetadata = metadata
return out, nil
}
type CopyDBClusterSnapshotInput struct {
// The identifier of the DB cluster snapshot to copy. This parameter isn't
// case-sensitive. You can't copy an encrypted, shared DB cluster snapshot from one
// Amazon Web Services Region to another. Constraints:
// - Must specify a valid system snapshot in the "available" state.
// - If the source snapshot is in the same Amazon Web Services Region as the
// copy, specify a valid DB snapshot identifier.
// - If the source snapshot is in a different Amazon Web Services Region than
// the copy, specify a valid DB cluster snapshot ARN. For more information, go to
// Copying Snapshots Across Amazon Web Services Regions (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html#USER_CopySnapshot.AcrossRegions)
// in the Amazon Aurora User Guide.
// Example: my-cluster-snapshot1
//
// This member is required.
SourceDBClusterSnapshotIdentifier *string
// The identifier of the new DB cluster snapshot to create from the source DB
// cluster snapshot. This parameter isn't case-sensitive. Constraints:
// - Must contain from 1 to 63 letters, numbers, or hyphens.
// - First character must be a letter.
// - Can't end with a hyphen or contain two consecutive hyphens.
// Example: my-cluster-snapshot2
//
// This member is required.
TargetDBClusterSnapshotIdentifier *string
// Specifies whether to copy all tags from the source DB cluster snapshot to the
// target DB cluster snapshot. By default, tags are not copied.
CopyTags *bool
// The Amazon Web Services KMS key identifier for an encrypted DB cluster
// snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID,
// alias ARN, or alias name for the Amazon Web Services KMS key. If you copy an
// encrypted DB cluster snapshot from your Amazon Web Services account, you can
// specify a value for KmsKeyId to encrypt the copy with a new KMS key. If you
// don't specify a value for KmsKeyId , then the copy of the DB cluster snapshot is
// encrypted with the same KMS key as the source DB cluster snapshot. If you copy
// an encrypted DB cluster snapshot that is shared from another Amazon Web Services
// account, then you must specify a value for KmsKeyId . To copy an encrypted DB
// cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId
// to the Amazon Web Services KMS key identifier you want to use to encrypt the
// copy of the DB cluster snapshot in the destination Amazon Web Services Region.
// KMS keys are specific to the Amazon Web Services Region that they are created
// in, and you can't use KMS keys from one Amazon Web Services Region in another
// Amazon Web Services Region. If you copy an unencrypted DB cluster snapshot and
// specify a value for the KmsKeyId parameter, an error is returned.
KmsKeyId *string
// When you are copying a DB cluster snapshot from one Amazon Web Services
// GovCloud (US) Region to another, the URL that contains a Signature Version 4
// signed request for the CopyDBClusterSnapshot API operation in the Amazon Web
// Services Region that contains the source DB cluster snapshot to copy. Use the
// PreSignedUrl parameter when copying an encrypted DB cluster snapshot from
// another Amazon Web Services Region. Don't specify PreSignedUrl when copying an
// encrypted DB cluster snapshot in the same Amazon Web Services Region. This
// setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored
// in other Amazon Web Services Regions. The presigned URL must be a valid request
// for the CopyDBClusterSnapshot API operation that can run in the source Amazon
// Web Services Region that contains the encrypted DB cluster snapshot to copy. The
// presigned URL request must contain the following parameter values:
// - KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy
// of the DB cluster snapshot in the destination Amazon Web Services Region. This
// is the same identifier for both the CopyDBClusterSnapshot operation that is
// called in the destination Amazon Web Services Region, and the operation
// contained in the presigned URL.
// - DestinationRegion - The name of the Amazon Web Services Region that the DB
// cluster snapshot is to be created in.
// - SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for
// the encrypted DB cluster snapshot to be copied. This identifier must be in the
// Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For
// example, if you are copying an encrypted DB cluster snapshot from the us-west-2
// Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks
// like the following example:
// arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115
// .
// To learn how to generate a Signature Version 4 signed request, see
// Authenticating Requests: Using Query Parameters (Amazon Web Services Signature
// Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html)
// and Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html)
// . If you are using an Amazon Web Services SDK tool or the CLI, you can specify
// SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl
// manually. Specifying SourceRegion autogenerates a presigned URL that is a valid
// request for the operation that can run in the source Amazon Web Services Region.
PreSignedUrl *string
// The AWS region the resource is in. The presigned URL will be created with this
// region, if the PresignURL member is empty set.
SourceRegion *string
// A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)
// in the Amazon RDS User Guide.
Tags []types.Tag
// Used by the SDK's PresignURL autofill customization to specify the region the
// of the client's request.
destinationRegion *string
noSmithyDocumentSerde
}
type CopyDBClusterSnapshotOutput struct {
// Contains the details for an Amazon RDS DB cluster snapshot This data type is
// used as a response element in the DescribeDBClusterSnapshots action.
DBClusterSnapshot *types.DBClusterSnapshot
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCopyDBClusterSnapshotMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsquery_serializeOpCopyDBClusterSnapshot{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpCopyDBClusterSnapshot{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CopyDBClusterSnapshot"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); 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 = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addCopyDBClusterSnapshotPresignURLMiddleware(stack, options); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpCopyDBClusterSnapshotValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCopyDBClusterSnapshot(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); 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
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func copyCopyDBClusterSnapshotInputForPresign(params interface{}) (interface{}, error) {
input, ok := params.(*CopyDBClusterSnapshotInput)
if !ok {
return nil, fmt.Errorf("expect *CopyDBClusterSnapshotInput type, got %T", params)
}
cpy := *input
return &cpy, nil
}
func getCopyDBClusterSnapshotPreSignedUrl(params interface{}) (string, bool, error) {
input, ok := params.(*CopyDBClusterSnapshotInput)
if !ok {
return ``, false, fmt.Errorf("expect *CopyDBClusterSnapshotInput type, got %T", params)
}
if input.PreSignedUrl == nil || len(*input.PreSignedUrl) == 0 {
return ``, false, nil
}
return *input.PreSignedUrl, true, nil
}
func getCopyDBClusterSnapshotSourceRegion(params interface{}) (string, bool, error) {
input, ok := params.(*CopyDBClusterSnapshotInput)
if !ok {
return ``, false, fmt.Errorf("expect *CopyDBClusterSnapshotInput type, got %T", params)
}
if input.SourceRegion == nil || len(*input.SourceRegion) == 0 {
return ``, false, nil
}
return *input.SourceRegion, true, nil
}
func setCopyDBClusterSnapshotPreSignedUrl(params interface{}, value string) error {
input, ok := params.(*CopyDBClusterSnapshotInput)
if !ok {
return fmt.Errorf("expect *CopyDBClusterSnapshotInput type, got %T", params)
}
input.PreSignedUrl = &value
return nil
}
func setCopyDBClusterSnapshotdestinationRegion(params interface{}, value string) error {
input, ok := params.(*CopyDBClusterSnapshotInput)
if !ok {
return fmt.Errorf("expect *CopyDBClusterSnapshotInput type, got %T", params)
}
input.destinationRegion = &value
return nil
}
func addCopyDBClusterSnapshotPresignURLMiddleware(stack *middleware.Stack, options Options) error {
return presignedurlcust.AddMiddleware(stack, presignedurlcust.Options{
Accessor: presignedurlcust.ParameterAccessor{
GetPresignedURL: getCopyDBClusterSnapshotPreSignedUrl,
GetSourceRegion: getCopyDBClusterSnapshotSourceRegion,
CopyInput: copyCopyDBClusterSnapshotInputForPresign,
SetDestinationRegion: setCopyDBClusterSnapshotdestinationRegion,
SetPresignedURL: setCopyDBClusterSnapshotPreSignedUrl,
},
Presigner: &presignAutoFillCopyDBClusterSnapshotClient{client: NewPresignClient(New(options))},
})
}
type presignAutoFillCopyDBClusterSnapshotClient struct {
client *PresignClient
}
// PresignURL is a middleware accessor that satisfies URLPresigner interface.
func (c *presignAutoFillCopyDBClusterSnapshotClient) PresignURL(ctx context.Context, srcRegion string, params interface{}) (*v4.PresignedHTTPRequest, error) {
input, ok := params.(*CopyDBClusterSnapshotInput)
if !ok {
return nil, fmt.Errorf("expect *CopyDBClusterSnapshotInput type, got %T", params)
}
optFn := func(o *Options) {
o.Region = srcRegion
o.APIOptions = append(o.APIOptions, presignedurlcust.RemoveMiddleware)
}
presignOptFn := WithPresignClientFromClientOptions(optFn)
return c.client.PresignCopyDBClusterSnapshot(ctx, input, presignOptFn)
}
func newServiceMetadataMiddleware_opCopyDBClusterSnapshot(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CopyDBClusterSnapshot",
}
}
// PresignCopyDBClusterSnapshot is used to generate a presigned HTTP Request which
// contains presigned URL, signed headers and HTTP method used.
func (c *PresignClient) PresignCopyDBClusterSnapshot(ctx context.Context, params *CopyDBClusterSnapshotInput, optFns ...func(*PresignOptions)) (*v4.PresignedHTTPRequest, error) {
if params == nil {
params = &CopyDBClusterSnapshotInput{}
}
options := c.options.copy()
for _, fn := range optFns {
fn(&options)
}
clientOptFns := append(options.ClientOptions, withNopHTTPClientAPIOption)
result, _, err := c.client.invokeOperation(ctx, "CopyDBClusterSnapshot", params, clientOptFns,
c.client.addOperationCopyDBClusterSnapshotMiddlewares,
presignConverter(options).convertToPresignMiddleware,
)
if err != nil {
return nil, err
}
out := result.(*v4.PresignedHTTPRequest)
return out, nil
}