-
Notifications
You must be signed in to change notification settings - Fork 602
/
api_op_RestoreDBClusterFromS3.go
398 lines (340 loc) · 14 KB
/
api_op_RestoreDBClusterFromS3.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
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
// 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/RestoreDBClusterFromS3Message
type RestoreDBClusterFromS3Input struct {
_ struct{} `type:"structure"`
// A list of Availability Zones (AZs) where instances in the restored DB cluster
// can be created.
AvailabilityZones []string `locationNameList:"AvailabilityZone" type:"list"`
// The target backtrack window, in seconds. To disable backtracking, set this
// value to 0.
//
// Default: 0
//
// Constraints:
//
// * If specified, this value must be set to a number from 0 to 259,200 (72
// hours).
BacktrackWindow *int64 `type:"long"`
// The number of days for which automated backups of the restored DB cluster
// are retained. You must specify a minimum value of 1.
//
// Default: 1
//
// Constraints:
//
// * Must be a value from 1 to 35
BackupRetentionPeriod *int64 `type:"integer"`
// A value that indicates that the restored DB cluster should be associated
// with the specified CharacterSet.
CharacterSetName *string `type:"string"`
// A value that indicates whether to copy all tags from the restored DB cluster
// to snapshots of the restored DB cluster. The default is not to copy them.
CopyTagsToSnapshot *bool `type:"boolean"`
// The name of the DB cluster to create from the source data in the Amazon S3
// bucket. This parameter is 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-cluster1
//
// DBClusterIdentifier is a required field
DBClusterIdentifier *string `type:"string" required:"true"`
// The name of the DB cluster parameter group to associate with the restored
// DB cluster. If this argument is omitted, default.aurora5.6 is used.
//
// Constraints:
//
// * If supplied, must match the name of an existing DBClusterParameterGroup.
DBClusterParameterGroupName *string `type:"string"`
// A DB subnet group to associate with the restored DB cluster.
//
// Constraints: If supplied, must match the name of an existing DBSubnetGroup.
//
// Example: mySubnetgroup
DBSubnetGroupName *string `type:"string"`
// The database name for the restored DB cluster.
DatabaseName *string `type:"string"`
// A value that indicates whether the DB cluster has deletion protection enabled.
// The database can't be deleted when deletion protection is enabled. By default,
// deletion protection is disabled.
DeletionProtection *bool `type:"boolean"`
// The list of logs that the restored DB cluster is to export to CloudWatch
// Logs. The values in the list depend on the DB engine being used. For more
// information, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
// in the Amazon Aurora User Guide.
EnableCloudwatchLogsExports []string `type:"list"`
// A value that indicates whether to enable mapping of AWS Identity and Access
// Management (IAM) accounts to database accounts. By default, mapping is disabled.
//
// For more information, see IAM Database Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html)
// in the Amazon Aurora User Guide.
EnableIAMDatabaseAuthentication *bool `type:"boolean"`
// The name of the database engine to be used for the restored DB cluster.
//
// Valid Values: aurora, aurora-postgresql
//
// Engine is a required field
Engine *string `type:"string" required:"true"`
// The version number of the database engine to use.
//
// To list all of the available engine versions for aurora (for MySQL 5.6-compatible
// Aurora), use the following command:
//
// aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
//
// To list all of the available engine versions for aurora-mysql (for MySQL
// 5.7-compatible Aurora), use the following command:
//
// aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
//
// To list all of the available engine versions for aurora-postgresql, use the
// following command:
//
// aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
//
// Aurora MySQL
//
// Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5
//
// Aurora PostgreSQL
//
// Example: 9.6.3, 10.7
EngineVersion *string `type:"string"`
// The AWS KMS key identifier for an encrypted DB cluster.
//
// The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption
// key. If you are creating a DB cluster with the same AWS account that owns
// the KMS encryption key used to encrypt the new DB cluster, then you can use
// the KMS key alias instead of the ARN for the KM encryption key.
//
// If the StorageEncrypted parameter is enabled, and you do not specify a value
// for the KmsKeyId parameter, then Amazon RDS will use your default encryption
// key. AWS KMS creates the default encryption key for your AWS account. Your
// AWS account has a different default encryption key for each AWS Region.
KmsKeyId *string `type:"string"`
// The password for the master database user. This password can contain any
// printable ASCII character except "/", """, or "@".
//
// Constraints: Must contain from 8 to 41 characters.
//
// MasterUserPassword is a required field
MasterUserPassword *string `type:"string" required:"true"`
// The name of the master user for the restored DB cluster.
//
// Constraints:
//
// * Must be 1 to 16 letters or numbers.
//
// * First character must be a letter.
//
// * Can't be a reserved word for the chosen database engine.
//
// MasterUsername is a required field
MasterUsername *string `type:"string" required:"true"`
// A value that indicates that the restored DB cluster should be associated
// with the specified option group.
//
// Permanent options can't be removed from an option group. An option group
// can't be removed from a DB cluster once it is associated with a DB cluster.
OptionGroupName *string `type:"string"`
// The port number on which the instances in the restored DB cluster accept
// connections.
//
// Default: 3306
Port *int64 `type:"integer"`
// The daily time range during which automated backups are created if automated
// backups are enabled using the BackupRetentionPeriod parameter.
//
// The default is a 30-minute window selected at random from an 8-hour block
// of time for each AWS Region. To see the time blocks available, see Adjusting
// the Preferred Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora)
// in the Amazon Aurora User Guide.
//
// Constraints:
//
// * Must be in the format hh24:mi-hh24:mi.
//
// * Must be in Universal Coordinated Time (UTC).
//
// * Must not conflict with the preferred maintenance window.
//
// * Must be at least 30 minutes.
PreferredBackupWindow *string `type:"string"`
// The weekly time range during which system maintenance can occur, in Universal
// Coordinated Time (UTC).
//
// Format: ddd:hh24:mi-ddd:hh24:mi
//
// The default is a 30-minute window selected at random from an 8-hour block
// of time for each AWS Region, occurring on a random day of the week. To see
// the time blocks available, see Adjusting the Preferred Maintenance Window
// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora)
// in the Amazon Aurora User Guide.
//
// Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
//
// Constraints: Minimum 30-minute window.
PreferredMaintenanceWindow *string `type:"string"`
// The name of the Amazon S3 bucket that contains the data used to create the
// Amazon Aurora DB cluster.
//
// S3BucketName is a required field
S3BucketName *string `type:"string" required:"true"`
// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
// (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your
// behalf.
//
// S3IngestionRoleArn is a required field
S3IngestionRoleArn *string `type:"string" required:"true"`
// The prefix for all of the file names that contain the data used to create
// the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value,
// then the Amazon Aurora DB cluster is created by using all of the files in
// the Amazon S3 bucket.
S3Prefix *string `type:"string"`
// The identifier for the database engine that was backed up to create the files
// stored in the Amazon S3 bucket.
//
// Valid values: mysql
//
// SourceEngine is a required field
SourceEngine *string `type:"string" required:"true"`
// The version of the database that the backup files were created from.
//
// MySQL version 5.5 and 5.6 are supported.
//
// Example: 5.6.22
//
// SourceEngineVersion is a required field
SourceEngineVersion *string `type:"string" required:"true"`
// A value that indicates whether the restored DB cluster is encrypted.
StorageEncrypted *bool `type:"boolean"`
// 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"`
// A list of EC2 VPC security groups to associate with the restored DB cluster.
VpcSecurityGroupIds []string `locationNameList:"VpcSecurityGroupId" type:"list"`
}
// String returns the string representation
func (s RestoreDBClusterFromS3Input) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *RestoreDBClusterFromS3Input) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "RestoreDBClusterFromS3Input"}
if s.DBClusterIdentifier == nil {
invalidParams.Add(aws.NewErrParamRequired("DBClusterIdentifier"))
}
if s.Engine == nil {
invalidParams.Add(aws.NewErrParamRequired("Engine"))
}
if s.MasterUserPassword == nil {
invalidParams.Add(aws.NewErrParamRequired("MasterUserPassword"))
}
if s.MasterUsername == nil {
invalidParams.Add(aws.NewErrParamRequired("MasterUsername"))
}
if s.S3BucketName == nil {
invalidParams.Add(aws.NewErrParamRequired("S3BucketName"))
}
if s.S3IngestionRoleArn == nil {
invalidParams.Add(aws.NewErrParamRequired("S3IngestionRoleArn"))
}
if s.SourceEngine == nil {
invalidParams.Add(aws.NewErrParamRequired("SourceEngine"))
}
if s.SourceEngineVersion == nil {
invalidParams.Add(aws.NewErrParamRequired("SourceEngineVersion"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterFromS3Result
type RestoreDBClusterFromS3Output struct {
_ struct{} `type:"structure"`
// Contains the details of an Amazon Aurora DB cluster.
//
// This data type is used as a response element in the DescribeDBClusters, StopDBCluster,
// and StartDBCluster actions.
DBCluster *DBCluster `type:"structure"`
}
// String returns the string representation
func (s RestoreDBClusterFromS3Output) String() string {
return awsutil.Prettify(s)
}
const opRestoreDBClusterFromS3 = "RestoreDBClusterFromS3"
// RestoreDBClusterFromS3Request returns a request value for making API operation for
// Amazon Relational Database Service.
//
// Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket.
// Amazon RDS must be authorized to access the Amazon S3 bucket and the data
// must be created using the Percona XtraBackup utility as described in Migrating
// Data to an Amazon Aurora MySQL DB Cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.html)
// in the Amazon Aurora User Guide.
//
// This action only applies to Aurora DB clusters.
//
// // Example sending a request using RestoreDBClusterFromS3Request.
// req := client.RestoreDBClusterFromS3Request(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/RestoreDBClusterFromS3
func (c *Client) RestoreDBClusterFromS3Request(input *RestoreDBClusterFromS3Input) RestoreDBClusterFromS3Request {
op := &aws.Operation{
Name: opRestoreDBClusterFromS3,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &RestoreDBClusterFromS3Input{}
}
req := c.newRequest(op, input, &RestoreDBClusterFromS3Output{})
return RestoreDBClusterFromS3Request{Request: req, Input: input, Copy: c.RestoreDBClusterFromS3Request}
}
// RestoreDBClusterFromS3Request is the request type for the
// RestoreDBClusterFromS3 API operation.
type RestoreDBClusterFromS3Request struct {
*aws.Request
Input *RestoreDBClusterFromS3Input
Copy func(*RestoreDBClusterFromS3Input) RestoreDBClusterFromS3Request
}
// Send marshals and sends the RestoreDBClusterFromS3 API request.
func (r RestoreDBClusterFromS3Request) Send(ctx context.Context) (*RestoreDBClusterFromS3Response, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &RestoreDBClusterFromS3Response{
RestoreDBClusterFromS3Output: r.Request.Data.(*RestoreDBClusterFromS3Output),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// RestoreDBClusterFromS3Response is the response type for the
// RestoreDBClusterFromS3 API operation.
type RestoreDBClusterFromS3Response struct {
*RestoreDBClusterFromS3Output
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// RestoreDBClusterFromS3 request.
func (r *RestoreDBClusterFromS3Response) SDKResponseMetdata() *aws.Response {
return r.response
}