-
Notifications
You must be signed in to change notification settings - Fork 597
/
api_op_RestoreDBClusterFromS3.go
367 lines (323 loc) · 14.7 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
// Code generated by smithy-go-codegen DO NOT EDIT.
package rds
import (
"context"
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/rds/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates an Amazon Aurora DB cluster from MySQL 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 from MySQL by Using an Amazon S3 Bucket
// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.ExtMySQL.html#AuroraMySQL.Migrating.ExtMySQL.S3)
// in the Amazon Aurora User Guide. This action only restores the DB cluster, not
// the DB instances for that DB cluster. You must invoke the CreateDBInstance
// action to create DB instances for the restored DB cluster, specifying the
// identifier of the restored DB cluster in DBClusterIdentifier. You can create DB
// instances only after the RestoreDBClusterFromS3 action has completed and the DB
// cluster is available. 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.
// The source DB engine must be MySQL.
func (c *Client) RestoreDBClusterFromS3(ctx context.Context, params *RestoreDBClusterFromS3Input, optFns ...func(*Options)) (*RestoreDBClusterFromS3Output, error) {
if params == nil {
params = &RestoreDBClusterFromS3Input{}
}
result, metadata, err := c.invokeOperation(ctx, "RestoreDBClusterFromS3", params, optFns, c.addOperationRestoreDBClusterFromS3Middlewares)
if err != nil {
return nil, err
}
out := result.(*RestoreDBClusterFromS3Output)
out.ResultMetadata = metadata
return out, nil
}
type RestoreDBClusterFromS3Input struct {
// The name of the DB cluster to create from the source data in the Amazon S3
// bucket. 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-cluster1
//
// This member is required.
DBClusterIdentifier *string
// The name of the database engine to be used for this DB cluster. Valid Values:
// aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible
// Aurora), and aurora-postgresql
//
// This member is required.
Engine *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.
//
// This member is required.
MasterUserPassword *string
// 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.
//
// This member is required.
MasterUsername *string
// The name of the Amazon S3 bucket that contains the data used to create the
// Amazon Aurora DB cluster.
//
// This member is required.
S3BucketName *string
// The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access
// Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket
// on your behalf.
//
// This member is required.
S3IngestionRoleArn *string
// The identifier for the database engine that was backed up to create the files
// stored in the Amazon S3 bucket. Valid values: mysql
//
// This member is required.
SourceEngine *string
// The version of the database that the backup files were created from. MySQL
// versions 5.5, 5.6, and 5.7 are supported. Example: 5.6.40, 5.7.28
//
// This member is required.
SourceEngineVersion *string
// A list of Availability Zones (AZs) where instances in the restored DB cluster
// can be created.
AvailabilityZones []string
// The target backtrack window, in seconds. To disable backtracking, set this value
// to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters.
// Default: 0 Constraints:
//
// * If specified, this value must be set to a number from
// 0 to 259,200 (72 hours).
BacktrackWindow *int64
// 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 *int32
// A value that indicates that the restored DB cluster should be associated with
// the specified CharacterSet.
CharacterSetName *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
// 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
// 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
// The database name for the restored DB cluster.
DatabaseName *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 isn't enabled.
DeletionProtection *bool
// Specify the Active Directory directory ID to restore the DB cluster in. The
// domain must be created prior to this operation. For Amazon Aurora DB clusters,
// Amazon RDS can use Kerberos Authentication to authenticate users that connect to
// the DB cluster. For more information, see Kerberos Authentication
// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html)
// in the Amazon Aurora User Guide.
Domain *string
// Specify the name of the IAM role to be used when making API calls to the
// Directory Service.
DomainIAMRoleName *string
// 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
// A value that indicates whether to enable mapping of Amazon Web Services Identity
// and Access Management (IAM) accounts to database accounts. By default, mapping
// isn't enabled. 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
// 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
// The Amazon Web Services KMS key identifier for an encrypted DB cluster. The
// Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or
// alias name for the KMS key. To use a KMS key in a different Amazon Web Services
// account, specify the key ARN or alias ARN. If the StorageEncrypted parameter is
// enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon
// RDS will use your default KMS key. There is a default KMS key for your Amazon
// Web Services account. Your Amazon Web Services account has a different default
// KMS key for each Amazon Web Services Region.
KmsKeyId *string
// 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
// The port number on which the instances in the restored DB cluster accept
// connections. Default: 3306
Port *int32
// 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 Amazon
// Web Services Region. To view the time blocks available, see Backup window
// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow)
// 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
// 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 Amazon
// Web Services 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
// 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
// A value that indicates whether the restored DB cluster is encrypted.
StorageEncrypted *bool
// 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
// A list of EC2 VPC security groups to associate with the restored DB cluster.
VpcSecurityGroupIds []string
noSmithyDocumentSerde
}
type RestoreDBClusterFromS3Output struct {
// Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. For
// an Amazon Aurora DB cluster, this data type is used as a response element in the
// operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters,
// FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster,
// RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot,
// RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster. For a Multi-AZ
// DB cluster, this data type is used as a response element in the operations
// CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,
// ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and
// RestoreDBClusterToPointInTime. 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 deployments with two readable standby DB instances
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)
// in the Amazon RDS User Guide. The Multi-AZ DB clusters feature is in preview and
// is subject to change.
DBCluster *types.DBCluster
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationRestoreDBClusterFromS3Middlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsquery_serializeOpRestoreDBClusterFromS3{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpRestoreDBClusterFromS3{}, 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 = addOpRestoreDBClusterFromS3ValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opRestoreDBClusterFromS3(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
}
func newServiceMetadataMiddleware_opRestoreDBClusterFromS3(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "rds",
OperationName: "RestoreDBClusterFromS3",
}
}