-
Notifications
You must be signed in to change notification settings - Fork 597
/
api_op_UpdateRelationalDatabase.go
240 lines (215 loc) · 7.68 KB
/
api_op_UpdateRelationalDatabase.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
// Code generated by smithy-go-codegen DO NOT EDIT.
package lightsail
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/lightsail/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Allows the update of one or more attributes of a database in Amazon Lightsail.
//
// Updates are applied immediately, or in cases where the updates could result in
// an outage, are applied during the database's predefined maintenance window.
//
// The update relational database operation supports tag-based access control via
// resource tags applied to the resource identified by relationalDatabaseName. For
// more information, see the [Amazon Lightsail Developer Guide].
//
// [Amazon Lightsail Developer Guide]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags
func (c *Client) UpdateRelationalDatabase(ctx context.Context, params *UpdateRelationalDatabaseInput, optFns ...func(*Options)) (*UpdateRelationalDatabaseOutput, error) {
if params == nil {
params = &UpdateRelationalDatabaseInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateRelationalDatabase", params, optFns, c.addOperationUpdateRelationalDatabaseMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateRelationalDatabaseOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateRelationalDatabaseInput struct {
// The name of your Lightsail database resource to update.
//
// This member is required.
RelationalDatabaseName *string
// When true , applies changes immediately. When false , applies changes during the
// preferred maintenance window. Some changes may cause an outage.
//
// Default: false
ApplyImmediately *bool
// Indicates the certificate that needs to be associated with the database.
CaCertificateIdentifier *string
// When true , disables automated backup retention for your database.
//
// Disabling backup retention deletes all automated database backups. Before
// disabling this, you may want to create a snapshot of your database using the
// create relational database snapshot operation.
//
// Updates are applied during the next maintenance window because this can result
// in an outage.
DisableBackupRetention *bool
// When true , enables automated backup retention for your database.
//
// Updates are applied during the next maintenance window because this can result
// in an outage.
EnableBackupRetention *bool
// The password for the master user. The password can include any printable ASCII
// character except "/", """, or "@".
//
// MySQL
//
// Constraints: Must contain from 8 to 41 characters.
//
// PostgreSQL
//
// Constraints: Must contain from 8 to 128 characters.
MasterUserPassword *string
// The daily time range during which automated backups are created for your
// database if automated backups are enabled.
//
// Constraints:
//
// - Must be in the hh24:mi-hh24:mi format.
//
// Example: 16:00-16:30
//
// - Specified in Coordinated Universal 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 on your
// database.
//
// 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.
//
// Constraints:
//
// - Must be in the ddd:hh24:mi-ddd:hh24:mi format.
//
// - Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
//
// - Must be at least 30 minutes.
//
// - Specified in Coordinated Universal Time (UTC).
//
// - Example: Tue:17:00-Tue:17:30
PreferredMaintenanceWindow *string
// Specifies the accessibility options for your database. A value of true
// specifies a database that is available to resources outside of your Lightsail
// account. A value of false specifies a database that is available only to your
// Lightsail resources in the same region as your database.
PubliclyAccessible *bool
// This parameter is used to update the major version of the database. Enter the
// blueprintId for the major version that you want to update to.
//
// Use the [GetRelationalDatabaseBlueprints] action to get a list of available blueprint IDs.
//
// [GetRelationalDatabaseBlueprints]: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRelationalDatabaseBlueprints.html
RelationalDatabaseBlueprintId *string
// When true , the master user password is changed to a new strong password
// generated by Lightsail.
//
// Use the get relational database master user password operation to get the new
// password.
RotateMasterUserPassword *bool
noSmithyDocumentSerde
}
type UpdateRelationalDatabaseOutput struct {
// An array of objects that describe the result of the action, such as the status
// of the request, the timestamp of the request, and the resources affected by the
// request.
Operations []types.Operation
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateRelationalDatabaseMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpUpdateRelationalDatabase{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpUpdateRelationalDatabase{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "UpdateRelationalDatabase"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateRelationalDatabaseValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateRelationalDatabase(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); 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
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateRelationalDatabase(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "UpdateRelationalDatabase",
}
}