-
Notifications
You must be signed in to change notification settings - Fork 597
/
api_op_RestoreDBInstanceFromS3.go
463 lines (404 loc) · 18 KB
/
api_op_RestoreDBInstanceFromS3.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
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
// 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"
)
// Amazon Relational Database Service (Amazon RDS) supports importing MySQL
// databases by using backup files. You can create a backup of your on-premises
// database, store it on Amazon Simple Storage Service (Amazon S3), and then
// restore the backup file onto a new Amazon RDS DB instance running MySQL. For
// more information, see Importing Data into an Amazon RDS MySQL DB Instance
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html)
// in the Amazon RDS User Guide. This command doesn't apply to RDS Custom.
func (c *Client) RestoreDBInstanceFromS3(ctx context.Context, params *RestoreDBInstanceFromS3Input, optFns ...func(*Options)) (*RestoreDBInstanceFromS3Output, error) {
if params == nil {
params = &RestoreDBInstanceFromS3Input{}
}
result, metadata, err := c.invokeOperation(ctx, "RestoreDBInstanceFromS3", params, optFns, c.addOperationRestoreDBInstanceFromS3Middlewares)
if err != nil {
return nil, err
}
out := result.(*RestoreDBInstanceFromS3Output)
out.ResultMetadata = metadata
return out, nil
}
type RestoreDBInstanceFromS3Input struct {
// The compute and memory capacity of the DB instance, for example db.m4.large. Not
// all DB instance classes are available in all Amazon Web Services Regions, or for
// all database engines. For the full list of DB instance classes, and availability
// for your engine, see DB Instance Class
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)
// in the Amazon RDS User Guide. Importing from Amazon S3 isn't supported on the
// db.t2.micro DB instance class.
//
// This member is required.
DBInstanceClass *string
// The DB instance identifier. This parameter is stored as a lowercase string.
// 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: mydbinstance
//
// This member is required.
DBInstanceIdentifier *string
// The name of the database engine to be used for this instance. Valid Values:
// mysql
//
// This member is required.
Engine *string
// The name of your Amazon S3 bucket that contains your database backup file.
//
// This member is required.
S3BucketName *string
// An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon
// RDS to access your Amazon S3 bucket.
//
// This member is required.
S3IngestionRoleArn *string
// The name of the engine of your source database. Valid Values: mysql
//
// This member is required.
SourceEngine *string
// The version of the database that the backup files were created from. MySQL
// versions 5.6 and 5.7 are supported. Example: 5.6.40
//
// This member is required.
SourceEngineVersion *string
// The amount of storage (in gigabytes) to allocate initially for the DB instance.
// Follow the allocation rules specified in CreateDBInstance. Be sure to allocate
// enough memory for your new DB instance so that the restore operation can
// succeed. You can also allocate additional memory for future growth.
AllocatedStorage *int32
// A value that indicates whether minor engine upgrades are applied automatically
// to the DB instance during the maintenance window. By default, minor engine
// upgrades are not applied automatically.
AutoMinorVersionUpgrade *bool
// The Availability Zone that the DB instance is created in. For information about
// Amazon Web Services Regions and Availability Zones, see Regions and Availability
// Zones
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)
// in the Amazon RDS User Guide. Default: A random, system-chosen Availability Zone
// in the endpoint's Amazon Web Services Region. Example: us-east-1d Constraint:
// The AvailabilityZone parameter can't be specified if the DB instance is a
// Multi-AZ deployment. The specified Availability Zone must be in the same Amazon
// Web Services Region as the current endpoint.
AvailabilityZone *string
// The number of days for which automated backups are retained. Setting this
// parameter to a positive number enables backups. For more information, see
// CreateDBInstance.
BackupRetentionPeriod *int32
// A value that indicates whether to copy all tags from the DB instance to
// snapshots of the DB instance. By default, tags are not copied.
CopyTagsToSnapshot *bool
// The name of the database to create when the DB instance is created. Follow the
// naming rules specified in CreateDBInstance.
DBName *string
// The name of the DB parameter group to associate with this DB instance. If you do
// not specify a value for DBParameterGroupName, then the default DBParameterGroup
// for the specified DB engine is used.
DBParameterGroupName *string
// A list of DB security groups to associate with this DB instance. Default: The
// default DB security group for the database engine.
DBSecurityGroups []string
// A DB subnet group to associate with this DB instance. Constraints: If supplied,
// must match the name of an existing DBSubnetGroup. Example: mydbsubnetgroup
DBSubnetGroupName *string
// A value that indicates whether the DB instance has deletion protection enabled.
// The database can't be deleted when deletion protection is enabled. By default,
// deletion protection isn't enabled. For more information, see Deleting a DB
// Instance
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
DeletionProtection *bool
// The list of logs that the restored DB instance 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/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
// in the Amazon RDS 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 about IAM database authentication, see IAM
// Database Authentication for MySQL and PostgreSQL
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html)
// in the Amazon RDS User Guide.
EnableIAMDatabaseAuthentication *bool
// A value that indicates whether to enable Performance Insights for the DB
// instance. For more information, see Using Amazon Performance Insights
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)
// in the Amazon RDS User Guide.
EnablePerformanceInsights *bool
// The version number of the database engine to use. Choose the latest minor
// version of your database engine. For information about engine versions, see
// CreateDBInstance, or call DescribeDBEngineVersions.
EngineVersion *string
// The amount of Provisioned IOPS (input/output operations per second) to allocate
// initially for the DB instance. For information about valid IOPS values, see
// Amazon RDS Provisioned IOPS storage
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS)
// in the Amazon RDS User Guide.
Iops *int32
// The Amazon Web Services KMS key identifier for an encrypted DB instance. 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
// The license model for this DB instance. Use general-public-license.
LicenseModel *string
// The password for the master user. The password can include any printable ASCII
// character except "/", """, or "@". Constraints: Must contain from 8 to 41
// characters.
MasterUserPassword *string
// The name for the master user. 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 *string
// The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale
// the storage of the DB instance. For more information about this setting,
// including limitations that apply to it, see Managing capacity automatically
// with Amazon RDS storage autoscaling
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling)
// in the Amazon RDS User Guide.
MaxAllocatedStorage *int32
// The interval, in seconds, between points when Enhanced Monitoring metrics are
// collected for the DB instance. To disable collecting Enhanced Monitoring
// metrics, specify 0. If MonitoringRoleArn is specified, then you must also set
// MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30,
// 60 Default: 0
MonitoringInterval *int32
// The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to
// Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For
// information on creating a monitoring role, see Setting Up and Enabling Enhanced
// Monitoring
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling)
// in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than
// 0, then you must supply a MonitoringRoleArn value.
MonitoringRoleArn *string
// A value that indicates whether the DB instance is a Multi-AZ deployment. If the
// DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone
// parameter.
MultiAZ *bool
// The network type of the DB instance. Valid values:
//
// * IPV4
//
// * DUAL
//
// The network
// type is determined by the DBSubnetGroup specified for the DB instance. A
// DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6
// protocols (DUAL). For more information, see Working with a DB instance in a VPC
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
// in the Amazon RDS User Guide.
NetworkType *string
// The name of the option group to associate with this DB instance. If this
// argument is omitted, the default option group for the specified engine is used.
OptionGroupName *string
// The Amazon Web Services KMS key identifier for encryption of Performance
// Insights data. The Amazon Web Services KMS key identifier is the key ARN, key
// ID, alias ARN, or alias name for the KMS key. If you do not specify a value for
// PerformanceInsightsKMSKeyId, then Amazon RDS uses 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.
PerformanceInsightsKMSKeyId *string
// The number of days to retain Performance Insights data. The default is 7 days.
// The following values are valid:
//
// * 7
//
// * month * 31, where month is a number of
// months from 1-23
//
// * 731
//
// For example, the following values are valid:
//
// * 93 (3
// months * 31)
//
// * 341 (11 months * 31)
//
// * 589 (19 months * 31)
//
// * 731
//
// If you
// specify a retention period such as 94, which isn't a valid value, RDS issues an
// error.
PerformanceInsightsRetentionPeriod *int32
// The port number on which the database accepts connections. Type: Integer Valid
// Values: 1150-65535 Default: 3306
Port *int32
// The time range each day during which automated backups are created if automated
// backups are enabled. For more information, see Backup window
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow)
// in the Amazon RDS 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 time range each week during which system maintenance can occur, in Universal
// Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance)
// in the Amazon RDS User Guide. Constraints:
//
// * Must be in the format
// ddd:hh24:mi-ddd:hh24:mi.
//
// * Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
//
// *
// Must be in Universal Coordinated Time (UTC).
//
// * Must not conflict with the
// preferred backup window.
//
// * Must be at least 30 minutes.
PreferredMaintenanceWindow *string
// The number of CPU cores and the number of threads per core for the DB instance
// class of the DB instance.
ProcessorFeatures []types.ProcessorFeature
// A value that indicates whether the DB instance is publicly accessible. When the
// DB instance is publicly accessible, its Domain Name System (DNS) endpoint
// resolves to the private IP address from within the DB instance's virtual private
// cloud (VPC). It resolves to the public IP address from outside of the DB
// instance's VPC. Access to the DB instance is ultimately controlled by the
// security group it uses. That public access is not permitted if the security
// group assigned to the DB instance doesn't permit it. When the DB instance isn't
// publicly accessible, it is an internal DB instance with a DNS name that resolves
// to a private IP address. For more information, see CreateDBInstance.
PubliclyAccessible *bool
// The prefix of your Amazon S3 bucket.
S3Prefix *string
// A value that indicates whether the new DB instance is encrypted or not.
StorageEncrypted *bool
// Specifies the storage throughput value for the DB instance. This setting doesn't
// apply to RDS Custom or Amazon Aurora.
StorageThroughput *int32
// Specifies the storage type to be associated with the DB instance. Valid values:
// gp2 | gp3 | io1 | standard If you specify io1 or gp3, you must also include a
// value for the Iops parameter. Default: io1 if the Iops parameter is specified;
// otherwise gp2
StorageType *string
// A list of tags to associate with this DB instance. 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 value that indicates whether the DB instance class of the DB instance uses its
// default processor features.
UseDefaultProcessorFeatures *bool
// A list of VPC security groups to associate with this DB instance.
VpcSecurityGroupIds []string
noSmithyDocumentSerde
}
type RestoreDBInstanceFromS3Output struct {
// Contains the details of an Amazon RDS DB instance. This data type is used as a
// response element in the operations CreateDBInstance,
// CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances,
// ModifyDBInstance, PromoteReadReplica, RebootDBInstance,
// RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3,
// RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
DBInstance *types.DBInstance
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationRestoreDBInstanceFromS3Middlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsquery_serializeOpRestoreDBInstanceFromS3{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpRestoreDBInstanceFromS3{}, 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 = addOpRestoreDBInstanceFromS3ValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opRestoreDBInstanceFromS3(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_opRestoreDBInstanceFromS3(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "rds",
OperationName: "RestoreDBInstanceFromS3",
}
}