cdk8s-aws-cdk 0.0.5
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 +21 -0
- package/.jsii +4392 -0
- package/API.md +2204 -0
- package/LICENSE +202 -0
- package/README.md +201 -0
- package/changelog.md +2 -0
- package/examples/rds-db-instance/README.md +0 -0
- package/examples/rds-db-instance/cdk.out/RdsDBInstanceStack.assets.json +19 -0
- package/examples/rds-db-instance/cdk.out/RdsDBInstanceStack.template.json +86 -0
- package/examples/rds-db-instance/cdk.out/cdk.out +1 -0
- package/examples/rds-db-instance/cdk.out/manifest.json +230 -0
- package/examples/rds-db-instance/cdk.out/tree.json +171 -0
- package/examples/rds-db-instance/main.ts +136 -0
- package/lib/adapter.d.ts +37 -0
- package/lib/adapter.d.ts.map +1 -0
- package/lib/adapter.js +196 -0
- package/lib/chart.d.ts +19 -0
- package/lib/chart.d.ts.map +1 -0
- package/lib/chart.js +63 -0
- package/lib/imports/cloudcontrol.services.k8s.aws.d.ts +106 -0
- package/lib/imports/cloudcontrol.services.k8s.aws.d.ts.map +1 -0
- package/lib/imports/cloudcontrol.services.k8s.aws.js +92 -0
- package/lib/imports/dynamotables-dynamodb.services.k8s.aws.d.ts +430 -0
- package/lib/imports/dynamotables-dynamodb.services.k8s.aws.d.ts.map +1 -0
- package/lib/imports/dynamotables-dynamodb.services.k8s.aws.js +314 -0
- package/lib/imports/ec2securitygroups-ec2.services.k8s.aws.d.ts +173 -0
- package/lib/imports/ec2securitygroups-ec2.services.k8s.aws.d.ts.map +1 -0
- package/lib/imports/ec2securitygroups-ec2.services.k8s.aws.js +156 -0
- package/lib/imports/fieldexports-services.k8s.aws.d.ts +159 -0
- package/lib/imports/fieldexports-services.k8s.aws.d.ts.map +1 -0
- package/lib/imports/fieldexports-services.k8s.aws.js +151 -0
- package/lib/imports/iampolicies-iam.services.k8s.aws.d.ts +135 -0
- package/lib/imports/iampolicies-iam.services.k8s.aws.d.ts.map +1 -0
- package/lib/imports/iampolicies-iam.services.k8s.aws.js +109 -0
- package/lib/imports/iamroles-iam.services.k8s.aws.d.ts +143 -0
- package/lib/imports/iamroles-iam.services.k8s.aws.d.ts.map +1 -0
- package/lib/imports/iamroles-iam.services.k8s.aws.js +112 -0
- package/lib/imports/k8s.d.ts +18619 -0
- package/lib/imports/k8s.d.ts.map +1 -0
- package/lib/imports/k8s.js +14701 -0
- package/lib/imports/lambdaeventsourcemappings-lambda.services.k8s.aws.d.ts +280 -0
- package/lib/imports/lambdaeventsourcemappings-lambda.services.k8s.aws.d.ts.map +1 -0
- package/lib/imports/lambdaeventsourcemappings-lambda.services.k8s.aws.js +183 -0
- package/lib/imports/lambdafunctions-lambda.services.k8s.aws.d.ts +343 -0
- package/lib/imports/lambdafunctions-lambda.services.k8s.aws.d.ts.map +1 -0
- package/lib/imports/lambdafunctions-lambda.services.k8s.aws.js +225 -0
- package/lib/imports/rdsdbinstances-rds.services.k8s.aws.d.ts +790 -0
- package/lib/imports/rdsdbinstances-rds.services.k8s.aws.d.ts.map +1 -0
- package/lib/imports/rdsdbinstances-rds.services.k8s.aws.js +217 -0
- package/lib/imports/rdsdbsubnetgroups-rds.services.k8s.aws.d.ts +114 -0
- package/lib/imports/rdsdbsubnetgroups-rds.services.k8s.aws.d.ts.map +1 -0
- package/lib/imports/rdsdbsubnetgroups-rds.services.k8s.aws.js +108 -0
- package/lib/imports/s3buckets-s3.services.k8s.aws.d.ts +2253 -0
- package/lib/imports/s3buckets-s3.services.k8s.aws.d.ts.map +1 -0
- package/lib/imports/s3buckets-s3.services.k8s.aws.js +1672 -0
- package/lib/imports/sfnmachines-sfn.services.k8s.aws.d.ts +203 -0
- package/lib/imports/sfnmachines-sfn.services.k8s.aws.d.ts.map +1 -0
- package/lib/imports/sfnmachines-sfn.services.k8s.aws.js +174 -0
- package/lib/imports/snstopics-sns.services.k8s.aws.d.ts +106 -0
- package/lib/imports/snstopics-sns.services.k8s.aws.d.ts.map +1 -0
- package/lib/imports/snstopics-sns.services.k8s.aws.js +110 -0
- package/lib/index.d.ts +4 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +16 -0
- package/lib/mappers/base.d.ts +23 -0
- package/lib/mappers/base.d.ts.map +1 -0
- package/lib/mappers/base.js +20 -0
- package/lib/mappers/ec2-security-group.d.ts +9 -0
- package/lib/mappers/ec2-security-group.d.ts.map +1 -0
- package/lib/mappers/ec2-security-group.js +33 -0
- package/lib/mappers/iam-policy.d.ts +9 -0
- package/lib/mappers/iam-policy.d.ts.map +1 -0
- package/lib/mappers/iam-policy.js +32 -0
- package/lib/mappers/iam-role.d.ts +9 -0
- package/lib/mappers/iam-role.d.ts.map +1 -0
- package/lib/mappers/iam-role.js +34 -0
- package/lib/mappers/index.d.ts +9 -0
- package/lib/mappers/index.d.ts.map +1 -0
- package/lib/mappers/index.js +21 -0
- package/lib/mappers/lambda-function.d.ts +9 -0
- package/lib/mappers/lambda-function.d.ts.map +1 -0
- package/lib/mappers/lambda-function.js +37 -0
- package/lib/mappers/rds-db-instance.d.ts +10 -0
- package/lib/mappers/rds-db-instance.d.ts.map +1 -0
- package/lib/mappers/rds-db-instance.js +65 -0
- package/lib/mappers/rds-db-subnet-group.d.ts +9 -0
- package/lib/mappers/rds-db-subnet-group.d.ts.map +1 -0
- package/lib/mappers/rds-db-subnet-group.js +34 -0
- package/lib/mappers/s3-bucket.d.ts +9 -0
- package/lib/mappers/s3-bucket.d.ts.map +1 -0
- package/lib/mappers/s3-bucket.js +53 -0
- package/package.json +129 -0
- package/releasetag.txt +1 -0
- package/version.txt +1 -0
|
@@ -0,0 +1,790 @@
|
|
|
1
|
+
import { ApiObject, ApiObjectMetadata, GroupVersionKind } from 'cdk8s';
|
|
2
|
+
import { Construct } from 'constructs';
|
|
3
|
+
/**
|
|
4
|
+
* DBInstance is the Schema for the DBInstances API
|
|
5
|
+
*
|
|
6
|
+
* @schema DBInstance
|
|
7
|
+
*/
|
|
8
|
+
export declare class DbInstance extends ApiObject {
|
|
9
|
+
/**
|
|
10
|
+
* Returns the apiVersion and kind for "DBInstance"
|
|
11
|
+
*/
|
|
12
|
+
static readonly GVK: GroupVersionKind;
|
|
13
|
+
/**
|
|
14
|
+
* Renders a Kubernetes manifest for "DBInstance".
|
|
15
|
+
*
|
|
16
|
+
* This can be used to inline resource manifests inside other objects (e.g. as templates).
|
|
17
|
+
*
|
|
18
|
+
* @param props initialization props
|
|
19
|
+
*/
|
|
20
|
+
static manifest(props?: DbInstanceProps): any;
|
|
21
|
+
/**
|
|
22
|
+
* Defines a "DBInstance" API object
|
|
23
|
+
* @param scope the scope in which to define this object
|
|
24
|
+
* @param id a scope-local name for the object
|
|
25
|
+
* @param props initialization props
|
|
26
|
+
*/
|
|
27
|
+
constructor(scope: Construct, id: string, props?: DbInstanceProps);
|
|
28
|
+
/**
|
|
29
|
+
* Renders the object to Kubernetes JSON.
|
|
30
|
+
*/
|
|
31
|
+
toJson(): any;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* DBInstance is the Schema for the DBInstances API
|
|
35
|
+
*
|
|
36
|
+
* @schema DBInstance
|
|
37
|
+
*/
|
|
38
|
+
export interface DbInstanceProps {
|
|
39
|
+
/**
|
|
40
|
+
* @schema DBInstance#metadata
|
|
41
|
+
*/
|
|
42
|
+
readonly metadata?: ApiObjectMetadata;
|
|
43
|
+
/**
|
|
44
|
+
* DBInstanceSpec defines the desired state of DBInstance.
|
|
45
|
+
* Contains the details of an Amazon RDS DB instance.
|
|
46
|
+
* This data type is used as a response element in the DescribeDBInstances action.
|
|
47
|
+
*
|
|
48
|
+
* @schema DBInstance#spec
|
|
49
|
+
*/
|
|
50
|
+
readonly spec?: DbInstanceSpec;
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Converts an object of type 'DbInstanceProps' to JSON representation.
|
|
54
|
+
*/
|
|
55
|
+
export declare function toJson_DbInstanceProps(obj: DbInstanceProps | undefined): Record<string, any> | undefined;
|
|
56
|
+
/**
|
|
57
|
+
* DBInstanceSpec defines the desired state of DBInstance.
|
|
58
|
+
* Contains the details of an Amazon RDS DB instance.
|
|
59
|
+
* This data type is used as a response element in the DescribeDBInstances action.
|
|
60
|
+
*
|
|
61
|
+
* @schema DbInstanceSpec
|
|
62
|
+
*/
|
|
63
|
+
export interface DbInstanceSpec {
|
|
64
|
+
/**
|
|
65
|
+
* The amount of storage in gibibytes (GiB) to allocate for the DB instance.
|
|
66
|
+
* Type: Integer
|
|
67
|
+
* Amazon Aurora
|
|
68
|
+
* Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
|
|
69
|
+
* Amazon RDS Custom
|
|
70
|
+
* Constraints to the amount of storage for each storage type are the following:
|
|
71
|
+
* * General Purpose (SSD) storage (gp2): Must be an integer from 40 to 65536.
|
|
72
|
+
* * Provisioned IOPS storage (io1): Must be an integer from 40 to 65536.
|
|
73
|
+
* MySQL
|
|
74
|
+
* Constraints to the amount of storage for each storage type are the following:
|
|
75
|
+
* * General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
|
|
76
|
+
* * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
|
|
77
|
+
* * Magnetic storage (standard): Must be an integer from 5 to 3072.
|
|
78
|
+
* MariaDB
|
|
79
|
+
* Constraints to the amount of storage for each storage type are the following:
|
|
80
|
+
* * General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
|
|
81
|
+
* * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
|
|
82
|
+
* * Magnetic storage (standard): Must be an integer from 5 to 3072.
|
|
83
|
+
* PostgreSQL
|
|
84
|
+
* Constraints to the amount of storage for each storage type are the following:
|
|
85
|
+
* * General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
|
|
86
|
+
* * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
|
|
87
|
+
* * Magnetic storage (standard): Must be an integer from 5 to 3072.
|
|
88
|
+
* Oracle
|
|
89
|
+
* Constraints to the amount of storage for each storage type are the following:
|
|
90
|
+
* * General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
|
|
91
|
+
* * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
|
|
92
|
+
* * Magnetic storage (standard): Must be an integer from 10 to 3072.
|
|
93
|
+
* SQL Server
|
|
94
|
+
* Constraints to the amount of storage for each storage type are the following:
|
|
95
|
+
* * General Purpose (SSD) storage (gp2): Enterprise and Standard editions: Must be an integer from 200 to 16384. Web and Express editions: Must be an integer from 20 to 16384.
|
|
96
|
+
* * Provisioned IOPS storage (io1): Enterprise and Standard editions: Must be an integer from 200 to 16384. Web and Express editions: Must be an integer from 100 to 16384.
|
|
97
|
+
* * Magnetic storage (standard): Enterprise and Standard editions: Must be an integer from 200 to 1024. Web and Express editions: Must be an integer from 20 to 1024.
|
|
98
|
+
*
|
|
99
|
+
* @schema DbInstanceSpec#allocatedStorage
|
|
100
|
+
*/
|
|
101
|
+
readonly allocatedStorage?: number;
|
|
102
|
+
/**
|
|
103
|
+
* A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
|
|
104
|
+
* If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to false.
|
|
105
|
+
*
|
|
106
|
+
* @schema DbInstanceSpec#autoMinorVersionUpgrade
|
|
107
|
+
*/
|
|
108
|
+
readonly autoMinorVersionUpgrade?: boolean;
|
|
109
|
+
/**
|
|
110
|
+
* The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).
|
|
111
|
+
* Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
|
|
112
|
+
* Example: us-east-1d
|
|
113
|
+
* Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
|
|
114
|
+
* If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.
|
|
115
|
+
* For more information about RDS on VMware, see the RDS on VMware User Guide. (https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html)
|
|
116
|
+
*
|
|
117
|
+
* @schema DbInstanceSpec#availabilityZone
|
|
118
|
+
*/
|
|
119
|
+
readonly availabilityZone?: string;
|
|
120
|
+
/**
|
|
121
|
+
* The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
|
|
122
|
+
* Amazon Aurora
|
|
123
|
+
* Not applicable. The retention period for automated backups is managed by the DB cluster.
|
|
124
|
+
* Default: 1
|
|
125
|
+
* Constraints:
|
|
126
|
+
* * Must be a value from 0 to 35
|
|
127
|
+
* * Can't be set to 0 if the DB instance is a source to read replicas
|
|
128
|
+
* * Can't be set to 0 or 35 for an RDS Custom DB instance
|
|
129
|
+
*
|
|
130
|
+
* @schema DbInstanceSpec#backupRetentionPeriod
|
|
131
|
+
*/
|
|
132
|
+
readonly backupRetentionPeriod?: number;
|
|
133
|
+
/**
|
|
134
|
+
* For supported engines, this value indicates that the DB instance should be associated with the specified CharacterSet.
|
|
135
|
+
* This setting doesn't apply to RDS Custom. However, if you need to change the character set, you can change it on the database itself.
|
|
136
|
+
* Amazon Aurora
|
|
137
|
+
* Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
|
|
138
|
+
*
|
|
139
|
+
* @schema DbInstanceSpec#characterSetName
|
|
140
|
+
*/
|
|
141
|
+
readonly characterSetName?: string;
|
|
142
|
+
/**
|
|
143
|
+
* A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
|
|
144
|
+
* Amazon Aurora
|
|
145
|
+
* Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
|
|
146
|
+
*
|
|
147
|
+
* @schema DbInstanceSpec#copyTagsToSnapshot
|
|
148
|
+
*/
|
|
149
|
+
readonly copyTagsToSnapshot?: boolean;
|
|
150
|
+
/**
|
|
151
|
+
* The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
|
|
152
|
+
* * The profile must exist in your account.
|
|
153
|
+
* * The profile must have an IAM role that Amazon EC2 has permissions to assume.
|
|
154
|
+
* * The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
|
|
155
|
+
* For the list of permissions required for the IAM role, see Configure IAM and your VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the Amazon Relational Database Service User Guide.
|
|
156
|
+
* This setting is required for RDS Custom.
|
|
157
|
+
*
|
|
158
|
+
* @schema DbInstanceSpec#customIAMInstanceProfile
|
|
159
|
+
*/
|
|
160
|
+
readonly customIamInstanceProfile?: string;
|
|
161
|
+
/**
|
|
162
|
+
* The identifier of the DB cluster that the instance will belong to.
|
|
163
|
+
* This setting doesn't apply to RDS Custom.
|
|
164
|
+
*
|
|
165
|
+
* @schema DbInstanceSpec#dbClusterIdentifier
|
|
166
|
+
*/
|
|
167
|
+
readonly dbClusterIdentifier?: string;
|
|
168
|
+
/**
|
|
169
|
+
* The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the Amazon RDS User Guide.
|
|
170
|
+
*
|
|
171
|
+
* @schema DbInstanceSpec#dbInstanceClass
|
|
172
|
+
*/
|
|
173
|
+
readonly dbInstanceClass: string;
|
|
174
|
+
/**
|
|
175
|
+
* The DB instance identifier. This parameter is stored as a lowercase string.
|
|
176
|
+
* Constraints:
|
|
177
|
+
* * Must contain from 1 to 63 letters, numbers, or hyphens.
|
|
178
|
+
* * First character must be a letter.
|
|
179
|
+
* * Can't end with a hyphen or contain two consecutive hyphens.
|
|
180
|
+
* Example: mydbinstance
|
|
181
|
+
*
|
|
182
|
+
* @schema DbInstanceSpec#dbInstanceIdentifier
|
|
183
|
+
*/
|
|
184
|
+
readonly dbInstanceIdentifier: string;
|
|
185
|
+
/**
|
|
186
|
+
* The meaning of this parameter differs according to the database engine you use.
|
|
187
|
+
* MySQL
|
|
188
|
+
* The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
|
|
189
|
+
* Constraints:
|
|
190
|
+
* * Must contain 1 to 64 letters or numbers.
|
|
191
|
+
* * Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
|
|
192
|
+
* * Can't be a word reserved by the specified database engine
|
|
193
|
+
* MariaDB
|
|
194
|
+
* The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
|
|
195
|
+
* Constraints:
|
|
196
|
+
* * Must contain 1 to 64 letters or numbers.
|
|
197
|
+
* * Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
|
|
198
|
+
* * Can't be a word reserved by the specified database engine
|
|
199
|
+
* PostgreSQL
|
|
200
|
+
* The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres is created in the DB instance.
|
|
201
|
+
* Constraints:
|
|
202
|
+
* * Must contain 1 to 63 letters, numbers, or underscores.
|
|
203
|
+
* * Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
|
|
204
|
+
* * Can't be a word reserved by the specified database engine
|
|
205
|
+
* Oracle
|
|
206
|
+
* The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName.
|
|
207
|
+
* Default: ORCL
|
|
208
|
+
* Constraints:
|
|
209
|
+
* * Can't be longer than 8 characters
|
|
210
|
+
* Amazon RDS Custom
|
|
211
|
+
* The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is ORCL.
|
|
212
|
+
* Default: ORCL
|
|
213
|
+
* Constraints:
|
|
214
|
+
* * It must contain 1 to 8 alphanumeric characters.
|
|
215
|
+
* * It must contain a letter.
|
|
216
|
+
* * It can't be a word reserved by the database engine.
|
|
217
|
+
* SQL Server
|
|
218
|
+
* Not applicable. Must be null.
|
|
219
|
+
* Amazon Aurora MySQL
|
|
220
|
+
* The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster.
|
|
221
|
+
* Constraints:
|
|
222
|
+
* * It must contain 1 to 64 alphanumeric characters.
|
|
223
|
+
* * It can't be a word reserved by the database engine.
|
|
224
|
+
* Amazon Aurora PostgreSQL
|
|
225
|
+
* The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, a database named postgres is created in the DB cluster.
|
|
226
|
+
* Constraints:
|
|
227
|
+
* * It must contain 1 to 63 alphanumeric characters.
|
|
228
|
+
* * It must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0 to 9).
|
|
229
|
+
* * It can't be a word reserved by the database engine.
|
|
230
|
+
*
|
|
231
|
+
* @schema DbInstanceSpec#dbName
|
|
232
|
+
*/
|
|
233
|
+
readonly dbName?: string;
|
|
234
|
+
/**
|
|
235
|
+
* The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used.
|
|
236
|
+
* This setting doesn't apply to RDS Custom.
|
|
237
|
+
* Constraints:
|
|
238
|
+
* * Must be 1 to 255 letters, numbers, or hyphens.
|
|
239
|
+
* * First character must be a letter
|
|
240
|
+
* * Can't end with a hyphen or contain two consecutive hyphens
|
|
241
|
+
*
|
|
242
|
+
* @schema DbInstanceSpec#dbParameterGroupName
|
|
243
|
+
*/
|
|
244
|
+
readonly dbParameterGroupName?: string;
|
|
245
|
+
/**
|
|
246
|
+
* A list of DB security groups to associate with this DB instance.
|
|
247
|
+
* Default: The default DB security group for the database engine.
|
|
248
|
+
*
|
|
249
|
+
* @schema DbInstanceSpec#dbSecurityGroups
|
|
250
|
+
*/
|
|
251
|
+
readonly dbSecurityGroups?: string[];
|
|
252
|
+
/**
|
|
253
|
+
* A DB subnet group to associate with this DB instance.
|
|
254
|
+
* If there is no DB subnet group, then it is a non-VPC DB instance.
|
|
255
|
+
*
|
|
256
|
+
* @schema DbInstanceSpec#dbSubnetGroupName
|
|
257
|
+
*/
|
|
258
|
+
readonly dbSubnetGroupName?: string;
|
|
259
|
+
/**
|
|
260
|
+
* A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
|
|
261
|
+
* Amazon Aurora
|
|
262
|
+
* Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
|
|
263
|
+
*
|
|
264
|
+
* @schema DbInstanceSpec#deletionProtection
|
|
265
|
+
*/
|
|
266
|
+
readonly deletionProtection?: boolean;
|
|
267
|
+
/**
|
|
268
|
+
* The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
|
|
269
|
+
* For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the Amazon RDS User Guide.
|
|
270
|
+
* This setting doesn't apply to RDS Custom.
|
|
271
|
+
*
|
|
272
|
+
* @schema DbInstanceSpec#domain
|
|
273
|
+
*/
|
|
274
|
+
readonly domain?: string;
|
|
275
|
+
/**
|
|
276
|
+
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
|
277
|
+
* This setting doesn't apply to RDS Custom.
|
|
278
|
+
*
|
|
279
|
+
* @schema DbInstanceSpec#domainIAMRoleName
|
|
280
|
+
*/
|
|
281
|
+
readonly domainIamRoleName?: string;
|
|
282
|
+
/**
|
|
283
|
+
* The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine. For more information, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the Amazon Relational Database Service User Guide.
|
|
284
|
+
* Amazon Aurora
|
|
285
|
+
* Not applicable. CloudWatch Logs exports are managed by the DB cluster.
|
|
286
|
+
* RDS Custom
|
|
287
|
+
* Not applicable.
|
|
288
|
+
* MariaDB
|
|
289
|
+
* Possible values are audit, error, general, and slowquery.
|
|
290
|
+
* Microsoft SQL Server
|
|
291
|
+
* Possible values are agent and error.
|
|
292
|
+
* MySQL
|
|
293
|
+
* Possible values are audit, error, general, and slowquery.
|
|
294
|
+
* Oracle
|
|
295
|
+
* Possible values are alert, audit, listener, trace, and oemagent.
|
|
296
|
+
* PostgreSQL
|
|
297
|
+
* Possible values are postgresql and upgrade.
|
|
298
|
+
*
|
|
299
|
+
* @schema DbInstanceSpec#enableCloudwatchLogsExports
|
|
300
|
+
*/
|
|
301
|
+
readonly enableCloudwatchLogsExports?: string[];
|
|
302
|
+
/**
|
|
303
|
+
* A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
|
|
304
|
+
* A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
|
|
305
|
+
* For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the Amazon RDS User Guide.
|
|
306
|
+
* For more information about CoIPs, see Customer-owned IP addresses (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing) in the Amazon Web Services Outposts User Guide.
|
|
307
|
+
*
|
|
308
|
+
* @schema DbInstanceSpec#enableCustomerOwnedIP
|
|
309
|
+
*/
|
|
310
|
+
readonly enableCustomerOwnedIp?: boolean;
|
|
311
|
+
/**
|
|
312
|
+
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
|
|
313
|
+
* This setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora, mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
|
|
314
|
+
* For more information, see IAM Database Authentication for MySQL and PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the Amazon RDS User Guide.
|
|
315
|
+
*
|
|
316
|
+
* @schema DbInstanceSpec#enableIAMDatabaseAuthentication
|
|
317
|
+
*/
|
|
318
|
+
readonly enableIamDatabaseAuthentication?: boolean;
|
|
319
|
+
/**
|
|
320
|
+
* The name of the database engine to be used for this instance.
|
|
321
|
+
* Not every database engine is available for every Amazon Web Services Region.
|
|
322
|
+
* Valid Values:
|
|
323
|
+
* * aurora (for MySQL 5.6-compatible Aurora)
|
|
324
|
+
* * aurora-mysql (for MySQL 5.7-compatible Aurora)
|
|
325
|
+
* * aurora-postgresql
|
|
326
|
+
* * custom-oracle-ee (for RDS Custom instances)
|
|
327
|
+
* * mariadb
|
|
328
|
+
* * mysql
|
|
329
|
+
* * oracle-ee
|
|
330
|
+
* * oracle-ee-cdb
|
|
331
|
+
* * oracle-se2
|
|
332
|
+
* * oracle-se2-cdb
|
|
333
|
+
* * postgres
|
|
334
|
+
* * sqlserver-ee
|
|
335
|
+
* * sqlserver-se
|
|
336
|
+
* * sqlserver-ex
|
|
337
|
+
* * sqlserver-web
|
|
338
|
+
*
|
|
339
|
+
* @schema DbInstanceSpec#engine
|
|
340
|
+
*/
|
|
341
|
+
readonly engine: string;
|
|
342
|
+
/**
|
|
343
|
+
* The version number of the database engine to use.
|
|
344
|
+
* For a list of valid engine versions, use the DescribeDBEngineVersions action.
|
|
345
|
+
* The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
|
|
346
|
+
* Amazon Aurora
|
|
347
|
+
* Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.
|
|
348
|
+
* Amazon RDS Custom
|
|
349
|
+
* A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom. The CEV name has the following format: 19.customized_string . An example identifier is 19.my_cev1. For more information, see Creating an RDS Custom DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create) in the Amazon RDS User Guide..
|
|
350
|
+
* MariaDB
|
|
351
|
+
* See MariaDB on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the Amazon RDS User Guide.
|
|
352
|
+
* Microsoft SQL Server
|
|
353
|
+
* See Microsoft SQL Server Versions on Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the Amazon RDS User Guide.
|
|
354
|
+
* MySQL
|
|
355
|
+
* See MySQL on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the Amazon RDS User Guide.
|
|
356
|
+
* Oracle
|
|
357
|
+
* See Oracle Database Engine Release Notes (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the Amazon RDS User Guide.
|
|
358
|
+
* PostgreSQL
|
|
359
|
+
* See Amazon RDS for PostgreSQL versions and extensions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) in the Amazon RDS User Guide.
|
|
360
|
+
*
|
|
361
|
+
* @schema DbInstanceSpec#engineVersion
|
|
362
|
+
*/
|
|
363
|
+
readonly engineVersion?: string;
|
|
364
|
+
/**
|
|
365
|
+
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the Amazon RDS User Guide.
|
|
366
|
+
* Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.
|
|
367
|
+
*
|
|
368
|
+
* @schema DbInstanceSpec#iops
|
|
369
|
+
*/
|
|
370
|
+
readonly iops?: number;
|
|
371
|
+
/**
|
|
372
|
+
* The Amazon Web Services KMS key identifier for an encrypted DB instance.
|
|
373
|
+
* The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
|
|
374
|
+
* Amazon Aurora
|
|
375
|
+
* Not applicable. The Amazon Web Services KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.
|
|
376
|
+
* If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
|
|
377
|
+
* Amazon RDS Custom
|
|
378
|
+
* A KMS key is required for RDS Custom Oracle instances. For most RDS engines, if you leave this parameter empty while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom for Oracle doesn't use the default key when this parameter is empty. You must explicitly specify a key.
|
|
379
|
+
*
|
|
380
|
+
* @schema DbInstanceSpec#kmsKeyID
|
|
381
|
+
*/
|
|
382
|
+
readonly kmsKeyId?: string;
|
|
383
|
+
/**
|
|
384
|
+
* AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using 'from' field Ex: APIIDRef: from: name: my-api
|
|
385
|
+
*
|
|
386
|
+
* @schema DbInstanceSpec#kmsKeyRef
|
|
387
|
+
*/
|
|
388
|
+
readonly kmsKeyRef?: DbInstanceSpecKmsKeyRef;
|
|
389
|
+
/**
|
|
390
|
+
* License model information for this DB instance.
|
|
391
|
+
* Valid values: license-included | bring-your-own-license | general-public-license
|
|
392
|
+
* This setting doesn't apply to RDS Custom.
|
|
393
|
+
*
|
|
394
|
+
* @schema DbInstanceSpec#licenseModel
|
|
395
|
+
*/
|
|
396
|
+
readonly licenseModel?: string;
|
|
397
|
+
/**
|
|
398
|
+
* The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
|
|
399
|
+
* Amazon Aurora
|
|
400
|
+
* Not applicable. The password for the master user is managed by the DB cluster.
|
|
401
|
+
* MariaDB
|
|
402
|
+
* Constraints: Must contain from 8 to 41 characters.
|
|
403
|
+
* Microsoft SQL Server
|
|
404
|
+
* Constraints: Must contain from 8 to 128 characters.
|
|
405
|
+
* MySQL
|
|
406
|
+
* Constraints: Must contain from 8 to 41 characters.
|
|
407
|
+
* Oracle
|
|
408
|
+
* Constraints: Must contain from 8 to 30 characters.
|
|
409
|
+
* PostgreSQL
|
|
410
|
+
* Constraints: Must contain from 8 to 128 characters.
|
|
411
|
+
*
|
|
412
|
+
* @schema DbInstanceSpec#masterUserPassword
|
|
413
|
+
*/
|
|
414
|
+
readonly masterUserPassword?: DbInstanceSpecMasterUserPassword;
|
|
415
|
+
/**
|
|
416
|
+
* The name for the master user.
|
|
417
|
+
* Amazon Aurora
|
|
418
|
+
* Not applicable. The name for the master user is managed by the DB cluster.
|
|
419
|
+
* MariaDB
|
|
420
|
+
* Constraints:
|
|
421
|
+
* * Required for MariaDB.
|
|
422
|
+
* * Must be 1 to 16 letters or numbers.
|
|
423
|
+
* * Can't be a reserved word for the chosen database engine.
|
|
424
|
+
* Microsoft SQL Server
|
|
425
|
+
* Constraints:
|
|
426
|
+
* * Required for SQL Server.
|
|
427
|
+
* * Must be 1 to 128 letters or numbers.
|
|
428
|
+
* * The first character must be a letter.
|
|
429
|
+
* * Can't be a reserved word for the chosen database engine.
|
|
430
|
+
* MySQL
|
|
431
|
+
* Constraints:
|
|
432
|
+
* * Required for MySQL.
|
|
433
|
+
* * Must be 1 to 16 letters or numbers.
|
|
434
|
+
* * First character must be a letter.
|
|
435
|
+
* * Can't be a reserved word for the chosen database engine.
|
|
436
|
+
* Oracle
|
|
437
|
+
* Constraints:
|
|
438
|
+
* * Required for Oracle.
|
|
439
|
+
* * Must be 1 to 30 letters or numbers.
|
|
440
|
+
* * First character must be a letter.
|
|
441
|
+
* * Can't be a reserved word for the chosen database engine.
|
|
442
|
+
* PostgreSQL
|
|
443
|
+
* Constraints:
|
|
444
|
+
* * Required for PostgreSQL.
|
|
445
|
+
* * Must be 1 to 63 letters or numbers.
|
|
446
|
+
* * First character must be a letter.
|
|
447
|
+
* * Can't be a reserved word for the chosen database engine.
|
|
448
|
+
*
|
|
449
|
+
* @schema DbInstanceSpec#masterUsername
|
|
450
|
+
*/
|
|
451
|
+
readonly masterUsername?: string;
|
|
452
|
+
/**
|
|
453
|
+
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
|
|
454
|
+
* For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the Amazon RDS User Guide.
|
|
455
|
+
* This setting doesn't apply to RDS Custom.
|
|
456
|
+
*
|
|
457
|
+
* @schema DbInstanceSpec#maxAllocatedStorage
|
|
458
|
+
*/
|
|
459
|
+
readonly maxAllocatedStorage?: number;
|
|
460
|
+
/**
|
|
461
|
+
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.
|
|
462
|
+
* If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.
|
|
463
|
+
* This setting doesn't apply to RDS Custom.
|
|
464
|
+
* Valid Values: 0, 1, 5, 10, 15, 30, 60
|
|
465
|
+
*
|
|
466
|
+
* @schema DbInstanceSpec#monitoringInterval
|
|
467
|
+
*/
|
|
468
|
+
readonly monitoringInterval?: number;
|
|
469
|
+
/**
|
|
470
|
+
* The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the Amazon RDS User Guide.
|
|
471
|
+
* If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
|
|
472
|
+
* This setting doesn't apply to RDS Custom.
|
|
473
|
+
*
|
|
474
|
+
* @schema DbInstanceSpec#monitoringRoleARN
|
|
475
|
+
*/
|
|
476
|
+
readonly monitoringRoleArn?: string;
|
|
477
|
+
/**
|
|
478
|
+
* A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
|
|
479
|
+
* This setting doesn't apply to RDS Custom.
|
|
480
|
+
*
|
|
481
|
+
* @schema DbInstanceSpec#multiAZ
|
|
482
|
+
*/
|
|
483
|
+
readonly multiAz?: boolean;
|
|
484
|
+
/**
|
|
485
|
+
* The name of the NCHAR character set for the Oracle DB instance.
|
|
486
|
+
* This parameter doesn't apply to RDS Custom.
|
|
487
|
+
*
|
|
488
|
+
* @schema DbInstanceSpec#ncharCharacterSetName
|
|
489
|
+
*/
|
|
490
|
+
readonly ncharCharacterSetName?: string;
|
|
491
|
+
/**
|
|
492
|
+
* A value that indicates that the DB instance should be associated with the specified option group.
|
|
493
|
+
* Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance after it is associated with a DB instance.
|
|
494
|
+
* This setting doesn't apply to RDS Custom.
|
|
495
|
+
*
|
|
496
|
+
* @schema DbInstanceSpec#optionGroupName
|
|
497
|
+
*/
|
|
498
|
+
readonly optionGroupName?: string;
|
|
499
|
+
/**
|
|
500
|
+
* A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the Amazon Relational Database Service User Guide.
|
|
501
|
+
* This setting doesn't apply to RDS Custom.
|
|
502
|
+
*
|
|
503
|
+
* @schema DbInstanceSpec#performanceInsightsEnabled
|
|
504
|
+
*/
|
|
505
|
+
readonly performanceInsightsEnabled?: boolean;
|
|
506
|
+
/**
|
|
507
|
+
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
|
508
|
+
* The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
509
|
+
* If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
|
|
510
|
+
* This setting doesn't apply to RDS Custom.
|
|
511
|
+
*
|
|
512
|
+
* @schema DbInstanceSpec#performanceInsightsKMSKeyID
|
|
513
|
+
*/
|
|
514
|
+
readonly performanceInsightsKmsKeyId?: string;
|
|
515
|
+
/**
|
|
516
|
+
* The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
|
|
517
|
+
* This setting doesn't apply to RDS Custom.
|
|
518
|
+
*
|
|
519
|
+
* @schema DbInstanceSpec#performanceInsightsRetentionPeriod
|
|
520
|
+
*/
|
|
521
|
+
readonly performanceInsightsRetentionPeriod?: number;
|
|
522
|
+
/**
|
|
523
|
+
* The port number on which the database accepts connections.
|
|
524
|
+
* MySQL
|
|
525
|
+
* Default: 3306
|
|
526
|
+
* Valid values: 1150-65535
|
|
527
|
+
* Type: Integer
|
|
528
|
+
* MariaDB
|
|
529
|
+
* Default: 3306
|
|
530
|
+
* Valid values: 1150-65535
|
|
531
|
+
* Type: Integer
|
|
532
|
+
* PostgreSQL
|
|
533
|
+
* Default: 5432
|
|
534
|
+
* Valid values: 1150-65535
|
|
535
|
+
* Type: Integer
|
|
536
|
+
* Oracle
|
|
537
|
+
* Default: 1521
|
|
538
|
+
* Valid values: 1150-65535
|
|
539
|
+
* SQL Server
|
|
540
|
+
* Default: 1433
|
|
541
|
+
* Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.
|
|
542
|
+
* Amazon Aurora
|
|
543
|
+
* Default: 3306
|
|
544
|
+
* Valid values: 1150-65535
|
|
545
|
+
* Type: Integer
|
|
546
|
+
*
|
|
547
|
+
* @schema DbInstanceSpec#port
|
|
548
|
+
*/
|
|
549
|
+
readonly port?: number;
|
|
550
|
+
/**
|
|
551
|
+
* The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the Amazon RDS User Guide.
|
|
552
|
+
* Amazon Aurora
|
|
553
|
+
* Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
|
|
554
|
+
* Constraints:
|
|
555
|
+
* * Must be in the format hh24:mi-hh24:mi.
|
|
556
|
+
* * Must be in Universal Coordinated Time (UTC).
|
|
557
|
+
* * Must not conflict with the preferred maintenance window.
|
|
558
|
+
* * Must be at least 30 minutes.
|
|
559
|
+
*
|
|
560
|
+
* @schema DbInstanceSpec#preferredBackupWindow
|
|
561
|
+
*/
|
|
562
|
+
readonly preferredBackupWindow?: string;
|
|
563
|
+
/**
|
|
564
|
+
* The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance).
|
|
565
|
+
* Format: ddd:hh24:mi-ddd:hh24:mi
|
|
566
|
+
* 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.
|
|
567
|
+
* Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
|
|
568
|
+
* Constraints: Minimum 30-minute window.
|
|
569
|
+
*
|
|
570
|
+
* @schema DbInstanceSpec#preferredMaintenanceWindow
|
|
571
|
+
*/
|
|
572
|
+
readonly preferredMaintenanceWindow?: string;
|
|
573
|
+
/**
|
|
574
|
+
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
|
575
|
+
* This setting doesn't apply to RDS Custom.
|
|
576
|
+
*
|
|
577
|
+
* @schema DbInstanceSpec#processorFeatures
|
|
578
|
+
*/
|
|
579
|
+
readonly processorFeatures?: DbInstanceSpecProcessorFeatures[];
|
|
580
|
+
/**
|
|
581
|
+
* A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) in the Amazon Aurora User Guide.
|
|
582
|
+
* This setting doesn't apply to RDS Custom.
|
|
583
|
+
* Default: 1
|
|
584
|
+
* Valid Values: 0 - 15
|
|
585
|
+
*
|
|
586
|
+
* @schema DbInstanceSpec#promotionTier
|
|
587
|
+
*/
|
|
588
|
+
readonly promotionTier?: number;
|
|
589
|
+
/**
|
|
590
|
+
* A value that indicates whether the DB instance is publicly accessible.
|
|
591
|
+
* When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
|
|
592
|
+
* When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
|
|
593
|
+
* Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
|
|
594
|
+
* If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
|
|
595
|
+
* * If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.
|
|
596
|
+
* * If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.
|
|
597
|
+
* If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
|
|
598
|
+
* * If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.
|
|
599
|
+
* * If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.
|
|
600
|
+
*
|
|
601
|
+
* @schema DbInstanceSpec#publiclyAccessible
|
|
602
|
+
*/
|
|
603
|
+
readonly publiclyAccessible?: boolean;
|
|
604
|
+
/**
|
|
605
|
+
* A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
|
|
606
|
+
* For RDS Custom Oracle instances, either set this parameter to true or leave it unset. If you set this parameter to false, RDS reports an error.
|
|
607
|
+
* Amazon Aurora
|
|
608
|
+
* Not applicable. The encryption for DB instances is managed by the DB cluster.
|
|
609
|
+
*
|
|
610
|
+
* @schema DbInstanceSpec#storageEncrypted
|
|
611
|
+
*/
|
|
612
|
+
readonly storageEncrypted?: boolean;
|
|
613
|
+
/**
|
|
614
|
+
* Specifies the storage type to be associated with the DB instance.
|
|
615
|
+
* Valid values: standard | gp2 | io1
|
|
616
|
+
* If you specify io1, you must also include a value for the Iops parameter.
|
|
617
|
+
* Default: io1 if the Iops parameter is specified, otherwise gp2
|
|
618
|
+
*
|
|
619
|
+
* @schema DbInstanceSpec#storageType
|
|
620
|
+
*/
|
|
621
|
+
readonly storageType?: string;
|
|
622
|
+
/**
|
|
623
|
+
* Tags to assign to the DB instance.
|
|
624
|
+
*
|
|
625
|
+
* @schema DbInstanceSpec#tags
|
|
626
|
+
*/
|
|
627
|
+
readonly tags?: DbInstanceSpecTags[];
|
|
628
|
+
/**
|
|
629
|
+
* The ARN from the key store with which to associate the instance for TDE encryption.
|
|
630
|
+
* This setting doesn't apply to RDS Custom.
|
|
631
|
+
*
|
|
632
|
+
* @schema DbInstanceSpec#tdeCredentialARN
|
|
633
|
+
*/
|
|
634
|
+
readonly tdeCredentialArn?: string;
|
|
635
|
+
/**
|
|
636
|
+
* The password for the given ARN from the key store in order to access the device.
|
|
637
|
+
* This setting doesn't apply to RDS Custom.
|
|
638
|
+
*
|
|
639
|
+
* @schema DbInstanceSpec#tdeCredentialPassword
|
|
640
|
+
*/
|
|
641
|
+
readonly tdeCredentialPassword?: string;
|
|
642
|
+
/**
|
|
643
|
+
* The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone).
|
|
644
|
+
*
|
|
645
|
+
* @schema DbInstanceSpec#timezone
|
|
646
|
+
*/
|
|
647
|
+
readonly timezone?: string;
|
|
648
|
+
/**
|
|
649
|
+
* A list of Amazon EC2 VPC security groups to associate with this DB instance.
|
|
650
|
+
* Amazon Aurora
|
|
651
|
+
* Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.
|
|
652
|
+
* Default: The default EC2 VPC security group for the DB subnet group's VPC.
|
|
653
|
+
*
|
|
654
|
+
* @schema DbInstanceSpec#vpcSecurityGroupIDs
|
|
655
|
+
*/
|
|
656
|
+
readonly vpcSecurityGroupIDs?: string[];
|
|
657
|
+
}
|
|
658
|
+
/**
|
|
659
|
+
* Converts an object of type 'DbInstanceSpec' to JSON representation.
|
|
660
|
+
*/
|
|
661
|
+
export declare function toJson_DbInstanceSpec(obj: DbInstanceSpec | undefined): Record<string, any> | undefined;
|
|
662
|
+
/**
|
|
663
|
+
* AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using 'from' field Ex: APIIDRef: from: name: my-api
|
|
664
|
+
*
|
|
665
|
+
* @schema DbInstanceSpecKmsKeyRef
|
|
666
|
+
*/
|
|
667
|
+
export interface DbInstanceSpecKmsKeyRef {
|
|
668
|
+
/**
|
|
669
|
+
* AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)
|
|
670
|
+
*
|
|
671
|
+
* @schema DbInstanceSpecKmsKeyRef#from
|
|
672
|
+
*/
|
|
673
|
+
readonly from?: DbInstanceSpecKmsKeyRefFrom;
|
|
674
|
+
}
|
|
675
|
+
/**
|
|
676
|
+
* Converts an object of type 'DbInstanceSpecKmsKeyRef' to JSON representation.
|
|
677
|
+
*/
|
|
678
|
+
export declare function toJson_DbInstanceSpecKmsKeyRef(obj: DbInstanceSpecKmsKeyRef | undefined): Record<string, any> | undefined;
|
|
679
|
+
/**
|
|
680
|
+
* The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
|
|
681
|
+
* Amazon Aurora
|
|
682
|
+
* Not applicable. The password for the master user is managed by the DB cluster.
|
|
683
|
+
* MariaDB
|
|
684
|
+
* Constraints: Must contain from 8 to 41 characters.
|
|
685
|
+
* Microsoft SQL Server
|
|
686
|
+
* Constraints: Must contain from 8 to 128 characters.
|
|
687
|
+
* MySQL
|
|
688
|
+
* Constraints: Must contain from 8 to 41 characters.
|
|
689
|
+
* Oracle
|
|
690
|
+
* Constraints: Must contain from 8 to 30 characters.
|
|
691
|
+
* PostgreSQL
|
|
692
|
+
* Constraints: Must contain from 8 to 128 characters.
|
|
693
|
+
*
|
|
694
|
+
* @schema DbInstanceSpecMasterUserPassword
|
|
695
|
+
*/
|
|
696
|
+
export interface DbInstanceSpecMasterUserPassword {
|
|
697
|
+
/**
|
|
698
|
+
* Key is the key within the secret
|
|
699
|
+
*
|
|
700
|
+
* @schema DbInstanceSpecMasterUserPassword#key
|
|
701
|
+
*/
|
|
702
|
+
readonly key: string;
|
|
703
|
+
/**
|
|
704
|
+
* Name is unique within a namespace to reference a secret resource.
|
|
705
|
+
*
|
|
706
|
+
* @schema DbInstanceSpecMasterUserPassword#name
|
|
707
|
+
*/
|
|
708
|
+
readonly name?: string;
|
|
709
|
+
/**
|
|
710
|
+
* Namespace defines the space within which the secret name must be unique.
|
|
711
|
+
*
|
|
712
|
+
* @schema DbInstanceSpecMasterUserPassword#namespace
|
|
713
|
+
*/
|
|
714
|
+
readonly namespace?: string;
|
|
715
|
+
}
|
|
716
|
+
/**
|
|
717
|
+
* Converts an object of type 'DbInstanceSpecMasterUserPassword' to JSON representation.
|
|
718
|
+
*/
|
|
719
|
+
export declare function toJson_DbInstanceSpecMasterUserPassword(obj: DbInstanceSpecMasterUserPassword | undefined): Record<string, any> | undefined;
|
|
720
|
+
/**
|
|
721
|
+
* Contains the processor features of a DB instance class.
|
|
722
|
+
* To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
|
|
723
|
+
* You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
|
|
724
|
+
* * CreateDBInstance
|
|
725
|
+
* * ModifyDBInstance
|
|
726
|
+
* * RestoreDBInstanceFromDBSnapshot
|
|
727
|
+
* * RestoreDBInstanceFromS3
|
|
728
|
+
* * RestoreDBInstanceToPointInTime
|
|
729
|
+
* You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
|
|
730
|
+
* In addition, you can use the following actions for DB instance class processor information:
|
|
731
|
+
* * DescribeDBInstances
|
|
732
|
+
* * DescribeDBSnapshots
|
|
733
|
+
* * DescribeValidDBInstanceModifications
|
|
734
|
+
* If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:
|
|
735
|
+
* * You are accessing an Oracle DB instance.
|
|
736
|
+
* * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.
|
|
737
|
+
* * The current number CPU cores and threads is set to a non-default value.
|
|
738
|
+
* For more information, see Configuring the Processor of the DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor) in the Amazon RDS User Guide.
|
|
739
|
+
*
|
|
740
|
+
* @schema DbInstanceSpecProcessorFeatures
|
|
741
|
+
*/
|
|
742
|
+
export interface DbInstanceSpecProcessorFeatures {
|
|
743
|
+
/**
|
|
744
|
+
* @schema DbInstanceSpecProcessorFeatures#name
|
|
745
|
+
*/
|
|
746
|
+
readonly name?: string;
|
|
747
|
+
/**
|
|
748
|
+
* @schema DbInstanceSpecProcessorFeatures#value
|
|
749
|
+
*/
|
|
750
|
+
readonly value?: string;
|
|
751
|
+
}
|
|
752
|
+
/**
|
|
753
|
+
* Converts an object of type 'DbInstanceSpecProcessorFeatures' to JSON representation.
|
|
754
|
+
*/
|
|
755
|
+
export declare function toJson_DbInstanceSpecProcessorFeatures(obj: DbInstanceSpecProcessorFeatures | undefined): Record<string, any> | undefined;
|
|
756
|
+
/**
|
|
757
|
+
* Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
|
|
758
|
+
*
|
|
759
|
+
* @schema DbInstanceSpecTags
|
|
760
|
+
*/
|
|
761
|
+
export interface DbInstanceSpecTags {
|
|
762
|
+
/**
|
|
763
|
+
* @schema DbInstanceSpecTags#key
|
|
764
|
+
*/
|
|
765
|
+
readonly key?: string;
|
|
766
|
+
/**
|
|
767
|
+
* @schema DbInstanceSpecTags#value
|
|
768
|
+
*/
|
|
769
|
+
readonly value?: string;
|
|
770
|
+
}
|
|
771
|
+
/**
|
|
772
|
+
* Converts an object of type 'DbInstanceSpecTags' to JSON representation.
|
|
773
|
+
*/
|
|
774
|
+
export declare function toJson_DbInstanceSpecTags(obj: DbInstanceSpecTags | undefined): Record<string, any> | undefined;
|
|
775
|
+
/**
|
|
776
|
+
* AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)
|
|
777
|
+
*
|
|
778
|
+
* @schema DbInstanceSpecKmsKeyRefFrom
|
|
779
|
+
*/
|
|
780
|
+
export interface DbInstanceSpecKmsKeyRefFrom {
|
|
781
|
+
/**
|
|
782
|
+
* @schema DbInstanceSpecKmsKeyRefFrom#name
|
|
783
|
+
*/
|
|
784
|
+
readonly name?: string;
|
|
785
|
+
}
|
|
786
|
+
/**
|
|
787
|
+
* Converts an object of type 'DbInstanceSpecKmsKeyRefFrom' to JSON representation.
|
|
788
|
+
*/
|
|
789
|
+
export declare function toJson_DbInstanceSpecKmsKeyRefFrom(obj: DbInstanceSpecKmsKeyRefFrom | undefined): Record<string, any> | undefined;
|
|
790
|
+
//# sourceMappingURL=rdsdbinstances-rds.services.k8s.aws.d.ts.map
|