-
Notifications
You must be signed in to change notification settings - Fork 597
/
api_op_CreateCustomDBEngineVersion.go
457 lines (386 loc) · 17.2 KB
/
api_op_CreateCustomDBEngineVersion.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
// Code generated by smithy-go-codegen DO NOT EDIT.
package rds
import (
"context"
"errors"
"fmt"
"github.com/aws/aws-sdk-go-v2/aws"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
internalauth "github.com/aws/aws-sdk-go-v2/internal/auth"
"github.com/aws/aws-sdk-go-v2/service/rds/types"
smithyendpoints "github.com/aws/smithy-go/endpoints"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Creates a custom DB engine version (CEV).
func (c *Client) CreateCustomDBEngineVersion(ctx context.Context, params *CreateCustomDBEngineVersionInput, optFns ...func(*Options)) (*CreateCustomDBEngineVersionOutput, error) {
if params == nil {
params = &CreateCustomDBEngineVersionInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateCustomDBEngineVersion", params, optFns, c.addOperationCreateCustomDBEngineVersionMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateCustomDBEngineVersionOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateCustomDBEngineVersionInput struct {
// The database engine to use for your custom engine version (CEV). The only
// supported value is custom-oracle-ee .
//
// This member is required.
Engine *string
// The name of your CEV. The name format is 19.customized_string. For example, a
// valid CEV name is 19.my_cev1 . This setting is required for RDS Custom for
// Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion
// is unique per customer per Region.
//
// This member is required.
EngineVersion *string
// The name of an Amazon S3 bucket that contains database installation files for
// your CEV. For example, a valid bucket name is my-custom-installation-files .
DatabaseInstallationFilesS3BucketName *string
// The Amazon S3 directory that contains the database installation files for your
// CEV. For example, a valid bucket name is 123456789012/cev1 . If this setting
// isn't specified, no prefix is assumed.
DatabaseInstallationFilesS3Prefix *string
// An optional description of your CEV.
Description *string
// The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI
// ID is required to create a CEV. For RDS Custom for Oracle, the default is the
// most recent AMI available, but you can specify an AMI ID that was used in a
// different Oracle CEV. Find the AMIs used by your CEVs by calling the
// DescribeDBEngineVersions (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBEngineVersions.html)
// operation.
ImageId *string
// The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric
// encryption KMS key is required for RDS Custom, but optional for Amazon RDS. If
// you have an existing symmetric encryption KMS key in your account, you can use
// it with RDS Custom. No further action is necessary. If you don't already have a
// symmetric encryption KMS key in your account, follow the instructions in
// Creating a symmetric encryption KMS key (https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk)
// in the Amazon Web Services Key Management Service Developer Guide. You can
// choose the same symmetric encryption key when you create a CEV and a DB
// instance, or choose different keys.
KMSKeyId *string
// The CEV manifest, which is a JSON document that describes the installation .zip
// files stored in Amazon S3. Specify the name/value pairs in a file or a quoted
// string. RDS Custom applies the patches in the order in which they are listed.
// The following JSON fields are valid: MediaImportTemplateVersion Version of the
// CEV manifest. The date is in the format YYYY-MM-DD .
// databaseInstallationFileNames Ordered list of installation files for the CEV.
// opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine.
// psuRuPatchFileNames The PSU and RU patches for this CEV. OtherPatchFileNames The
// patches that are not in the list of PSU and RU patches. Amazon RDS applies these
// patches after applying the PSU and RU patches. For more information, see
// Creating the CEV manifest (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest)
// in the Amazon RDS User Guide.
Manifest *string
// Reserved for future use.
SourceCustomDbEngineVersionIdentifier *string
// A list of tags. 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
// Reserved for future use.
UseAwsProvidedLatestImage *bool
noSmithyDocumentSerde
}
// This data type is used as a response element in the action
// DescribeDBEngineVersions .
type CreateCustomDBEngineVersionOutput struct {
// The creation time of the DB engine version.
CreateTime *time.Time
// JSON string that lists the installation files and parameters that RDS Custom
// uses to create a custom engine version (CEV). RDS Custom applies the patches in
// the order in which they're listed in the manifest. You can set the Oracle home,
// Oracle base, and UNIX/Linux user and group using the installation parameters.
// For more information, see JSON fields in the CEV manifest (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest.fields)
// in the Amazon RDS User Guide.
CustomDBEngineVersionManifest *string
// The description of the database engine.
DBEngineDescription *string
// A value that indicates the source media provider of the AMI based on the usage
// operation. Applicable for RDS Custom for SQL Server.
DBEngineMediaType *string
// The ARN of the custom engine version.
DBEngineVersionArn *string
// The description of the database engine version.
DBEngineVersionDescription *string
// The name of the DB parameter group family for the database engine.
DBParameterGroupFamily *string
// The name of the Amazon S3 bucket that contains your database installation files.
DatabaseInstallationFilesS3BucketName *string
// The Amazon S3 directory that contains the database installation files. If not
// specified, then no prefix is assumed.
DatabaseInstallationFilesS3Prefix *string
// The default character set for new instances of this engine version, if the
// CharacterSetName parameter of the CreateDBInstance API isn't specified.
DefaultCharacterSet *types.CharacterSet
// The name of the database engine.
Engine *string
// The version number of the database engine.
EngineVersion *string
// The types of logs that the database engine has available for export to
// CloudWatch Logs.
ExportableLogTypes []string
// The EC2 image
Image *types.CustomDBEngineVersionAMI
// The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter
// is required for RDS Custom, but optional for Amazon RDS.
KMSKeyId *string
// The major engine version of the CEV.
MajorEngineVersion *string
// The status of the DB engine version, either available or deprecated .
Status *string
// A list of the supported CA certificate identifiers. For more information, see
// Using SSL/TLS to encrypt a connection to a DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html)
// in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB
// cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html)
// in the Amazon Aurora User Guide.
SupportedCACertificateIdentifiers []string
// A list of the character sets supported by this engine for the CharacterSetName
// parameter of the CreateDBInstance operation.
SupportedCharacterSets []types.CharacterSet
// A list of the supported DB engine modes.
SupportedEngineModes []string
// A list of features supported by the DB engine. The supported features vary by
// DB engine and DB engine version. To determine the supported features for a
// specific DB engine and DB engine version using the CLI, use the following
// command: aws rds describe-db-engine-versions --engine --engine-version For
// example, to determine the supported features for RDS for PostgreSQL version 13.3
// using the CLI, use the following command: aws rds describe-db-engine-versions
// --engine postgres --engine-version 13.3 The supported features are listed under
// SupportedFeatureNames in the output.
SupportedFeatureNames []string
// A list of the character sets supported by the Oracle DB engine for the
// NcharCharacterSetName parameter of the CreateDBInstance operation.
SupportedNcharCharacterSets []types.CharacterSet
// A list of the time zones supported by this engine for the Timezone parameter of
// the CreateDBInstance action.
SupportedTimezones []types.Timezone
// Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
SupportsBabelfish *bool
// Indicates whether the engine version supports rotating the server certificate
// without rebooting the DB instance.
SupportsCertificateRotationWithoutRestart *bool
// Indicates whether you can use Aurora global databases with a specific DB engine
// version.
SupportsGlobalDatabases *bool
// Indicates whether the DB engine version supports Aurora zero-ETL integrations
// with Amazon Redshift.
SupportsIntegrations *bool
// Indicates whether the DB engine version supports forwarding write operations
// from reader DB instances to the writer DB instance in the DB cluster. By
// default, write operations aren't allowed on reader DB instances. Valid for:
// Aurora DB clusters only
SupportsLocalWriteForwarding *bool
// Indicates whether the engine version supports exporting the log types specified
// by ExportableLogTypes to CloudWatch Logs.
SupportsLogExportsToCloudwatchLogs *bool
// Indicates whether you can use Aurora parallel query with a specific DB engine
// version.
SupportsParallelQuery *bool
// Indicates whether the database engine version supports read replicas.
SupportsReadReplica *bool
// A list of tags. 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.
TagList []types.Tag
// A list of engine versions that this database engine version can be upgraded to.
ValidUpgradeTarget []types.UpgradeTarget
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateCustomDBEngineVersionMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsquery_serializeOpCreateCustomDBEngineVersion{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpCreateCustomDBEngineVersion{}, middleware.After)
if err != nil {
return err
}
if err = addlegacyEndpointContextSetter(stack, options); 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, 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 = addCreateCustomDBEngineVersionResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addOpCreateCustomDBEngineVersionValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateCustomDBEngineVersion(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.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 = addendpointDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opCreateCustomDBEngineVersion(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "rds",
OperationName: "CreateCustomDBEngineVersion",
}
}
type opCreateCustomDBEngineVersionResolveEndpointMiddleware struct {
EndpointResolver EndpointResolverV2
BuiltInResolver builtInParameterResolver
}
func (*opCreateCustomDBEngineVersionResolveEndpointMiddleware) ID() string {
return "ResolveEndpointV2"
}
func (m *opCreateCustomDBEngineVersionResolveEndpointMiddleware) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
out middleware.SerializeOutput, metadata middleware.Metadata, err error,
) {
if awsmiddleware.GetRequiresLegacyEndpoints(ctx) {
return next.HandleSerialize(ctx, in)
}
req, ok := in.Request.(*smithyhttp.Request)
if !ok {
return out, metadata, fmt.Errorf("unknown transport type %T", in.Request)
}
if m.EndpointResolver == nil {
return out, metadata, fmt.Errorf("expected endpoint resolver to not be nil")
}
params := EndpointParameters{}
m.BuiltInResolver.ResolveBuiltIns(¶ms)
var resolvedEndpoint smithyendpoints.Endpoint
resolvedEndpoint, err = m.EndpointResolver.ResolveEndpoint(ctx, params)
if err != nil {
return out, metadata, fmt.Errorf("failed to resolve service endpoint, %w", err)
}
req.URL = &resolvedEndpoint.URI
for k := range resolvedEndpoint.Headers {
req.Header.Set(
k,
resolvedEndpoint.Headers.Get(k),
)
}
authSchemes, err := internalauth.GetAuthenticationSchemes(&resolvedEndpoint.Properties)
if err != nil {
var nfe *internalauth.NoAuthenticationSchemesFoundError
if errors.As(err, &nfe) {
// if no auth scheme is found, default to sigv4
signingName := "rds"
signingRegion := m.BuiltInResolver.(*builtInResolver).Region
ctx = awsmiddleware.SetSigningName(ctx, signingName)
ctx = awsmiddleware.SetSigningRegion(ctx, signingRegion)
}
var ue *internalauth.UnSupportedAuthenticationSchemeSpecifiedError
if errors.As(err, &ue) {
return out, metadata, fmt.Errorf(
"This operation requests signer version(s) %v but the client only supports %v",
ue.UnsupportedSchemes,
internalauth.SupportedSchemes,
)
}
}
for _, authScheme := range authSchemes {
switch authScheme.(type) {
case *internalauth.AuthenticationSchemeV4:
v4Scheme, _ := authScheme.(*internalauth.AuthenticationSchemeV4)
var signingName, signingRegion string
if v4Scheme.SigningName == nil {
signingName = "rds"
} else {
signingName = *v4Scheme.SigningName
}
if v4Scheme.SigningRegion == nil {
signingRegion = m.BuiltInResolver.(*builtInResolver).Region
} else {
signingRegion = *v4Scheme.SigningRegion
}
if v4Scheme.DisableDoubleEncoding != nil {
// The signer sets an equivalent value at client initialization time.
// Setting this context value will cause the signer to extract it
// and override the value set at client initialization time.
ctx = internalauth.SetDisableDoubleEncoding(ctx, *v4Scheme.DisableDoubleEncoding)
}
ctx = awsmiddleware.SetSigningName(ctx, signingName)
ctx = awsmiddleware.SetSigningRegion(ctx, signingRegion)
break
case *internalauth.AuthenticationSchemeV4A:
v4aScheme, _ := authScheme.(*internalauth.AuthenticationSchemeV4A)
if v4aScheme.SigningName == nil {
v4aScheme.SigningName = aws.String("rds")
}
if v4aScheme.DisableDoubleEncoding != nil {
// The signer sets an equivalent value at client initialization time.
// Setting this context value will cause the signer to extract it
// and override the value set at client initialization time.
ctx = internalauth.SetDisableDoubleEncoding(ctx, *v4aScheme.DisableDoubleEncoding)
}
ctx = awsmiddleware.SetSigningName(ctx, *v4aScheme.SigningName)
ctx = awsmiddleware.SetSigningRegion(ctx, v4aScheme.SigningRegionSet[0])
break
case *internalauth.AuthenticationSchemeNone:
break
}
}
return next.HandleSerialize(ctx, in)
}
func addCreateCustomDBEngineVersionResolveEndpointMiddleware(stack *middleware.Stack, options Options) error {
return stack.Serialize.Insert(&opCreateCustomDBEngineVersionResolveEndpointMiddleware{
EndpointResolver: options.EndpointResolverV2,
BuiltInResolver: &builtInResolver{
Region: options.Region,
UseDualStack: options.EndpointOptions.UseDualStackEndpoint,
UseFIPS: options.EndpointOptions.UseFIPSEndpoint,
Endpoint: options.BaseEndpoint,
},
}, "ResolveEndpoint", middleware.After)
}