@horietakehiro/aws-cdk-utul 0.40.3 → 0.41.0
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/lib/types/cfn-resource-types/aws-bedrock-guardrail.d.ts +20 -0
- package/lib/types/cfn-resource-types/aws-bedrock-guardrail.js +1 -1
- package/lib/types/cfn-resource-types/aws-cassandra-table.d.ts +16 -0
- package/lib/types/cfn-resource-types/aws-cassandra-table.js +1 -1
- package/lib/types/cfn-resource-types/aws-connect-rule.d.ts +4 -4
- package/lib/types/cfn-resource-types/aws-connect-rule.js +1 -1
- package/lib/types/cfn-resource-types/aws-dynamodb-globaltable.d.ts +108 -99
- package/lib/types/cfn-resource-types/aws-dynamodb-globaltable.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-trafficmirrortarget.d.ts +16 -1
- package/lib/types/cfn-resource-types/aws-ec2-trafficmirrortarget.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-vpcendpoint.d.ts +3 -0
- package/lib/types/cfn-resource-types/aws-ec2-vpcendpoint.js +1 -1
- package/lib/types/cfn-resource-types/aws-ecs-service.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-ecs-service.js +1 -1
- package/lib/types/cfn-resource-types/aws-ecs-taskdefinition.d.ts +1 -13
- package/lib/types/cfn-resource-types/aws-ecs-taskdefinition.js +1 -1
- package/lib/types/cfn-resource-types/aws-events-eventbus.d.ts +19 -19
- package/lib/types/cfn-resource-types/aws-events-eventbus.js +1 -1
- package/lib/types/cfn-resource-types/aws-imagebuilder-component.d.ts +2 -4
- package/lib/types/cfn-resource-types/aws-imagebuilder-component.js +1 -1
- package/lib/types/cfn-resource-types/aws-imagebuilder-workflow.d.ts +2 -4
- package/lib/types/cfn-resource-types/aws-imagebuilder-workflow.js +1 -1
- package/lib/types/cfn-resource-types/aws-kinesis-streamconsumer.d.ts +34 -1
- package/lib/types/cfn-resource-types/aws-kinesis-streamconsumer.js +1 -1
- package/lib/types/cfn-resource-types/aws-odb-cloudautonomousvmcluster.d.ts +220 -0
- package/lib/types/cfn-resource-types/aws-odb-cloudautonomousvmcluster.js +3 -0
- package/lib/types/cfn-resource-types/aws-odb-cloudexadatainfrastructure.d.ts +151 -0
- package/lib/types/cfn-resource-types/aws-odb-cloudexadatainfrastructure.js +3 -0
- package/lib/types/cfn-resource-types/aws-odb-cloudvmcluster.d.ts +172 -0
- package/lib/types/cfn-resource-types/aws-odb-cloudvmcluster.js +3 -0
- package/lib/types/cfn-resource-types/aws-odb-odbnetwork.d.ts +70 -0
- package/lib/types/cfn-resource-types/aws-odb-odbnetwork.js +3 -0
- package/lib/types/cfn-resource-types/aws-pcs-cluster.d.ts +32 -32
- package/lib/types/cfn-resource-types/aws-pcs-cluster.js +1 -1
- package/lib/types/cfn-resource-types/aws-qbusiness-dataaccessor.d.ts +18 -0
- package/lib/types/cfn-resource-types/aws-qbusiness-dataaccessor.js +1 -1
- package/lib/types/cfn-resource-types/aws-qbusiness-permission.d.ts +14 -0
- package/lib/types/cfn-resource-types/aws-qbusiness-permission.js +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-custompermissions.d.ts +24 -18
- package/lib/types/cfn-resource-types/aws-quicksight-custompermissions.js +1 -1
- package/lib/types/cfn-resource-types/aws-rds-dbinstance.d.ts +558 -557
- package/lib/types/cfn-resource-types/aws-rds-dbinstance.js +1 -1
- package/lib/types/cfn-resource-types/aws-redshiftserverless-snapshot.d.ts +49 -0
- package/lib/types/cfn-resource-types/aws-redshiftserverless-snapshot.js +3 -0
- package/lib/types/cfn-resource-types/aws-s3tables-table.d.ts +111 -0
- package/lib/types/cfn-resource-types/aws-s3tables-table.js +3 -0
- package/lib/types/cfn-resource-types.d.ts +12 -0
- package/lib/types/cfn-resource-types.js +23 -11
- package/package.json +2 -5
|
@@ -23,69 +23,217 @@
|
|
|
23
23
|
*/
|
|
24
24
|
export interface _AWS_RDS_DBINSTANCE {
|
|
25
25
|
/**
|
|
26
|
-
* The
|
|
27
|
-
*
|
|
26
|
+
* The amount of storage in gibibytes (GiB) to be initially allocated for the database instance.
|
|
27
|
+
* If any value is set in the ``Iops`` parameter, ``AllocatedStorage`` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the ``Iops`` value (in 1,000 IOPS increments), then you must also increase the ``AllocatedStorage`` value (in 100-GiB increments).
|
|
28
|
+
* *Amazon Aurora*
|
|
29
|
+
* 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.
|
|
30
|
+
* *Db2*
|
|
31
|
+
* Constraints to the amount of storage for each storage type are the following:
|
|
32
|
+
* + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.
|
|
33
|
+
* + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.
|
|
34
|
+
*
|
|
35
|
+
* *MySQL*
|
|
36
|
+
* Constraints to the amount of storage for each storage type are the following:
|
|
37
|
+
* + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
|
|
38
|
+
* + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
|
|
39
|
+
* + Magnetic storage (standard): Must be an integer from 5 to 3072.
|
|
40
|
+
*
|
|
41
|
+
* *MariaDB*
|
|
42
|
+
* Constraints to the amount of storage for each storage type are the following:
|
|
43
|
+
* + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
|
|
44
|
+
* + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
|
|
45
|
+
* + Magnetic storage (standard): Must be an integer from 5 to 3072.
|
|
46
|
+
*
|
|
47
|
+
* *PostgreSQL*
|
|
48
|
+
* Constraints to the amount of storage for each storage type are the following:
|
|
49
|
+
* + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
|
|
50
|
+
* + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
|
|
51
|
+
* + Magnetic storage (standard): Must be an integer from 5 to 3072.
|
|
52
|
+
*
|
|
53
|
+
* *Oracle*
|
|
54
|
+
* Constraints to the amount of storage for each storage type are the following:
|
|
55
|
+
* + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
|
|
56
|
+
* + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
|
|
57
|
+
* + Magnetic storage (standard): Must be an integer from 10 to 3072.
|
|
58
|
+
*
|
|
59
|
+
* *SQL Server*
|
|
60
|
+
* Constraints to the amount of storage for each storage type are the following:
|
|
61
|
+
* + General Purpose (SSD) storage (gp2):
|
|
62
|
+
* + Enterprise and Standard editions: Must be an integer from 20 to 16384.
|
|
63
|
+
* + Web and Express editions: Must be an integer from 20 to 16384.
|
|
64
|
+
*
|
|
65
|
+
* + Provisioned IOPS storage (io1):
|
|
66
|
+
* + Enterprise and Standard editions: Must be an integer from 20 to 16384.
|
|
67
|
+
* + Web and Express editions: Must be an integer from 20 to 16384.
|
|
68
|
+
*
|
|
69
|
+
* + Magnetic storage (standard):
|
|
70
|
+
* + Enterprise and Standard editions: Must be an integer from 20 to 1024.
|
|
71
|
+
* + Web and Express editions: Must be an integer from 20 to 1024.
|
|
28
72
|
*/
|
|
29
|
-
|
|
73
|
+
AllocatedStorage?: string;
|
|
30
74
|
/**
|
|
31
|
-
* A value that indicates whether
|
|
32
|
-
*
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
75
|
+
* A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
|
|
76
|
+
* Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version.
|
|
77
|
+
*/
|
|
78
|
+
AllowMajorVersionUpgrade?: boolean;
|
|
79
|
+
/**
|
|
80
|
+
* The IAMlong (IAM) roles associated with the DB instance.
|
|
36
81
|
* *Amazon Aurora*
|
|
37
|
-
* Not applicable. The
|
|
82
|
+
* Not applicable. The associated roles are managed by the DB cluster.
|
|
38
83
|
*/
|
|
39
|
-
|
|
84
|
+
AssociatedRoles?: DBInstanceRole[];
|
|
40
85
|
/**
|
|
41
|
-
*
|
|
86
|
+
* 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.
|
|
42
87
|
*/
|
|
43
|
-
|
|
88
|
+
AutoMinorVersionUpgrade?: boolean;
|
|
44
89
|
/**
|
|
45
|
-
* The
|
|
90
|
+
* The AWS-Region associated with the automated backup.
|
|
46
91
|
*/
|
|
47
|
-
|
|
92
|
+
AutomaticBackupReplicationRegion?: string;
|
|
93
|
+
/**
|
|
94
|
+
* The AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS-Region, for example, ``arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE``.
|
|
95
|
+
*/
|
|
96
|
+
AutomaticBackupReplicationKmsKeyId?: string;
|
|
97
|
+
/**
|
|
98
|
+
* The retention period for automated backups in a different AWS Region. Use this parameter to set a unique retention period that only applies to cross-Region automated backups. To enable automated backups in a different Region, specify a positive value for the ``AutomaticBackupReplicationRegion`` parameter.
|
|
99
|
+
* If not specified, this parameter defaults to the value of the ``BackupRetentionPeriod`` parameter. The maximum allowed value is 35.
|
|
100
|
+
*/
|
|
101
|
+
AutomaticBackupReplicationRetentionPeriod?: number;
|
|
102
|
+
/**
|
|
103
|
+
* The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).
|
|
104
|
+
* For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
|
|
105
|
+
* Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region.
|
|
106
|
+
* Constraints:
|
|
107
|
+
* + The ``AvailabilityZone`` parameter can't be specified if the DB instance is a Multi-AZ deployment.
|
|
108
|
+
* + The specified Availability Zone must be in the same AWS-Region as the current endpoint.
|
|
109
|
+
*
|
|
110
|
+
* Example: ``us-east-1d``
|
|
111
|
+
*/
|
|
112
|
+
AvailabilityZone?: string;
|
|
113
|
+
/**
|
|
114
|
+
* 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.
|
|
115
|
+
* *Amazon Aurora*
|
|
116
|
+
* Not applicable. The retention period for automated backups is managed by the DB cluster.
|
|
117
|
+
* Default: 1
|
|
118
|
+
* Constraints:
|
|
119
|
+
* + Must be a value from 0 to 35
|
|
120
|
+
* + Can't be set to 0 if the DB instance is a source to read replicas
|
|
121
|
+
*/
|
|
122
|
+
BackupRetentionPeriod?: number;
|
|
123
|
+
BackupTarget?: string;
|
|
124
|
+
/**
|
|
125
|
+
* The identifier of the CA certificate for this DB instance.
|
|
126
|
+
* For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.
|
|
127
|
+
*/
|
|
128
|
+
CACertificateIdentifier?: string;
|
|
48
129
|
CertificateDetails?: CertificateDetails;
|
|
49
130
|
/**
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
* +
|
|
55
|
-
* +
|
|
56
|
-
* + RDS for Microsoft SQL Server - ``1433``
|
|
57
|
-
* + RDS for MySQL - ``3306``
|
|
58
|
-
* + RDS for Oracle - ``1521``
|
|
59
|
-
* + RDS for PostgreSQL - ``5432``
|
|
131
|
+
* Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
|
|
132
|
+
* By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
|
|
133
|
+
* Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance.
|
|
134
|
+
* If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
|
|
135
|
+
* + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.*
|
|
136
|
+
* + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*.
|
|
60
137
|
*
|
|
138
|
+
* This setting doesn't apply to RDS Custom DB instances.
|
|
139
|
+
*/
|
|
140
|
+
CertificateRotationRestart?: boolean;
|
|
141
|
+
/**
|
|
142
|
+
* For supported engines, indicates that the DB instance should be associated with the specified character set.
|
|
143
|
+
* *Amazon Aurora*
|
|
144
|
+
* Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html).
|
|
145
|
+
*/
|
|
146
|
+
CharacterSetName?: string;
|
|
147
|
+
/**
|
|
148
|
+
* Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
|
|
149
|
+
* This setting doesn't apply to Amazon Aurora DB instances. 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.
|
|
150
|
+
*/
|
|
151
|
+
CopyTagsToSnapshot?: boolean;
|
|
152
|
+
/**
|
|
153
|
+
* The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
|
|
154
|
+
* This setting is required for RDS Custom.
|
|
61
155
|
* Constraints:
|
|
62
|
-
* +
|
|
156
|
+
* + The profile must exist in your account.
|
|
157
|
+
* + The profile must have an IAM role that Amazon EC2 has permissions to assume.
|
|
158
|
+
* + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``.
|
|
159
|
+
*
|
|
160
|
+
* 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 RDS User Guide*.
|
|
63
161
|
*/
|
|
64
|
-
|
|
162
|
+
CustomIAMInstanceProfile?: string;
|
|
163
|
+
/**
|
|
164
|
+
* The mode of Database Insights to enable for the DB instance.
|
|
165
|
+
* Aurora DB instances inherit this value from the DB cluster, so you can't change this value.
|
|
166
|
+
*/
|
|
167
|
+
DatabaseInsightsMode?: string;
|
|
65
168
|
/**
|
|
66
169
|
* The identifier of the DB cluster that this DB instance will belong to.
|
|
67
170
|
* This setting doesn't apply to RDS Custom DB instances.
|
|
68
171
|
*/
|
|
69
172
|
DBClusterIdentifier?: string;
|
|
70
173
|
/**
|
|
71
|
-
*
|
|
72
|
-
*
|
|
174
|
+
* The identifier for the Multi-AZ DB cluster snapshot to restore from.
|
|
175
|
+
* For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*.
|
|
176
|
+
* Constraints:
|
|
177
|
+
* + Must match the identifier of an existing Multi-AZ DB cluster snapshot.
|
|
178
|
+
* + Can't be specified when ``DBSnapshotIdentifier`` is specified.
|
|
179
|
+
* + Must be specified when ``DBSnapshotIdentifier`` isn't specified.
|
|
180
|
+
* + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot.
|
|
181
|
+
* + Can't be the identifier of an Aurora DB cluster snapshot.
|
|
73
182
|
*/
|
|
74
|
-
|
|
183
|
+
DBClusterSnapshotIdentifier?: string;
|
|
184
|
+
DBInstanceArn?: string;
|
|
75
185
|
/**
|
|
76
|
-
* The
|
|
77
|
-
* If not specified, this parameter defaults to the value of the ``BackupRetentionPeriod`` parameter. The maximum allowed value is 35.
|
|
186
|
+
* The compute and memory capacity of the DB instance, for example ``db.m5.large``. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*.
|
|
78
187
|
*/
|
|
79
|
-
|
|
188
|
+
DBInstanceClass?: string;
|
|
189
|
+
/**
|
|
190
|
+
* A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
|
|
191
|
+
* For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.
|
|
192
|
+
* If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
|
|
193
|
+
*/
|
|
194
|
+
DBInstanceIdentifier?: string;
|
|
80
195
|
DbiResourceId?: string;
|
|
81
196
|
/**
|
|
82
|
-
* The
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
197
|
+
* The meaning of this parameter differs according to the database engine you use.
|
|
198
|
+
* If you specify the ``DBSnapshotIdentifier`` property, this property only applies to RDS for Oracle.
|
|
199
|
+
* *Amazon Aurora*
|
|
200
|
+
* Not applicable. The database name is managed by the DB cluster.
|
|
201
|
+
* *Db2*
|
|
202
|
+
* 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.
|
|
203
|
+
* Constraints:
|
|
204
|
+
* + Must contain 1 to 64 letters or numbers.
|
|
205
|
+
* + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
|
|
206
|
+
* + Can't be a word reserved by the specified database engine.
|
|
207
|
+
*
|
|
208
|
+
* *MySQL*
|
|
209
|
+
* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
|
|
210
|
+
* Constraints:
|
|
211
|
+
* + Must contain 1 to 64 letters or numbers.
|
|
212
|
+
* + Can't be a word reserved by the specified database engine
|
|
213
|
+
*
|
|
214
|
+
* *MariaDB*
|
|
215
|
+
* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
|
|
216
|
+
* Constraints:
|
|
217
|
+
* + Must contain 1 to 64 letters or numbers.
|
|
218
|
+
* + Can't be a word reserved by the specified database engine
|
|
219
|
+
*
|
|
220
|
+
* *PostgreSQL*
|
|
221
|
+
* The name of the database to create when the DB instance is created. If this parameter is not specified, the default ``postgres`` database is created in the DB instance.
|
|
222
|
+
* Constraints:
|
|
223
|
+
* + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
|
|
224
|
+
* + Must contain 1 to 63 characters.
|
|
225
|
+
* + Can't be a word reserved by the specified database engine
|
|
226
|
+
*
|
|
227
|
+
* *Oracle*
|
|
228
|
+
* 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``.
|
|
229
|
+
* Default: ``ORCL``
|
|
230
|
+
* Constraints:
|
|
231
|
+
* + Can't be longer than 8 characters
|
|
232
|
+
*
|
|
233
|
+
* *SQL Server*
|
|
234
|
+
* Not applicable. Must be null.
|
|
87
235
|
*/
|
|
88
|
-
|
|
236
|
+
DBName?: string;
|
|
89
237
|
/**
|
|
90
238
|
* The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template.
|
|
91
239
|
* To list all of the available DB parameter group names, use the following command:
|
|
@@ -93,21 +241,156 @@ export interface _AWS_RDS_DBINSTANCE {
|
|
|
93
241
|
* If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.
|
|
94
242
|
* If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used.
|
|
95
243
|
*/
|
|
96
|
-
DBParameterGroupName?: string;
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
244
|
+
DBParameterGroupName?: string;
|
|
245
|
+
/**
|
|
246
|
+
* A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template.
|
|
247
|
+
* If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups.
|
|
248
|
+
* If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:
|
|
249
|
+
* + ``AllocatedStorage``
|
|
250
|
+
* + ``AutoMinorVersionUpgrade``
|
|
251
|
+
* + ``AvailabilityZone``
|
|
252
|
+
* + ``BackupRetentionPeriod``
|
|
253
|
+
* + ``CharacterSetName``
|
|
254
|
+
* + ``DBInstanceClass``
|
|
255
|
+
* + ``DBName``
|
|
256
|
+
* + ``DBParameterGroupName``
|
|
257
|
+
* + ``DBSecurityGroups``
|
|
258
|
+
* + ``DBSubnetGroupName``
|
|
259
|
+
* + ``Engine``
|
|
260
|
+
* + ``EngineVersion``
|
|
261
|
+
* + ``Iops``
|
|
262
|
+
* + ``LicenseModel``
|
|
263
|
+
* + ``MasterUsername``
|
|
264
|
+
* + ``MasterUserPassword``
|
|
265
|
+
* + ``MultiAZ``
|
|
266
|
+
* + ``OptionGroupName``
|
|
267
|
+
* + ``PreferredBackupWindow``
|
|
268
|
+
* + ``PreferredMaintenanceWindow``
|
|
269
|
+
*
|
|
270
|
+
* All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as ``StorageType``, ``StorageEncrypted``, or ``KmsKeyId``. If you're already using the ``DBSecurityGroups`` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.
|
|
271
|
+
*/
|
|
272
|
+
DBSecurityGroups?: string[];
|
|
273
|
+
/**
|
|
274
|
+
* The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.
|
|
275
|
+
* By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack.
|
|
276
|
+
* Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties, and the point-in-time recovery properties ``RestoreTime`` and ``UseLatestRestorableTime``. For information about the properties that you can specify, see the [RestoreDBInstanceFromDBSnapshot](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html) action in the *Amazon RDS API Reference*.
|
|
277
|
+
* After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted.
|
|
278
|
+
* If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties:
|
|
279
|
+
* + ``CharacterSetName``
|
|
280
|
+
* + ``DBClusterIdentifier``
|
|
281
|
+
* + ``DBName``
|
|
282
|
+
* + ``KmsKeyId``
|
|
283
|
+
* + ``MasterUsername``
|
|
284
|
+
* + ``MasterUserPassword``
|
|
285
|
+
* + ``PromotionTier``
|
|
286
|
+
* + ``SourceDBInstanceIdentifier``
|
|
287
|
+
* + ``SourceRegion``
|
|
288
|
+
* + ``StorageEncrypted`` (for an unencrypted snapshot)
|
|
289
|
+
* + ``Timezone``
|
|
290
|
+
*
|
|
291
|
+
* *Amazon Aurora*
|
|
292
|
+
* Not applicable. Snapshot restore is managed by the DB cluster.
|
|
293
|
+
*/
|
|
294
|
+
DBSnapshotIdentifier?: string;
|
|
295
|
+
/**
|
|
296
|
+
* A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC.
|
|
297
|
+
* If you don't specify a DB subnet group, RDS uses the default DB subnet group if one exists. If a default DB subnet group does not exist, and you don't specify a ``DBSubnetGroupName``, the DB instance fails to launch.
|
|
298
|
+
* For more information about using Amazon RDS in a VPC, see [Amazon VPC and Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*.
|
|
299
|
+
* This setting doesn't apply to Amazon Aurora DB instances. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
|
|
300
|
+
*/
|
|
301
|
+
DBSubnetGroupName?: string;
|
|
302
|
+
/**
|
|
303
|
+
* The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to ``RDSCDB``. The Oracle SID is also the name of your CDB.
|
|
304
|
+
*/
|
|
305
|
+
DBSystemId?: string;
|
|
306
|
+
/**
|
|
307
|
+
* Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
|
|
308
|
+
*/
|
|
309
|
+
DedicatedLogVolume?: boolean;
|
|
310
|
+
/**
|
|
311
|
+
* A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.
|
|
312
|
+
* *Amazon Aurora*
|
|
313
|
+
* Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
|
|
314
|
+
*/
|
|
315
|
+
DeleteAutomatedBackups?: boolean;
|
|
316
|
+
/**
|
|
317
|
+
* Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
|
|
318
|
+
* This setting doesn't apply to Amazon Aurora DB instances. 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.
|
|
319
|
+
*/
|
|
320
|
+
DeletionProtection?: boolean;
|
|
321
|
+
/**
|
|
322
|
+
* The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
|
|
323
|
+
* For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*.
|
|
324
|
+
*/
|
|
325
|
+
Domain?: string;
|
|
326
|
+
/**
|
|
327
|
+
* The ARN for the Secrets Manager secret with the credentials for the user joining the domain.
|
|
328
|
+
* Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456``
|
|
329
|
+
*/
|
|
330
|
+
DomainAuthSecretArn?: string;
|
|
331
|
+
/**
|
|
332
|
+
* The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
|
|
333
|
+
* Constraints:
|
|
334
|
+
* + Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.
|
|
335
|
+
*
|
|
336
|
+
* Example: ``123.124.125.126,234.235.236.237``
|
|
337
|
+
*/
|
|
338
|
+
DomainDnsIps?: string[];
|
|
339
|
+
/**
|
|
340
|
+
* The fully qualified domain name (FQDN) of an Active Directory domain.
|
|
341
|
+
* Constraints:
|
|
342
|
+
* + Can't be longer than 64 characters.
|
|
343
|
+
*
|
|
344
|
+
* Example: ``mymanagedADtest.mymanagedAD.mydomain``
|
|
345
|
+
*/
|
|
346
|
+
DomainFqdn?: string;
|
|
347
|
+
/**
|
|
348
|
+
* The name of the IAM role to use when making API calls to the Directory Service.
|
|
349
|
+
* This setting doesn't apply to the following DB instances:
|
|
350
|
+
* + Amazon Aurora (The domain is managed by the DB cluster.)
|
|
351
|
+
* + RDS Custom
|
|
352
|
+
*/
|
|
353
|
+
DomainIAMRoleName?: string;
|
|
354
|
+
/**
|
|
355
|
+
* The Active Directory organizational unit for your DB instance to join.
|
|
356
|
+
* Constraints:
|
|
357
|
+
* + Must be in the distinguished name format.
|
|
358
|
+
* + Can't be longer than 64 characters.
|
|
359
|
+
*
|
|
360
|
+
* Example: ``OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain``
|
|
361
|
+
*/
|
|
362
|
+
DomainOu?: string;
|
|
363
|
+
/**
|
|
364
|
+
* 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 being used. 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*.
|
|
365
|
+
* *Amazon Aurora*
|
|
366
|
+
* Not applicable. CloudWatch Logs exports are managed by the DB cluster.
|
|
367
|
+
* *Db2*
|
|
368
|
+
* Valid values: ``diag.log``, ``notify.log``
|
|
369
|
+
* *MariaDB*
|
|
370
|
+
* Valid values: ``audit``, ``error``, ``general``, ``slowquery``
|
|
371
|
+
* *Microsoft SQL Server*
|
|
372
|
+
* Valid values: ``agent``, ``error``
|
|
373
|
+
* *MySQL*
|
|
374
|
+
* Valid values: ``audit``, ``error``, ``general``, ``slowquery``
|
|
375
|
+
* *Oracle*
|
|
376
|
+
* Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent``
|
|
377
|
+
* *PostgreSQL*
|
|
378
|
+
* Valid values: ``postgresql``, ``upgrade``
|
|
379
|
+
*/
|
|
380
|
+
EnableCloudwatchLogsExports?: string[];
|
|
100
381
|
/**
|
|
101
|
-
*
|
|
382
|
+
* A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
|
|
383
|
+
* This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.*
|
|
384
|
+
* *Amazon Aurora*
|
|
385
|
+
* Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
|
|
102
386
|
*/
|
|
103
|
-
|
|
387
|
+
EnableIAMDatabaseAuthentication?: boolean;
|
|
104
388
|
/**
|
|
105
|
-
* Specifies whether
|
|
106
|
-
* This setting doesn't apply to
|
|
107
|
-
* + Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
|
|
108
|
-
* + RDS Custom
|
|
389
|
+
* Specifies 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 RDS User Guide*.
|
|
390
|
+
* This setting doesn't apply to RDS Custom DB instances.
|
|
109
391
|
*/
|
|
110
|
-
|
|
392
|
+
EnablePerformanceInsights?: boolean;
|
|
393
|
+
Endpoint?: Endpoint;
|
|
111
394
|
/**
|
|
112
395
|
* The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region.
|
|
113
396
|
* This property is required when creating a DB instance.
|
|
@@ -136,30 +419,14 @@ export interface _AWS_RDS_DBINSTANCE {
|
|
|
136
419
|
*/
|
|
137
420
|
Engine?: string;
|
|
138
421
|
/**
|
|
139
|
-
*
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
-
* 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 AWS account. Your AWS account has a different default KMS key for each AWS Region.
|
|
146
|
-
* For information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights).
|
|
147
|
-
*/
|
|
148
|
-
PerformanceInsightsKMSKeyId?: string;
|
|
149
|
-
TdeCredentialPassword?: string;
|
|
150
|
-
/**
|
|
151
|
-
* If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*.
|
|
152
|
-
* For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.
|
|
153
|
-
* The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the read replica to a standalone DB instance.
|
|
154
|
-
* If you specify the ``UseLatestRestorableTime`` or ``RestoreTime`` properties in conjunction with the ``SourceDBInstanceIdentifier`` property, RDS restores the DB instance to the requested point in time, thereby creating a new DB instance.
|
|
155
|
-
* + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the property, the read replica inherits the value of the ``VPCSecurityGroups`` property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's ``VPCSecurityGroups`` property to the default value because it's not defined in the stack's template. This change might cause unexpected issues.
|
|
156
|
-
* + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica.
|
|
157
|
-
* + If you specify ``SourceDBInstanceIdentifier``, don't specify the ``DBSnapshotIdentifier`` property. You can't create a read replica from a snapshot.
|
|
158
|
-
* + Don't set the ``BackupRetentionPeriod``, ``DBName``, ``MasterUsername``, ``MasterUserPassword``, and ``PreferredBackupWindow`` properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas.
|
|
159
|
-
* + If the source DB instance is in a different region than the read replica, specify the source region in ``SourceRegion``, and specify an ARN for a valid DB instance in ``SourceDBInstanceIdentifier``. For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*.
|
|
160
|
-
* + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances.
|
|
422
|
+
* The life cycle type for this DB instance.
|
|
423
|
+
* By default, this value is set to ``open-source-rds-extended-support``, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to ``open-source-rds-extended-support-disabled``. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date.
|
|
424
|
+
* This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
|
|
425
|
+
* You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see [Amazon RDS Extended Support with Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide*.
|
|
426
|
+
* Valid Values: ``open-source-rds-extended-support | open-source-rds-extended-support-disabled``
|
|
427
|
+
* Default: ``open-source-rds-extended-support``
|
|
161
428
|
*/
|
|
162
|
-
|
|
429
|
+
EngineLifecycleSupport?: string;
|
|
163
430
|
/**
|
|
164
431
|
* The version number of the database engine to use.
|
|
165
432
|
* For a list of valid engine versions, use the ``DescribeDBEngineVersions`` action.
|
|
@@ -181,199 +448,47 @@ export interface _AWS_RDS_DBINSTANCE {
|
|
|
181
448
|
*/
|
|
182
449
|
EngineVersion?: string;
|
|
183
450
|
/**
|
|
184
|
-
*
|
|
185
|
-
*
|
|
186
|
-
* This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
|
|
187
|
-
* Valid Values: ``gp2 | gp3 | io1 | io2 | standard``
|
|
188
|
-
* Default: ``io1``, if the ``Iops`` parameter is specified. Otherwise, ``gp3``.
|
|
189
|
-
*/
|
|
190
|
-
StorageType?: string;
|
|
191
|
-
/**
|
|
192
|
-
* The ARN of the AWS KMS key that's used to encrypt the DB instance, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true.
|
|
193
|
-
* If you specify the ``SourceDBInstanceIdentifier`` or ``SourceDbiResourceId`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. However, if the source DB instance is in a different AWS Region, you must specify a KMS key ID.
|
|
194
|
-
* If you specify the ``SourceDBInstanceAutomatedBackupsArn`` property, don't specify this property. The value is inherited from the source DB instance automated backup, and if the automated backup is encrypted, the specified ``KmsKeyId`` property is used.
|
|
195
|
-
* If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region.
|
|
196
|
-
* If you specify the ``DBSnapshotIdentifier`` property, don't specify this property. The ``StorageEncrypted`` property value is inherited from the snapshot. If the DB instance is encrypted, the specified ``KmsKeyId`` property is also inherited from the snapshot.
|
|
197
|
-
* If you specify ``DBSecurityGroups``, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*.
|
|
198
|
-
* *Amazon Aurora*
|
|
199
|
-
* Not applicable. The KMS key identifier is managed by the DB cluster.
|
|
200
|
-
*/
|
|
201
|
-
KmsKeyId?: string;
|
|
202
|
-
/**
|
|
203
|
-
* The compute and memory capacity of the DB instance, for example ``db.m5.large``. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*.
|
|
204
|
-
*/
|
|
205
|
-
DBInstanceClass?: string;
|
|
206
|
-
/**
|
|
207
|
-
* A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.
|
|
208
|
-
* *Amazon Aurora*
|
|
209
|
-
* Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
|
|
210
|
-
*/
|
|
211
|
-
DeleteAutomatedBackups?: boolean;
|
|
212
|
-
/**
|
|
213
|
-
* The number of days to retain Performance Insights data. When creating a DB instance without enabling Performance Insights, you can't specify the parameter ``PerformanceInsightsRetentionPeriod``.
|
|
214
|
-
* This setting doesn't apply to RDS Custom DB instances.
|
|
215
|
-
* Valid Values:
|
|
216
|
-
* + ``7``
|
|
217
|
-
* + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31)
|
|
218
|
-
* + ``731``
|
|
219
|
-
*
|
|
220
|
-
* Default: ``7`` days
|
|
221
|
-
* If you specify a retention period that isn't valid, such as ``94``, Amazon RDS returns an error.
|
|
222
|
-
*/
|
|
223
|
-
PerformanceInsightsRetentionPeriod?: number;
|
|
224
|
-
/**
|
|
225
|
-
* The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).
|
|
226
|
-
* For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
|
|
227
|
-
* Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region.
|
|
228
|
-
* Constraints:
|
|
229
|
-
* + The ``AvailabilityZone`` parameter can't be specified if the DB instance is a Multi-AZ deployment.
|
|
230
|
-
* + The specified Availability Zone must be in the same AWS-Region as the current endpoint.
|
|
231
|
-
*
|
|
232
|
-
* Example: ``us-east-1d``
|
|
233
|
-
*/
|
|
234
|
-
AvailabilityZone?: string;
|
|
235
|
-
/**
|
|
236
|
-
* Indicates that the DB instance should be associated with the specified option group.
|
|
237
|
-
* 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 once it is associated with a DB instance.
|
|
238
|
-
*/
|
|
239
|
-
OptionGroupName?: string;
|
|
240
|
-
/**
|
|
241
|
-
* Specifies 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 RDS User Guide*.
|
|
242
|
-
* This setting doesn't apply to RDS Custom DB instances.
|
|
243
|
-
*/
|
|
244
|
-
EnablePerformanceInsights?: boolean;
|
|
245
|
-
/**
|
|
246
|
-
* 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.
|
|
247
|
-
*/
|
|
248
|
-
AutoMinorVersionUpgrade?: boolean;
|
|
249
|
-
/**
|
|
250
|
-
* A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC.
|
|
251
|
-
* If you don't specify a DB subnet group, RDS uses the default DB subnet group if one exists. If a default DB subnet group does not exist, and you don't specify a ``DBSubnetGroupName``, the DB instance fails to launch.
|
|
252
|
-
* For more information about using Amazon RDS in a VPC, see [Amazon VPC and Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*.
|
|
253
|
-
* This setting doesn't apply to Amazon Aurora DB instances. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
|
|
254
|
-
*/
|
|
255
|
-
DBSubnetGroupName?: string;
|
|
256
|
-
/**
|
|
257
|
-
* Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
|
|
258
|
-
* This setting doesn't apply to Amazon Aurora DB instances. 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.
|
|
259
|
-
*/
|
|
260
|
-
DeletionProtection?: boolean;
|
|
261
|
-
/**
|
|
262
|
-
* A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
|
|
263
|
-
* For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.
|
|
264
|
-
* If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
|
|
265
|
-
*/
|
|
266
|
-
DBInstanceIdentifier?: string;
|
|
267
|
-
/**
|
|
268
|
-
* The amount of storage in gibibytes (GiB) to be initially allocated for the database instance.
|
|
269
|
-
* If any value is set in the ``Iops`` parameter, ``AllocatedStorage`` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the ``Iops`` value (in 1,000 IOPS increments), then you must also increase the ``AllocatedStorage`` value (in 100-GiB increments).
|
|
270
|
-
* *Amazon Aurora*
|
|
271
|
-
* 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.
|
|
272
|
-
* *Db2*
|
|
273
|
-
* Constraints to the amount of storage for each storage type are the following:
|
|
274
|
-
* + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.
|
|
275
|
-
* + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.
|
|
276
|
-
*
|
|
277
|
-
* *MySQL*
|
|
278
|
-
* Constraints to the amount of storage for each storage type are the following:
|
|
279
|
-
* + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
|
|
280
|
-
* + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
|
|
281
|
-
* + Magnetic storage (standard): Must be an integer from 5 to 3072.
|
|
282
|
-
*
|
|
283
|
-
* *MariaDB*
|
|
284
|
-
* Constraints to the amount of storage for each storage type are the following:
|
|
285
|
-
* + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
|
|
286
|
-
* + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
|
|
287
|
-
* + Magnetic storage (standard): Must be an integer from 5 to 3072.
|
|
288
|
-
*
|
|
289
|
-
* *PostgreSQL*
|
|
290
|
-
* Constraints to the amount of storage for each storage type are the following:
|
|
291
|
-
* + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
|
|
292
|
-
* + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
|
|
293
|
-
* + Magnetic storage (standard): Must be an integer from 5 to 3072.
|
|
294
|
-
*
|
|
295
|
-
* *Oracle*
|
|
296
|
-
* Constraints to the amount of storage for each storage type are the following:
|
|
297
|
-
* + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
|
|
298
|
-
* + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
|
|
299
|
-
* + Magnetic storage (standard): Must be an integer from 10 to 3072.
|
|
300
|
-
*
|
|
301
|
-
* *SQL Server*
|
|
302
|
-
* Constraints to the amount of storage for each storage type are the following:
|
|
303
|
-
* + General Purpose (SSD) storage (gp2):
|
|
304
|
-
* + Enterprise and Standard editions: Must be an integer from 20 to 16384.
|
|
305
|
-
* + Web and Express editions: Must be an integer from 20 to 16384.
|
|
306
|
-
*
|
|
307
|
-
* + Provisioned IOPS storage (io1):
|
|
308
|
-
* + Enterprise and Standard editions: Must be an integer from 20 to 16384.
|
|
309
|
-
* + Web and Express editions: Must be an integer from 20 to 16384.
|
|
310
|
-
*
|
|
311
|
-
* + Magnetic storage (standard):
|
|
312
|
-
* + Enterprise and Standard editions: Must be an integer from 20 to 1024.
|
|
313
|
-
* + Web and Express editions: Must be an integer from 20 to 1024.
|
|
314
|
-
*/
|
|
315
|
-
AllocatedStorage?: string;
|
|
316
|
-
/**
|
|
317
|
-
* The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
|
|
318
|
-
* *Amazon Aurora*
|
|
319
|
-
* Not applicable. The password for the master user is managed by the DB cluster.
|
|
320
|
-
* *RDS for Db2*
|
|
321
|
-
* Must contain from 8 to 255 characters.
|
|
322
|
-
* *RDS for MariaDB*
|
|
323
|
-
* Constraints: Must contain from 8 to 41 characters.
|
|
324
|
-
* *RDS for Microsoft SQL Server*
|
|
325
|
-
* Constraints: Must contain from 8 to 128 characters.
|
|
326
|
-
* *RDS for MySQL*
|
|
327
|
-
* Constraints: Must contain from 8 to 41 characters.
|
|
328
|
-
* *RDS for Oracle*
|
|
329
|
-
* Constraints: Must contain from 8 to 30 characters.
|
|
330
|
-
* *RDS for PostgreSQL*
|
|
331
|
-
* Constraints: Must contain from 8 to 128 characters.
|
|
332
|
-
*/
|
|
333
|
-
MasterUserPassword?: string;
|
|
334
|
-
MasterUserSecret?: MasterUserSecret;
|
|
335
|
-
/**
|
|
336
|
-
* The name of the NCHAR character set for the Oracle DB instance.
|
|
337
|
-
* This setting doesn't apply to RDS Custom DB instances.
|
|
338
|
-
*/
|
|
339
|
-
NcharCharacterSetName?: string;
|
|
340
|
-
/**
|
|
341
|
-
* The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.
|
|
451
|
+
* Specifies whether to manage the master user password with AWS Secrets Manager.
|
|
452
|
+
* For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*
|
|
342
453
|
* Constraints:
|
|
343
|
-
* +
|
|
344
|
-
* + Can't be specified if the ``SourceDBInstanceIdentifier`` parameter is also specified.
|
|
345
|
-
* + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
|
|
346
|
-
* + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.
|
|
454
|
+
* + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified.
|
|
347
455
|
*/
|
|
348
|
-
|
|
456
|
+
ManageMasterUserPassword?: boolean;
|
|
349
457
|
/**
|
|
350
|
-
*
|
|
351
|
-
*
|
|
352
|
-
* If you specify
|
|
353
|
-
*
|
|
354
|
-
* +
|
|
355
|
-
* +
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
*
|
|
360
|
-
*
|
|
361
|
-
*
|
|
362
|
-
*
|
|
363
|
-
*
|
|
364
|
-
*
|
|
365
|
-
*
|
|
366
|
-
*
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
*
|
|
371
|
-
*
|
|
372
|
-
* +
|
|
458
|
+
* The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000.
|
|
459
|
+
* If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*.
|
|
460
|
+
* If you specify ``io1`` for the ``StorageType`` property, then you must also specify the ``Iops`` property.
|
|
461
|
+
* Constraints:
|
|
462
|
+
* + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.
|
|
463
|
+
* + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
|
|
464
|
+
*/
|
|
465
|
+
Iops?: number;
|
|
466
|
+
/**
|
|
467
|
+
* The ARN of the AWS KMS key that's used to encrypt the DB instance, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true.
|
|
468
|
+
* If you specify the ``SourceDBInstanceIdentifier`` or ``SourceDbiResourceId`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. However, if the source DB instance is in a different AWS Region, you must specify a KMS key ID.
|
|
469
|
+
* If you specify the ``SourceDBInstanceAutomatedBackupsArn`` property, don't specify this property. The value is inherited from the source DB instance automated backup, and if the automated backup is encrypted, the specified ``KmsKeyId`` property is used.
|
|
470
|
+
* If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region.
|
|
471
|
+
* If you specify the ``DBSnapshotIdentifier`` property, don't specify this property. The ``StorageEncrypted`` property value is inherited from the snapshot. If the DB instance is encrypted, the specified ``KmsKeyId`` property is also inherited from the snapshot.
|
|
472
|
+
* If you specify ``DBSecurityGroups``, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*.
|
|
473
|
+
* *Amazon Aurora*
|
|
474
|
+
* Not applicable. The KMS key identifier is managed by the DB cluster.
|
|
475
|
+
*/
|
|
476
|
+
KmsKeyId?: string;
|
|
477
|
+
/**
|
|
478
|
+
* License model information for this DB instance.
|
|
479
|
+
* Valid Values:
|
|
480
|
+
* + Aurora MySQL - ``general-public-license``
|
|
481
|
+
* + Aurora PostgreSQL - ``postgresql-license``
|
|
482
|
+
* + RDS for Db2 - ``bring-your-own-license``. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.*
|
|
483
|
+
* + RDS for MariaDB - ``general-public-license``
|
|
484
|
+
* + RDS for Microsoft SQL Server - ``license-included``
|
|
485
|
+
* + RDS for MySQL - ``general-public-license``
|
|
486
|
+
* + RDS for Oracle - ``bring-your-own-license`` or ``license-included``
|
|
487
|
+
* + RDS for PostgreSQL - ``postgresql-license``
|
|
373
488
|
*
|
|
374
|
-
*
|
|
489
|
+
* If you've specified ``DBSecurityGroups`` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.
|
|
375
490
|
*/
|
|
376
|
-
|
|
491
|
+
LicenseModel?: string;
|
|
377
492
|
/**
|
|
378
493
|
* The master user name for the DB instance.
|
|
379
494
|
* If you specify the ``SourceDBInstanceIdentifier`` or ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the source DB instance or snapshot.
|
|
@@ -416,6 +531,25 @@ export interface _AWS_RDS_DBINSTANCE {
|
|
|
416
531
|
* + Can't be a reserved word for the chosen database engine.
|
|
417
532
|
*/
|
|
418
533
|
MasterUsername?: string;
|
|
534
|
+
/**
|
|
535
|
+
* The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
|
|
536
|
+
* *Amazon Aurora*
|
|
537
|
+
* Not applicable. The password for the master user is managed by the DB cluster.
|
|
538
|
+
* *RDS for Db2*
|
|
539
|
+
* Must contain from 8 to 255 characters.
|
|
540
|
+
* *RDS for MariaDB*
|
|
541
|
+
* Constraints: Must contain from 8 to 41 characters.
|
|
542
|
+
* *RDS for Microsoft SQL Server*
|
|
543
|
+
* Constraints: Must contain from 8 to 128 characters.
|
|
544
|
+
* *RDS for MySQL*
|
|
545
|
+
* Constraints: Must contain from 8 to 41 characters.
|
|
546
|
+
* *RDS for Oracle*
|
|
547
|
+
* Constraints: Must contain from 8 to 30 characters.
|
|
548
|
+
* *RDS for PostgreSQL*
|
|
549
|
+
* Constraints: Must contain from 8 to 128 characters.
|
|
550
|
+
*/
|
|
551
|
+
MasterUserPassword?: string;
|
|
552
|
+
MasterUserSecret?: MasterUserSecret;
|
|
419
553
|
/**
|
|
420
554
|
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
|
|
421
555
|
* 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*.
|
|
@@ -425,84 +559,81 @@ export interface _AWS_RDS_DBINSTANCE {
|
|
|
425
559
|
*/
|
|
426
560
|
MaxAllocatedStorage?: number;
|
|
427
561
|
/**
|
|
428
|
-
* The
|
|
562
|
+
* 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``.
|
|
563
|
+
* If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than ``0``.
|
|
429
564
|
* This setting doesn't apply to RDS Custom DB instances.
|
|
430
|
-
*
|
|
431
|
-
*
|
|
565
|
+
* Valid Values: ``0 | 1 | 5 | 10 | 15 | 30 | 60``
|
|
566
|
+
* Default: ``0``
|
|
432
567
|
*/
|
|
433
|
-
|
|
568
|
+
MonitoringInterval?: number;
|
|
434
569
|
/**
|
|
435
|
-
*
|
|
436
|
-
*
|
|
570
|
+
* 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*.
|
|
571
|
+
* If ``MonitoringInterval`` is set to a value other than ``0``, then you must supply a ``MonitoringRoleArn`` value.
|
|
572
|
+
* This setting doesn't apply to RDS Custom DB instances.
|
|
437
573
|
*/
|
|
438
|
-
|
|
574
|
+
MonitoringRoleArn?: string;
|
|
439
575
|
/**
|
|
440
|
-
*
|
|
441
|
-
*
|
|
576
|
+
* Specifies 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.
|
|
577
|
+
* This setting doesn't apply to the following DB instances:
|
|
578
|
+
* + Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
|
|
579
|
+
* + RDS Custom
|
|
442
580
|
*/
|
|
443
|
-
|
|
581
|
+
MultiAZ?: boolean;
|
|
444
582
|
/**
|
|
445
|
-
*
|
|
446
|
-
*
|
|
447
|
-
* Default: ``true``
|
|
583
|
+
* The name of the NCHAR character set for the Oracle DB instance.
|
|
584
|
+
* This setting doesn't apply to RDS Custom DB instances.
|
|
448
585
|
*/
|
|
449
|
-
|
|
586
|
+
NcharCharacterSetName?: string;
|
|
450
587
|
/**
|
|
451
|
-
* The
|
|
452
|
-
*
|
|
453
|
-
* +
|
|
588
|
+
* The network type of the DB instance.
|
|
589
|
+
* Valid values:
|
|
590
|
+
* + ``IPV4``
|
|
591
|
+
* + ``DUAL``
|
|
454
592
|
*
|
|
455
|
-
*
|
|
456
|
-
|
|
457
|
-
DomainFqdn?: string;
|
|
458
|
-
/**
|
|
459
|
-
* For supported engines, indicates that the DB instance should be associated with the specified character set.
|
|
460
|
-
* *Amazon Aurora*
|
|
461
|
-
* Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html).
|
|
593
|
+
* The network type is determined by the ``DBSubnetGroup`` specified for the DB instance. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``).
|
|
594
|
+
* For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*
|
|
462
595
|
*/
|
|
463
|
-
|
|
596
|
+
NetworkType?: string;
|
|
464
597
|
/**
|
|
465
|
-
*
|
|
466
|
-
*
|
|
467
|
-
* This setting doesn't apply to RDS Custom DB instances.
|
|
598
|
+
* Indicates that the DB instance should be associated with the specified option group.
|
|
599
|
+
* 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 once it is associated with a DB instance.
|
|
468
600
|
*/
|
|
469
|
-
|
|
601
|
+
OptionGroupName?: string;
|
|
470
602
|
/**
|
|
471
|
-
* The
|
|
472
|
-
*
|
|
473
|
-
*
|
|
603
|
+
* The AWS KMS key identifier for encryption of Performance Insights data.
|
|
604
|
+
* The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
605
|
+
* 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 AWS account. Your AWS account has a different default KMS key for each AWS Region.
|
|
606
|
+
* For information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights).
|
|
474
607
|
*/
|
|
475
|
-
|
|
608
|
+
PerformanceInsightsKMSKeyId?: string;
|
|
476
609
|
/**
|
|
477
|
-
* The
|
|
478
|
-
*
|
|
479
|
-
*
|
|
480
|
-
* +
|
|
610
|
+
* The number of days to retain Performance Insights data. When creating a DB instance without enabling Performance Insights, you can't specify the parameter ``PerformanceInsightsRetentionPeriod``.
|
|
611
|
+
* This setting doesn't apply to RDS Custom DB instances.
|
|
612
|
+
* Valid Values:
|
|
613
|
+
* + ``7``
|
|
614
|
+
* + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31)
|
|
615
|
+
* + ``731``
|
|
481
616
|
*
|
|
482
|
-
*
|
|
617
|
+
* Default: ``7`` days
|
|
618
|
+
* If you specify a retention period that isn't valid, such as ``94``, Amazon RDS returns an error.
|
|
483
619
|
*/
|
|
484
|
-
|
|
620
|
+
PerformanceInsightsRetentionPeriod?: number;
|
|
485
621
|
/**
|
|
486
|
-
* The
|
|
487
|
-
*
|
|
622
|
+
* The port number on which the database accepts connections.
|
|
623
|
+
* This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.
|
|
624
|
+
* Valid Values: ``1150-65535``
|
|
625
|
+
* Default:
|
|
626
|
+
* + RDS for Db2 - ``50000``
|
|
627
|
+
* + RDS for MariaDB - ``3306``
|
|
628
|
+
* + RDS for Microsoft SQL Server - ``1433``
|
|
629
|
+
* + RDS for MySQL - ``3306``
|
|
630
|
+
* + RDS for Oracle - ``1521``
|
|
631
|
+
* + RDS for PostgreSQL - ``5432``
|
|
632
|
+
*
|
|
488
633
|
* Constraints:
|
|
489
|
-
* +
|
|
490
|
-
* + Can't be specified when ``DBSnapshotIdentifier`` is specified.
|
|
491
|
-
* + Must be specified when ``DBSnapshotIdentifier`` isn't specified.
|
|
492
|
-
* + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot.
|
|
493
|
-
* + Can't be the identifier of an Aurora DB cluster snapshot.
|
|
494
|
-
*/
|
|
495
|
-
DBClusterSnapshotIdentifier?: string;
|
|
496
|
-
/**
|
|
497
|
-
* The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, ``arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE``.
|
|
498
|
-
* This setting doesn't apply to RDS Custom.
|
|
499
|
-
*/
|
|
500
|
-
SourceDBInstanceAutomatedBackupsArn?: string;
|
|
501
|
-
/**
|
|
502
|
-
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
|
503
|
-
* This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
|
|
634
|
+
* + For RDS for Microsoft SQL Server, the value can't be ``1234``, ``1434``, ``3260``, ``3343``, ``3389``, ``47001``, or ``49152-49156``.
|
|
504
635
|
*/
|
|
505
|
-
|
|
636
|
+
Port?: string;
|
|
506
637
|
/**
|
|
507
638
|
* The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. 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.*
|
|
508
639
|
* Constraints:
|
|
@@ -516,52 +647,30 @@ export interface _AWS_RDS_DBINSTANCE {
|
|
|
516
647
|
*/
|
|
517
648
|
PreferredBackupWindow?: string;
|
|
518
649
|
/**
|
|
519
|
-
* The
|
|
520
|
-
*
|
|
521
|
-
*
|
|
522
|
-
*
|
|
523
|
-
*
|
|
524
|
-
*
|
|
525
|
-
* Example: ``2009-09-07T23:45:00Z``
|
|
526
|
-
*/
|
|
527
|
-
RestoreTime?: string;
|
|
528
|
-
/**
|
|
529
|
-
* Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
|
|
530
|
-
* By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
|
|
531
|
-
* Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance.
|
|
532
|
-
* If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
|
|
533
|
-
* + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.*
|
|
534
|
-
* + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*.
|
|
535
|
-
*
|
|
536
|
-
* This setting doesn't apply to RDS Custom DB instances.
|
|
537
|
-
*/
|
|
538
|
-
CertificateRotationRestart?: boolean;
|
|
539
|
-
/**
|
|
540
|
-
* The network type of the DB instance.
|
|
541
|
-
* Valid values:
|
|
542
|
-
* + ``IPV4``
|
|
543
|
-
* + ``DUAL``
|
|
544
|
-
*
|
|
545
|
-
* The network type is determined by the ``DBSubnetGroup`` specified for the DB instance. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``).
|
|
546
|
-
* For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*
|
|
650
|
+
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
|
651
|
+
* Format: ``ddd:hh24:mi-ddd:hh24:mi``
|
|
652
|
+
* The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Maintaining a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.*
|
|
653
|
+
* This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately.
|
|
654
|
+
* Constraints: Minimum 30-minute window.
|
|
547
655
|
*/
|
|
548
|
-
|
|
656
|
+
PreferredMaintenanceWindow?: string;
|
|
549
657
|
/**
|
|
550
|
-
*
|
|
658
|
+
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
|
659
|
+
* This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
|
|
551
660
|
*/
|
|
552
|
-
|
|
661
|
+
ProcessorFeatures?: ProcessorFeature[];
|
|
553
662
|
/**
|
|
554
|
-
*
|
|
555
|
-
* This setting doesn't apply to
|
|
663
|
+
* The order of priority 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/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*.
|
|
664
|
+
* This setting doesn't apply to RDS Custom DB instances.
|
|
665
|
+
* Default: ``1``
|
|
666
|
+
* Valid Values: ``0 - 15``
|
|
556
667
|
*/
|
|
557
|
-
|
|
668
|
+
PromotionTier?: number;
|
|
558
669
|
/**
|
|
559
|
-
*
|
|
560
|
-
*
|
|
561
|
-
* + Amazon Aurora (The domain is managed by the DB cluster.)
|
|
562
|
-
* + RDS Custom
|
|
670
|
+
* Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address.
|
|
671
|
+
* The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*.
|
|
563
672
|
*/
|
|
564
|
-
|
|
673
|
+
PubliclyAccessible?: boolean;
|
|
565
674
|
/**
|
|
566
675
|
* The open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*.
|
|
567
676
|
* This setting is only supported in RDS for Oracle.
|
|
@@ -570,89 +679,94 @@ export interface _AWS_RDS_DBINSTANCE {
|
|
|
570
679
|
*/
|
|
571
680
|
ReplicaMode?: string;
|
|
572
681
|
/**
|
|
573
|
-
* The
|
|
574
|
-
*
|
|
575
|
-
*
|
|
576
|
-
*
|
|
577
|
-
*
|
|
578
|
-
* Default: ``open-source-rds-extended-support``
|
|
579
|
-
*/
|
|
580
|
-
EngineLifecycleSupport?: string;
|
|
581
|
-
/**
|
|
582
|
-
* License model information for this DB instance.
|
|
583
|
-
* Valid Values:
|
|
584
|
-
* + Aurora MySQL - ``general-public-license``
|
|
585
|
-
* + Aurora PostgreSQL - ``postgresql-license``
|
|
586
|
-
* + RDS for Db2 - ``bring-your-own-license``. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.*
|
|
587
|
-
* + RDS for MariaDB - ``general-public-license``
|
|
588
|
-
* + RDS for Microsoft SQL Server - ``license-included``
|
|
589
|
-
* + RDS for MySQL - ``general-public-license``
|
|
590
|
-
* + RDS for Oracle - ``bring-your-own-license`` or ``license-included``
|
|
591
|
-
* + RDS for PostgreSQL - ``postgresql-license``
|
|
682
|
+
* The date and time to restore from. This parameter applies to point-in-time recovery. For more information, see [Restoring a DB instance to a specified time](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIT.html) in the in the *Amazon RDS User Guide*.
|
|
683
|
+
* Constraints:
|
|
684
|
+
* + Must be a time in Universal Coordinated Time (UTC) format.
|
|
685
|
+
* + Must be before the latest restorable time for the DB instance.
|
|
686
|
+
* + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled.
|
|
592
687
|
*
|
|
593
|
-
*
|
|
688
|
+
* Example: ``2009-09-07T23:45:00Z``
|
|
594
689
|
*/
|
|
595
|
-
|
|
690
|
+
RestoreTime?: string;
|
|
596
691
|
/**
|
|
597
|
-
* The
|
|
692
|
+
* The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.
|
|
598
693
|
* Constraints:
|
|
599
|
-
* +
|
|
600
|
-
*
|
|
601
|
-
*
|
|
694
|
+
* + Must be the identifier of an existing Multi-AZ DB cluster.
|
|
695
|
+
* + Can't be specified if the ``SourceDBInstanceIdentifier`` parameter is also specified.
|
|
696
|
+
* + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
|
|
697
|
+
* + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.
|
|
698
|
+
*/
|
|
699
|
+
SourceDBClusterIdentifier?: string;
|
|
700
|
+
/**
|
|
701
|
+
* The resource ID of the source DB instance from which to restore.
|
|
602
702
|
*/
|
|
603
|
-
|
|
703
|
+
SourceDbiResourceId?: string;
|
|
604
704
|
/**
|
|
605
|
-
* The
|
|
606
|
-
*
|
|
607
|
-
* The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Maintaining a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.*
|
|
608
|
-
* This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately.
|
|
609
|
-
* Constraints: Minimum 30-minute window.
|
|
705
|
+
* The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, ``arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE``.
|
|
706
|
+
* This setting doesn't apply to RDS Custom.
|
|
610
707
|
*/
|
|
611
|
-
|
|
708
|
+
SourceDBInstanceAutomatedBackupsArn?: string;
|
|
612
709
|
/**
|
|
613
|
-
*
|
|
614
|
-
*
|
|
615
|
-
*
|
|
616
|
-
*
|
|
617
|
-
*
|
|
618
|
-
* +
|
|
710
|
+
* If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*.
|
|
711
|
+
* For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*.
|
|
712
|
+
* The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the read replica to a standalone DB instance.
|
|
713
|
+
* If you specify the ``UseLatestRestorableTime`` or ``RestoreTime`` properties in conjunction with the ``SourceDBInstanceIdentifier`` property, RDS restores the DB instance to the requested point in time, thereby creating a new DB instance.
|
|
714
|
+
* + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the property, the read replica inherits the value of the ``VPCSecurityGroups`` property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's ``VPCSecurityGroups`` property to the default value because it's not defined in the stack's template. This change might cause unexpected issues.
|
|
715
|
+
* + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica.
|
|
716
|
+
* + If you specify ``SourceDBInstanceIdentifier``, don't specify the ``DBSnapshotIdentifier`` property. You can't create a read replica from a snapshot.
|
|
717
|
+
* + Don't set the ``BackupRetentionPeriod``, ``DBName``, ``MasterUsername``, ``MasterUserPassword``, and ``PreferredBackupWindow`` properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas.
|
|
718
|
+
* + If the source DB instance is in a different region than the read replica, specify the source region in ``SourceRegion``, and specify an ARN for a valid DB instance in ``SourceDBInstanceIdentifier``. For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*.
|
|
719
|
+
* + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances.
|
|
619
720
|
*/
|
|
620
|
-
|
|
721
|
+
SourceDBInstanceIdentifier?: string;
|
|
621
722
|
/**
|
|
622
723
|
* The ID of the region that contains the source DB instance for the read replica.
|
|
623
724
|
*/
|
|
624
725
|
SourceRegion?: string;
|
|
625
726
|
/**
|
|
626
|
-
*
|
|
627
|
-
*
|
|
628
|
-
*
|
|
727
|
+
* A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
|
|
728
|
+
* If you specify the ``KmsKeyId`` property, then you must enable encryption.
|
|
729
|
+
* If you specify the ``SourceDBInstanceIdentifier`` or ``SourceDbiResourceId`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used.
|
|
730
|
+
* If you specify the ``SourceDBInstanceAutomatedBackupsArn`` property, don't specify this property. The value is inherited from the source DB instance automated backup.
|
|
731
|
+
* If you specify ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the snapshot.
|
|
732
|
+
* *Amazon Aurora*
|
|
733
|
+
* Not applicable. The encryption for DB instances is managed by the DB cluster.
|
|
629
734
|
*/
|
|
630
|
-
|
|
735
|
+
StorageEncrypted?: boolean;
|
|
631
736
|
/**
|
|
632
|
-
* The
|
|
633
|
-
*
|
|
737
|
+
* The storage type to associate with the DB instance.
|
|
738
|
+
* If you specify ``io1``, ``io2``, or ``gp3``, you must also include a value for the ``Iops`` parameter.
|
|
739
|
+
* This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.
|
|
740
|
+
* Valid Values: ``gp2 | gp3 | io1 | io2 | standard``
|
|
741
|
+
* Default: ``io1``, if the ``Iops`` parameter is specified. Otherwise, ``gp3``.
|
|
634
742
|
*/
|
|
635
|
-
|
|
743
|
+
StorageType?: string;
|
|
636
744
|
/**
|
|
637
|
-
* Specifies
|
|
638
|
-
*
|
|
639
|
-
* Constraints:
|
|
640
|
-
* + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified.
|
|
745
|
+
* Specifies the storage throughput value, in mebibyte per second (MiBps), for the DB instance. This setting applies only to the ``gp3`` storage type.
|
|
746
|
+
* This setting doesn't apply to RDS Custom or Amazon Aurora.
|
|
641
747
|
*/
|
|
642
|
-
|
|
748
|
+
StorageThroughput?: number;
|
|
643
749
|
/**
|
|
644
|
-
*
|
|
750
|
+
* Tags to assign to the DB instance.
|
|
645
751
|
*/
|
|
646
|
-
|
|
752
|
+
Tags?: Tag[];
|
|
753
|
+
TdeCredentialArn?: string;
|
|
754
|
+
TdeCredentialPassword?: string;
|
|
647
755
|
/**
|
|
648
|
-
* The
|
|
649
|
-
* Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456``
|
|
756
|
+
* The time zone of the DB instance. The time zone parameter is currently supported only by [RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone) and [RDS for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone).
|
|
650
757
|
*/
|
|
651
|
-
|
|
758
|
+
Timezone?: string;
|
|
652
759
|
/**
|
|
653
|
-
*
|
|
760
|
+
* Specifies whether the DB instance class of the DB instance uses its default processor features.
|
|
761
|
+
* This setting doesn't apply to RDS Custom DB instances.
|
|
654
762
|
*/
|
|
655
|
-
|
|
763
|
+
UseDefaultProcessorFeatures?: boolean;
|
|
764
|
+
/**
|
|
765
|
+
* Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. This parameter applies to point-in-time recovery. For more information, see [Restoring a DB instance to a specified time](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIT.html) in the in the *Amazon RDS User Guide*.
|
|
766
|
+
* Constraints:
|
|
767
|
+
* + Can't be specified if the ``RestoreTime`` parameter is provided.
|
|
768
|
+
*/
|
|
769
|
+
UseLatestRestorableTime?: boolean;
|
|
656
770
|
/**
|
|
657
771
|
* A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template.
|
|
658
772
|
* If you plan to update the resource, don't specify VPC security groups in a shared VPC.
|
|
@@ -668,134 +782,34 @@ export interface _AWS_RDS_DBINSTANCE {
|
|
|
668
782
|
*/
|
|
669
783
|
VPCSecurityGroups?: string[];
|
|
670
784
|
/**
|
|
671
|
-
*
|
|
672
|
-
*
|
|
673
|
-
|
|
674
|
-
AllowMajorVersionUpgrade?: boolean;
|
|
675
|
-
/**
|
|
676
|
-
* The meaning of this parameter differs according to the database engine you use.
|
|
677
|
-
* If you specify the ``DBSnapshotIdentifier`` property, this property only applies to RDS for Oracle.
|
|
678
|
-
* *Amazon Aurora*
|
|
679
|
-
* Not applicable. The database name is managed by the DB cluster.
|
|
680
|
-
* *Db2*
|
|
681
|
-
* 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.
|
|
682
|
-
* Constraints:
|
|
683
|
-
* + Must contain 1 to 64 letters or numbers.
|
|
684
|
-
* + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
|
|
685
|
-
* + Can't be a word reserved by the specified database engine.
|
|
686
|
-
*
|
|
687
|
-
* *MySQL*
|
|
688
|
-
* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
|
|
689
|
-
* Constraints:
|
|
690
|
-
* + Must contain 1 to 64 letters or numbers.
|
|
691
|
-
* + Can't be a word reserved by the specified database engine
|
|
692
|
-
*
|
|
693
|
-
* *MariaDB*
|
|
694
|
-
* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
|
|
695
|
-
* Constraints:
|
|
696
|
-
* + Must contain 1 to 64 letters or numbers.
|
|
697
|
-
* + Can't be a word reserved by the specified database engine
|
|
698
|
-
*
|
|
699
|
-
* *PostgreSQL*
|
|
700
|
-
* The name of the database to create when the DB instance is created. If this parameter is not specified, the default ``postgres`` database is created in the DB instance.
|
|
701
|
-
* Constraints:
|
|
702
|
-
* + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
|
|
703
|
-
* + Must contain 1 to 63 characters.
|
|
704
|
-
* + Can't be a word reserved by the specified database engine
|
|
705
|
-
*
|
|
706
|
-
* *Oracle*
|
|
707
|
-
* 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``.
|
|
708
|
-
* Default: ``ORCL``
|
|
709
|
-
* Constraints:
|
|
710
|
-
* + Can't be longer than 8 characters
|
|
711
|
-
*
|
|
712
|
-
* *SQL Server*
|
|
713
|
-
* Not applicable. Must be null.
|
|
714
|
-
*/
|
|
715
|
-
DBName?: string;
|
|
716
|
-
/**
|
|
717
|
-
* A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
|
|
718
|
-
* This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.*
|
|
719
|
-
* *Amazon Aurora*
|
|
720
|
-
* Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
|
|
721
|
-
*/
|
|
722
|
-
EnableIAMDatabaseAuthentication?: boolean;
|
|
723
|
-
/**
|
|
724
|
-
* 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.
|
|
725
|
-
* *Amazon Aurora*
|
|
726
|
-
* Not applicable. The retention period for automated backups is managed by the DB cluster.
|
|
727
|
-
* Default: 1
|
|
728
|
-
* Constraints:
|
|
729
|
-
* + Must be a value from 0 to 35
|
|
730
|
-
* + Can't be set to 0 if the DB instance is a source to read replicas
|
|
731
|
-
*/
|
|
732
|
-
BackupRetentionPeriod?: number;
|
|
733
|
-
/**
|
|
734
|
-
* The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
|
|
735
|
-
* This setting is required for RDS Custom.
|
|
736
|
-
* Constraints:
|
|
737
|
-
* + The profile must exist in your account.
|
|
738
|
-
* + The profile must have an IAM role that Amazon EC2 has permissions to assume.
|
|
739
|
-
* + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``.
|
|
740
|
-
*
|
|
741
|
-
* 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 RDS User Guide*.
|
|
742
|
-
*/
|
|
743
|
-
CustomIAMInstanceProfile?: string;
|
|
744
|
-
/**
|
|
745
|
-
* The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.
|
|
746
|
-
* By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack.
|
|
747
|
-
* Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties, and the point-in-time recovery properties ``RestoreTime`` and ``UseLatestRestorableTime``. For information about the properties that you can specify, see the [RestoreDBInstanceFromDBSnapshot](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_RestoreDBInstanceFromDBSnapshot.html) action in the *Amazon RDS API Reference*.
|
|
748
|
-
* After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted.
|
|
749
|
-
* If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties:
|
|
750
|
-
* + ``CharacterSetName``
|
|
751
|
-
* + ``DBClusterIdentifier``
|
|
752
|
-
* + ``DBName``
|
|
753
|
-
* + ``KmsKeyId``
|
|
754
|
-
* + ``MasterUsername``
|
|
755
|
-
* + ``MasterUserPassword``
|
|
756
|
-
* + ``PromotionTier``
|
|
757
|
-
* + ``SourceDBInstanceIdentifier``
|
|
758
|
-
* + ``SourceRegion``
|
|
759
|
-
* + ``StorageEncrypted`` (for an unencrypted snapshot)
|
|
760
|
-
* + ``Timezone``
|
|
761
|
-
*
|
|
762
|
-
* *Amazon Aurora*
|
|
763
|
-
* Not applicable. Snapshot restore is managed by the DB cluster.
|
|
785
|
+
* Specifies whether changes to the DB instance and any pending modifications are applied immediately, regardless of the ``PreferredMaintenanceWindow`` setting. If set to ``false``, changes are applied during the next maintenance window. Until RDS applies the changes, the DB instance remains in a drift state. As a result, the configuration doesn't fully reflect the requested modifications and temporarily diverges from the intended state.
|
|
786
|
+
* In addition to the settings described in [Modifying a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html), this property also determines whether the DB instance reboots when a static parameter is modified in the associated DB parameter group.
|
|
787
|
+
* Default: ``true``
|
|
764
788
|
*/
|
|
765
|
-
|
|
789
|
+
ApplyImmediately?: boolean;
|
|
790
|
+
}
|
|
791
|
+
/**
|
|
792
|
+
* Information about an AWS Identity and Access Management (IAM) role that is associated with a DB instance.
|
|
793
|
+
*/
|
|
794
|
+
export interface DBInstanceRole {
|
|
766
795
|
/**
|
|
767
|
-
* The
|
|
768
|
-
* *Amazon Aurora*
|
|
769
|
-
* Not applicable. CloudWatch Logs exports are managed by the DB cluster.
|
|
770
|
-
* *Db2*
|
|
771
|
-
* Valid values: ``diag.log``, ``notify.log``
|
|
772
|
-
* *MariaDB*
|
|
773
|
-
* Valid values: ``audit``, ``error``, ``general``, ``slowquery``
|
|
774
|
-
* *Microsoft SQL Server*
|
|
775
|
-
* Valid values: ``agent``, ``error``
|
|
776
|
-
* *MySQL*
|
|
777
|
-
* Valid values: ``audit``, ``error``, ``general``, ``slowquery``
|
|
778
|
-
* *Oracle*
|
|
779
|
-
* Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent``
|
|
780
|
-
* *PostgreSQL*
|
|
781
|
-
* Valid values: ``postgresql``, ``upgrade``
|
|
796
|
+
* The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the ``SupportedFeatureNames`` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html) in the *Amazon RDS API Reference*.
|
|
782
797
|
*/
|
|
783
|
-
|
|
798
|
+
FeatureName: string;
|
|
784
799
|
/**
|
|
785
|
-
*
|
|
786
|
-
* This setting doesn't apply to RDS Custom DB instances.
|
|
800
|
+
* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
|
|
787
801
|
*/
|
|
788
|
-
|
|
802
|
+
RoleArn: string;
|
|
789
803
|
}
|
|
790
804
|
export interface CertificateDetails {
|
|
791
|
-
/**
|
|
792
|
-
* The expiration date of the DB instance’s server certificate.
|
|
793
|
-
*/
|
|
794
|
-
ValidTill?: string;
|
|
795
805
|
/**
|
|
796
806
|
* The CA identifier of the CA certificate used for the DB instance's server certificate.
|
|
797
807
|
*/
|
|
798
808
|
CAIdentifier?: string;
|
|
809
|
+
/**
|
|
810
|
+
* The expiration date of the DB instance’s server certificate.
|
|
811
|
+
*/
|
|
812
|
+
ValidTill?: string;
|
|
799
813
|
}
|
|
800
814
|
export interface Endpoint {
|
|
801
815
|
/**
|
|
@@ -811,20 +825,6 @@ export interface Endpoint {
|
|
|
811
825
|
*/
|
|
812
826
|
HostedZoneId?: string;
|
|
813
827
|
}
|
|
814
|
-
/**
|
|
815
|
-
* Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
|
|
816
|
-
* For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.
|
|
817
|
-
*/
|
|
818
|
-
export interface Tag {
|
|
819
|
-
/**
|
|
820
|
-
* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").
|
|
821
|
-
*/
|
|
822
|
-
Value?: string;
|
|
823
|
-
/**
|
|
824
|
-
* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").
|
|
825
|
-
*/
|
|
826
|
-
Key: string;
|
|
827
|
-
}
|
|
828
828
|
/**
|
|
829
829
|
* The secret managed by RDS in AWS Secrets Manager for the master user password.
|
|
830
830
|
* For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*
|
|
@@ -840,28 +840,29 @@ export interface MasterUserSecret {
|
|
|
840
840
|
KmsKeyId?: string;
|
|
841
841
|
}
|
|
842
842
|
/**
|
|
843
|
-
*
|
|
843
|
+
* The ``ProcessorFeature`` property type specifies the processor features of a DB instance class.
|
|
844
844
|
*/
|
|
845
|
-
export interface
|
|
845
|
+
export interface ProcessorFeature {
|
|
846
846
|
/**
|
|
847
|
-
* The
|
|
847
|
+
* The name of the processor feature. Valid names are ``coreCount`` and ``threadsPerCore``.
|
|
848
848
|
*/
|
|
849
|
-
|
|
849
|
+
Name?: ("coreCount" | "threadsPerCore");
|
|
850
850
|
/**
|
|
851
|
-
* The
|
|
851
|
+
* The value of a processor feature.
|
|
852
852
|
*/
|
|
853
|
-
|
|
853
|
+
Value?: string;
|
|
854
854
|
}
|
|
855
855
|
/**
|
|
856
|
-
*
|
|
856
|
+
* Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
|
|
857
|
+
* For more information, see [Tagging Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html) in the *Amazon Aurora User Guide*.
|
|
857
858
|
*/
|
|
858
|
-
export interface
|
|
859
|
+
export interface Tag {
|
|
859
860
|
/**
|
|
860
|
-
* The value of
|
|
861
|
+
* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").
|
|
861
862
|
*/
|
|
862
|
-
|
|
863
|
+
Key: string;
|
|
863
864
|
/**
|
|
864
|
-
*
|
|
865
|
+
* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").
|
|
865
866
|
*/
|
|
866
|
-
|
|
867
|
+
Value?: string;
|
|
867
868
|
}
|