@awboost/cfn-resource-types 0.1.107 → 0.1.109

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.
Files changed (37) hide show
  1. package/lib/AWS-CloudFormation-StackSet.d.ts +10 -0
  2. package/lib/AWS-CodePipeline-Pipeline.d.ts +220 -10
  3. package/lib/AWS-CodePipeline-Pipeline.js +1 -1
  4. package/lib/AWS-Deadline-MeteredProduct.d.ts +15 -15
  5. package/lib/AWS-ECS-TaskDefinition.d.ts +6 -6
  6. package/lib/AWS-EntityResolution-IdMappingWorkflow.d.ts +36 -3
  7. package/lib/AWS-EntityResolution-IdNamespace.d.ts +43 -1
  8. package/lib/AWS-EntityResolution-MatchingWorkflow.d.ts +7 -1
  9. package/lib/AWS-EntityResolution-SchemaMapping.d.ts +1 -0
  10. package/lib/AWS-LaunchWizard-Deployment.d.ts +109 -0
  11. package/lib/AWS-LaunchWizard-Deployment.js +12 -0
  12. package/lib/AWS-RDS-DBCluster.d.ts +448 -161
  13. package/lib/AWS-RDS-DBCluster.js +17 -1
  14. package/lib/AWS-RDS-DBClusterParameterGroup.d.ts +29 -11
  15. package/lib/AWS-RDS-DBClusterParameterGroup.js +4 -1
  16. package/lib/AWS-RDS-DBInstance.d.ts +9 -1
  17. package/lib/AWS-RDS-EventSubscription.d.ts +29 -17
  18. package/lib/AWS-RDS-EventSubscription.js +1 -1
  19. package/lib/AWS-RDS-OptionGroup.d.ts +36 -15
  20. package/lib/AWS-RDS-OptionGroup.js +1 -1
  21. package/lib/AWS-S3-Bucket.d.ts +1 -1
  22. package/lib/AWS-SES-MailManagerAddonInstance.d.ts +60 -0
  23. package/lib/AWS-SES-MailManagerAddonInstance.js +12 -0
  24. package/lib/AWS-SES-MailManagerAddonSubscription.d.ts +54 -0
  25. package/lib/AWS-SES-MailManagerAddonSubscription.js +12 -0
  26. package/lib/AWS-SES-MailManagerArchive.d.ts +81 -0
  27. package/lib/AWS-SES-MailManagerArchive.js +12 -0
  28. package/lib/AWS-SES-MailManagerIngressPoint.d.ts +105 -0
  29. package/lib/AWS-SES-MailManagerIngressPoint.js +12 -0
  30. package/lib/AWS-SES-MailManagerRelay.d.ts +88 -0
  31. package/lib/AWS-SES-MailManagerRelay.js +12 -0
  32. package/lib/AWS-SES-MailManagerRuleSet.d.ts +447 -0
  33. package/lib/AWS-SES-MailManagerRuleSet.js +12 -0
  34. package/lib/AWS-SES-MailManagerTrafficPolicy.d.ts +212 -0
  35. package/lib/AWS-SES-MailManagerTrafficPolicy.js +12 -0
  36. package/lib/AWS-WorkSpacesThinClient-Environment.d.ts +5 -0
  37. package/package.json +1 -1
@@ -1,251 +1,506 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
3
3
  /**
4
- * The AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster.
4
+ * The ``AWS::RDS::DBCluster`` resource creates an Amazon Aurora DB cluster or Multi-AZ DB cluster.
5
+ For more information about creating an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.
6
+ For more information about creating a Multi-AZ DB cluster, see [Creating a Multi-AZ DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html) in the *Amazon RDS User Guide*.
7
+ You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported.
8
+ *Updating DB clusters*
9
+ When properties labeled "*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" are updated, AWS CloudFormation first creates a replacement DB cluster, then changes references from other dependent resources to point to the replacement DB cluster, and finally deletes the old DB cluster.
10
+ We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB cluster. To preserve your data, perform the following procedure:
11
+ 1. Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.
12
+ 1. Create a snapshot of the DB cluster. For more information, see [Creating a DB Cluster Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CreateSnapshotCluster.html).
13
+ 1. If you want to restore your DB cluster using a DB cluster snapshot, modify the updated template with your DB cluster changes and add the ``SnapshotIdentifier`` property with the ID of the DB cluster snapshot that you want to use.
14
+ After you restore a DB cluster with a ``SnapshotIdentifier`` property, you must specify the same ``SnapshotIdentifier`` property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the DB cluster snapshot again, and the data in the database is not changed. However, if you don't specify the ``SnapshotIdentifier`` property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified ``SnapshotIdentifier`` property, and the original DB cluster is deleted.
15
+ 1. Update the stack.
16
+
17
+ Currently, when you are updating the stack for an Aurora Serverless DB cluster, you can't include changes to any other properties when you specify one of the following properties: ``PreferredBackupWindow``, ``PreferredMaintenanceWindow``, and ``Port``. This limitation doesn't apply to provisioned DB clusters.
18
+ For more information about updating other properties of this resource, see ``ModifyDBCluster``. For more information about updating stacks, see [CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html).
19
+ *Deleting DB clusters*
20
+ The default ``DeletionPolicy`` for ``AWS::RDS::DBCluster`` resources is ``Snapshot``. For more information about how AWS CloudFormation deletes resources, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).
5
21
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html}
6
22
  */
