-
Notifications
You must be signed in to change notification settings - Fork 597
/
api_op_RestoreDBClusterFromSnapshot.go
409 lines (369 loc) · 18.1 KB
/
api_op_RestoreDBClusterFromSnapshot.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
// 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 a new DB cluster from a DB snapshot or DB cluster snapshot. The target
// DB cluster is created from the source snapshot with a default configuration. If
// you don't specify a security group, the new DB cluster is associated with the
// default security group. 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 RestoreDBClusterFromSnapshot action has completed and the DB cluster
// is available. 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.
func (c *Client) RestoreDBClusterFromSnapshot(ctx context.Context, params *RestoreDBClusterFromSnapshotInput, optFns ...func(*Options)) (*RestoreDBClusterFromSnapshotOutput, error) {
if params == nil {
params = &RestoreDBClusterFromSnapshotInput{}
}
result, metadata, err := c.invokeOperation(ctx, "RestoreDBClusterFromSnapshot", params, optFns, c.addOperationRestoreDBClusterFromSnapshotMiddlewares)
if err != nil {
return nil, err
}
out := result.(*RestoreDBClusterFromSnapshotOutput)
out.ResultMetadata = metadata
return out, nil
}
//
type RestoreDBClusterFromSnapshotInput struct {
// The name of the DB cluster to create from the DB snapshot or 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-snapshot-id Valid for: Aurora DB clusters and Multi-AZ DB clusters
//
// This member is required.
DBClusterIdentifier *string
// The database engine to use for the new DB cluster. Default: The same as source
// Constraint: Must be compatible with the engine of the source Valid for: Aurora
// DB clusters and Multi-AZ DB clusters
//
// This member is required.
Engine *string
// The identifier for the DB snapshot or DB cluster snapshot to restore from. You
// can use either the name or the Amazon Resource Name (ARN) to specify a DB
// cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
// Constraints:
//
// * Must match the identifier of an existing Snapshot.
//
// Valid for:
// Aurora DB clusters and Multi-AZ DB clusters
//
// This member is required.
SnapshotIdentifier *string
// Provides the list of Availability Zones (AZs) where instances in the restored DB
// cluster can be created. Valid for: Aurora DB clusters only
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).
//
// Valid for: Aurora DB clusters only
BacktrackWindow *int64
// 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. Valid
// for: Aurora DB clusters and Multi-AZ DB clusters
CopyTagsToSnapshot *bool
// The compute and memory capacity of the each DB instance in the Multi-AZ DB
// cluster, for example db.m6g.xlarge. 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. Valid for: Multi-AZ DB clusters only
DBClusterInstanceClass *string
// The name of the DB cluster parameter group to associate with this DB cluster. If
// this argument is omitted, the default DB cluster parameter group for the
// specified engine is used. Constraints:
//
// * If supplied, must match the name of an
// existing default DB cluster parameter group.
//
// * Must be 1 to 255 letters,
// numbers, or hyphens.
//
// * First character must be a letter.
//
// * Can't end with a
// hyphen or contain two consecutive hyphens.
//
// Valid for: Aurora DB clusters and
// Multi-AZ DB clusters
DBClusterParameterGroupName *string
// The name of the DB subnet group to use for the new DB cluster. Constraints: If
// supplied, must match the name of an existing DB subnet group. Example:
// mydbsubnetgroup Valid for: Aurora DB clusters and Multi-AZ DB clusters
DBSubnetGroupName *string
// The database name for the restored DB cluster. Valid for: Aurora DB clusters and
// Multi-AZ DB clusters
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. Valid for: Aurora DB clusters and Multi-AZ DB
// clusters
DeletionProtection *bool
// Specify the Active Directory directory ID to restore the DB cluster in. The
// domain must be created prior to this operation. Currently, only MySQL, Microsoft
// SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active
// Directory Domain. For more information, see Kerberos Authentication
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html)
// in the Amazon RDS User Guide. Valid for: Aurora DB clusters only
Domain *string
// Specify the name of the IAM role to be used when making API calls to the
// Directory Service. Valid for: Aurora DB clusters only
DomainIAMRoleName *string
// The list of logs that the restored DB cluster is to export to Amazon CloudWatch
// Logs. The values in the list depend on the DB engine being used. RDS for MySQL
// Possible values are error, general, and slowquery. RDS for PostgreSQL Possible
// values are postgresql and upgrade. Aurora MySQL Possible values are audit,
// error, general, and slowquery. Aurora PostgreSQL Possible value is postgresql.
// For more information about exporting CloudWatch Logs for Amazon RDS, 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.. For more information about exporting CloudWatch
// Logs for Amazon Aurora, 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. Valid for: Aurora DB clusters and Multi-AZ DB
// clusters
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. Valid for: Aurora DB clusters only
EnableIAMDatabaseAuthentication *bool
// The DB engine mode of the DB cluster, either provisioned, serverless,
// parallelquery, global, or multimaster. For more information, see
// CreateDBCluster
// (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html).
// Valid for: Aurora DB clusters only
EngineMode *string
// The version of the database engine to use for the new DB cluster. To list all of
// the available engine versions 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 MySQL 5.7-compatible and MySQL 8.0-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" To list all of the available engine versions
// for RDS for MySQL, use the following command: aws rds
// describe-db-engine-versions --engine mysql --query
// "DBEngineVersions[].EngineVersion" To list all of the available engine versions
// for RDS for PostgreSQL, use the following command: aws rds
// describe-db-engine-versions --engine postgres --query
// "DBEngineVersions[].EngineVersion" Aurora MySQL See MySQL on Amazon RDS Versions
// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html)
// in the Amazon Aurora User Guide. Aurora PostgreSQL See Amazon Aurora PostgreSQL
// releases and engine versions
// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html)
// in the Amazon Aurora User Guide. MySQL See MySQL on Amazon RDS Versions
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)
// in the Amazon RDS User Guide. PostgreSQL See Amazon RDS for PostgreSQL versions
// and extensions
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts)
// in the Amazon RDS User Guide. Valid for: Aurora DB clusters and Multi-AZ DB
// clusters
EngineVersion *string
// The amount of Provisioned IOPS (input/output operations per second) to be
// initially allocated for each DB instance in the Multi-AZ DB cluster. For
// information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to
// Improve Performance
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS)
// in the Amazon RDS User Guide. Constraints: Must be a multiple between .5 and 50
// of the storage amount for the DB instance. Valid for: Aurora DB clusters and
// Multi-AZ DB clusters
Iops *int32
// The Amazon Web Services KMS key identifier to use when restoring an encrypted DB
// cluster from a DB snapshot or DB cluster snapshot. 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. When you don't specify a value for the KmsKeyId parameter, then
// the following occurs:
//
// * If the DB snapshot or DB cluster snapshot in
// SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using
// the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
//
// *
// If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted,
// then the restored DB cluster isn't encrypted.
//
// Valid for: Aurora DB clusters and
// Multi-AZ DB clusters
KmsKeyId *string
// The name of the option group to use for the restored DB cluster. DB clusters are
// associated with a default option group that can't be modified.
OptionGroupName *string
// The port number on which the new DB cluster accepts connections. Constraints:
// This value must be 1150-65535 Default: The same port as the original DB cluster.
// Valid for: Aurora DB clusters and Multi-AZ DB clusters
Port *int32
// A value that indicates whether the DB cluster is publicly accessible. When the
// DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
// resolves to the private IP address from within the DB cluster's virtual private
// cloud (VPC). It resolves to the public IP address from outside of the DB
// cluster's VPC. Access to the DB cluster is ultimately controlled by the security
// group it uses. That public access is not permitted if the security group
// assigned to the DB cluster doesn't permit it. When the DB cluster isn't publicly
// accessible, it is an internal DB cluster with a DNS name that resolves to a
// private IP address. Default: The default behavior varies depending on whether
// DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and
// PubliclyAccessible isn't specified, the following applies:
//
// * If the default VPC
// in the target Region doesn’t have an internet gateway attached to it, the DB
// cluster is private.
//
// * If the default VPC in the target Region has an internet
// gateway attached to it, the DB cluster is public.
//
// If DBSubnetGroupName is
// specified, and PubliclyAccessible isn't specified, the following applies:
//
// * If
// the subnets are part of a VPC that doesn’t have an internet gateway attached to
// it, the DB cluster is private.
//
// * If the subnets are part of a VPC that has an
// internet gateway attached to it, the DB cluster is public.
//
// Valid for: Aurora DB
// clusters and Multi-AZ DB clusters
PubliclyAccessible *bool
// For DB clusters in serverless DB engine mode, the scaling properties of the DB
// cluster. Valid for: Aurora DB clusters only
ScalingConfiguration *types.ScalingConfiguration
// Contains the scaling configuration of an Aurora Serverless v2 DB cluster. For
// more information, see Using Amazon Aurora Serverless v2
// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html)
// in the Amazon Aurora User Guide.
ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration
// Specifies the storage type to be associated with the each DB instance in the
// Multi-AZ DB cluster. Valid values: io1 When specified, a value for the Iops
// parameter is required. Default: io1 Valid for: Aurora DB clusters and Multi-AZ
// DB clusters
StorageType *string
// The tags to be assigned to the restored DB cluster. Valid for: Aurora DB
// clusters and Multi-AZ DB clusters
Tags []types.Tag
// A list of VPC security groups that the new DB cluster will belong to. Valid for:
// Aurora DB clusters and Multi-AZ DB clusters
VpcSecurityGroupIds []string
noSmithyDocumentSerde
}
type RestoreDBClusterFromSnapshotOutput 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.
DBCluster *types.DBCluster
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationRestoreDBClusterFromSnapshotMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsquery_serializeOpRestoreDBClusterFromSnapshot{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpRestoreDBClusterFromSnapshot{}, 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 = addOpRestoreDBClusterFromSnapshotValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opRestoreDBClusterFromSnapshot(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_opRestoreDBClusterFromSnapshot(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "rds",
OperationName: "RestoreDBClusterFromSnapshot",
}
}