-
Notifications
You must be signed in to change notification settings - Fork 623
/
api_op_ModifyDBCluster.go
233 lines (198 loc) · 7.53 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
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package docdb
import (
"context"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
)
// Represents the input to ModifyDBCluster.
type ModifyDBClusterInput struct {
_ struct{} `type:"structure"`
// A value that specifies whether the changes in this request and any pending
// changes are asynchronously applied as soon as possible, regardless of the
// PreferredMaintenanceWindow setting for the DB cluster. If this parameter
// is set to false, changes to the DB cluster are applied during the next maintenance
// window.
//
// The ApplyImmediately parameter affects only the NewDBClusterIdentifier and
// MasterUserPassword values. If you set this parameter value to false, the
// changes to the NewDBClusterIdentifier and MasterUserPassword values are applied
// during the next maintenance window. All other changes are applied immediately,
// regardless of the value of the ApplyImmediately parameter.
//
// Default: false
ApplyImmediately *bool `type:"boolean"`
// 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 *int64 `type:"integer"`
// The configuration setting for the log types to be enabled for export to Amazon
// CloudWatch Logs for a specific DB instance or DB cluster. The EnableLogTypes
// and DisableLogTypes arrays determine which logs are exported (or not exported)
// to CloudWatch Logs.
CloudwatchLogsExportConfiguration *CloudwatchLogsExportConfiguration `type:"structure"`
// The DB cluster identifier for the cluster that is being modified. This parameter
// is not case sensitive.
//
// Constraints:
//
// * Must match the identifier of an existing DBCluster.
//
// DBClusterIdentifier is a required field
DBClusterIdentifier *string `type:"string" required:"true"`
// The name of the DB cluster parameter group to use for the DB cluster.
DBClusterParameterGroupName *string `type:"string"`
// Specifies whether this cluster can be deleted. If DeletionProtection is enabled,
// the cluster cannot be deleted unless it is modified and DeletionProtection
// is disabled. DeletionProtection protects clusters from being accidentally
// deleted.
DeletionProtection *bool `type:"boolean"`
// 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 the ApplyImmediately parameter is set to true.
EngineVersion *string `type:"string"`
// The password for the master database user. This password can contain any
// printable ASCII character except forward slash (/), double quote ("), or
// the "at" symbol (@).
//
// Constraints: Must contain from 8 to 41 characters.
MasterUserPassword *string `type:"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.
//
// * Cannot end with a hyphen or contain two consecutive hyphens.
//
// Example: my-cluster2
NewDBClusterIdentifier *string `type:"string"`
// The port number on which the DB cluster accepts connections.
//
// Constraints: Must be a value from 1150 to 65535.
//
// Default: The same port as the original DB cluster.
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.
//
// 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.
//
// Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
//
// Constraints: Minimum 30-minute window.
PreferredMaintenanceWindow *string `type:"string"`
// A list of virtual private cloud (VPC) security groups that the DB cluster
// will belong to.
VpcSecurityGroupIds []string `locationNameList:"VpcSecurityGroupId" type:"list"`
}
// String returns the string representation
func (s ModifyDBClusterInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ModifyDBClusterInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "ModifyDBClusterInput"}
if s.DBClusterIdentifier == nil {
invalidParams.Add(aws.NewErrParamRequired("DBClusterIdentifier"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
type ModifyDBClusterOutput struct {
_ struct{} `type:"structure"`
// Detailed information about a DB cluster.
DBCluster *DBCluster `type:"structure"`
}
// String returns the string representation
func (s ModifyDBClusterOutput) String() string {
return awsutil.Prettify(s)
}
const opModifyDBCluster = "ModifyDBCluster"
// ModifyDBClusterRequest returns a request value for making API operation for
// Amazon DocumentDB with MongoDB compatibility.
//
// Modifies a setting for an Amazon DocumentDB DB cluster. You can change one
// or more database configuration parameters by specifying these parameters
// and the new values in the request.
//
// // Example sending a request using ModifyDBClusterRequest.
// req := client.ModifyDBClusterRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBCluster
func (c *Client) ModifyDBClusterRequest(input *ModifyDBClusterInput) ModifyDBClusterRequest {
op := &aws.Operation{
Name: opModifyDBCluster,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &ModifyDBClusterInput{}
}
req := c.newRequest(op, input, &ModifyDBClusterOutput{})
return ModifyDBClusterRequest{Request: req, Input: input, Copy: c.ModifyDBClusterRequest}
}
// ModifyDBClusterRequest is the request type for the
// ModifyDBCluster API operation.
type ModifyDBClusterRequest struct {
*aws.Request
Input *ModifyDBClusterInput
Copy func(*ModifyDBClusterInput) ModifyDBClusterRequest
}
// Send marshals and sends the ModifyDBCluster API request.
func (r ModifyDBClusterRequest) Send(ctx context.Context) (*ModifyDBClusterResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &ModifyDBClusterResponse{
ModifyDBClusterOutput: r.Request.Data.(*ModifyDBClusterOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// ModifyDBClusterResponse is the response type for the
// ModifyDBCluster API operation.
type ModifyDBClusterResponse struct {
*ModifyDBClusterOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// ModifyDBCluster request.
func (r *ModifyDBClusterResponse) SDKResponseMetdata() *aws.Response {
return r.response
}