cdk-rds-sql 0.0.6 → 0.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.gitattributes +0 -1
- package/.jsii +3 -3
- package/.projenrc.ts +1 -0
- package/README.md +6 -0
- package/lib/database.js +1 -1
- package/lib/provider.js +1 -1
- package/lib/role.js +1 -1
- package/lib/schema.js +1 -1
- package/lib/sql.js +1 -1
- package/package.json +1 -3
- package/API.md +0 -1406
package/API.md
DELETED
|
@@ -1,1406 +0,0 @@
|
|
|
1
|
-
# API Reference <a name="API Reference" id="api-reference"></a>
|
|
2
|
-
|
|
3
|
-
## Constructs <a name="Constructs" id="Constructs"></a>
|
|
4
|
-
|
|
5
|
-
### Database <a name="Database" id="cdk-rds-sql.Database"></a>
|
|
6
|
-
|
|
7
|
-
#### Initializers <a name="Initializers" id="cdk-rds-sql.Database.Initializer"></a>
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
import { Database } from 'cdk-rds-sql'
|
|
11
|
-
|
|
12
|
-
new Database(scope: Construct, id: string, props: DatabaseProps)
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
| **Name** | **Type** | **Description** |
|
|
16
|
-
| --- | --- | --- |
|
|
17
|
-
| <code><a href="#cdk-rds-sql.Database.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
|
|
18
|
-
| <code><a href="#cdk-rds-sql.Database.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
|
|
19
|
-
| <code><a href="#cdk-rds-sql.Database.Initializer.parameter.props">props</a></code> | <code><a href="#cdk-rds-sql.DatabaseProps">DatabaseProps</a></code> | *No description.* |
|
|
20
|
-
|
|
21
|
-
---
|
|
22
|
-
|
|
23
|
-
##### `scope`<sup>Required</sup> <a name="scope" id="cdk-rds-sql.Database.Initializer.parameter.scope"></a>
|
|
24
|
-
|
|
25
|
-
- *Type:* constructs.Construct
|
|
26
|
-
|
|
27
|
-
---
|
|
28
|
-
|
|
29
|
-
##### `id`<sup>Required</sup> <a name="id" id="cdk-rds-sql.Database.Initializer.parameter.id"></a>
|
|
30
|
-
|
|
31
|
-
- *Type:* string
|
|
32
|
-
|
|
33
|
-
---
|
|
34
|
-
|
|
35
|
-
##### `props`<sup>Required</sup> <a name="props" id="cdk-rds-sql.Database.Initializer.parameter.props"></a>
|
|
36
|
-
|
|
37
|
-
- *Type:* <a href="#cdk-rds-sql.DatabaseProps">DatabaseProps</a>
|
|
38
|
-
|
|
39
|
-
---
|
|
40
|
-
|
|
41
|
-
#### Methods <a name="Methods" id="Methods"></a>
|
|
42
|
-
|
|
43
|
-
| **Name** | **Description** |
|
|
44
|
-
| --- | --- |
|
|
45
|
-
| <code><a href="#cdk-rds-sql.Database.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
46
|
-
| <code><a href="#cdk-rds-sql.Database.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
|
|
47
|
-
| <code><a href="#cdk-rds-sql.Database.getAtt">getAtt</a></code> | Returns the value of an attribute of the custom resource of an arbitrary type. |
|
|
48
|
-
| <code><a href="#cdk-rds-sql.Database.getAttString">getAttString</a></code> | Returns the value of an attribute of the custom resource of type string. |
|
|
49
|
-
|
|
50
|
-
---
|
|
51
|
-
|
|
52
|
-
##### `toString` <a name="toString" id="cdk-rds-sql.Database.toString"></a>
|
|
53
|
-
|
|
54
|
-
```typescript
|
|
55
|
-
public toString(): string
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
Returns a string representation of this construct.
|
|
59
|
-
|
|
60
|
-
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="cdk-rds-sql.Database.applyRemovalPolicy"></a>
|
|
61
|
-
|
|
62
|
-
```typescript
|
|
63
|
-
public applyRemovalPolicy(policy: RemovalPolicy): void
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
Apply the given removal policy to this resource.
|
|
67
|
-
|
|
68
|
-
The Removal Policy controls what happens to this resource when it stops
|
|
69
|
-
being managed by CloudFormation, either because you've removed it from the
|
|
70
|
-
CDK application or because you've made a change that requires the resource
|
|
71
|
-
to be replaced.
|
|
72
|
-
|
|
73
|
-
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
|
|
74
|
-
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
|
|
75
|
-
|
|
76
|
-
###### `policy`<sup>Required</sup> <a name="policy" id="cdk-rds-sql.Database.applyRemovalPolicy.parameter.policy"></a>
|
|
77
|
-
|
|
78
|
-
- *Type:* aws-cdk-lib.RemovalPolicy
|
|
79
|
-
|
|
80
|
-
---
|
|
81
|
-
|
|
82
|
-
##### `getAtt` <a name="getAtt" id="cdk-rds-sql.Database.getAtt"></a>
|
|
83
|
-
|
|
84
|
-
```typescript
|
|
85
|
-
public getAtt(attributeName: string): Reference
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
Returns the value of an attribute of the custom resource of an arbitrary type.
|
|
89
|
-
|
|
90
|
-
Attributes are returned from the custom resource provider through the
|
|
91
|
-
`Data` map where the key is the attribute name.
|
|
92
|
-
|
|
93
|
-
###### `attributeName`<sup>Required</sup> <a name="attributeName" id="cdk-rds-sql.Database.getAtt.parameter.attributeName"></a>
|
|
94
|
-
|
|
95
|
-
- *Type:* string
|
|
96
|
-
|
|
97
|
-
the name of the attribute.
|
|
98
|
-
|
|
99
|
-
---
|
|
100
|
-
|
|
101
|
-
##### `getAttString` <a name="getAttString" id="cdk-rds-sql.Database.getAttString"></a>
|
|
102
|
-
|
|
103
|
-
```typescript
|
|
104
|
-
public getAttString(attributeName: string): string
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
Returns the value of an attribute of the custom resource of type string.
|
|
108
|
-
|
|
109
|
-
Attributes are returned from the custom resource provider through the
|
|
110
|
-
`Data` map where the key is the attribute name.
|
|
111
|
-
|
|
112
|
-
###### `attributeName`<sup>Required</sup> <a name="attributeName" id="cdk-rds-sql.Database.getAttString.parameter.attributeName"></a>
|
|
113
|
-
|
|
114
|
-
- *Type:* string
|
|
115
|
-
|
|
116
|
-
the name of the attribute.
|
|
117
|
-
|
|
118
|
-
---
|
|
119
|
-
|
|
120
|
-
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
121
|
-
|
|
122
|
-
| **Name** | **Description** |
|
|
123
|
-
| --- | --- |
|
|
124
|
-
| <code><a href="#cdk-rds-sql.Database.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
125
|
-
| <code><a href="#cdk-rds-sql.Database.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
|
|
126
|
-
| <code><a href="#cdk-rds-sql.Database.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
|
|
127
|
-
|
|
128
|
-
---
|
|
129
|
-
|
|
130
|
-
##### `isConstruct` <a name="isConstruct" id="cdk-rds-sql.Database.isConstruct"></a>
|
|
131
|
-
|
|
132
|
-
```typescript
|
|
133
|
-
import { Database } from 'cdk-rds-sql'
|
|
134
|
-
|
|
135
|
-
Database.isConstruct(x: any)
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
Checks if `x` is a construct.
|
|
139
|
-
|
|
140
|
-
Use this method instead of `instanceof` to properly detect `Construct`
|
|
141
|
-
instances, even when the construct library is symlinked.
|
|
142
|
-
|
|
143
|
-
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
144
|
-
disk are seen as independent, completely different libraries. As a
|
|
145
|
-
consequence, the class `Construct` in each copy of the `constructs` library
|
|
146
|
-
is seen as a different class, and an instance of one class will not test as
|
|
147
|
-
`instanceof` the other class. `npm install` will not create installations
|
|
148
|
-
like this, but users may manually symlink construct libraries together or
|
|
149
|
-
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
150
|
-
library can be accidentally installed, and `instanceof` will behave
|
|
151
|
-
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
152
|
-
this type-testing method instead.
|
|
153
|
-
|
|
154
|
-
###### `x`<sup>Required</sup> <a name="x" id="cdk-rds-sql.Database.isConstruct.parameter.x"></a>
|
|
155
|
-
|
|
156
|
-
- *Type:* any
|
|
157
|
-
|
|
158
|
-
Any object.
|
|
159
|
-
|
|
160
|
-
---
|
|
161
|
-
|
|
162
|
-
##### `isOwnedResource` <a name="isOwnedResource" id="cdk-rds-sql.Database.isOwnedResource"></a>
|
|
163
|
-
|
|
164
|
-
```typescript
|
|
165
|
-
import { Database } from 'cdk-rds-sql'
|
|
166
|
-
|
|
167
|
-
Database.isOwnedResource(construct: IConstruct)
|
|
168
|
-
```
|
|
169
|
-
|
|
170
|
-
Returns true if the construct was created by CDK, and false otherwise.
|
|
171
|
-
|
|
172
|
-
###### `construct`<sup>Required</sup> <a name="construct" id="cdk-rds-sql.Database.isOwnedResource.parameter.construct"></a>
|
|
173
|
-
|
|
174
|
-
- *Type:* constructs.IConstruct
|
|
175
|
-
|
|
176
|
-
---
|
|
177
|
-
|
|
178
|
-
##### `isResource` <a name="isResource" id="cdk-rds-sql.Database.isResource"></a>
|
|
179
|
-
|
|
180
|
-
```typescript
|
|
181
|
-
import { Database } from 'cdk-rds-sql'
|
|
182
|
-
|
|
183
|
-
Database.isResource(construct: IConstruct)
|
|
184
|
-
```
|
|
185
|
-
|
|
186
|
-
Check whether the given construct is a Resource.
|
|
187
|
-
|
|
188
|
-
###### `construct`<sup>Required</sup> <a name="construct" id="cdk-rds-sql.Database.isResource.parameter.construct"></a>
|
|
189
|
-
|
|
190
|
-
- *Type:* constructs.IConstruct
|
|
191
|
-
|
|
192
|
-
---
|
|
193
|
-
|
|
194
|
-
#### Properties <a name="Properties" id="Properties"></a>
|
|
195
|
-
|
|
196
|
-
| **Name** | **Type** | **Description** |
|
|
197
|
-
| --- | --- | --- |
|
|
198
|
-
| <code><a href="#cdk-rds-sql.Database.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
199
|
-
| <code><a href="#cdk-rds-sql.Database.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
|
|
200
|
-
| <code><a href="#cdk-rds-sql.Database.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
|
|
201
|
-
| <code><a href="#cdk-rds-sql.Database.property.ref">ref</a></code> | <code>string</code> | The physical name of this custom resource. |
|
|
202
|
-
| <code><a href="#cdk-rds-sql.Database.property.databaseName">databaseName</a></code> | <code>string</code> | *No description.* |
|
|
203
|
-
|
|
204
|
-
---
|
|
205
|
-
|
|
206
|
-
##### `node`<sup>Required</sup> <a name="node" id="cdk-rds-sql.Database.property.node"></a>
|
|
207
|
-
|
|
208
|
-
```typescript
|
|
209
|
-
public readonly node: Node;
|
|
210
|
-
```
|
|
211
|
-
|
|
212
|
-
- *Type:* constructs.Node
|
|
213
|
-
|
|
214
|
-
The tree node.
|
|
215
|
-
|
|
216
|
-
---
|
|
217
|
-
|
|
218
|
-
##### `env`<sup>Required</sup> <a name="env" id="cdk-rds-sql.Database.property.env"></a>
|
|
219
|
-
|
|
220
|
-
```typescript
|
|
221
|
-
public readonly env: ResourceEnvironment;
|
|
222
|
-
```
|
|
223
|
-
|
|
224
|
-
- *Type:* aws-cdk-lib.ResourceEnvironment
|
|
225
|
-
|
|
226
|
-
The environment this resource belongs to.
|
|
227
|
-
|
|
228
|
-
For resources that are created and managed by the CDK
|
|
229
|
-
(generally, those created by creating new class instances like Role, Bucket, etc.),
|
|
230
|
-
this is always the same as the environment of the stack they belong to;
|
|
231
|
-
however, for imported resources
|
|
232
|
-
(those obtained from static methods like fromRoleArn, fromBucketName, etc.),
|
|
233
|
-
that might be different than the stack they were imported into.
|
|
234
|
-
|
|
235
|
-
---
|
|
236
|
-
|
|
237
|
-
##### `stack`<sup>Required</sup> <a name="stack" id="cdk-rds-sql.Database.property.stack"></a>
|
|
238
|
-
|
|
239
|
-
```typescript
|
|
240
|
-
public readonly stack: Stack;
|
|
241
|
-
```
|
|
242
|
-
|
|
243
|
-
- *Type:* aws-cdk-lib.Stack
|
|
244
|
-
|
|
245
|
-
The stack in which this resource is defined.
|
|
246
|
-
|
|
247
|
-
---
|
|
248
|
-
|
|
249
|
-
##### `ref`<sup>Required</sup> <a name="ref" id="cdk-rds-sql.Database.property.ref"></a>
|
|
250
|
-
|
|
251
|
-
```typescript
|
|
252
|
-
public readonly ref: string;
|
|
253
|
-
```
|
|
254
|
-
|
|
255
|
-
- *Type:* string
|
|
256
|
-
|
|
257
|
-
The physical name of this custom resource.
|
|
258
|
-
|
|
259
|
-
---
|
|
260
|
-
|
|
261
|
-
##### `databaseName`<sup>Required</sup> <a name="databaseName" id="cdk-rds-sql.Database.property.databaseName"></a>
|
|
262
|
-
|
|
263
|
-
```typescript
|
|
264
|
-
public readonly databaseName: string;
|
|
265
|
-
```
|
|
266
|
-
|
|
267
|
-
- *Type:* string
|
|
268
|
-
|
|
269
|
-
---
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
### Provider <a name="Provider" id="cdk-rds-sql.Provider"></a>
|
|
273
|
-
|
|
274
|
-
#### Initializers <a name="Initializers" id="cdk-rds-sql.Provider.Initializer"></a>
|
|
275
|
-
|
|
276
|
-
```typescript
|
|
277
|
-
import { Provider } from 'cdk-rds-sql'
|
|
278
|
-
|
|
279
|
-
new Provider(scope: Construct, id: string, props: RdsSqlProps)
|
|
280
|
-
```
|
|
281
|
-
|
|
282
|
-
| **Name** | **Type** | **Description** |
|
|
283
|
-
| --- | --- | --- |
|
|
284
|
-
| <code><a href="#cdk-rds-sql.Provider.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
|
|
285
|
-
| <code><a href="#cdk-rds-sql.Provider.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
|
|
286
|
-
| <code><a href="#cdk-rds-sql.Provider.Initializer.parameter.props">props</a></code> | <code><a href="#cdk-rds-sql.RdsSqlProps">RdsSqlProps</a></code> | *No description.* |
|
|
287
|
-
|
|
288
|
-
---
|
|
289
|
-
|
|
290
|
-
##### `scope`<sup>Required</sup> <a name="scope" id="cdk-rds-sql.Provider.Initializer.parameter.scope"></a>
|
|
291
|
-
|
|
292
|
-
- *Type:* constructs.Construct
|
|
293
|
-
|
|
294
|
-
---
|
|
295
|
-
|
|
296
|
-
##### `id`<sup>Required</sup> <a name="id" id="cdk-rds-sql.Provider.Initializer.parameter.id"></a>
|
|
297
|
-
|
|
298
|
-
- *Type:* string
|
|
299
|
-
|
|
300
|
-
---
|
|
301
|
-
|
|
302
|
-
##### `props`<sup>Required</sup> <a name="props" id="cdk-rds-sql.Provider.Initializer.parameter.props"></a>
|
|
303
|
-
|
|
304
|
-
- *Type:* <a href="#cdk-rds-sql.RdsSqlProps">RdsSqlProps</a>
|
|
305
|
-
|
|
306
|
-
---
|
|
307
|
-
|
|
308
|
-
#### Methods <a name="Methods" id="Methods"></a>
|
|
309
|
-
|
|
310
|
-
| **Name** | **Description** |
|
|
311
|
-
| --- | --- |
|
|
312
|
-
| <code><a href="#cdk-rds-sql.Provider.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
313
|
-
|
|
314
|
-
---
|
|
315
|
-
|
|
316
|
-
##### `toString` <a name="toString" id="cdk-rds-sql.Provider.toString"></a>
|
|
317
|
-
|
|
318
|
-
```typescript
|
|
319
|
-
public toString(): string
|
|
320
|
-
```
|
|
321
|
-
|
|
322
|
-
Returns a string representation of this construct.
|
|
323
|
-
|
|
324
|
-
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
325
|
-
|
|
326
|
-
| **Name** | **Description** |
|
|
327
|
-
| --- | --- |
|
|
328
|
-
| <code><a href="#cdk-rds-sql.Provider.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
329
|
-
|
|
330
|
-
---
|
|
331
|
-
|
|
332
|
-
##### `isConstruct` <a name="isConstruct" id="cdk-rds-sql.Provider.isConstruct"></a>
|
|
333
|
-
|
|
334
|
-
```typescript
|
|
335
|
-
import { Provider } from 'cdk-rds-sql'
|
|
336
|
-
|
|
337
|
-
Provider.isConstruct(x: any)
|
|
338
|
-
```
|
|
339
|
-
|
|
340
|
-
Checks if `x` is a construct.
|
|
341
|
-
|
|
342
|
-
Use this method instead of `instanceof` to properly detect `Construct`
|
|
343
|
-
instances, even when the construct library is symlinked.
|
|
344
|
-
|
|
345
|
-
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
346
|
-
disk are seen as independent, completely different libraries. As a
|
|
347
|
-
consequence, the class `Construct` in each copy of the `constructs` library
|
|
348
|
-
is seen as a different class, and an instance of one class will not test as
|
|
349
|
-
`instanceof` the other class. `npm install` will not create installations
|
|
350
|
-
like this, but users may manually symlink construct libraries together or
|
|
351
|
-
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
352
|
-
library can be accidentally installed, and `instanceof` will behave
|
|
353
|
-
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
354
|
-
this type-testing method instead.
|
|
355
|
-
|
|
356
|
-
###### `x`<sup>Required</sup> <a name="x" id="cdk-rds-sql.Provider.isConstruct.parameter.x"></a>
|
|
357
|
-
|
|
358
|
-
- *Type:* any
|
|
359
|
-
|
|
360
|
-
Any object.
|
|
361
|
-
|
|
362
|
-
---
|
|
363
|
-
|
|
364
|
-
#### Properties <a name="Properties" id="Properties"></a>
|
|
365
|
-
|
|
366
|
-
| **Name** | **Type** | **Description** |
|
|
367
|
-
| --- | --- | --- |
|
|
368
|
-
| <code><a href="#cdk-rds-sql.Provider.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
369
|
-
| <code><a href="#cdk-rds-sql.Provider.property.handler">handler</a></code> | <code>aws-cdk-lib.aws_lambda.IFunction</code> | *No description.* |
|
|
370
|
-
| <code><a href="#cdk-rds-sql.Provider.property.secret">secret</a></code> | <code>aws-cdk-lib.aws_secretsmanager.ISecret</code> | *No description.* |
|
|
371
|
-
| <code><a href="#cdk-rds-sql.Provider.property.serviceToken">serviceToken</a></code> | <code>string</code> | *No description.* |
|
|
372
|
-
|
|
373
|
-
---
|
|
374
|
-
|
|
375
|
-
##### `node`<sup>Required</sup> <a name="node" id="cdk-rds-sql.Provider.property.node"></a>
|
|
376
|
-
|
|
377
|
-
```typescript
|
|
378
|
-
public readonly node: Node;
|
|
379
|
-
```
|
|
380
|
-
|
|
381
|
-
- *Type:* constructs.Node
|
|
382
|
-
|
|
383
|
-
The tree node.
|
|
384
|
-
|
|
385
|
-
---
|
|
386
|
-
|
|
387
|
-
##### `handler`<sup>Required</sup> <a name="handler" id="cdk-rds-sql.Provider.property.handler"></a>
|
|
388
|
-
|
|
389
|
-
```typescript
|
|
390
|
-
public readonly handler: IFunction;
|
|
391
|
-
```
|
|
392
|
-
|
|
393
|
-
- *Type:* aws-cdk-lib.aws_lambda.IFunction
|
|
394
|
-
|
|
395
|
-
---
|
|
396
|
-
|
|
397
|
-
##### `secret`<sup>Required</sup> <a name="secret" id="cdk-rds-sql.Provider.property.secret"></a>
|
|
398
|
-
|
|
399
|
-
```typescript
|
|
400
|
-
public readonly secret: ISecret;
|
|
401
|
-
```
|
|
402
|
-
|
|
403
|
-
- *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
|
|
404
|
-
|
|
405
|
-
---
|
|
406
|
-
|
|
407
|
-
##### `serviceToken`<sup>Required</sup> <a name="serviceToken" id="cdk-rds-sql.Provider.property.serviceToken"></a>
|
|
408
|
-
|
|
409
|
-
```typescript
|
|
410
|
-
public readonly serviceToken: string;
|
|
411
|
-
```
|
|
412
|
-
|
|
413
|
-
- *Type:* string
|
|
414
|
-
|
|
415
|
-
---
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
### Role <a name="Role" id="cdk-rds-sql.Role"></a>
|
|
419
|
-
|
|
420
|
-
#### Initializers <a name="Initializers" id="cdk-rds-sql.Role.Initializer"></a>
|
|
421
|
-
|
|
422
|
-
```typescript
|
|
423
|
-
import { Role } from 'cdk-rds-sql'
|
|
424
|
-
|
|
425
|
-
new Role(scope: Construct, id: string, props: RoleProps)
|
|
426
|
-
```
|
|
427
|
-
|
|
428
|
-
| **Name** | **Type** | **Description** |
|
|
429
|
-
| --- | --- | --- |
|
|
430
|
-
| <code><a href="#cdk-rds-sql.Role.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
|
|
431
|
-
| <code><a href="#cdk-rds-sql.Role.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
|
|
432
|
-
| <code><a href="#cdk-rds-sql.Role.Initializer.parameter.props">props</a></code> | <code><a href="#cdk-rds-sql.RoleProps">RoleProps</a></code> | *No description.* |
|
|
433
|
-
|
|
434
|
-
---
|
|
435
|
-
|
|
436
|
-
##### `scope`<sup>Required</sup> <a name="scope" id="cdk-rds-sql.Role.Initializer.parameter.scope"></a>
|
|
437
|
-
|
|
438
|
-
- *Type:* constructs.Construct
|
|
439
|
-
|
|
440
|
-
---
|
|
441
|
-
|
|
442
|
-
##### `id`<sup>Required</sup> <a name="id" id="cdk-rds-sql.Role.Initializer.parameter.id"></a>
|
|
443
|
-
|
|
444
|
-
- *Type:* string
|
|
445
|
-
|
|
446
|
-
---
|
|
447
|
-
|
|
448
|
-
##### `props`<sup>Required</sup> <a name="props" id="cdk-rds-sql.Role.Initializer.parameter.props"></a>
|
|
449
|
-
|
|
450
|
-
- *Type:* <a href="#cdk-rds-sql.RoleProps">RoleProps</a>
|
|
451
|
-
|
|
452
|
-
---
|
|
453
|
-
|
|
454
|
-
#### Methods <a name="Methods" id="Methods"></a>
|
|
455
|
-
|
|
456
|
-
| **Name** | **Description** |
|
|
457
|
-
| --- | --- |
|
|
458
|
-
| <code><a href="#cdk-rds-sql.Role.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
459
|
-
|
|
460
|
-
---
|
|
461
|
-
|
|
462
|
-
##### `toString` <a name="toString" id="cdk-rds-sql.Role.toString"></a>
|
|
463
|
-
|
|
464
|
-
```typescript
|
|
465
|
-
public toString(): string
|
|
466
|
-
```
|
|
467
|
-
|
|
468
|
-
Returns a string representation of this construct.
|
|
469
|
-
|
|
470
|
-
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
471
|
-
|
|
472
|
-
| **Name** | **Description** |
|
|
473
|
-
| --- | --- |
|
|
474
|
-
| <code><a href="#cdk-rds-sql.Role.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
475
|
-
|
|
476
|
-
---
|
|
477
|
-
|
|
478
|
-
##### `isConstruct` <a name="isConstruct" id="cdk-rds-sql.Role.isConstruct"></a>
|
|
479
|
-
|
|
480
|
-
```typescript
|
|
481
|
-
import { Role } from 'cdk-rds-sql'
|
|
482
|
-
|
|
483
|
-
Role.isConstruct(x: any)
|
|
484
|
-
```
|
|
485
|
-
|
|
486
|
-
Checks if `x` is a construct.
|
|
487
|
-
|
|
488
|
-
Use this method instead of `instanceof` to properly detect `Construct`
|
|
489
|
-
instances, even when the construct library is symlinked.
|
|
490
|
-
|
|
491
|
-
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
492
|
-
disk are seen as independent, completely different libraries. As a
|
|
493
|
-
consequence, the class `Construct` in each copy of the `constructs` library
|
|
494
|
-
is seen as a different class, and an instance of one class will not test as
|
|
495
|
-
`instanceof` the other class. `npm install` will not create installations
|
|
496
|
-
like this, but users may manually symlink construct libraries together or
|
|
497
|
-
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
498
|
-
library can be accidentally installed, and `instanceof` will behave
|
|
499
|
-
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
500
|
-
this type-testing method instead.
|
|
501
|
-
|
|
502
|
-
###### `x`<sup>Required</sup> <a name="x" id="cdk-rds-sql.Role.isConstruct.parameter.x"></a>
|
|
503
|
-
|
|
504
|
-
- *Type:* any
|
|
505
|
-
|
|
506
|
-
Any object.
|
|
507
|
-
|
|
508
|
-
---
|
|
509
|
-
|
|
510
|
-
#### Properties <a name="Properties" id="Properties"></a>
|
|
511
|
-
|
|
512
|
-
| **Name** | **Type** | **Description** |
|
|
513
|
-
| --- | --- | --- |
|
|
514
|
-
| <code><a href="#cdk-rds-sql.Role.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
515
|
-
| <code><a href="#cdk-rds-sql.Role.property.roleName">roleName</a></code> | <code>string</code> | *No description.* |
|
|
516
|
-
|
|
517
|
-
---
|
|
518
|
-
|
|
519
|
-
##### `node`<sup>Required</sup> <a name="node" id="cdk-rds-sql.Role.property.node"></a>
|
|
520
|
-
|
|
521
|
-
```typescript
|
|
522
|
-
public readonly node: Node;
|
|
523
|
-
```
|
|
524
|
-
|
|
525
|
-
- *Type:* constructs.Node
|
|
526
|
-
|
|
527
|
-
The tree node.
|
|
528
|
-
|
|
529
|
-
---
|
|
530
|
-
|
|
531
|
-
##### `roleName`<sup>Required</sup> <a name="roleName" id="cdk-rds-sql.Role.property.roleName"></a>
|
|
532
|
-
|
|
533
|
-
```typescript
|
|
534
|
-
public readonly roleName: string;
|
|
535
|
-
```
|
|
536
|
-
|
|
537
|
-
- *Type:* string
|
|
538
|
-
|
|
539
|
-
---
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
### Schema <a name="Schema" id="cdk-rds-sql.Schema"></a>
|
|
543
|
-
|
|
544
|
-
#### Initializers <a name="Initializers" id="cdk-rds-sql.Schema.Initializer"></a>
|
|
545
|
-
|
|
546
|
-
```typescript
|
|
547
|
-
import { Schema } from 'cdk-rds-sql'
|
|
548
|
-
|
|
549
|
-
new Schema(scope: Construct, id: string, props: SchemaProps)
|
|
550
|
-
```
|
|
551
|
-
|
|
552
|
-
| **Name** | **Type** | **Description** |
|
|
553
|
-
| --- | --- | --- |
|
|
554
|
-
| <code><a href="#cdk-rds-sql.Schema.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
|
|
555
|
-
| <code><a href="#cdk-rds-sql.Schema.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
|
|
556
|
-
| <code><a href="#cdk-rds-sql.Schema.Initializer.parameter.props">props</a></code> | <code><a href="#cdk-rds-sql.SchemaProps">SchemaProps</a></code> | *No description.* |
|
|
557
|
-
|
|
558
|
-
---
|
|
559
|
-
|
|
560
|
-
##### `scope`<sup>Required</sup> <a name="scope" id="cdk-rds-sql.Schema.Initializer.parameter.scope"></a>
|
|
561
|
-
|
|
562
|
-
- *Type:* constructs.Construct
|
|
563
|
-
|
|
564
|
-
---
|
|
565
|
-
|
|
566
|
-
##### `id`<sup>Required</sup> <a name="id" id="cdk-rds-sql.Schema.Initializer.parameter.id"></a>
|
|
567
|
-
|
|
568
|
-
- *Type:* string
|
|
569
|
-
|
|
570
|
-
---
|
|
571
|
-
|
|
572
|
-
##### `props`<sup>Required</sup> <a name="props" id="cdk-rds-sql.Schema.Initializer.parameter.props"></a>
|
|
573
|
-
|
|
574
|
-
- *Type:* <a href="#cdk-rds-sql.SchemaProps">SchemaProps</a>
|
|
575
|
-
|
|
576
|
-
---
|
|
577
|
-
|
|
578
|
-
#### Methods <a name="Methods" id="Methods"></a>
|
|
579
|
-
|
|
580
|
-
| **Name** | **Description** |
|
|
581
|
-
| --- | --- |
|
|
582
|
-
| <code><a href="#cdk-rds-sql.Schema.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
583
|
-
| <code><a href="#cdk-rds-sql.Schema.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
|
|
584
|
-
| <code><a href="#cdk-rds-sql.Schema.getAtt">getAtt</a></code> | Returns the value of an attribute of the custom resource of an arbitrary type. |
|
|
585
|
-
| <code><a href="#cdk-rds-sql.Schema.getAttString">getAttString</a></code> | Returns the value of an attribute of the custom resource of type string. |
|
|
586
|
-
|
|
587
|
-
---
|
|
588
|
-
|
|
589
|
-
##### `toString` <a name="toString" id="cdk-rds-sql.Schema.toString"></a>
|
|
590
|
-
|
|
591
|
-
```typescript
|
|
592
|
-
public toString(): string
|
|
593
|
-
```
|
|
594
|
-
|
|
595
|
-
Returns a string representation of this construct.
|
|
596
|
-
|
|
597
|
-
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="cdk-rds-sql.Schema.applyRemovalPolicy"></a>
|
|
598
|
-
|
|
599
|
-
```typescript
|
|
600
|
-
public applyRemovalPolicy(policy: RemovalPolicy): void
|
|
601
|
-
```
|
|
602
|
-
|
|
603
|
-
Apply the given removal policy to this resource.
|
|
604
|
-
|
|
605
|
-
The Removal Policy controls what happens to this resource when it stops
|
|
606
|
-
being managed by CloudFormation, either because you've removed it from the
|
|
607
|
-
CDK application or because you've made a change that requires the resource
|
|
608
|
-
to be replaced.
|
|
609
|
-
|
|
610
|
-
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
|
|
611
|
-
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
|
|
612
|
-
|
|
613
|
-
###### `policy`<sup>Required</sup> <a name="policy" id="cdk-rds-sql.Schema.applyRemovalPolicy.parameter.policy"></a>
|
|
614
|
-
|
|
615
|
-
- *Type:* aws-cdk-lib.RemovalPolicy
|
|
616
|
-
|
|
617
|
-
---
|
|
618
|
-
|
|
619
|
-
##### `getAtt` <a name="getAtt" id="cdk-rds-sql.Schema.getAtt"></a>
|
|
620
|
-
|
|
621
|
-
```typescript
|
|
622
|
-
public getAtt(attributeName: string): Reference
|
|
623
|
-
```
|
|
624
|
-
|
|
625
|
-
Returns the value of an attribute of the custom resource of an arbitrary type.
|
|
626
|
-
|
|
627
|
-
Attributes are returned from the custom resource provider through the
|
|
628
|
-
`Data` map where the key is the attribute name.
|
|
629
|
-
|
|
630
|
-
###### `attributeName`<sup>Required</sup> <a name="attributeName" id="cdk-rds-sql.Schema.getAtt.parameter.attributeName"></a>
|
|
631
|
-
|
|
632
|
-
- *Type:* string
|
|
633
|
-
|
|
634
|
-
the name of the attribute.
|
|
635
|
-
|
|
636
|
-
---
|
|
637
|
-
|
|
638
|
-
##### `getAttString` <a name="getAttString" id="cdk-rds-sql.Schema.getAttString"></a>
|
|
639
|
-
|
|
640
|
-
```typescript
|
|
641
|
-
public getAttString(attributeName: string): string
|
|
642
|
-
```
|
|
643
|
-
|
|
644
|
-
Returns the value of an attribute of the custom resource of type string.
|
|
645
|
-
|
|
646
|
-
Attributes are returned from the custom resource provider through the
|
|
647
|
-
`Data` map where the key is the attribute name.
|
|
648
|
-
|
|
649
|
-
###### `attributeName`<sup>Required</sup> <a name="attributeName" id="cdk-rds-sql.Schema.getAttString.parameter.attributeName"></a>
|
|
650
|
-
|
|
651
|
-
- *Type:* string
|
|
652
|
-
|
|
653
|
-
the name of the attribute.
|
|
654
|
-
|
|
655
|
-
---
|
|
656
|
-
|
|
657
|
-
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
658
|
-
|
|
659
|
-
| **Name** | **Description** |
|
|
660
|
-
| --- | --- |
|
|
661
|
-
| <code><a href="#cdk-rds-sql.Schema.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
662
|
-
| <code><a href="#cdk-rds-sql.Schema.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
|
|
663
|
-
| <code><a href="#cdk-rds-sql.Schema.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
|
|
664
|
-
|
|
665
|
-
---
|
|
666
|
-
|
|
667
|
-
##### `isConstruct` <a name="isConstruct" id="cdk-rds-sql.Schema.isConstruct"></a>
|
|
668
|
-
|
|
669
|
-
```typescript
|
|
670
|
-
import { Schema } from 'cdk-rds-sql'
|
|
671
|
-
|
|
672
|
-
Schema.isConstruct(x: any)
|
|
673
|
-
```
|
|
674
|
-
|
|
675
|
-
Checks if `x` is a construct.
|
|
676
|
-
|
|
677
|
-
Use this method instead of `instanceof` to properly detect `Construct`
|
|
678
|
-
instances, even when the construct library is symlinked.
|
|
679
|
-
|
|
680
|
-
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
681
|
-
disk are seen as independent, completely different libraries. As a
|
|
682
|
-
consequence, the class `Construct` in each copy of the `constructs` library
|
|
683
|
-
is seen as a different class, and an instance of one class will not test as
|
|
684
|
-
`instanceof` the other class. `npm install` will not create installations
|
|
685
|
-
like this, but users may manually symlink construct libraries together or
|
|
686
|
-
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
687
|
-
library can be accidentally installed, and `instanceof` will behave
|
|
688
|
-
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
689
|
-
this type-testing method instead.
|
|
690
|
-
|
|
691
|
-
###### `x`<sup>Required</sup> <a name="x" id="cdk-rds-sql.Schema.isConstruct.parameter.x"></a>
|
|
692
|
-
|
|
693
|
-
- *Type:* any
|
|
694
|
-
|
|
695
|
-
Any object.
|
|
696
|
-
|
|
697
|
-
---
|
|
698
|
-
|
|
699
|
-
##### `isOwnedResource` <a name="isOwnedResource" id="cdk-rds-sql.Schema.isOwnedResource"></a>
|
|
700
|
-
|
|
701
|
-
```typescript
|
|
702
|
-
import { Schema } from 'cdk-rds-sql'
|
|
703
|
-
|
|
704
|
-
Schema.isOwnedResource(construct: IConstruct)
|
|
705
|
-
```
|
|
706
|
-
|
|
707
|
-
Returns true if the construct was created by CDK, and false otherwise.
|
|
708
|
-
|
|
709
|
-
###### `construct`<sup>Required</sup> <a name="construct" id="cdk-rds-sql.Schema.isOwnedResource.parameter.construct"></a>
|
|
710
|
-
|
|
711
|
-
- *Type:* constructs.IConstruct
|
|
712
|
-
|
|
713
|
-
---
|
|
714
|
-
|
|
715
|
-
##### `isResource` <a name="isResource" id="cdk-rds-sql.Schema.isResource"></a>
|
|
716
|
-
|
|
717
|
-
```typescript
|
|
718
|
-
import { Schema } from 'cdk-rds-sql'
|
|
719
|
-
|
|
720
|
-
Schema.isResource(construct: IConstruct)
|
|
721
|
-
```
|
|
722
|
-
|
|
723
|
-
Check whether the given construct is a Resource.
|
|
724
|
-
|
|
725
|
-
###### `construct`<sup>Required</sup> <a name="construct" id="cdk-rds-sql.Schema.isResource.parameter.construct"></a>
|
|
726
|
-
|
|
727
|
-
- *Type:* constructs.IConstruct
|
|
728
|
-
|
|
729
|
-
---
|
|
730
|
-
|
|
731
|
-
#### Properties <a name="Properties" id="Properties"></a>
|
|
732
|
-
|
|
733
|
-
| **Name** | **Type** | **Description** |
|
|
734
|
-
| --- | --- | --- |
|
|
735
|
-
| <code><a href="#cdk-rds-sql.Schema.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
736
|
-
| <code><a href="#cdk-rds-sql.Schema.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
|
|
737
|
-
| <code><a href="#cdk-rds-sql.Schema.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
|
|
738
|
-
| <code><a href="#cdk-rds-sql.Schema.property.ref">ref</a></code> | <code>string</code> | The physical name of this custom resource. |
|
|
739
|
-
| <code><a href="#cdk-rds-sql.Schema.property.schemaName">schemaName</a></code> | <code>string</code> | *No description.* |
|
|
740
|
-
|
|
741
|
-
---
|
|
742
|
-
|
|
743
|
-
##### `node`<sup>Required</sup> <a name="node" id="cdk-rds-sql.Schema.property.node"></a>
|
|
744
|
-
|
|
745
|
-
```typescript
|
|
746
|
-
public readonly node: Node;
|
|
747
|
-
```
|
|
748
|
-
|
|
749
|
-
- *Type:* constructs.Node
|
|
750
|
-
|
|
751
|
-
The tree node.
|
|
752
|
-
|
|
753
|
-
---
|
|
754
|
-
|
|
755
|
-
##### `env`<sup>Required</sup> <a name="env" id="cdk-rds-sql.Schema.property.env"></a>
|
|
756
|
-
|
|
757
|
-
```typescript
|
|
758
|
-
public readonly env: ResourceEnvironment;
|
|
759
|
-
```
|
|
760
|
-
|
|
761
|
-
- *Type:* aws-cdk-lib.ResourceEnvironment
|
|
762
|
-
|
|
763
|
-
The environment this resource belongs to.
|
|
764
|
-
|
|
765
|
-
For resources that are created and managed by the CDK
|
|
766
|
-
(generally, those created by creating new class instances like Role, Bucket, etc.),
|
|
767
|
-
this is always the same as the environment of the stack they belong to;
|
|
768
|
-
however, for imported resources
|
|
769
|
-
(those obtained from static methods like fromRoleArn, fromBucketName, etc.),
|
|
770
|
-
that might be different than the stack they were imported into.
|
|
771
|
-
|
|
772
|
-
---
|
|
773
|
-
|
|
774
|
-
##### `stack`<sup>Required</sup> <a name="stack" id="cdk-rds-sql.Schema.property.stack"></a>
|
|
775
|
-
|
|
776
|
-
```typescript
|
|
777
|
-
public readonly stack: Stack;
|
|
778
|
-
```
|
|
779
|
-
|
|
780
|
-
- *Type:* aws-cdk-lib.Stack
|
|
781
|
-
|
|
782
|
-
The stack in which this resource is defined.
|
|
783
|
-
|
|
784
|
-
---
|
|
785
|
-
|
|
786
|
-
##### `ref`<sup>Required</sup> <a name="ref" id="cdk-rds-sql.Schema.property.ref"></a>
|
|
787
|
-
|
|
788
|
-
```typescript
|
|
789
|
-
public readonly ref: string;
|
|
790
|
-
```
|
|
791
|
-
|
|
792
|
-
- *Type:* string
|
|
793
|
-
|
|
794
|
-
The physical name of this custom resource.
|
|
795
|
-
|
|
796
|
-
---
|
|
797
|
-
|
|
798
|
-
##### `schemaName`<sup>Required</sup> <a name="schemaName" id="cdk-rds-sql.Schema.property.schemaName"></a>
|
|
799
|
-
|
|
800
|
-
```typescript
|
|
801
|
-
public readonly schemaName: string;
|
|
802
|
-
```
|
|
803
|
-
|
|
804
|
-
- *Type:* string
|
|
805
|
-
|
|
806
|
-
---
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
### Sql <a name="Sql" id="cdk-rds-sql.Sql"></a>
|
|
810
|
-
|
|
811
|
-
#### Initializers <a name="Initializers" id="cdk-rds-sql.Sql.Initializer"></a>
|
|
812
|
-
|
|
813
|
-
```typescript
|
|
814
|
-
import { Sql } from 'cdk-rds-sql'
|
|
815
|
-
|
|
816
|
-
new Sql(scope: Construct, id: string, props: SqlProps)
|
|
817
|
-
```
|
|
818
|
-
|
|
819
|
-
| **Name** | **Type** | **Description** |
|
|
820
|
-
| --- | --- | --- |
|
|
821
|
-
| <code><a href="#cdk-rds-sql.Sql.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
|
|
822
|
-
| <code><a href="#cdk-rds-sql.Sql.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
|
|
823
|
-
| <code><a href="#cdk-rds-sql.Sql.Initializer.parameter.props">props</a></code> | <code><a href="#cdk-rds-sql.SqlProps">SqlProps</a></code> | *No description.* |
|
|
824
|
-
|
|
825
|
-
---
|
|
826
|
-
|
|
827
|
-
##### `scope`<sup>Required</sup> <a name="scope" id="cdk-rds-sql.Sql.Initializer.parameter.scope"></a>
|
|
828
|
-
|
|
829
|
-
- *Type:* constructs.Construct
|
|
830
|
-
|
|
831
|
-
---
|
|
832
|
-
|
|
833
|
-
##### `id`<sup>Required</sup> <a name="id" id="cdk-rds-sql.Sql.Initializer.parameter.id"></a>
|
|
834
|
-
|
|
835
|
-
- *Type:* string
|
|
836
|
-
|
|
837
|
-
---
|
|
838
|
-
|
|
839
|
-
##### `props`<sup>Required</sup> <a name="props" id="cdk-rds-sql.Sql.Initializer.parameter.props"></a>
|
|
840
|
-
|
|
841
|
-
- *Type:* <a href="#cdk-rds-sql.SqlProps">SqlProps</a>
|
|
842
|
-
|
|
843
|
-
---
|
|
844
|
-
|
|
845
|
-
#### Methods <a name="Methods" id="Methods"></a>
|
|
846
|
-
|
|
847
|
-
| **Name** | **Description** |
|
|
848
|
-
| --- | --- |
|
|
849
|
-
| <code><a href="#cdk-rds-sql.Sql.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
850
|
-
| <code><a href="#cdk-rds-sql.Sql.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
|
|
851
|
-
| <code><a href="#cdk-rds-sql.Sql.getAtt">getAtt</a></code> | Returns the value of an attribute of the custom resource of an arbitrary type. |
|
|
852
|
-
| <code><a href="#cdk-rds-sql.Sql.getAttString">getAttString</a></code> | Returns the value of an attribute of the custom resource of type string. |
|
|
853
|
-
|
|
854
|
-
---
|
|
855
|
-
|
|
856
|
-
##### `toString` <a name="toString" id="cdk-rds-sql.Sql.toString"></a>
|
|
857
|
-
|
|
858
|
-
```typescript
|
|
859
|
-
public toString(): string
|
|
860
|
-
```
|
|
861
|
-
|
|
862
|
-
Returns a string representation of this construct.
|
|
863
|
-
|
|
864
|
-
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="cdk-rds-sql.Sql.applyRemovalPolicy"></a>
|
|
865
|
-
|
|
866
|
-
```typescript
|
|
867
|
-
public applyRemovalPolicy(policy: RemovalPolicy): void
|
|
868
|
-
```
|
|
869
|
-
|
|
870
|
-
Apply the given removal policy to this resource.
|
|
871
|
-
|
|
872
|
-
The Removal Policy controls what happens to this resource when it stops
|
|
873
|
-
being managed by CloudFormation, either because you've removed it from the
|
|
874
|
-
CDK application or because you've made a change that requires the resource
|
|
875
|
-
to be replaced.
|
|
876
|
-
|
|
877
|
-
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
|
|
878
|
-
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
|
|
879
|
-
|
|
880
|
-
###### `policy`<sup>Required</sup> <a name="policy" id="cdk-rds-sql.Sql.applyRemovalPolicy.parameter.policy"></a>
|
|
881
|
-
|
|
882
|
-
- *Type:* aws-cdk-lib.RemovalPolicy
|
|
883
|
-
|
|
884
|
-
---
|
|
885
|
-
|
|
886
|
-
##### `getAtt` <a name="getAtt" id="cdk-rds-sql.Sql.getAtt"></a>
|
|
887
|
-
|
|
888
|
-
```typescript
|
|
889
|
-
public getAtt(attributeName: string): Reference
|
|
890
|
-
```
|
|
891
|
-
|
|
892
|
-
Returns the value of an attribute of the custom resource of an arbitrary type.
|
|
893
|
-
|
|
894
|
-
Attributes are returned from the custom resource provider through the
|
|
895
|
-
`Data` map where the key is the attribute name.
|
|
896
|
-
|
|
897
|
-
###### `attributeName`<sup>Required</sup> <a name="attributeName" id="cdk-rds-sql.Sql.getAtt.parameter.attributeName"></a>
|
|
898
|
-
|
|
899
|
-
- *Type:* string
|
|
900
|
-
|
|
901
|
-
the name of the attribute.
|
|
902
|
-
|
|
903
|
-
---
|
|
904
|
-
|
|
905
|
-
##### `getAttString` <a name="getAttString" id="cdk-rds-sql.Sql.getAttString"></a>
|
|
906
|
-
|
|
907
|
-
```typescript
|
|
908
|
-
public getAttString(attributeName: string): string
|
|
909
|
-
```
|
|
910
|
-
|
|
911
|
-
Returns the value of an attribute of the custom resource of type string.
|
|
912
|
-
|
|
913
|
-
Attributes are returned from the custom resource provider through the
|
|
914
|
-
`Data` map where the key is the attribute name.
|
|
915
|
-
|
|
916
|
-
###### `attributeName`<sup>Required</sup> <a name="attributeName" id="cdk-rds-sql.Sql.getAttString.parameter.attributeName"></a>
|
|
917
|
-
|
|
918
|
-
- *Type:* string
|
|
919
|
-
|
|
920
|
-
the name of the attribute.
|
|
921
|
-
|
|
922
|
-
---
|
|
923
|
-
|
|
924
|
-
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
925
|
-
|
|
926
|
-
| **Name** | **Description** |
|
|
927
|
-
| --- | --- |
|
|
928
|
-
| <code><a href="#cdk-rds-sql.Sql.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
929
|
-
| <code><a href="#cdk-rds-sql.Sql.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
|
|
930
|
-
| <code><a href="#cdk-rds-sql.Sql.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
|
|
931
|
-
|
|
932
|
-
---
|
|
933
|
-
|
|
934
|
-
##### `isConstruct` <a name="isConstruct" id="cdk-rds-sql.Sql.isConstruct"></a>
|
|
935
|
-
|
|
936
|
-
```typescript
|
|
937
|
-
import { Sql } from 'cdk-rds-sql'
|
|
938
|
-
|
|
939
|
-
Sql.isConstruct(x: any)
|
|
940
|
-
```
|
|
941
|
-
|
|
942
|
-
Checks if `x` is a construct.
|
|
943
|
-
|
|
944
|
-
Use this method instead of `instanceof` to properly detect `Construct`
|
|
945
|
-
instances, even when the construct library is symlinked.
|
|
946
|
-
|
|
947
|
-
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
948
|
-
disk are seen as independent, completely different libraries. As a
|
|
949
|
-
consequence, the class `Construct` in each copy of the `constructs` library
|
|
950
|
-
is seen as a different class, and an instance of one class will not test as
|
|
951
|
-
`instanceof` the other class. `npm install` will not create installations
|
|
952
|
-
like this, but users may manually symlink construct libraries together or
|
|
953
|
-
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
954
|
-
library can be accidentally installed, and `instanceof` will behave
|
|
955
|
-
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
956
|
-
this type-testing method instead.
|
|
957
|
-
|
|
958
|
-
###### `x`<sup>Required</sup> <a name="x" id="cdk-rds-sql.Sql.isConstruct.parameter.x"></a>
|
|
959
|
-
|
|
960
|
-
- *Type:* any
|
|
961
|
-
|
|
962
|
-
Any object.
|
|
963
|
-
|
|
964
|
-
---
|
|
965
|
-
|
|
966
|
-
##### `isOwnedResource` <a name="isOwnedResource" id="cdk-rds-sql.Sql.isOwnedResource"></a>
|
|
967
|
-
|
|
968
|
-
```typescript
|
|
969
|
-
import { Sql } from 'cdk-rds-sql'
|
|
970
|
-
|
|
971
|
-
Sql.isOwnedResource(construct: IConstruct)
|
|
972
|
-
```
|
|
973
|
-
|
|
974
|
-
Returns true if the construct was created by CDK, and false otherwise.
|
|
975
|
-
|
|
976
|
-
###### `construct`<sup>Required</sup> <a name="construct" id="cdk-rds-sql.Sql.isOwnedResource.parameter.construct"></a>
|
|
977
|
-
|
|
978
|
-
- *Type:* constructs.IConstruct
|
|
979
|
-
|
|
980
|
-
---
|
|
981
|
-
|
|
982
|
-
##### `isResource` <a name="isResource" id="cdk-rds-sql.Sql.isResource"></a>
|
|
983
|
-
|
|
984
|
-
```typescript
|
|
985
|
-
import { Sql } from 'cdk-rds-sql'
|
|
986
|
-
|
|
987
|
-
Sql.isResource(construct: IConstruct)
|
|
988
|
-
```
|
|
989
|
-
|
|
990
|
-
Check whether the given construct is a Resource.
|
|
991
|
-
|
|
992
|
-
###### `construct`<sup>Required</sup> <a name="construct" id="cdk-rds-sql.Sql.isResource.parameter.construct"></a>
|
|
993
|
-
|
|
994
|
-
- *Type:* constructs.IConstruct
|
|
995
|
-
|
|
996
|
-
---
|
|
997
|
-
|
|
998
|
-
#### Properties <a name="Properties" id="Properties"></a>
|
|
999
|
-
|
|
1000
|
-
| **Name** | **Type** | **Description** |
|
|
1001
|
-
| --- | --- | --- |
|
|
1002
|
-
| <code><a href="#cdk-rds-sql.Sql.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
1003
|
-
| <code><a href="#cdk-rds-sql.Sql.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
|
|
1004
|
-
| <code><a href="#cdk-rds-sql.Sql.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
|
|
1005
|
-
| <code><a href="#cdk-rds-sql.Sql.property.ref">ref</a></code> | <code>string</code> | The physical name of this custom resource. |
|
|
1006
|
-
|
|
1007
|
-
---
|
|
1008
|
-
|
|
1009
|
-
##### `node`<sup>Required</sup> <a name="node" id="cdk-rds-sql.Sql.property.node"></a>
|
|
1010
|
-
|
|
1011
|
-
```typescript
|
|
1012
|
-
public readonly node: Node;
|
|
1013
|
-
```
|
|
1014
|
-
|
|
1015
|
-
- *Type:* constructs.Node
|
|
1016
|
-
|
|
1017
|
-
The tree node.
|
|
1018
|
-
|
|
1019
|
-
---
|
|
1020
|
-
|
|
1021
|
-
##### `env`<sup>Required</sup> <a name="env" id="cdk-rds-sql.Sql.property.env"></a>
|
|
1022
|
-
|
|
1023
|
-
```typescript
|
|
1024
|
-
public readonly env: ResourceEnvironment;
|
|
1025
|
-
```
|
|
1026
|
-
|
|
1027
|
-
- *Type:* aws-cdk-lib.ResourceEnvironment
|
|
1028
|
-
|
|
1029
|
-
The environment this resource belongs to.
|
|
1030
|
-
|
|
1031
|
-
For resources that are created and managed by the CDK
|
|
1032
|
-
(generally, those created by creating new class instances like Role, Bucket, etc.),
|
|
1033
|
-
this is always the same as the environment of the stack they belong to;
|
|
1034
|
-
however, for imported resources
|
|
1035
|
-
(those obtained from static methods like fromRoleArn, fromBucketName, etc.),
|
|
1036
|
-
that might be different than the stack they were imported into.
|
|
1037
|
-
|
|
1038
|
-
---
|
|
1039
|
-
|
|
1040
|
-
##### `stack`<sup>Required</sup> <a name="stack" id="cdk-rds-sql.Sql.property.stack"></a>
|
|
1041
|
-
|
|
1042
|
-
```typescript
|
|
1043
|
-
public readonly stack: Stack;
|
|
1044
|
-
```
|
|
1045
|
-
|
|
1046
|
-
- *Type:* aws-cdk-lib.Stack
|
|
1047
|
-
|
|
1048
|
-
The stack in which this resource is defined.
|
|
1049
|
-
|
|
1050
|
-
---
|
|
1051
|
-
|
|
1052
|
-
##### `ref`<sup>Required</sup> <a name="ref" id="cdk-rds-sql.Sql.property.ref"></a>
|
|
1053
|
-
|
|
1054
|
-
```typescript
|
|
1055
|
-
public readonly ref: string;
|
|
1056
|
-
```
|
|
1057
|
-
|
|
1058
|
-
- *Type:* string
|
|
1059
|
-
|
|
1060
|
-
The physical name of this custom resource.
|
|
1061
|
-
|
|
1062
|
-
---
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
## Structs <a name="Structs" id="Structs"></a>
|
|
1066
|
-
|
|
1067
|
-
### DatabaseProps <a name="DatabaseProps" id="cdk-rds-sql.DatabaseProps"></a>
|
|
1068
|
-
|
|
1069
|
-
#### Initializer <a name="Initializer" id="cdk-rds-sql.DatabaseProps.Initializer"></a>
|
|
1070
|
-
|
|
1071
|
-
```typescript
|
|
1072
|
-
import { DatabaseProps } from 'cdk-rds-sql'
|
|
1073
|
-
|
|
1074
|
-
const databaseProps: DatabaseProps = { ... }
|
|
1075
|
-
```
|
|
1076
|
-
|
|
1077
|
-
#### Properties <a name="Properties" id="Properties"></a>
|
|
1078
|
-
|
|
1079
|
-
| **Name** | **Type** | **Description** |
|
|
1080
|
-
| --- | --- | --- |
|
|
1081
|
-
| <code><a href="#cdk-rds-sql.DatabaseProps.property.databaseName">databaseName</a></code> | <code>string</code> | Name of database to create. |
|
|
1082
|
-
| <code><a href="#cdk-rds-sql.DatabaseProps.property.provider">provider</a></code> | <code><a href="#cdk-rds-sql.Provider">Provider</a></code> | Provider. |
|
|
1083
|
-
| <code><a href="#cdk-rds-sql.DatabaseProps.property.owner">owner</a></code> | <code><a href="#cdk-rds-sql.Role">Role</a></code> | Optional database owner. |
|
|
1084
|
-
|
|
1085
|
-
---
|
|
1086
|
-
|
|
1087
|
-
##### `databaseName`<sup>Required</sup> <a name="databaseName" id="cdk-rds-sql.DatabaseProps.property.databaseName"></a>
|
|
1088
|
-
|
|
1089
|
-
```typescript
|
|
1090
|
-
public readonly databaseName: string;
|
|
1091
|
-
```
|
|
1092
|
-
|
|
1093
|
-
- *Type:* string
|
|
1094
|
-
|
|
1095
|
-
Name of database to create.
|
|
1096
|
-
|
|
1097
|
-
---
|
|
1098
|
-
|
|
1099
|
-
##### `provider`<sup>Required</sup> <a name="provider" id="cdk-rds-sql.DatabaseProps.property.provider"></a>
|
|
1100
|
-
|
|
1101
|
-
```typescript
|
|
1102
|
-
public readonly provider: Provider;
|
|
1103
|
-
```
|
|
1104
|
-
|
|
1105
|
-
- *Type:* <a href="#cdk-rds-sql.Provider">Provider</a>
|
|
1106
|
-
|
|
1107
|
-
Provider.
|
|
1108
|
-
|
|
1109
|
-
---
|
|
1110
|
-
|
|
1111
|
-
##### `owner`<sup>Optional</sup> <a name="owner" id="cdk-rds-sql.DatabaseProps.property.owner"></a>
|
|
1112
|
-
|
|
1113
|
-
```typescript
|
|
1114
|
-
public readonly owner: Role;
|
|
1115
|
-
```
|
|
1116
|
-
|
|
1117
|
-
- *Type:* <a href="#cdk-rds-sql.Role">Role</a>
|
|
1118
|
-
|
|
1119
|
-
Optional database owner.
|
|
1120
|
-
|
|
1121
|
-
---
|
|
1122
|
-
|
|
1123
|
-
### RdsSqlProps <a name="RdsSqlProps" id="cdk-rds-sql.RdsSqlProps"></a>
|
|
1124
|
-
|
|
1125
|
-
#### Initializer <a name="Initializer" id="cdk-rds-sql.RdsSqlProps.Initializer"></a>
|
|
1126
|
-
|
|
1127
|
-
```typescript
|
|
1128
|
-
import { RdsSqlProps } from 'cdk-rds-sql'
|
|
1129
|
-
|
|
1130
|
-
const rdsSqlProps: RdsSqlProps = { ... }
|
|
1131
|
-
```
|
|
1132
|
-
|
|
1133
|
-
#### Properties <a name="Properties" id="Properties"></a>
|
|
1134
|
-
|
|
1135
|
-
| **Name** | **Type** | **Description** |
|
|
1136
|
-
| --- | --- | --- |
|
|
1137
|
-
| <code><a href="#cdk-rds-sql.RdsSqlProps.property.cluster">cluster</a></code> | <code>aws-cdk-lib.aws_rds.IServerlessCluster</code> | *No description.* |
|
|
1138
|
-
| <code><a href="#cdk-rds-sql.RdsSqlProps.property.secret">secret</a></code> | <code>aws-cdk-lib.aws_secretsmanager.ISecret</code> | *No description.* |
|
|
1139
|
-
| <code><a href="#cdk-rds-sql.RdsSqlProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | *No description.* |
|
|
1140
|
-
|
|
1141
|
-
---
|
|
1142
|
-
|
|
1143
|
-
##### `cluster`<sup>Required</sup> <a name="cluster" id="cdk-rds-sql.RdsSqlProps.property.cluster"></a>
|
|
1144
|
-
|
|
1145
|
-
```typescript
|
|
1146
|
-
public readonly cluster: IServerlessCluster;
|
|
1147
|
-
```
|
|
1148
|
-
|
|
1149
|
-
- *Type:* aws-cdk-lib.aws_rds.IServerlessCluster
|
|
1150
|
-
|
|
1151
|
-
---
|
|
1152
|
-
|
|
1153
|
-
##### `secret`<sup>Required</sup> <a name="secret" id="cdk-rds-sql.RdsSqlProps.property.secret"></a>
|
|
1154
|
-
|
|
1155
|
-
```typescript
|
|
1156
|
-
public readonly secret: ISecret;
|
|
1157
|
-
```
|
|
1158
|
-
|
|
1159
|
-
- *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
|
|
1160
|
-
|
|
1161
|
-
---
|
|
1162
|
-
|
|
1163
|
-
##### `vpc`<sup>Required</sup> <a name="vpc" id="cdk-rds-sql.RdsSqlProps.property.vpc"></a>
|
|
1164
|
-
|
|
1165
|
-
```typescript
|
|
1166
|
-
public readonly vpc: IVpc;
|
|
1167
|
-
```
|
|
1168
|
-
|
|
1169
|
-
- *Type:* aws-cdk-lib.aws_ec2.IVpc
|
|
1170
|
-
|
|
1171
|
-
---
|
|
1172
|
-
|
|
1173
|
-
### RoleProps <a name="RoleProps" id="cdk-rds-sql.RoleProps"></a>
|
|
1174
|
-
|
|
1175
|
-
#### Initializer <a name="Initializer" id="cdk-rds-sql.RoleProps.Initializer"></a>
|
|
1176
|
-
|
|
1177
|
-
```typescript
|
|
1178
|
-
import { RoleProps } from 'cdk-rds-sql'
|
|
1179
|
-
|
|
1180
|
-
const roleProps: RoleProps = { ... }
|
|
1181
|
-
```
|
|
1182
|
-
|
|
1183
|
-
#### Properties <a name="Properties" id="Properties"></a>
|
|
1184
|
-
|
|
1185
|
-
| **Name** | **Type** | **Description** |
|
|
1186
|
-
| --- | --- | --- |
|
|
1187
|
-
| <code><a href="#cdk-rds-sql.RoleProps.property.cluster">cluster</a></code> | <code>aws-cdk-lib.aws_rds.ServerlessCluster</code> | Database cluster to access. |
|
|
1188
|
-
| <code><a href="#cdk-rds-sql.RoleProps.property.databaseName">databaseName</a></code> | <code>string</code> | Database name this user is expected to use. |
|
|
1189
|
-
| <code><a href="#cdk-rds-sql.RoleProps.property.provider">provider</a></code> | <code><a href="#cdk-rds-sql.Provider">Provider</a></code> | Provider. |
|
|
1190
|
-
| <code><a href="#cdk-rds-sql.RoleProps.property.roleName">roleName</a></code> | <code>string</code> | SQL. |
|
|
1191
|
-
| <code><a href="#cdk-rds-sql.RoleProps.property.encryptionKey">encryptionKey</a></code> | <code>aws-cdk-lib.aws_kms.IKey</code> | A new secret is created for this user. |
|
|
1192
|
-
|
|
1193
|
-
---
|
|
1194
|
-
|
|
1195
|
-
##### `cluster`<sup>Required</sup> <a name="cluster" id="cdk-rds-sql.RoleProps.property.cluster"></a>
|
|
1196
|
-
|
|
1197
|
-
```typescript
|
|
1198
|
-
public readonly cluster: ServerlessCluster;
|
|
1199
|
-
```
|
|
1200
|
-
|
|
1201
|
-
- *Type:* aws-cdk-lib.aws_rds.ServerlessCluster
|
|
1202
|
-
|
|
1203
|
-
Database cluster to access.
|
|
1204
|
-
|
|
1205
|
-
---
|
|
1206
|
-
|
|
1207
|
-
##### `databaseName`<sup>Required</sup> <a name="databaseName" id="cdk-rds-sql.RoleProps.property.databaseName"></a>
|
|
1208
|
-
|
|
1209
|
-
```typescript
|
|
1210
|
-
public readonly databaseName: string;
|
|
1211
|
-
```
|
|
1212
|
-
|
|
1213
|
-
- *Type:* string
|
|
1214
|
-
|
|
1215
|
-
Database name this user is expected to use.
|
|
1216
|
-
|
|
1217
|
-
---
|
|
1218
|
-
|
|
1219
|
-
##### `provider`<sup>Required</sup> <a name="provider" id="cdk-rds-sql.RoleProps.property.provider"></a>
|
|
1220
|
-
|
|
1221
|
-
```typescript
|
|
1222
|
-
public readonly provider: Provider;
|
|
1223
|
-
```
|
|
1224
|
-
|
|
1225
|
-
- *Type:* <a href="#cdk-rds-sql.Provider">Provider</a>
|
|
1226
|
-
|
|
1227
|
-
Provider.
|
|
1228
|
-
|
|
1229
|
-
---
|
|
1230
|
-
|
|
1231
|
-
##### `roleName`<sup>Required</sup> <a name="roleName" id="cdk-rds-sql.RoleProps.property.roleName"></a>
|
|
1232
|
-
|
|
1233
|
-
```typescript
|
|
1234
|
-
public readonly roleName: string;
|
|
1235
|
-
```
|
|
1236
|
-
|
|
1237
|
-
- *Type:* string
|
|
1238
|
-
|
|
1239
|
-
SQL.
|
|
1240
|
-
|
|
1241
|
-
---
|
|
1242
|
-
|
|
1243
|
-
##### `encryptionKey`<sup>Optional</sup> <a name="encryptionKey" id="cdk-rds-sql.RoleProps.property.encryptionKey"></a>
|
|
1244
|
-
|
|
1245
|
-
```typescript
|
|
1246
|
-
public readonly encryptionKey: IKey;
|
|
1247
|
-
```
|
|
1248
|
-
|
|
1249
|
-
- *Type:* aws-cdk-lib.aws_kms.IKey
|
|
1250
|
-
|
|
1251
|
-
A new secret is created for this user.
|
|
1252
|
-
|
|
1253
|
-
Optionally encrypt it with the given key.
|
|
1254
|
-
|
|
1255
|
-
---
|
|
1256
|
-
|
|
1257
|
-
### SchemaProps <a name="SchemaProps" id="cdk-rds-sql.SchemaProps"></a>
|
|
1258
|
-
|
|
1259
|
-
#### Initializer <a name="Initializer" id="cdk-rds-sql.SchemaProps.Initializer"></a>
|
|
1260
|
-
|
|
1261
|
-
```typescript
|
|
1262
|
-
import { SchemaProps } from 'cdk-rds-sql'
|
|
1263
|
-
|
|
1264
|
-
const schemaProps: SchemaProps = { ... }
|
|
1265
|
-
```
|
|
1266
|
-
|
|
1267
|
-
#### Properties <a name="Properties" id="Properties"></a>
|
|
1268
|
-
|
|
1269
|
-
| **Name** | **Type** | **Description** |
|
|
1270
|
-
| --- | --- | --- |
|
|
1271
|
-
| <code><a href="#cdk-rds-sql.SchemaProps.property.provider">provider</a></code> | <code><a href="#cdk-rds-sql.Provider">Provider</a></code> | Provider. |
|
|
1272
|
-
| <code><a href="#cdk-rds-sql.SchemaProps.property.schemaName">schemaName</a></code> | <code>string</code> | SQL. |
|
|
1273
|
-
| <code><a href="#cdk-rds-sql.SchemaProps.property.databaseName">databaseName</a></code> | <code>string</code> | Optional database. |
|
|
1274
|
-
|
|
1275
|
-
---
|
|
1276
|
-
|
|
1277
|
-
##### `provider`<sup>Required</sup> <a name="provider" id="cdk-rds-sql.SchemaProps.property.provider"></a>
|
|
1278
|
-
|
|
1279
|
-
```typescript
|
|
1280
|
-
public readonly provider: Provider;
|
|
1281
|
-
```
|
|
1282
|
-
|
|
1283
|
-
- *Type:* <a href="#cdk-rds-sql.Provider">Provider</a>
|
|
1284
|
-
|
|
1285
|
-
Provider.
|
|
1286
|
-
|
|
1287
|
-
---
|
|
1288
|
-
|
|
1289
|
-
##### `schemaName`<sup>Required</sup> <a name="schemaName" id="cdk-rds-sql.SchemaProps.property.schemaName"></a>
|
|
1290
|
-
|
|
1291
|
-
```typescript
|
|
1292
|
-
public readonly schemaName: string;
|
|
1293
|
-
```
|
|
1294
|
-
|
|
1295
|
-
- *Type:* string
|
|
1296
|
-
|
|
1297
|
-
SQL.
|
|
1298
|
-
|
|
1299
|
-
---
|
|
1300
|
-
|
|
1301
|
-
##### `databaseName`<sup>Optional</sup> <a name="databaseName" id="cdk-rds-sql.SchemaProps.property.databaseName"></a>
|
|
1302
|
-
|
|
1303
|
-
```typescript
|
|
1304
|
-
public readonly databaseName: string;
|
|
1305
|
-
```
|
|
1306
|
-
|
|
1307
|
-
- *Type:* string
|
|
1308
|
-
- *Default:* use default database
|
|
1309
|
-
|
|
1310
|
-
Optional database.
|
|
1311
|
-
|
|
1312
|
-
---
|
|
1313
|
-
|
|
1314
|
-
### SqlProps <a name="SqlProps" id="cdk-rds-sql.SqlProps"></a>
|
|
1315
|
-
|
|
1316
|
-
#### Initializer <a name="Initializer" id="cdk-rds-sql.SqlProps.Initializer"></a>
|
|
1317
|
-
|
|
1318
|
-
```typescript
|
|
1319
|
-
import { SqlProps } from 'cdk-rds-sql'
|
|
1320
|
-
|
|
1321
|
-
const sqlProps: SqlProps = { ... }
|
|
1322
|
-
```
|
|
1323
|
-
|
|
1324
|
-
#### Properties <a name="Properties" id="Properties"></a>
|
|
1325
|
-
|
|
1326
|
-
| **Name** | **Type** | **Description** |
|
|
1327
|
-
| --- | --- | --- |
|
|
1328
|
-
| <code><a href="#cdk-rds-sql.SqlProps.property.provider">provider</a></code> | <code><a href="#cdk-rds-sql.Provider">Provider</a></code> | Provider. |
|
|
1329
|
-
| <code><a href="#cdk-rds-sql.SqlProps.property.databaseName">databaseName</a></code> | <code>string</code> | Optional database. |
|
|
1330
|
-
| <code><a href="#cdk-rds-sql.SqlProps.property.statement">statement</a></code> | <code>string</code> | SQL. |
|
|
1331
|
-
|
|
1332
|
-
---
|
|
1333
|
-
|
|
1334
|
-
##### `provider`<sup>Required</sup> <a name="provider" id="cdk-rds-sql.SqlProps.property.provider"></a>
|
|
1335
|
-
|
|
1336
|
-
```typescript
|
|
1337
|
-
public readonly provider: Provider;
|
|
1338
|
-
```
|
|
1339
|
-
|
|
1340
|
-
- *Type:* <a href="#cdk-rds-sql.Provider">Provider</a>
|
|
1341
|
-
|
|
1342
|
-
Provider.
|
|
1343
|
-
|
|
1344
|
-
---
|
|
1345
|
-
|
|
1346
|
-
##### `databaseName`<sup>Optional</sup> <a name="databaseName" id="cdk-rds-sql.SqlProps.property.databaseName"></a>
|
|
1347
|
-
|
|
1348
|
-
```typescript
|
|
1349
|
-
public readonly databaseName: string;
|
|
1350
|
-
```
|
|
1351
|
-
|
|
1352
|
-
- *Type:* string
|
|
1353
|
-
- *Default:* use default database
|
|
1354
|
-
|
|
1355
|
-
Optional database.
|
|
1356
|
-
|
|
1357
|
-
---
|
|
1358
|
-
|
|
1359
|
-
##### `statement`<sup>Optional</sup> <a name="statement" id="cdk-rds-sql.SqlProps.property.statement"></a>
|
|
1360
|
-
|
|
1361
|
-
```typescript
|
|
1362
|
-
public readonly statement: string;
|
|
1363
|
-
```
|
|
1364
|
-
|
|
1365
|
-
- *Type:* string
|
|
1366
|
-
|
|
1367
|
-
SQL.
|
|
1368
|
-
|
|
1369
|
-
---
|
|
1370
|
-
|
|
1371
|
-
|
|
1372
|
-
|
|
1373
|
-
## Enums <a name="Enums" id="Enums"></a>
|
|
1374
|
-
|
|
1375
|
-
### RdsSqlResource <a name="RdsSqlResource" id="cdk-rds-sql.RdsSqlResource"></a>
|
|
1376
|
-
|
|
1377
|
-
#### Members <a name="Members" id="Members"></a>
|
|
1378
|
-
|
|
1379
|
-
| **Name** | **Description** |
|
|
1380
|
-
| --- | --- |
|
|
1381
|
-
| <code><a href="#cdk-rds-sql.RdsSqlResource.SCHEMA">SCHEMA</a></code> | *No description.* |
|
|
1382
|
-
| <code><a href="#cdk-rds-sql.RdsSqlResource.ROLE">ROLE</a></code> | *No description.* |
|
|
1383
|
-
| <code><a href="#cdk-rds-sql.RdsSqlResource.SQL">SQL</a></code> | *No description.* |
|
|
1384
|
-
| <code><a href="#cdk-rds-sql.RdsSqlResource.DATABASE">DATABASE</a></code> | *No description.* |
|
|
1385
|
-
|
|
1386
|
-
---
|
|
1387
|
-
|
|
1388
|
-
##### `SCHEMA` <a name="SCHEMA" id="cdk-rds-sql.RdsSqlResource.SCHEMA"></a>
|
|
1389
|
-
|
|
1390
|
-
---
|
|
1391
|
-
|
|
1392
|
-
|
|
1393
|
-
##### `ROLE` <a name="ROLE" id="cdk-rds-sql.RdsSqlResource.ROLE"></a>
|
|
1394
|
-
|
|
1395
|
-
---
|
|
1396
|
-
|
|
1397
|
-
|
|
1398
|
-
##### `SQL` <a name="SQL" id="cdk-rds-sql.RdsSqlResource.SQL"></a>
|
|
1399
|
-
|
|
1400
|
-
---
|
|
1401
|
-
|
|
1402
|
-
|
|
1403
|
-
##### `DATABASE` <a name="DATABASE" id="cdk-rds-sql.RdsSqlResource.DATABASE"></a>
|
|
1404
|
-
|
|
1405
|
-
---
|
|
1406
|
-
|