7
23
  export type RDSDBClusterProperties = {
8
24
  /**
9
- * The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
10
- */
25
+ * The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
26
+ Valid for Cluster Type: Multi-AZ DB clusters only
27
+ This setting is required to create a Multi-AZ DB cluster.
28
+ */
11
29
  AllocatedStorage?: number;
12
30
  /**
13
- * Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
14
- */
31
+ * Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
32
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
33
+ */
15
34
  AssociatedRoles?: DBClusterRole[];
16
35
  /**
17
- * A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
18
- */
36
+ * Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
37
+ Valid for Cluster Type: Multi-AZ DB clusters only
38
+ */
19
39
  AutoMinorVersionUpgrade?: boolean;
20
40
  /**
21
- * A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
22
- */
41
+ * A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see [Choosing the Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the *Amazon Aurora User Guide*.
42
+ Valid for: Aurora DB clusters only
43
+ */
23
44
  AvailabilityZones?: string[];
24
45
  /**
25
- * The target backtrack window, in seconds. To disable backtracking, set this value to 0.
26
- * @min `0`
27
- */
46
+ * The target backtrack window, in seconds. To disable backtracking, set this value to 0.
47
+ Currently, Backtrack is only supported for Aurora MySQL DB clusters.
48
+ Default: 0
49
+ Constraints:
50
+ + If specified, this value must be set to a number from 0 to 259,200 (72 hours).
51
+
52
+ Valid for: Aurora MySQL DB clusters only
53
+ * @min `0`
54
+ */
28
55
  BacktrackWindow?: number;
29
56
  /**
30
- * The number of days for which automated backups are retained.
31
- * @min `1`
32
- */
57
+ * The number of days for which automated backups are retained.
58
+ Default: 1
59
+ Constraints:
60
+ + Must be a value from 1 to 35
61
+
62
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
63
+ * @min `1`
64
+ */
33
65
  BackupRetentionPeriod?: number;
34
66
  /**
35
- * A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
36
- */
67
+ * A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
68
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
69
+ */
37
70
  CopyTagsToSnapshot?: boolean;
38
71
  /**
39
- * The DB cluster identifier. This parameter is stored as a lowercase string.
40
- * @minLength `1`
41
- * @maxLength `63`
42
- * @pattern `^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$`
43
- */
72
+ * The DB cluster identifier. This parameter is stored as a lowercase string.
73
+ Constraints:
74
+ + Must contain from 1 to 63 letters, numbers, or hyphens.
75
+ + First character must be a letter.
76
+ + Can't end with a hyphen or contain two consecutive hyphens.
77
+
78
+ Example: ``my-cluster1``
79
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
80
+ * @minLength `1`
81
+ * @maxLength `63`
82
+ * @pattern `^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$`
83
+ */
44
84
  DBClusterIdentifier?: string;
45
85
  /**
46
- * The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
47
- */
86
+ * The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example ``db.m6gd.xlarge``. Not all DB instance classes are available in all AWS-Regions, or for all database engines.
87
+ For the full list of DB instance classes and availability for your engine, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide*.
88
+ This setting is required to create a Multi-AZ DB cluster.
89
+ Valid for Cluster Type: Multi-AZ DB clusters only
90
+ */
48
91
  DBClusterInstanceClass?: string;
49
92
  /**
50
- * The name of the DB cluster parameter group to associate with this DB cluster.
51
- */
93
+ * The name of the DB cluster parameter group to associate with this DB cluster.
94
+ If you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.
95
+ If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started.
96
+ To list all of the available DB cluster parameter group names, use the following command:
97
+ ``aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text``
98
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
99
+ */
52
100
  DBClusterParameterGroupName?: string;
53
101
  /**
54
- * The name of the DB parameter group to apply to all instances of the DB cluster.
55
- */
102
+ * The name of the DB parameter group to apply to all instances of the DB cluster.
103
+ When you apply a parameter group using the ``DBInstanceParameterGroupName`` parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.
104
+ Valid for Cluster Type: Aurora DB clusters only
105
+ Default: The existing name setting
106
+ Constraints:
107
+ + The DB parameter group must be in the same DB parameter group family as this DB cluster.
108
+ + The ``DBInstanceParameterGroupName`` parameter is valid in combination with the ``AllowMajorVersionUpgrade`` parameter for a major version upgrade only.
109
+ */
56
110
  DBInstanceParameterGroupName?: string;
57
111
  /**
58
- * A DB subnet group that you want to associate with this DB cluster.
59
- */
112
+ * A DB subnet group that you want to associate with this DB cluster.
113
+ If you are restoring a DB cluster to a point in time with ``RestoreType`` set to ``copy-on-write``, and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group.
114
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
115
+ */
60
116
  DBSubnetGroupName?: string;
61
117
  /**
62
118
  * Reserved for future use.
63
119
  */
64
120
  DBSystemId?: string;
65
121
  /**
66
- * The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide.
67
- */
122
+ * The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see [Naming Constraints](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon Aurora User Guide*.
123
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
124
+ */
68
125
  DatabaseName?: string;
69
126
  /**
70
- * A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
71
- */
127
+ * A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
128
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
129
+ */
72
130
  DeletionProtection?: boolean;
73
131
  /**
74
- * The Active Directory directory ID to create the DB cluster in.
75
- */
132
+ * Indicates the directory ID of the Active Directory to create the DB cluster.
133
+ For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.
134
+ For more information, see [Kerberos authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the *Amazon Aurora User Guide*.
135
+ Valid for: Aurora DB clusters only
136
+ */
76
137
  Domain?: string;
77
138
  /**
78
- * Specify the name of the IAM role to be used when making API calls to the Directory Service.
79
- */
139
+ * Specifies the name of the IAM role to use when making API calls to the Directory Service.
140
+ Valid for: Aurora DB clusters only
141
+ */
80
142
  DomainIAMRoleName?: string;
81
143
  /**
82
- * 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 in the Amazon Aurora User Guide.
83
- */
144
+ * 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/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide*.
145
+ *Aurora MySQL*
146
+ Valid values: ``audit``, ``error``, ``general``, ``slowquery``
147
+ *Aurora PostgreSQL*
148
+ Valid values: ``postgresql``
149
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
150
+ */
84
151
  EnableCloudwatchLogsExports?: string[];
85
152
  /**
86
- * Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
87
- */
153
+ * Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
154
+ You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.
155
+ Valid for Cluster Type: Aurora DB clusters only
156
+ */
88
157
  EnableGlobalWriteForwarding?: boolean;
89
158
  /**
90
- * A value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled.
91
- */
159
+ * Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
160
+ When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
161
+ RDS Data API is supported with the following DB clusters:
162
+ + Aurora PostgreSQL Serverless v2 and provisioned
163
+ + Aurora PostgreSQL and Aurora MySQL Serverless v1
164
+
165
+ For more information, see [Using RDS Data API](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide*.
166
+ Valid for Cluster Type: Aurora DB clusters only
167
+ */
92
168
  EnableHttpEndpoint?: boolean;
93
169
  /**
94
- * A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
95
- */
170
+ * A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
171
+ For more information, see [IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide.*
172
+ Valid for: Aurora DB clusters only
173
+ */
96
174
  EnableIAMDatabaseAuthentication?: boolean;
97
175
  /**
98
- * Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
99
- */
176
+ * Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
177
+ Valid for: Aurora DB clusters only
178
+ */
100
179
  EnableLocalWriteForwarding?: boolean;
101
180
  /**
102
- * The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
103
- */
181
+ * The name of the database engine to be used for this DB cluster.
182
+ Valid Values:
183
+ + ``aurora-mysql``
184
+ + ``aurora-postgresql``
185
+ + ``mysql``
186
+ + ``postgres``
187
+
188
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
189
+ */
104
190
  Engine?: string;
105
191
  /**
106
- * The life cycle type of the DB cluster. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support.
107
- */
192
+ * The life cycle type for this DB cluster.
193
+ By default, this value is set to ``open-source-rds-extended-support``, which enrolls your DB cluster 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 cluster will fail if the DB major version is past its end of standard support date.
194
+ You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
195
+ + Amazon Aurora (PostgreSQL only) - [Using Amazon RDS Extended Support](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html) in the *Amazon Aurora User Guide*
196
+ + Amazon RDS - [Using Amazon RDS Extended Support](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide*
197
+
198
+ Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
199
+ Valid Values: ``open-source-rds-extended-support | open-source-rds-extended-support-disabled``
200
+ Default: ``open-source-rds-extended-support``
201
+ */
108
202
  EngineLifecycleSupport?: string;
109
203
  /**
110
- * The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
111
- */
204
+ * The DB engine mode of the DB cluster, either ``provisioned`` or ``serverless``.
205
+ The ``serverless`` engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the ``provisioned`` engine mode.
206
+ For information about limitations and requirements for Serverless DB clusters, see the following sections in the *Amazon Aurora User Guide*:
207
+ + [Limitations of Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations)
208
+ + [Requirements for Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html)
209
+
210
+ Valid for Cluster Type: Aurora DB clusters only
211
+ */
112
212
  EngineMode?: string;
113
213
  /**
114
- * The version number of the database engine to use.
115
- */
214
+ * The version number of the database engine to use.
215
+ To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (8.0-compatible), use the following command:
216
+ ``aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"``
217
+ You can supply either ``5.7`` or ``8.0`` to use the default engine version for Aurora MySQL version 2 or version 3, respectively.
218
+ To list all of the available engine versions for Aurora PostgreSQL, use the following command:
219
+ ``aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"``
220
+ To list all of the available engine versions for RDS for MySQL, use the following command:
221
+ ``aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"``
222
+ To list all of the available engine versions for RDS for PostgreSQL, use the following command:
223
+ ``aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"``
224
+ *Aurora MySQL*
225
+ For information, see [Database engine updates for Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) in the *Amazon Aurora User Guide*.
226
+ *Aurora PostgreSQL*
227
+ For information, see [Amazon Aurora PostgreSQL releases and engine versions](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html) in the *Amazon Aurora User Guide*.
228
+ *MySQL*
229
+ For information, see [Amazon RDS for MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide*.
230
+ *PostgreSQL*
231
+ For information, see [Amazon RDS for PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) in the *Amazon RDS User Guide*.
232
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
233
+ */
116
234
  EngineVersion?: string;
117
235
  /**
118
- * If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.
119
-
120
- If you aren't configuring a global database cluster, don't specify this property.
236
+ * If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the [AWS::RDS::GlobalCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html) resource.
237
+ If you aren't configuring a global database cluster, don't specify this property.
238
+ To remove the DB cluster from a global database cluster, specify an empty value for the ``GlobalClusterIdentifier`` property.
239
+ For information about Aurora global databases, see [Working with Amazon Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) in the *Amazon Aurora User Guide*.
240
+ Valid for: Aurora DB clusters only
121
241
  * @minLength `0`
122
242
  * @maxLength `63`
123
243
  * @pattern `^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$`
124
244
  */
125
245
  GlobalClusterIdentifier?: string;
126
246
  /**
127
- * The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
128
- */
247
+ * The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
248
+ For information about valid IOPS values, see [Provisioned IOPS storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*.
249
+ This setting is required to create a Multi-AZ DB cluster.
250
+ Valid for Cluster Type: Multi-AZ DB clusters only
251
+ Constraints:
252
+ + Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
253
+ */
129
254
  Iops?: number;
130
255
  /**
131
- * The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, 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, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true.
132
- */
256
+ * The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, 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, the default KMS key is used. If you specify this property, you must set the ``StorageEncrypted`` property to ``true``.
257
+ If you specify the ``SnapshotIdentifier`` property, the ``StorageEncrypted`` property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified ``KmsKeyId`` property is used.
258
+ If you create a read replica of an encrypted DB cluster in another AWS Region, make sure to set ``KmsKeyId`` to a KMS key identifier that is valid in the destination AWS Region. This KMS key is used to encrypt the read replica in that AWS Region.
259
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
260
+ */
133
261
  KmsKeyId?: string;
134
262
  /**
135
- * A value that indicates whether to manage the master user password with AWS Secrets Manager.
136
- */
263
+ * Specifies whether to manage the master user password with AWS Secrets Manager.
264
+ 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* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*
265
+ Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
266
+ Constraints:
267
+ + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified.
268
+ */
137
269
  ManageMasterUserPassword?: boolean;
138
270
  /**
139
- * The master password for the DB instance.
140
- */
271
+ * The master password for the DB instance.
272
+ If you specify the ``SourceDBClusterIdentifier``, ``SnapshotIdentifier``, or ``GlobalClusterIdentifier`` property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.
273
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
274
+ */
141
275
  MasterUserPassword?: string;
142
276
  /**
143
- * Contains the secret managed by RDS in AWS Secrets Manager for the master user password.
144
- */
277
+ * The secret managed by RDS in AWS Secrets Manager for the master user password.
278
+ 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* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*
279
+ */
145
280
  MasterUserSecret?: MasterUserSecret;
146
281
  /**
147
- * The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.
148
- * @minLength `1`
149
- * @pattern `^[a-zA-Z]{1}[a-zA-Z0-9_]*$`
150
- */
282
+ * The name of the master user for the DB cluster.
283
+ If you specify the ``SourceDBClusterIdentifier``, ``SnapshotIdentifier``, or ``GlobalClusterIdentifier`` property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.
284
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
285
+ * @minLength `1`
286
+ * @pattern `^[a-zA-Z]{1}[a-zA-Z0-9_]*$`
287
+ */
151
288
  MasterUsername?: string;
152
289
  /**
153
- * The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.
154
- */
290
+ * The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify ``0``.
291
+ If ``MonitoringRoleArn`` is specified, also set ``MonitoringInterval`` to a value other than ``0``.
292
+ Valid for Cluster Type: Multi-AZ DB clusters only
293
+ Valid Values: ``0 | 1 | 5 | 10 | 15 | 30 | 60``
294
+ Default: ``0``
295
+ */
155
296
  MonitoringInterval?: number;
156
297
  /**
157
- * The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
158
- */
298
+ * The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is ``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*.
299
+ If ``MonitoringInterval`` is set to a value other than ``0``, supply a ``MonitoringRoleArn`` value.
300
+ Valid for Cluster Type: Multi-AZ DB clusters only
301
+ */
159
302
  MonitoringRoleArn?: string;
160
303
  /**
161
- * The network type of the DB cluster.
162
- */
304
+ * The network type of the DB cluster.
305
+ Valid values:
306
+ + ``IPV4``
307
+ + ``DUAL``
308
+
309
+ The network type is determined by the ``DBSubnetGroup`` specified for the DB cluster. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``).
310
+ For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon Aurora User Guide.*
311
+ Valid for: Aurora DB clusters only
312
+ */
163
313
  NetworkType?: string;
164
314
  /**
165
- * A value that indicates whether to turn on Performance Insights for the DB cluster.
166
- */
315
+ * Specifies whether to turn on Performance Insights for the DB cluster.
316
+ 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*.
317
+ Valid for Cluster Type: Multi-AZ DB clusters only
318
+ */
167
319
  PerformanceInsightsEnabled?: boolean;
168
320
  /**
169
- * The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
170
- */
321
+ * The AWS KMS key identifier for encryption of Performance Insights data.
322
+ The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
323
+ If you don't 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.
324
+ Valid for Cluster Type: Multi-AZ DB clusters only
325
+ */
171
326
  PerformanceInsightsKmsKeyId?: string;
172
327
  /**
173
- * The amount of time, in days, to retain Performance Insights data.
174
- */
328
+ * The number of days to retain Performance Insights data.
329
+ Valid for Cluster Type: Multi-AZ DB clusters only
330
+ Valid Values:
331
+ + ``7``
332
+ + *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)
333
+ + ``731``
334
+
335
+ Default: ``7`` days
336
+ If you specify a retention period that isn't valid, such as ``94``, Amazon RDS issues an error.
337
+ */
175
338
  PerformanceInsightsRetentionPeriod?: number;
176
339
  /**
177
- * The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.
178
- */
340
+ * The port number on which the DB instances in the DB cluster accept connections.
341
+ Default:
342
+ + When ``EngineMode`` is ``provisioned``, ``3306`` (for both Aurora MySQL and Aurora PostgreSQL)
343
+ + When ``EngineMode`` is ``serverless``:
344
+ + ``3306`` when ``Engine`` is ``aurora`` or ``aurora-mysql``
345
+ + ``5432`` when ``Engine`` is ``aurora-postgresql``
346
+
347
+
348
+ The ``No interruption`` on update behavior only applies to DB clusters. If you are updating a DB instance, see [Port](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port) for the AWS::RDS::DBInstance resource.
349
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
350
+ */
179
351
  Port?: number;
180
352
  /**
181
- * The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
182
- */
353
+ * The daily time range during which automated backups are created. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the *Amazon Aurora User Guide.*
354
+ Constraints:
355
+ + Must be in the format ``hh24:mi-hh24:mi``.
356
+ + Must be in Universal Coordinated Time (UTC).
357
+ + Must not conflict with the preferred maintenance window.
358
+ + Must be at least 30 minutes.
359
+
360
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
361
+ */
183
362
  PreferredBackupWindow?: string;
184
363
  /**
185
- * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). 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 Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
186
- */
364
+ * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
365
+ Format: ``ddd:hh24:mi-ddd:hh24:mi``
366
+ 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 [Adjusting the Preferred DB Cluster Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the *Amazon Aurora User Guide.*
367
+ Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
368
+ Constraints: Minimum 30-minute window.
369
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
370
+ */
187
371
  PreferredMaintenanceWindow?: string;
188
372
  /**
189
- * A value that indicates whether the DB cluster is publicly accessible.
190
- */
373
+ * Specifies whether the DB cluster is publicly accessible.
374
+ When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
375
+ When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
376
+ Valid for Cluster Type: Multi-AZ DB clusters only
377
+ Default: The default behavior varies depending on whether ``DBSubnetGroupName`` is specified.
378
+ If ``DBSubnetGroupName`` isn't specified, and ``PubliclyAccessible`` isn't specified, the following applies:
379
+ + If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
380
+ + If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
381
+
382
+ If ``DBSubnetGroupName`` is specified, and ``PubliclyAccessible`` isn't specified, the following applies:
383
+ + If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
384
+ + If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
385
+ */
191
386
  PubliclyAccessible?: boolean;
192
387
  /**
193
- * The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
194
- */
388
+ * The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
389
+ Valid for: Aurora DB clusters only
390
+ */
195
391
  ReplicationSourceIdentifier?: string;
196
392
  /**
197
- * The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z
198
- */
393
+ * The date and time to restore the DB cluster to.
394
+ Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
395
+ Constraints:
396
+ + Must be before the latest restorable time for the DB instance
397
+ + Must be specified if ``UseLatestRestorableTime`` parameter isn't provided
398
+ + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled
399
+ + Can't be specified if the ``RestoreType`` parameter is ``copy-on-write``
400
+
401
+ This property must be used with ``SourceDBClusterIdentifier`` property. The resulting cluster will have the identifier that matches the value of the ``DBclusterIdentifier`` property.
402
+ Example: ``2015-03-07T23:45:00Z``
403
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
404
+ */
199
405
  RestoreToTime?: string;
200
406
  /**
201
407
  * The type of restore to be performed. You can specify one of the following values:
202
- full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
203
- copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
408
+ + ``full-copy`` - The new DB cluster is restored as a full copy of the source DB cluster.
409
+ + ``copy-on-write`` - The new DB cluster is restored as a clone of the source DB cluster.
410
+
411
+ If you don't specify a ``RestoreType`` value, then the new DB cluster is restored as a full copy of the source DB cluster.
412
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
204
413
  */
205
414
  RestoreType?: string;
206
415
  /**
207
- * The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.
208
- */
416
+ * The scaling configuration of an Aurora Serverless v1 DB cluster.
417
+ This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ``ServerlessV2ScalingConfiguration`` property.
418
+ Valid for: Aurora Serverless v1 DB clusters only
419
+ */
209
420
  ScalingConfiguration?: ScalingConfiguration;
210
421
  /**
211
- * Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
212
- */
422
+ * The scaling configuration of an Aurora Serverless V2 DB cluster.
423
+ This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, Use the ``ScalingConfiguration`` property.
424
+ Valid for: Aurora Serverless v2 DB clusters only
425
+ */
213
426
  ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfiguration;
214
427
  /**
215
428
  * The identifier for the DB snapshot or DB cluster snapshot to restore from.
216
- You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
217
- After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
429
+ You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
430
+ After you restore a DB cluster with a ``SnapshotIdentifier`` property, you must specify the same ``SnapshotIdentifier`` property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the ``SnapshotIdentifier`` property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified ``SnapshotIdentifier`` property, and the original DB cluster is deleted.
431
+ If you specify the ``SnapshotIdentifier`` property to restore a DB cluster (as opposed to specifying it for DB cluster updates), then don't specify the following properties:
432
+ + ``GlobalClusterIdentifier``
433
+ + ``MasterUsername``
434
+ + ``MasterUserPassword``
435
+ + ``ReplicationSourceIdentifier``
436
+ + ``RestoreType``
437
+ + ``SourceDBClusterIdentifier``
438
+ + ``SourceRegion``
439
+ + ``StorageEncrypted`` (for an encrypted snapshot)
440
+ + ``UseLatestRestorableTime``
441
+
442
+ Constraints:
443
+ + Must match the identifier of an existing Snapshot.
444
+
445
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
218
446
  */
219
447
  SnapshotIdentifier?: string;
220
448
  /**
221
- * The identifier of the source DB cluster from which to restore.
222
- */
449
+ * When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.
450
+ Constraints:
451
+ + Must match the identifier of an existing DBCluster.
452
+
453
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
454
+ */
223
455
  SourceDBClusterIdentifier?: string;
224
456
  /**
225
- * The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.
226
- */
457
+ * The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, ``us-east-1``.
458
+ Valid for: Aurora DB clusters only
459
+ */
227
460
  SourceRegion?: string;
228
461
  /**
229
- * Indicates whether the DB instance is encrypted.
230
- If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance.
462
+ * Indicates whether the DB cluster is encrypted.
463
+ If you specify the ``KmsKeyId`` property, then you must enable encryption.
464
+ If you specify the ``SourceDBClusterIdentifier`` property, don't specify this property. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specified ``KmsKeyId`` property is used.
465
+ If you specify the ``SnapshotIdentifier`` and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified ``KmsKeyId`` property is used.
466
+ If you specify the ``SnapshotIdentifier`` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB cluster is encrypted. Specify the ``KmsKeyId`` property for the KMS key to use for encryption. If you don't want the restored DB cluster to be encrypted, then don't set this property or set it to ``false``.
467
+ If you specify both the ``StorageEncrypted`` and ``SnapshotIdentifier`` properties without specifying the ``KmsKeyId`` property, then the restored DB cluster inherits the encryption settings from the DB snapshot that provide.
468
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
231
469
  */
232
470
  StorageEncrypted?: boolean;
233
471
  /**
234
- * Specifies the storage type to be associated with the DB cluster.
235
- */
472
+ * The storage type to associate with the DB cluster.
473
+ For information on storage types for Aurora DB clusters, see [Storage configurations for Amazon Aurora DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type). For information on storage types for Multi-AZ DB clusters, see [Settings for creating Multi-AZ DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings).
474
+ This setting is required to create a Multi-AZ DB cluster.
475
+ When specified for a Multi-AZ DB cluster, a value for the ``Iops`` parameter is required.
476
+ Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
477
+ Valid Values:
478
+ + Aurora DB clusters - ``aurora | aurora-iopt1``
479
+ + Multi-AZ DB clusters - ``io1 | io2 | gp3``
480
+
481
+ Default:
482
+ + Aurora DB clusters - ``aurora``
483
+ + Multi-AZ DB clusters - ``io1``
484
+
485
+ When you create an Aurora DB cluster with the storage type set to ``aurora-iopt1``, the storage type is returned in the response. The storage type isn't returned when you set it to ``aurora``.
486
+ */
236
487
  StorageType?: string;
237
488
  /**
238
- * An array of key-value pairs to apply to this resource.
239
- * @maxLength `50`
240
- */
489
+ * An optional array of key-value pairs to apply to this DB cluster.
490
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
491
+ * @maxLength `50`
492
+ */
241
493
  Tags?: Tag[];
242
494
  /**
243
- * A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time.
244
- */
495
+ * A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time.
496
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
497
+ */
245
498
  UseLatestRestorableTime?: boolean;
246
499
  /**
247
- * A list of EC2 VPC security groups to associate with this DB cluster.
248
- */
500
+ * A list of EC2 VPC security groups to associate with this DB cluster.
501
+ If you plan to update the resource, don't specify VPC security groups in a shared VPC.
502
+ Valid for: Aurora DB clusters and Multi-AZ DB clusters
503
+ */
249
504
  VpcSecurityGroupIds?: string[];
250
505
  };
251
506
  /**
@@ -253,42 +508,45 @@ export type RDSDBClusterProperties = {
253
508
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#aws-resource-rds-dbcluster-return-values}
254
509
  */
255
510
  export type RDSDBClusterAttributes = {
256
- /**
257
- * The Amazon Resource Name (ARN) for the DB cluster.
258
- */
259
511
  DBClusterArn: string;
512
+ DBClusterResourceId: string;
260
513
  /**
261
- * The AWS Region-unique, immutable identifier for the DB cluster.
514
+ * The ``Endpoint`` return value specifies the connection endpoint for the primary instance of the DB cluster.
262
515
  */
263
- DBClusterResourceId: string;
264
516
  Endpoint: {
265
517
  /**
266
- * The connection endpoint for the DB cluster.
518
+ * Specifies the connection endpoint for the primary instance of the DB cluster.
267
519
  */
268
520
  Address: string;
269
521
  /**
270
- * The port number that will accept connections on this DB cluster.
522
+ * Specifies the port that the database engine is listening on.
271
523
  */
272
524
  Port: string;
273
525
  };
274
526
  /**
275
- * Contains the secret managed by RDS in AWS Secrets Manager for the master user password.
276
- */
527
+ * The secret managed by RDS in AWS Secrets Manager for the master user password.
528
+ 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* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*
529
+ */
277
530
  MasterUserSecret: {
278
531
  /**
279
532
  * The Amazon Resource Name (ARN) of the secret.
280
533
  */
281
534
  SecretArn: string;
282
535
  };
536
+ /**
537
+ * This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:
538
+ + ``CreateDBInstance``
539
+ + ``DescribeDBInstances``
540
+ + ``DeleteDBInstance``
541
+
542
+ For the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``.
543
+ */
283
544
  ReadEndpoint: {
284
545
  /**
285
- * The reader endpoint for the DB cluster.
546
+ * The host address of the reader endpoint.
286
547
  */
287
548
  Address: string;
288
549
  };
289
- /**
290
- * Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type.
291
- */
292
550
  StorageThroughput: number;
293
551
  };
294
552
  /**
@@ -298,7 +556,7 @@ export type RDSDBClusterAttributes = {
298
556
  */
299
557
  export type DBClusterRole = {
300
558
  /**
301
- * The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference.
559
+ * The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB cluster grant permission for the DB cluster 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*.
302
560
  */
303
561
  FeatureName?: string;
304
562
  /**
@@ -308,6 +566,8 @@ export type DBClusterRole = {
308
566
  };
309
567
  /**
310
568
  * Type definition for `AWS::RDS::DBCluster.MasterUserSecret`.
569
+ * The ``MasterUserSecret`` return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password.
570
+ 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* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*
311
571
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html}
312
572
  */
313
573
  export type MasterUserSecret = {
@@ -318,55 +578,65 @@ export type MasterUserSecret = {
318
578
  };
319
579
  /**
320
580
  * Type definition for `AWS::RDS::DBCluster.ScalingConfiguration`.
321
- * The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.
581
+ * The ``ScalingConfiguration`` property type specifies the scaling configuration of an Aurora Serverless v1 DB cluster.
582
+ For more information, see [Using Amazon Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) in the *Amazon Aurora User Guide*.
583
+ This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ``ServerlessV2ScalingConfiguration`` property.
584
+ Valid for: Aurora Serverless v1 DB clusters only
322
585
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html}
323
586
  */
324
587
  export type ScalingConfiguration = {
325
588
  /**
326
- * A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
327
- */
589
+ * Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in ``serverless`` DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
590
+ If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
591
+ */
328
592
  AutoPause?: boolean;
329
593
  /**
330
- * The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
331
- For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
332
- For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
333
- The maximum capacity must be greater than or equal to the minimum capacity.
594
+ * The maximum capacity for an Aurora DB cluster in ``serverless`` DB engine mode.
595
+ For Aurora MySQL, valid capacity values are ``1``, ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``128``, and ``256``.
596
+ For Aurora PostgreSQL, valid capacity values are ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``192``, and ``384``.
597
+ The maximum capacity must be greater than or equal to the minimum capacity.
334
598
  */
335
599
  MaxCapacity?: number;
336
600
  /**
337
- * The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
338
- For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
339
- For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
340
- The minimum capacity must be less than or equal to the maximum capacity.
601
+ * The minimum capacity for an Aurora DB cluster in ``serverless`` DB engine mode.
602
+ For Aurora MySQL, valid capacity values are ``1``, ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``128``, and ``256``.
603
+ For Aurora PostgreSQL, valid capacity values are ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``192``, and ``384``.
604
+ The minimum capacity must be less than or equal to the maximum capacity.
341
605
  */
342
606
  MinCapacity?: number;
343
607
  /**
344
- * The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action.
345
- The default is 300.
608
+ * The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
609
+ Specify a value between 60 and 600 seconds.
346
610
  */
347
611
  SecondsBeforeTimeout?: number;
348
612
  /**
349
- * The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
350
- */
613
+ * The time, in seconds, before an Aurora DB cluster in ``serverless`` mode is paused.
614
+ Specify a value between 300 and 86,400 seconds.
615
+ */
351
616
  SecondsUntilAutoPause?: number;
352
617
  /**
353
- * The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
354
- ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.
355
- RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.
356
-
357
- For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
618
+ * The action to take when the timeout is reached, either ``ForceApplyCapacityChange`` or ``RollbackCapacityChange``.
619
+ ``ForceApplyCapacityChange`` sets the capacity to the specified value as soon as possible.
620
+ ``RollbackCapacityChange``, the default, ignores the capacity change if a scaling point isn't found in the timeout period.
621
+ If you specify ``ForceApplyCapacityChange``, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.
622
+ For more information, see [Autoscaling for Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling) in the *Amazon Aurora User Guide*.
358
623
  */
359
624
  TimeoutAction?: string;
360
625
  };
361
626
  /**
362
627
  * Type definition for `AWS::RDS::DBCluster.ServerlessV2ScalingConfiguration`.
363
- * Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
628
+ * The ``ServerlessV2ScalingConfiguration`` property type specifies the scaling configuration of an Aurora Serverless V2 DB cluster. For more information, see [Using Amazon Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) in the *Amazon Aurora User Guide*.
629
+ If you have an Aurora cluster, you must set this attribute before you add a DB instance that uses the ``db.serverless`` DB instance class. For more information, see [Clusters that use Aurora Serverless v2 must have a capacity range specified](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html#aurora-serverless-v2.requirements.capacity-range) in the *Amazon Aurora User Guide*.
630
+ This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, use the ``ScalingConfiguration`` property.
631
+ Valid for: Aurora Serverless v2 DB clusters
364
632
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-serverlessv2scalingconfiguration.html}
365
633
  */
366
634
  export type ServerlessV2ScalingConfiguration = {
367
635
  /**
368
- * The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
369
- */
636
+ * The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
637
+ The maximum capacity must be higher than 0.5 ACUs. For more information, see [Choosing the maximum Aurora Serverless v2 capacity setting for a cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.setting-capacity.html#aurora-serverless-v2.max_capacity_considerations) in the *Amazon Aurora User Guide*.
638
+ Aurora automatically sets certain parameters for Aurora Serverless V2 DB instances to values that depend on the maximum ACU value in the capacity range. When you update the maximum capacity value, the ``ParameterApplyStatus`` value for the DB instance changes to ``pending-reboot``. You can update the parameter values by rebooting the DB instance after changing the capacity range.
639
+ */
370
640
  MaxCapacity?: number;
371
641
  /**
372
642
  * The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
@@ -375,25 +645,42 @@ export type ServerlessV2ScalingConfiguration = {
375
645
  };
376
646
  /**
377
647
  * Type definition for `AWS::RDS::DBCluster.Tag`.
378
- * A key-value pair to associate with a resource.
648
+ * Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
649
+ 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*.
379
650
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-tag.html}
380
651
  */
381
652
  export type Tag = {
382
653
  /**
383
- * The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
654
+ * 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}_.:/=+\\-@]*)$").
384
655
  * @minLength `1`
385
656
  * @maxLength `128`
386
657
  */
387
658
  Key: string;
388
659
  /**
389
- * The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
660
+ * 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}_.:/=+\\-@]*)$").
390
661
  * @minLength `0`
391
662
  * @maxLength `256`
392
663
  */
393
664
  Value?: string;
394
665
  };
395
666
  /**
396
- * The AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster.
667
+ * The ``AWS::RDS::DBCluster`` resource creates an Amazon Aurora DB cluster or Multi-AZ DB cluster.
668
+ For more information about creating an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.
669
+ For more information about creating a Multi-AZ DB cluster, see [Creating a Multi-AZ DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html) in the *Amazon RDS User Guide*.
670
+ You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported.
671
+ *Updating DB clusters*
672
+ When properties labeled "*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" are updated, AWS CloudFormation first creates a replacement DB cluster, then changes references from other dependent resources to point to the replacement DB cluster, and finally deletes the old DB cluster.
673
+ We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB cluster. To preserve your data, perform the following procedure:
674
+ 1. Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.
675
+ 1. Create a snapshot of the DB cluster. For more information, see [Creating a DB Cluster Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CreateSnapshotCluster.html).
676
+ 1. If you want to restore your DB cluster using a DB cluster snapshot, modify the updated template with your DB cluster changes and add the ``SnapshotIdentifier`` property with the ID of the DB cluster snapshot that you want to use.
677
+ After you restore a DB cluster with a ``SnapshotIdentifier`` property, you must specify the same ``SnapshotIdentifier`` property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the DB cluster snapshot again, and the data in the database is not changed. However, if you don't specify the ``SnapshotIdentifier`` property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified ``SnapshotIdentifier`` property, and the original DB cluster is deleted.
678
+ 1. Update the stack.
679
+
680
+ Currently, when you are updating the stack for an Aurora Serverless DB cluster, you can't include changes to any other properties when you specify one of the following properties: ``PreferredBackupWindow``, ``PreferredMaintenanceWindow``, and ``Port``. This limitation doesn't apply to provisioned DB clusters.
681
+ For more information about updating other properties of this resource, see ``ModifyDBCluster``. For more information about updating stacks, see [CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html).
682
+ *Deleting DB clusters*
683
+ The default ``DeletionPolicy`` for ``AWS::RDS::DBCluster`` resources is ``Snapshot``. For more information about how AWS CloudFormation deletes resources, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).
397
684
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html}
398
685
  */
399
686
  export declare class RDSDBCluster extends $Resource<"AWS::RDS::DBCluster", RDSDBClusterProperties, RDSDBClusterAttributes> {