-
Notifications
You must be signed in to change notification settings - Fork 606
/
api_op_CopyDBClusterSnapshot.go
285 lines (254 loc) · 12.5 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
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package rds
import (
"context"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
)
// Please also see https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CopyDBClusterSnapshotMessage
type CopyDBClusterSnapshotInput struct {
_ struct{} `type:"structure"`
// A value that indicates 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 `type:"boolean"`
// DestinationRegion is used for presigning the request to a given region.
DestinationRegion *string `type:"string"`
// The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key
// ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key
// alias for the KMS encryption key.
//
// If you copy an encrypted DB cluster snapshot from your AWS account, you can
// specify a value for KmsKeyId to encrypt the copy with a new KMS encryption
// 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
// AWS account, then you must specify a value for KmsKeyId.
//
// To copy an encrypted DB cluster snapshot to another AWS Region, you must
// set KmsKeyId to the KMS key ID you want to use to encrypt the copy of the
// DB cluster snapshot in the destination AWS Region. KMS encryption keys are
// specific to the AWS Region that they are created in, and you can't use encryption
// keys from one AWS Region in another AWS Region.
//
// If you copy an unencrypted DB cluster snapshot and specify a value for the
// KmsKeyId parameter, an error is returned.
KmsKeyId *string `type:"string"`
// The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot
// API action in the AWS Region that contains the source DB cluster snapshot
// to copy. The PreSignedUrl parameter must be used when copying an encrypted
// DB cluster snapshot from another AWS Region.
//
// The pre-signed URL must be a valid request for the CopyDBSClusterSnapshot
// API action that can be executed in the source AWS Region that contains the
// encrypted DB cluster snapshot to be copied. The pre-signed URL request must
// contain the following parameter values:
//
// * KmsKeyId - The AWS KMS key identifier for the key to use to encrypt
// the copy of the DB cluster snapshot in the destination AWS Region. This
// is the same identifier for both the CopyDBClusterSnapshot action that
// is called in the destination AWS Region, and the action contained in the
// pre-signed URL.
//
// * DestinationRegion - The name of the AWS Region that the DB cluster snapshot
// will 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 AWS Region.
// For example, if you are copying an encrypted DB cluster snapshot from
// the us-west-2 AWS 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 (AWS 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).
PreSignedUrl *string `type:"string"`
// The identifier of the DB cluster snapshot to copy. This parameter is not
// case-sensitive.
//
// You can't copy an encrypted, shared DB cluster snapshot from one AWS Region
// to another.
//
// Constraints:
//
// * Must specify a valid system snapshot in the "available" state.
//
// * If the source snapshot is in the same AWS Region as the copy, specify
// a valid DB snapshot identifier.
//
// * If the source snapshot is in a different AWS Region than the copy, specify
// a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots
// Across AWS 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
//
// SourceDBClusterSnapshotIdentifier is a required field
SourceDBClusterSnapshotIdentifier *string `type:"string" required:"true"`
// SourceRegion is the source region where the resource exists. This is not
// sent over the wire and is only used for presigning. This value should always
// have the same region as the source ARN.
SourceRegion *string `type:"string" ignore:"true"`
// 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 []Tag `locationNameList:"Tag" type:"list"`
// The identifier of the new DB cluster snapshot to create from the source DB
// cluster snapshot. This parameter is not 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
//
// TargetDBClusterSnapshotIdentifier is a required field
TargetDBClusterSnapshotIdentifier *string `type:"string" required:"true"`
}
// String returns the string representation
func (s CopyDBClusterSnapshotInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CopyDBClusterSnapshotInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "CopyDBClusterSnapshotInput"}
if s.SourceDBClusterSnapshotIdentifier == nil {
invalidParams.Add(aws.NewErrParamRequired("SourceDBClusterSnapshotIdentifier"))
}
if s.TargetDBClusterSnapshotIdentifier == nil {
invalidParams.Add(aws.NewErrParamRequired("TargetDBClusterSnapshotIdentifier"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CopyDBClusterSnapshotResult
type CopyDBClusterSnapshotOutput struct {
_ struct{} `type:"structure"`
// Contains the details for an Amazon RDS DB cluster snapshot
//
// This data type is used as a response element in the DescribeDBClusterSnapshots
// action.
DBClusterSnapshot *DBClusterSnapshot `type:"structure"`
}
// String returns the string representation
func (s CopyDBClusterSnapshotOutput) String() string {
return awsutil.Prettify(s)
}
const opCopyDBClusterSnapshot = "CopyDBClusterSnapshot"
// CopyDBClusterSnapshotRequest returns a request value for making API operation for
// Amazon Relational Database Service.
//
// 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 AWS Region. In
// that case, the AWS Region where you call the CopyDBClusterSnapshot action
// is the destination AWS Region for the encrypted DB cluster snapshot to be
// copied to. To copy an encrypted DB cluster snapshot from another AWS Region,
// you must provide the following values:
//
// * KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for
// the key to use to encrypt the copy of the DB cluster snapshot in the destination
// AWS Region.
//
// * PreSignedUrl - A URL that contains a Signature Version 4 signed request
// for the CopyDBClusterSnapshot action to be called in the source AWS Region
// where the DB cluster snapshot is copied from. The pre-signed URL must
// be a valid request for the CopyDBClusterSnapshot API action that can be
// executed in the source AWS Region that contains the encrypted DB cluster
// snapshot to be copied. The pre-signed URL request must contain the following
// parameter values: KmsKeyId - The KMS key identifier for the key to use
// to encrypt the copy of the DB cluster snapshot in the destination AWS
// Region. This is the same identifier for both the CopyDBClusterSnapshot
// action that is called in the destination AWS Region, and the action contained
// in the pre-signed URL. DestinationRegion - The name of the AWS Region
// that the DB cluster snapshot will 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 AWS Region. For example, if you are copying an encrypted
// DB cluster snapshot from the us-west-2 AWS 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 (AWS 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).
//
// * TargetDBClusterSnapshotIdentifier - The identifier for the new copy
// of the DB cluster snapshot in the destination AWS 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 AWS Region and is the same value as
// the SourceDBClusterSnapshotIdentifier in the pre-signed 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 DB cluster snapshots from one AWS
// 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, see What Is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)
// in the Amazon Aurora User Guide.
//
// This action only applies to Aurora DB clusters.
//
// // Example sending a request using CopyDBClusterSnapshotRequest.
// req := client.CopyDBClusterSnapshotRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CopyDBClusterSnapshot
func (c *Client) CopyDBClusterSnapshotRequest(input *CopyDBClusterSnapshotInput) CopyDBClusterSnapshotRequest {
op := &aws.Operation{
Name: opCopyDBClusterSnapshot,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CopyDBClusterSnapshotInput{}
}
req := c.newRequest(op, input, &CopyDBClusterSnapshotOutput{})
return CopyDBClusterSnapshotRequest{Request: req, Input: input, Copy: c.CopyDBClusterSnapshotRequest}
}
// CopyDBClusterSnapshotRequest is the request type for the
// CopyDBClusterSnapshot API operation.
type CopyDBClusterSnapshotRequest struct {
*aws.Request
Input *CopyDBClusterSnapshotInput
Copy func(*CopyDBClusterSnapshotInput) CopyDBClusterSnapshotRequest
}
// Send marshals and sends the CopyDBClusterSnapshot API request.
func (r CopyDBClusterSnapshotRequest) Send(ctx context.Context) (*CopyDBClusterSnapshotResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &CopyDBClusterSnapshotResponse{
CopyDBClusterSnapshotOutput: r.Request.Data.(*CopyDBClusterSnapshotOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// CopyDBClusterSnapshotResponse is the response type for the
// CopyDBClusterSnapshot API operation.
type CopyDBClusterSnapshotResponse struct {
*CopyDBClusterSnapshotOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// CopyDBClusterSnapshot request.
func (r *CopyDBClusterSnapshotResponse) SDKResponseMetdata() *aws.Response {
return r.response
}