@awboost/cfn-resource-types 0.1.123 → 0.1.124
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/AWS-KinesisFirehose-DeliveryStream.d.ts +0 -1
- package/lib/AWS-NetworkFirewall-LoggingConfiguration.d.ts +1 -1
- package/lib/AWS-OSIS-Pipeline.d.ts +28 -0
- package/lib/AWS-RDS-DBCluster.d.ts +10 -12
- package/lib/AWS-RDS-DBCluster.js +2 -2
- package/lib/AWS-RDS-DBClusterParameterGroup.d.ts +23 -11
- package/lib/AWS-RDS-DBClusterParameterGroup.js +1 -1
- package/lib/AWS-RDS-DBInstance.d.ts +36 -28
- package/lib/AWS-RDS-DBInstance.js +1 -1
- package/lib/AWS-RDS-DBParameterGroup.d.ts +26 -14
- package/lib/AWS-RDS-DBSubnetGroup.d.ts +7 -3
- package/lib/AWS-RDS-EventSubscription.d.ts +4 -3
- package/lib/AWS-RDS-OptionGroup.d.ts +2 -2
- package/package.json +1 -1
|
@@ -30,7 +30,7 @@ export type LogDestinationConfig = {
|
|
|
30
30
|
*/
|
|
31
31
|
LogDestination: Record<string, string>;
|
|
32
32
|
LogDestinationType: "S3" | "CloudWatchLogs" | "KinesisDataFirehose";
|
|
33
|
-
LogType: "ALERT" | "FLOW";
|
|
33
|
+
LogType: "ALERT" | "FLOW" | "TLS";
|
|
34
34
|
};
|
|
35
35
|
/**
|
|
36
36
|
* Type definition for `AWS::NetworkFirewall::LoggingConfiguration.LoggingConfiguration`.
|
|
@@ -98,6 +98,20 @@ export type OSISPipelineAttributes = {
|
|
|
98
98
|
* A list of subnet IDs associated with the VPC endpoint.
|
|
99
99
|
*/
|
|
100
100
|
SubnetIds: string[];
|
|
101
|
+
/**
|
|
102
|
+
* Options for attaching a VPC to the pipeline.
|
|
103
|
+
*/
|
|
104
|
+
VpcAttachmentOptions: {
|
|
105
|
+
/**
|
|
106
|
+
* Whether the pipeline should be attached to the provided VPC
|
|
107
|
+
*/
|
|
108
|
+
AttachToVpc: boolean;
|
|
109
|
+
/**
|
|
110
|
+
* The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).
|
|
111
|
+
* @pattern `^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(3[0-2]|[12]?[0-9])$`
|
|
112
|
+
*/
|
|
113
|
+
CidrBlock: string;
|
|
114
|
+
};
|
|
101
115
|
/**
|
|
102
116
|
* Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.
|
|
103
117
|
*/
|
|
@@ -201,6 +215,20 @@ export type VpcOptions = {
|
|
|
201
215
|
* A list of subnet IDs associated with the VPC endpoint.
|
|
202
216
|
*/
|
|
203
217
|
SubnetIds: string[];
|
|
218
|
+
/**
|
|
219
|
+
* Options for attaching a VPC to the pipeline.
|
|
220
|
+
*/
|
|
221
|
+
VpcAttachmentOptions?: {
|
|
222
|
+
/**
|
|
223
|
+
* Whether the pipeline should be attached to the provided VPC
|
|
224
|
+
*/
|
|
225
|
+
AttachToVpc: boolean;
|
|
226
|
+
/**
|
|
227
|
+
* The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).
|
|
228
|
+
* @pattern `^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(3[0-2]|[12]?[0-9])$`
|
|
229
|
+
*/
|
|
230
|
+
CidrBlock: string;
|
|
231
|
+
};
|
|
204
232
|
/**
|
|
205
233
|
* Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.
|
|
206
234
|
*/
|
|
@@ -5,11 +5,11 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
|
|
|
5
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
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
7
|
You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported.
|
|
8
|
-
|
|
8
|
+
*Updating DB clusters*
|
|
9
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
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
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
|
|
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
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
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
15
|
1. Update the stack.
|
|
@@ -43,13 +43,11 @@ export type RDSDBClusterProperties = {
|
|
|
43
43
|
*/
|
|
44
44
|
AvailabilityZones?: string[];
|
|
45
45
|
/**
|
|
46
|
-
* The target backtrack window, in seconds. To disable backtracking, set this value to 0
|
|
47
|
-
|
|
48
|
-
|
|
46
|
+
* The target backtrack window, in seconds. To disable backtracking, set this value to ``0``.
|
|
47
|
+
Valid for Cluster Type: Aurora MySQL DB clusters only
|
|
48
|
+
Default: ``0``
|
|
49
49
|
Constraints:
|
|
50
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
51
|
* @min `0`
|
|
54
52
|
*/
|
|
55
53
|
BacktrackWindow?: number;
|
|
@@ -408,7 +406,7 @@ export type RDSDBClusterProperties = {
|
|
|
408
406
|
+ ``full-copy`` - The new DB cluster is restored as a full copy of the source DB cluster.
|
|
409
407
|
+ ``copy-on-write`` - The new DB cluster is restored as a clone of the source DB cluster.
|
|
410
408
|
|
|
411
|
-
|
|
409
|
+
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
410
|
Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
413
411
|
*/
|
|
414
412
|
RestoreType?: string;
|
|
@@ -486,8 +484,8 @@ export type RDSDBClusterProperties = {
|
|
|
486
484
|
*/
|
|
487
485
|
StorageType?: string;
|
|
488
486
|
/**
|
|
489
|
-
*
|
|
490
|
-
Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
487
|
+
* Tags to assign to the DB cluster.
|
|
488
|
+
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
491
489
|
* @maxLength `50`
|
|
492
490
|
*/
|
|
493
491
|
Tags?: Tag[];
|
|
@@ -668,11 +666,11 @@ export type Tag = {
|
|
|
668
666
|
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
667
|
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
668
|
You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported.
|
|
671
|
-
|
|
669
|
+
*Updating DB clusters*
|
|
672
670
|
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
671
|
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
672
|
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
|
|
673
|
+
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
674
|
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
675
|
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
676
|
1. Update the stack.
|
package/lib/AWS-RDS-DBCluster.js
CHANGED
|
@@ -4,11 +4,11 @@ import { Resource as $Resource } from "@awboost/cfn-template-builder/template/re
|
|
|
4
4
|
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*.
|
|
5
5
|
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*.
|
|
6
6
|
You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported.
|
|
7
|
-
|
|
7
|
+
*Updating DB clusters*
|
|
8
8
|
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.
|
|
9
9
|
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:
|
|
10
10
|
1. Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.
|
|
11
|
-
1. Create a snapshot of the DB cluster. For more information, see [Creating a DB
|
|
11
|
+
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).
|
|
12
12
|
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.
|
|
13
13
|
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.
|
|
14
14
|
1. Update the stack.
|
|
@@ -4,7 +4,7 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
|
|
|
4
4
|
* The ``AWS::RDS::DBClusterParameterGroup`` resource creates a new Amazon RDS DB cluster parameter group.
|
|
5
5
|
For information about configuring parameters for Amazon Aurora DB clusters, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
|
|
6
6
|
If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.
|
|
7
|
-
If you apply a change to parameter group associated with a stopped DB cluster, then the
|
|
7
|
+
If you apply a change to parameter group associated with a stopped DB cluster, then the updated stack waits until the DB cluster is started.
|
|
8
8
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html}
|
|
9
9
|
*/
|
|
10
10
|
export type RDSDBClusterParameterGroupProperties = {
|
|
@@ -13,22 +13,34 @@ export type RDSDBClusterParameterGroupProperties = {
|
|
|
13
13
|
Constraints:
|
|
14
14
|
+ Must not match the name of an existing DB cluster parameter group.
|
|
15
15
|
|
|
16
|
-
If you don't specify a value for ``DBClusterParameterGroupName`` property, a name is automatically created for the DB cluster parameter group.
|
|
17
16
|
This value is stored as a lowercase string.
|
|
18
17
|
* @pattern `^[a-zA-Z]{1}(?:-?[a-zA-Z0-9])*$`
|
|
19
18
|
*/
|
|
20
19
|
DBClusterParameterGroupName?: string;
|
|
21
20
|
/**
|
|
22
|
-
*
|
|
21
|
+
* The description for the DB cluster parameter group.
|
|
23
22
|
*/
|
|
24
23
|
Description: string;
|
|
25
24
|
/**
|
|
26
|
-
* The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
25
|
+
* The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
|
|
26
|
+
*Aurora MySQL*
|
|
27
|
+
Example: ``aurora-mysql5.7``, ``aurora-mysql8.0``
|
|
28
|
+
*Aurora PostgreSQL*
|
|
29
|
+
Example: ``aurora-postgresql14``
|
|
30
|
+
*RDS for MySQL*
|
|
31
|
+
Example: ``mysql8.0``
|
|
32
|
+
*RDS for PostgreSQL*
|
|
33
|
+
Example: ``postgres13``
|
|
34
|
+
To list all of the available parameter group families for a DB engine, use the following command:
|
|
35
|
+
``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>``
|
|
36
|
+
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
|
|
37
|
+
``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql``
|
|
38
|
+
The output contains duplicates.
|
|
39
|
+
The following are the valid DB engine values:
|
|
40
|
+
+ ``aurora-mysql``
|
|
41
|
+
+ ``aurora-postgresql``
|
|
42
|
+
+ ``mysql``
|
|
43
|
+
+ ``postgres``
|
|
32
44
|
*/
|
|
33
45
|
Family: string;
|
|
34
46
|
/**
|
|
@@ -36,7 +48,7 @@ export type RDSDBClusterParameterGroupProperties = {
|
|
|
36
48
|
*/
|
|
37
49
|
Parameters: Record<string, any>;
|
|
38
50
|
/**
|
|
39
|
-
*
|
|
51
|
+
* Tags to assign to the DB cluster parameter group.
|
|
40
52
|
* @maxLength `50`
|
|
41
53
|
*/
|
|
42
54
|
Tags?: Tag[];
|
|
@@ -65,7 +77,7 @@ export type Tag = {
|
|
|
65
77
|
* The ``AWS::RDS::DBClusterParameterGroup`` resource creates a new Amazon RDS DB cluster parameter group.
|
|
66
78
|
For information about configuring parameters for Amazon Aurora DB clusters, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
|
|
67
79
|
If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.
|
|
68
|
-
If you apply a change to parameter group associated with a stopped DB cluster, then the
|
|
80
|
+
If you apply a change to parameter group associated with a stopped DB cluster, then the updated stack waits until the DB cluster is started.
|
|
69
81
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html}
|
|
70
82
|
*/
|
|
71
83
|
export declare class RDSDBClusterParameterGroup extends $Resource<"AWS::RDS::DBClusterParameterGroup", RDSDBClusterParameterGroupProperties, Record<string, never>> {
|
|
@@ -3,7 +3,7 @@ import { Resource as $Resource } from "@awboost/cfn-template-builder/template/re
|
|
|
3
3
|
* The ``AWS::RDS::DBClusterParameterGroup`` resource creates a new Amazon RDS DB cluster parameter group.
|
|
4
4
|
For information about configuring parameters for Amazon Aurora DB clusters, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
|
|
5
5
|
If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.
|
|
6
|
-
If you apply a change to parameter group associated with a stopped DB cluster, then the
|
|
6
|
+
If you apply a change to parameter group associated with a stopped DB cluster, then the updated stack waits until the DB cluster is started.
|
|
7
7
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html}
|
|
8
8
|
*/
|
|
9
9
|
export class RDSDBClusterParameterGroup extends $Resource {
|
|
@@ -6,7 +6,7 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
|
|
|
6
6
|
For more information about creating a DB instance in 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*.
|
|
7
7
|
If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.
|
|
8
8
|
If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html).
|
|
9
|
-
|
|
9
|
+
*Updating DB instances*
|
|
10
10
|
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 instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.
|
|
11
11
|
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 instance. To preserve your data, perform the following procedure:
|
|
12
12
|
1. Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.
|
|
@@ -156,8 +156,9 @@ export type RDSDBInstanceProperties = {
|
|
|
156
156
|
*/
|
|
157
157
|
CustomIAMInstanceProfile?: string;
|
|
158
158
|
/**
|
|
159
|
-
|
|
160
|
-
|
|
159
|
+
* The identifier of the DB cluster that this DB instance will belong to.
|
|
160
|
+
This setting doesn't apply to RDS Custom DB instances.
|
|
161
|
+
*/
|
|
161
162
|
DBClusterIdentifier?: string;
|
|
162
163
|
/**
|
|
163
164
|
* The identifier for the Multi-AZ DB cluster snapshot to restore from.
|
|
@@ -288,9 +289,8 @@ export type RDSDBInstanceProperties = {
|
|
|
288
289
|
/**
|
|
289
290
|
* 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.
|
|
290
291
|
If there's no DB subnet group, then the DB instance isn't a VPC DB instance.
|
|
291
|
-
For more information about using Amazon RDS in a VPC, see [
|
|
292
|
-
|
|
293
|
-
Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
|
|
292
|
+
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*.
|
|
293
|
+
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.
|
|
294
294
|
*/
|
|
295
295
|
DBSubnetGroupName?: string;
|
|
296
296
|
/**
|
|
@@ -304,9 +304,8 @@ export type RDSDBInstanceProperties = {
|
|
|
304
304
|
*/
|
|
305
305
|
DeleteAutomatedBackups?: boolean;
|
|
306
306
|
/**
|
|
307
|
-
*
|
|
308
|
-
|
|
309
|
-
Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
|
|
307
|
+
* 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).
|
|
308
|
+
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.
|
|
310
309
|
*/
|
|
311
310
|
DeletionProtection?: boolean;
|
|
312
311
|
/**
|
|
@@ -516,30 +515,30 @@ export type RDSDBInstanceProperties = {
|
|
|
516
515
|
|
|
517
516
|
*RDS for MariaDB*
|
|
518
517
|
Constraints:
|
|
519
|
-
|
|
518
|
+
+ Must be 1 to 16 letters or numbers.
|
|
520
519
|
+ Can't be a reserved word for the chosen database engine.
|
|
521
520
|
|
|
522
521
|
*RDS for Microsoft SQL Server*
|
|
523
522
|
Constraints:
|
|
524
|
-
|
|
523
|
+
+ Must be 1 to 128 letters or numbers.
|
|
525
524
|
+ First character must be a letter.
|
|
526
525
|
+ Can't be a reserved word for the chosen database engine.
|
|
527
526
|
|
|
528
527
|
*RDS for MySQL*
|
|
529
528
|
Constraints:
|
|
530
|
-
|
|
529
|
+
+ Must be 1 to 16 letters or numbers.
|
|
531
530
|
+ First character must be a letter.
|
|
532
531
|
+ Can't be a reserved word for the chosen database engine.
|
|
533
532
|
|
|
534
533
|
*RDS for Oracle*
|
|
535
534
|
Constraints:
|
|
536
|
-
|
|
535
|
+
+ Must be 1 to 30 letters or numbers.
|
|
537
536
|
+ First character must be a letter.
|
|
538
537
|
+ Can't be a reserved word for the chosen database engine.
|
|
539
538
|
|
|
540
539
|
*RDS for PostgreSQL*
|
|
541
540
|
Constraints:
|
|
542
|
-
|
|
541
|
+
+ Must be 1 to 63 letters or numbers.
|
|
543
542
|
+ First character must be a letter.
|
|
544
543
|
+ Can't be a reserved word for the chosen database engine.
|
|
545
544
|
* @minLength `1`
|
|
@@ -556,10 +555,11 @@ export type RDSDBInstanceProperties = {
|
|
|
556
555
|
*/
|
|
557
556
|
MaxAllocatedStorage?: number;
|
|
558
557
|
/**
|
|
559
|
-
* 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
|
|
560
|
-
If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than 0
|
|
561
|
-
This setting doesn't apply to RDS Custom.
|
|
562
|
-
Valid Values: ``0
|
|
558
|
+
* 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``.
|
|
559
|
+
If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than ``0``.
|
|
560
|
+
This setting doesn't apply to RDS Custom DB instances.
|
|
561
|
+
Valid Values: ``0 | 1 | 5 | 10 | 15 | 30 | 60``
|
|
562
|
+
Default: ``0``
|
|
563
563
|
*/
|
|
564
564
|
MonitoringInterval?: number;
|
|
565
565
|
/**
|
|
@@ -569,10 +569,10 @@ export type RDSDBInstanceProperties = {
|
|
|
569
569
|
*/
|
|
570
570
|
MonitoringRoleArn?: string;
|
|
571
571
|
/**
|
|
572
|
-
* Specifies whether the
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
572
|
+
* 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.
|
|
573
|
+
This setting doesn't apply to the following DB instances:
|
|
574
|
+
+ Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
|
|
575
|
+
+ RDS Custom
|
|
576
576
|
*/
|
|
577
577
|
MultiAZ?: boolean;
|
|
578
578
|
/**
|
|
@@ -616,10 +616,18 @@ export type RDSDBInstanceProperties = {
|
|
|
616
616
|
PerformanceInsightsRetentionPeriod?: number;
|
|
617
617
|
/**
|
|
618
618
|
* The port number on which the database accepts connections.
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
619
|
+
This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.
|
|
620
|
+
Valid Values: ``1150-65535``
|
|
621
|
+
Default:
|
|
622
|
+
+ RDS for Db2 - ``50000``
|
|
623
|
+
+ RDS for MariaDB - ``3306``
|
|
624
|
+
+ RDS for Microsoft SQL Server - ``1433``
|
|
625
|
+
+ RDS for MySQL - ``3306``
|
|
626
|
+
+ RDS for Oracle - ``1521``
|
|
627
|
+
+ RDS for PostgreSQL - ``5432``
|
|
628
|
+
|
|
629
|
+
Constraints:
|
|
630
|
+
+ For RDS for Microsoft SQL Server, the value can't be ``1234``, ``1434``, ``3260``, ``3343``, ``3389``, ``47001``, or ``49152-49156``.
|
|
623
631
|
* @pattern `^\d*$`
|
|
624
632
|
*/
|
|
625
633
|
Port?: string;
|
|
@@ -737,7 +745,7 @@ export type RDSDBInstanceProperties = {
|
|
|
737
745
|
*/
|
|
738
746
|
StorageType?: string;
|
|
739
747
|
/**
|
|
740
|
-
*
|
|
748
|
+
* Tags to assign to the DB instance.
|
|
741
749
|
*/
|
|
742
750
|
Tags?: Tag[];
|
|
743
751
|
TdeCredentialArn?: string;
|
|
@@ -893,7 +901,7 @@ export type Tag = {
|
|
|
893
901
|
For more information about creating a DB instance in 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*.
|
|
894
902
|
If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.
|
|
895
903
|
If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html).
|
|
896
|
-
|
|
904
|
+
*Updating DB instances*
|
|
897
905
|
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 instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.
|
|
898
906
|
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 instance. To preserve your data, perform the following procedure:
|
|
899
907
|
1. Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.
|
|
@@ -5,7 +5,7 @@ import { Resource as $Resource } from "@awboost/cfn-template-builder/template/re
|
|
|
5
5
|
For more information about creating a DB instance in 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
6
|
If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.
|
|
7
7
|
If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html).
|
|
8
|
-
|
|
8
|
+
*Updating DB instances*
|
|
9
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 instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.
|
|
10
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 instance. To preserve your data, perform the following procedure:
|
|
11
11
|
1. Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.
|
|
@@ -26,27 +26,39 @@ export type RDSDBParameterGroupProperties = {
|
|
|
26
26
|
*/
|
|
27
27
|
Description: string;
|
|
28
28
|
/**
|
|
29
|
-
* The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
29
|
+
* The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
|
|
30
|
+
To list all of the available parameter group families for a DB engine, use the following command:
|
|
31
|
+
``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>``
|
|
32
|
+
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
|
|
33
|
+
``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql``
|
|
34
|
+
The output contains duplicates.
|
|
35
|
+
The following are the valid DB engine values:
|
|
36
|
+
+ ``aurora-mysql``
|
|
37
|
+
+ ``aurora-postgresql``
|
|
38
|
+
+ ``db2-ae``
|
|
39
|
+
+ ``db2-se``
|
|
40
|
+
+ ``mysql``
|
|
41
|
+
+ ``oracle-ee``
|
|
42
|
+
+ ``oracle-ee-cdb``
|
|
43
|
+
+ ``oracle-se2``
|
|
44
|
+
+ ``oracle-se2-cdb``
|
|
45
|
+
+ ``postgres``
|
|
46
|
+
+ ``sqlserver-ee``
|
|
47
|
+
+ ``sqlserver-se``
|
|
48
|
+
+ ``sqlserver-ex``
|
|
49
|
+
+ ``sqlserver-web``
|
|
35
50
|
*/
|
|
36
51
|
Family: string;
|
|
37
52
|
/**
|
|
38
|
-
* An array of parameter names and values for the parameter update.
|
|
39
|
-
|
|
40
|
-
For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.
|
|
41
|
-
For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
|
|
53
|
+
* An array of parameter names and values for the parameter update. You must specify at least one parameter name and value.
|
|
54
|
+
For more information about parameter groups, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*, or [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
|
|
42
55
|
AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.
|
|
43
56
|
*/
|
|
44
57
|
Parameters?: Record<string, any>;
|
|
45
58
|
/**
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
*/
|
|
59
|
+
* Tags to assign to the DB parameter group.
|
|
60
|
+
* @maxLength `50`
|
|
61
|
+
*/
|
|
50
62
|
Tags?: Tag[];
|
|
51
63
|
};
|
|
52
64
|
/**
|
|
@@ -12,8 +12,12 @@ export type RDSDBSubnetGroupProperties = {
|
|
|
12
12
|
DBSubnetGroupDescription: string;
|
|
13
13
|
/**
|
|
14
14
|
* The name for the DB subnet group. This value is stored as a lowercase string.
|
|
15
|
-
Constraints:
|
|
16
|
-
|
|
15
|
+
Constraints:
|
|
16
|
+
+ Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
|
|
17
|
+
+ Must not be default.
|
|
18
|
+
+ First character must be a letter.
|
|
19
|
+
|
|
20
|
+
Example: ``mydbsubnetgroup``
|
|
17
21
|
*/
|
|
18
22
|
DBSubnetGroupName?: string;
|
|
19
23
|
/**
|
|
@@ -21,7 +25,7 @@ export type RDSDBSubnetGroupProperties = {
|
|
|
21
25
|
*/
|
|
22
26
|
SubnetIds: string[];
|
|
23
27
|
/**
|
|
24
|
-
*
|
|
28
|
+
* Tags to assign to the DB subnet group.
|
|
25
29
|
* @maxLength `50`
|
|
26
30
|
*/
|
|
27
31
|
Tags?: Tag[];
|
|
@@ -21,18 +21,19 @@ export type RDSEventSubscriptionProperties = {
|
|
|
21
21
|
/**
|
|
22
22
|
* The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.
|
|
23
23
|
Constraints:
|
|
24
|
-
+ If
|
|
24
|
+
+ If ``SourceIds`` are supplied, ``SourceType`` must also be provided.
|
|
25
25
|
+ If the source type is a DB instance, a ``DBInstanceIdentifier`` value must be supplied.
|
|
26
26
|
+ If the source type is a DB cluster, a ``DBClusterIdentifier`` value must be supplied.
|
|
27
27
|
+ If the source type is a DB parameter group, a ``DBParameterGroupName`` value must be supplied.
|
|
28
28
|
+ If the source type is a DB security group, a ``DBSecurityGroupName`` value must be supplied.
|
|
29
29
|
+ If the source type is a DB snapshot, a ``DBSnapshotIdentifier`` value must be supplied.
|
|
30
30
|
+ If the source type is a DB cluster snapshot, a ``DBClusterSnapshotIdentifier`` value must be supplied.
|
|
31
|
+
+ If the source type is an RDS Proxy, a ``DBProxyName`` value must be supplied.
|
|
31
32
|
*/
|
|
32
33
|
SourceIds?: string[];
|
|
33
34
|
/**
|
|
34
|
-
* The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, set this parameter to ``db-instance``. If this value isn't specified, all events are returned.
|
|
35
|
-
Valid
|
|
35
|
+
* The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to ``db-instance``. For RDS Proxy events, specify ``db-proxy``. If this value isn't specified, all events are returned.
|
|
36
|
+
Valid Values:``db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment``
|
|
36
37
|
*/
|
|
37
38
|
SourceType?: string;
|
|
38
39
|
/**
|
|
@@ -26,7 +26,7 @@ export type RDSOptionGroupProperties = {
|
|
|
26
26
|
*/
|
|
27
27
|
MajorEngineVersion: string;
|
|
28
28
|
/**
|
|
29
|
-
* A list of
|
|
29
|
+
* A list of all available options
|
|
30
30
|
*/
|
|
31
31
|
OptionConfigurations?: OptionConfiguration[];
|
|
32
32
|
/**
|
|
@@ -46,7 +46,7 @@ export type RDSOptionGroupProperties = {
|
|
|
46
46
|
*/
|
|
47
47
|
OptionGroupName?: string;
|
|
48
48
|
/**
|
|
49
|
-
*
|
|
49
|
+
* Tags to assign to the option group.
|
|
50
50
|
*/
|
|
51
51
|
Tags?: Tag[];
|
|
52
52
|
};
|