-
Notifications
You must be signed in to change notification settings - Fork 598
/
api_op_ModifyDBCluster.go
306 lines (271 loc) · 12.8 KB
/
api_op_ModifyDBCluster.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
// 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/awslabs/smithy-go/middleware"
smithyhttp "github.com/awslabs/smithy-go/transport/http"
)
// Modify a setting for an Amazon Aurora DB cluster. You can change one or more
// database configuration parameters by specifying these parameters and the new
// values in the request. 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.
func (c *Client) ModifyDBCluster(ctx context.Context, params *ModifyDBClusterInput, optFns ...func(*Options)) (*ModifyDBClusterOutput, error) {
if params == nil {
params = &ModifyDBClusterInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ModifyDBCluster", params, optFns, addOperationModifyDBClusterMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ModifyDBClusterOutput)
out.ResultMetadata = metadata
return out, nil
}
//
type ModifyDBClusterInput struct {
// The DB cluster identifier for the cluster being modified. This parameter isn't
// case-sensitive. Constraints: This identifier must match the identifier of an
// existing DB cluster.
//
// This member is required.
DBClusterIdentifier *string
// A value that indicates whether major version upgrades are allowed. Constraints:
// You must allow major version upgrades when specifying a value for the
// EngineVersion parameter that is a different major version than the DB cluster's
// current version.
AllowMajorVersionUpgrade bool
// A value that indicates whether the modifications in this request and any pending
// modifications are asynchronously applied as soon as possible, regardless of the
// PreferredMaintenanceWindow setting for the DB cluster. If this parameter is
// disabled, changes to the DB cluster are applied during the next maintenance
// window. The ApplyImmediately parameter only affects the
// EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier
// values. If the ApplyImmediately parameter is disabled, then changes to the
// EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier
// values are applied during the next maintenance window. All other changes are
// applied immediately, regardless of the value of the ApplyImmediately parameter.
// By default, this parameter is disabled.
ApplyImmediately bool
// 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 are retained. You must specify a
// minimum value of 1. Default: 1 Constraints:
//
// * Must be a value from 1 to 35
BackupRetentionPeriod *int32
// The configuration setting for the log types to be enabled for export to
// CloudWatch Logs for a specific DB cluster.
CloudwatchLogsExportConfiguration *types.CloudwatchLogsExportConfiguration
// A value that indicates whether to copy all tags from the DB cluster to snapshots
// of the DB cluster. The default is not to copy them.
CopyTagsToSnapshot *bool
// The name of the DB cluster parameter group to use for the DB cluster.
DBClusterParameterGroupName *string
// The name of the DB parameter group to apply to all instances of the DB cluster.
// When you apply a parameter group using the DBInstanceParameterGroupName
// parameter, the DB cluster isn't rebooted automatically. Also, parameter changes
// aren't applied during the next maintenance window but instead are applied
// immediately. Default: The existing name setting Constraints:
//
// * The DB parameter
// group must be in the same DB parameter group family as this DB cluster.
//
// * The
// DBInstanceParameterGroupName parameter is only valid in combination with the
// AllowMajorVersionUpgrade parameter.
DBInstanceParameterGroupName *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
// The Active Directory directory ID to move the DB cluster to. Specify none to
// remove the cluster from its current domain. The domain must be created prior to
// this operation. 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
// A value that indicates whether to enable write operations to be forwarded from
// this cluster to the primary cluster in an Aurora global database. The resulting
// changes are replicated back to this cluster. This parameter only applies to DB
// clusters that are secondary clusters in an Aurora global database. By default,
// Aurora disallows write operations for secondary clusters.
EnableGlobalWriteForwarding *bool
// A value that indicates whether to enable the HTTP endpoint for an Aurora
// Serverless DB cluster. By default, the HTTP endpoint is disabled. When enabled,
// the HTTP endpoint provides a connectionless web service API for running SQL
// queries on the Aurora Serverless DB cluster. You can also query your database
// from inside the RDS console with the query editor. For more information, see
// Using the Data API for Aurora Serverless
// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in
// the Amazon Aurora User Guide.
EnableHttpEndpoint *bool
// 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
// The version number of the database engine to which you want to upgrade. Changing
// this parameter results in an outage. The change is applied during the next
// maintenance window unless ApplyImmediately is enabled. 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"
EngineVersion *string
// The new 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 *string
// The new DB cluster identifier for the DB cluster when renaming a DB cluster.
// This value is stored as a lowercase string. Constraints:
//
// * Must contain from 1
// to 63 letters, numbers, or hyphens
//
// * The first character must be a letter
//
// *
// Can't end with a hyphen or contain two consecutive hyphens
//
// Example: my-cluster2
NewDBClusterIdentifier *string
// A value that indicates that the DB cluster should be associated with the
// specified option group. Changing this parameter doesn't result in an outage
// except in the following case, and the change is applied during the next
// maintenance window unless the ApplyImmediately is enabled for this request. If
// the parameter change results in an option group that enables OEM, this change
// can cause a brief (sub-second) period during which new connections are rejected
// but existing connections are not interrupted. Permanent options can't be removed
// from an option group. The 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 DB cluster accepts connections. Constraints: Value
// must be 1150-65535 Default: The same port as the original DB cluster.
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 AWS
// Region. To see the time blocks available, see Adjusting the Preferred DB
// Cluster 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
// 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 DB Cluster 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 scaling properties of the DB cluster. You can only modify scaling properties
// for DB clusters in serverless DB engine mode.
ScalingConfiguration *types.ScalingConfiguration
// A list of VPC security groups that the DB cluster will belong to.
VpcSecurityGroupIds []string
}
type ModifyDBClusterOutput struct {
// 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 *types.DBCluster
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
}
func addOperationModifyDBClusterMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsquery_serializeOpModifyDBCluster{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpModifyDBCluster{}, 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.AddAttemptClockSkewMiddleware(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 = addOpModifyDBClusterValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opModifyDBCluster(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_opModifyDBCluster(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "rds",
OperationName: "ModifyDBCluster",
}
}