File: api_op_CreateRelationalDatabase.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.17.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 384,244 kB
  • sloc: java: 13,538; makefile: 400; sh: 137
file content (285 lines) | stat: -rw-r--r-- 10,417 bytes parent folder | download
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
// Code generated by smithy-go-codegen DO NOT EDIT.

package lightsail

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/lightsail/types"
	"github.com/aws/smithy-go/middleware"
	smithyhttp "github.com/aws/smithy-go/transport/http"
)

// Creates a new database in Amazon Lightsail. The create relational database
// operation supports tag-based access control via request tags. For more
// information, see the Amazon Lightsail Developer Guide
// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
func (c *Client) CreateRelationalDatabase(ctx context.Context, params *CreateRelationalDatabaseInput, optFns ...func(*Options)) (*CreateRelationalDatabaseOutput, error) {
	if params == nil {
		params = &CreateRelationalDatabaseInput{}
	}

	result, metadata, err := c.invokeOperation(ctx, "CreateRelationalDatabase", params, optFns, c.addOperationCreateRelationalDatabaseMiddlewares)
	if err != nil {
		return nil, err
	}

	out := result.(*CreateRelationalDatabaseOutput)
	out.ResultMetadata = metadata
	return out, nil
}

type CreateRelationalDatabaseInput struct {

	// The meaning of this parameter differs according to the database engine you use.
	// MySQL The name of the database to create when the Lightsail database resource is
	// created. If this parameter isn't specified, no database is created in the
	// database resource. Constraints:
	//
	// * Must contain 1 to 64 letters or numbers.
	//
	// *
	// Must begin with a letter. Subsequent characters can be letters, underscores, or
	// digits (0- 9).
	//
	// * Can't be a word reserved by the specified database engine. For
	// more information about reserved words in MySQL, see the Keywords and Reserved
	// Words articles for MySQL 5.6
	// (https://dev.mysql.com/doc/refman/5.6/en/keywords.html), MySQL 5.7
	// (https://dev.mysql.com/doc/refman/5.7/en/keywords.html), and MySQL 8.0
	// (https://dev.mysql.com/doc/refman/8.0/en/keywords.html).
	//
	// PostgreSQL The name of
	// the database to create when the Lightsail database resource is created. If this
	// parameter isn't specified, a database named postgres is created in the database
	// resource. Constraints:
	//
	// * Must contain 1 to 63 letters or numbers.
	//
	// * Must begin
	// with a letter. Subsequent characters can be letters, underscores, or digits (0-
	// 9).
	//
	// * Can't be a word reserved by the specified database engine. For more
	// information about reserved words in PostgreSQL, see the SQL Key Words articles
	// for PostgreSQL 9.6
	// (https://www.postgresql.org/docs/9.6/sql-keywords-appendix.html), PostgreSQL 10
	// (https://www.postgresql.org/docs/10/sql-keywords-appendix.html), PostgreSQL 11
	// (https://www.postgresql.org/docs/11/sql-keywords-appendix.html), and PostgreSQL
	// 12 (https://www.postgresql.org/docs/12/sql-keywords-appendix.html).
	//
	// This member is required.
	MasterDatabaseName *string

	// The name for the master user. MySQL Constraints:
	//
	// * Required for MySQL.
	//
	// * Must
	// be 1 to 16 letters or numbers. Can contain underscores.
	//
	// * First character must
	// be a letter.
	//
	// * Can't be a reserved word for the chosen database engine. For
	// more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and
	// Reserved Words articles for MySQL 5.6
	// (https://dev.mysql.com/doc/refman/5.6/en/keywords.html), MySQL 5.7
	// (https://dev.mysql.com/doc/refman/5.7/en/keywords.html), or MySQL 8.0
	// (https://dev.mysql.com/doc/refman/8.0/en/keywords.html).
	//
	// PostgreSQL
	// Constraints:
	//
	// * Required for PostgreSQL.
	//
	// * Must be 1 to 63 letters or numbers.
	// Can contain underscores.
	//
	// * First character must be a letter.
	//
	// * Can't be a
	// reserved word for the chosen database engine. For more information about
	// reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles
	// for PostgreSQL 9.6
	// (https://www.postgresql.org/docs/9.6/sql-keywords-appendix.html), PostgreSQL 10
	// (https://www.postgresql.org/docs/10/sql-keywords-appendix.html), PostgreSQL 11
	// (https://www.postgresql.org/docs/11/sql-keywords-appendix.html), and PostgreSQL
	// 12 (https://www.postgresql.org/docs/12/sql-keywords-appendix.html).
	//
	// This member is required.
	MasterUsername *string

	// The blueprint ID for your new database. A blueprint describes the major engine
	// version of a database. You can get a list of database blueprints IDs by using
	// the get relational database blueprints operation.
	//
	// This member is required.
	RelationalDatabaseBlueprintId *string

	// The bundle ID for your new database. A bundle describes the performance
	// specifications for your database. You can get a list of database bundle IDs by
	// using the get relational database bundles operation.
	//
	// This member is required.
	RelationalDatabaseBundleId *string

	// The name to use for your new Lightsail database resource. Constraints:
	//
	// * Must
	// contain from 2 to 255 alphanumeric characters, or hyphens.
	//
	// * The first and last
	// character must be a letter or number.
	//
	// This member is required.
	RelationalDatabaseName *string

	// The Availability Zone in which to create your new database. Use the us-east-2a
	// case-sensitive format. You can get a list of Availability Zones by using the get
	// regions operation. Be sure to add the include relational database Availability
	// Zones parameter to your request.
	AvailabilityZone *string

	// The password for the master user. The password can include any printable ASCII
	// character except "/", """, or "@". It cannot contain spaces. 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 new
	// database if automated backups are enabled. The default is a 30-minute window
	// selected at random from an 8-hour block of time for each AWS Region. For more
	// information about the preferred backup window time blocks for each region, see
	// the Working With Backups
	// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow)
	// guide in the Amazon Relational Database Service (Amazon RDS) documentation.
	// 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 new
	// database. 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.
	// 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 new 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

	// The tag keys and optional values to add to the resource during create. Use the
	// TagResource action to tag a resource after it's created.
	Tags []types.Tag

	noSmithyDocumentSerde
}

type CreateRelationalDatabaseOutput 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) addOperationCreateRelationalDatabaseMiddlewares(stack *middleware.Stack, options Options) (err error) {
	err = stack.Serialize.Add(&awsAwsjson11_serializeOpCreateRelationalDatabase{}, middleware.After)
	if err != nil {
		return err
	}
	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpCreateRelationalDatabase{}, 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 = addOpCreateRelationalDatabaseValidationMiddleware(stack); err != nil {
		return err
	}
	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateRelationalDatabase(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_opCreateRelationalDatabase(region string) *awsmiddleware.RegisterServiceMetadata {
	return &awsmiddleware.RegisterServiceMetadata{
		Region:        region,
		ServiceID:     ServiceID,
		SigningName:   "lightsail",
		OperationName: "CreateRelationalDatabase",
	}
}