@horietakehiro/aws-cdk-utul 0.12.0 → 0.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +0 -1
- package/index.js +3 -3
- package/lib/assertions.d.ts +114 -2
- package/lib/assertions.js +121 -5
- package/lib/stack-manager.d.ts +0 -41
- package/lib/stack-manager.js +188 -131
- package/lib/typed-resource.d.ts +6 -5
- package/lib/typed-resource.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigateway-account.d.ts +0 -3
- package/lib/types/cfn-resource-types/aws-apigateway-account.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigateway-apikey.d.ts +0 -27
- package/lib/types/cfn-resource-types/aws-apigateway-apikey.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigateway-authorizer.d.ts +0 -30
- package/lib/types/cfn-resource-types/aws-apigateway-authorizer.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigateway-basepathmapping.d.ts +0 -12
- package/lib/types/cfn-resource-types/aws-apigateway-basepathmapping.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigateway-clientcertificate.d.ts +0 -6
- package/lib/types/cfn-resource-types/aws-apigateway-clientcertificate.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigateway-deployment.d.ts +0 -63
- package/lib/types/cfn-resource-types/aws-apigateway-deployment.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigateway-documentationpart.d.ts +0 -24
- package/lib/types/cfn-resource-types/aws-apigateway-documentationpart.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigateway-documentationversion.d.ts +0 -9
- package/lib/types/cfn-resource-types/aws-apigateway-documentationversion.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigateway-gatewayresponse.d.ts +0 -15
- package/lib/types/cfn-resource-types/aws-apigateway-gatewayresponse.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigateway-method.d.ts +0 -109
- package/lib/types/cfn-resource-types/aws-apigateway-method.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigateway-model.d.ts +0 -12
- package/lib/types/cfn-resource-types/aws-apigateway-model.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigateway-requestvalidator.d.ts +0 -12
- package/lib/types/cfn-resource-types/aws-apigateway-requestvalidator.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigateway-resource.d.ts +0 -9
- package/lib/types/cfn-resource-types/aws-apigateway-resource.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigateway-restapi.d.ts +0 -33
- package/lib/types/cfn-resource-types/aws-apigateway-restapi.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigateway-stage.d.ts +0 -75
- package/lib/types/cfn-resource-types/aws-apigateway-stage.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigateway-usageplan.d.ts +0 -48
- package/lib/types/cfn-resource-types/aws-apigateway-usageplan.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigateway-usageplankey.d.ts +0 -3
- package/lib/types/cfn-resource-types/aws-apigateway-usageplankey.js +1 -1
- package/lib/types/cfn-resource-types/aws-appsync-api.d.ts +123 -0
- package/lib/types/cfn-resource-types/aws-appsync-api.js +3 -0
- package/lib/types/cfn-resource-types/aws-appsync-channelnamespace.d.ts +66 -0
- package/lib/types/cfn-resource-types/aws-appsync-channelnamespace.js +3 -0
- package/lib/types/cfn-resource-types/aws-autoscaling-autoscalinggroup.d.ts +30 -0
- package/lib/types/cfn-resource-types/aws-autoscaling-autoscalinggroup.js +1 -1
- package/lib/types/cfn-resource-types/aws-bedrock-applicationinferenceprofile.d.ts +82 -0
- package/lib/types/cfn-resource-types/aws-bedrock-applicationinferenceprofile.js +3 -0
- package/lib/types/cfn-resource-types/aws-cleanrooms-analysistemplate.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-cleanrooms-analysistemplate.js +1 -1
- package/lib/types/cfn-resource-types/aws-cleanrooms-collaboration.d.ts +2 -0
- package/lib/types/cfn-resource-types/aws-cleanrooms-collaboration.js +1 -1
- package/lib/types/cfn-resource-types/aws-cleanrooms-membership.d.ts +1 -0
- package/lib/types/cfn-resource-types/aws-cleanrooms-membership.js +1 -1
- package/lib/types/cfn-resource-types/aws-codebuild-fleet.d.ts +28 -1
- package/lib/types/cfn-resource-types/aws-codebuild-fleet.js +1 -1
- package/lib/types/cfn-resource-types/aws-cognito-userpool.d.ts +94 -94
- package/lib/types/cfn-resource-types/aws-cognito-userpool.js +1 -1
- package/lib/types/cfn-resource-types/aws-datasync-task.d.ts +100 -96
- package/lib/types/cfn-resource-types/aws-datasync-task.js +1 -1
- package/lib/types/cfn-resource-types/aws-dynamodb-globaltable.d.ts +96 -96
- package/lib/types/cfn-resource-types/aws-dynamodb-globaltable.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-securitygroupvpcassociation.d.ts +25 -0
- package/lib/types/cfn-resource-types/aws-ec2-securitygroupvpcassociation.js +3 -0
- package/lib/types/cfn-resource-types/aws-ec2-vpnconnection.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-vpnconnection.js +1 -1
- package/lib/types/cfn-resource-types/aws-ecs-service.d.ts +5 -4
- package/lib/types/cfn-resource-types/aws-ecs-service.js +1 -1
- package/lib/types/cfn-resource-types/aws-elasticloadbalancingv2-loadbalancer.d.ts +17 -14
- package/lib/types/cfn-resource-types/aws-elasticloadbalancingv2-loadbalancer.js +1 -1
- package/lib/types/cfn-resource-types/aws-events-connection.d.ts +26 -26
- package/lib/types/cfn-resource-types/aws-events-connection.js +1 -1
- package/lib/types/cfn-resource-types/aws-gamelift-containergroupdefinition.d.ts +4 -179
- package/lib/types/cfn-resource-types/aws-gamelift-containergroupdefinition.js +1 -1
- package/lib/types/cfn-resource-types/aws-gamelift-fleet.d.ts +1 -42
- package/lib/types/cfn-resource-types/aws-gamelift-fleet.js +1 -1
- package/lib/types/cfn-resource-types/aws-inspectorv2-cisscanconfiguration.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-inspectorv2-cisscanconfiguration.js +1 -1
- package/lib/types/cfn-resource-types/aws-iotwireless-wirelessdeviceimporttask.d.ts +12 -1
- package/lib/types/cfn-resource-types/aws-iotwireless-wirelessdeviceimporttask.js +1 -1
- package/lib/types/cfn-resource-types/aws-lambda-function.d.ts +24 -4
- package/lib/types/cfn-resource-types/aws-lambda-function.js +1 -1
- package/lib/types/cfn-resource-types/aws-lambda-version.d.ts +1 -9
- package/lib/types/cfn-resource-types/aws-lambda-version.js +1 -1
- package/lib/types/cfn-resource-types/aws-logs-delivery.d.ts +20 -0
- package/lib/types/cfn-resource-types/aws-logs-delivery.js +1 -1
- package/lib/types/cfn-resource-types/aws-logs-deliverydestination.d.ts +4 -0
- package/lib/types/cfn-resource-types/aws-logs-deliverydestination.js +1 -1
- package/lib/types/cfn-resource-types/aws-m2-application.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-m2-application.js +1 -1
- package/lib/types/cfn-resource-types/aws-mediapackagev2-originendpoint.d.ts +19 -0
- package/lib/types/cfn-resource-types/aws-mediapackagev2-originendpoint.js +1 -1
- package/lib/types/cfn-resource-types/aws-nimblestudio-launchprofile.d.ts +23 -143
- package/lib/types/cfn-resource-types/aws-nimblestudio-launchprofile.js +1 -1
- package/lib/types/cfn-resource-types/aws-nimblestudio-streamingimage.d.ts +16 -46
- package/lib/types/cfn-resource-types/aws-nimblestudio-streamingimage.js +1 -1
- package/lib/types/cfn-resource-types/aws-nimblestudio-studio.d.ts +15 -47
- package/lib/types/cfn-resource-types/aws-nimblestudio-studio.js +1 -1
- package/lib/types/cfn-resource-types/aws-nimblestudio-studiocomponent.d.ts +36 -163
- package/lib/types/cfn-resource-types/aws-nimblestudio-studiocomponent.js +1 -1
- package/lib/types/cfn-resource-types/aws-opensearchservice-application.d.ts +89 -0
- package/lib/types/cfn-resource-types/aws-opensearchservice-application.js +3 -0
- package/lib/types/cfn-resource-types/aws-opensearchservice-domain.d.ts +30 -0
- package/lib/types/cfn-resource-types/aws-opensearchservice-domain.js +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-analysis.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-analysis.js +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-dashboard.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-dashboard.js +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-datasource.d.ts +22 -9
- package/lib/types/cfn-resource-types/aws-quicksight-datasource.js +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-template.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-template.js +1 -1
- package/lib/types/cfn-resource-types/aws-rds-dbcluster.d.ts +372 -371
- package/lib/types/cfn-resource-types/aws-rds-dbcluster.js +1 -1
- package/lib/types/cfn-resource-types/aws-rds-dbshardgroup.d.ts +56 -0
- package/lib/types/cfn-resource-types/aws-rds-dbshardgroup.js +3 -0
- package/lib/types/cfn-resource-types/aws-sagemaker-studiolifecycleconfig.d.ts +2 -2
- package/lib/types/cfn-resource-types/aws-sagemaker-studiolifecycleconfig.js +1 -1
- package/lib/types/cfn-resource-types/aws-secretsmanager-rotationschedule.d.ts +71 -11
- package/lib/types/cfn-resource-types/aws-secretsmanager-rotationschedule.js +1 -1
- package/lib/types/cfn-resource-types/aws-ses-configurationset.d.ts +4 -0
- package/lib/types/cfn-resource-types/aws-ses-configurationset.js +1 -1
- package/lib/types/cfn-resource-types/aws-transfer-user.d.ts +28 -14
- package/lib/types/cfn-resource-types/aws-transfer-user.js +1 -1
- package/lib/types/cfn-resource-types/aws-wisdom-aiagent.d.ts +76 -0
- package/lib/types/cfn-resource-types/aws-wisdom-aiagent.js +3 -0
- package/lib/types/cfn-resource-types/aws-wisdom-aiagentversion.d.ts +12 -0
- package/lib/types/cfn-resource-types/aws-wisdom-aiagentversion.js +3 -0
- package/lib/types/cfn-resource-types/aws-wisdom-aipromptversion.d.ts +12 -0
- package/lib/types/cfn-resource-types/aws-wisdom-aipromptversion.js +3 -0
- package/lib/types/cfn-resource-types.d.ts +19 -1
- package/lib/types/cfn-resource-types.js +45 -27
- package/package.json +1 -1
|
@@ -18,57 +18,88 @@
|
|
|
18
18
|
* 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).
|
|
19
19
|
*/
|
|
20
20
|
export interface _AWS_RDS_DBCLUSTER {
|
|
21
|
+
Endpoint?: Endpoint;
|
|
22
|
+
ReadEndpoint?: ReadEndpoint;
|
|
21
23
|
/**
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
* 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.
|
|
26
|
-
* 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``.
|
|
27
|
-
* 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.
|
|
28
|
-
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
24
|
+
* The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
|
|
25
|
+
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
26
|
+
* This setting is required to create a Multi-AZ DB cluster.
|
|
29
27
|
*/
|
|
30
|
-
|
|
28
|
+
AllocatedStorage?: number;
|
|
31
29
|
/**
|
|
32
|
-
*
|
|
30
|
+
* 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.
|
|
31
|
+
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
33
32
|
*/
|
|
34
|
-
|
|
33
|
+
AssociatedRoles?: DBClusterRole[];
|
|
35
34
|
/**
|
|
36
|
-
*
|
|
37
|
-
* Valid
|
|
35
|
+
* 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*.
|
|
36
|
+
* Valid for: Aurora DB clusters only
|
|
37
|
+
*/
|
|
38
|
+
AvailabilityZones?: string[];
|
|
39
|
+
/**
|
|
40
|
+
* Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
|
|
41
|
+
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
42
|
+
*/
|
|
43
|
+
AutoMinorVersionUpgrade?: boolean;
|
|
44
|
+
/**
|
|
45
|
+
* The target backtrack window, in seconds. To disable backtracking, set this value to ``0``.
|
|
46
|
+
* Valid for Cluster Type: Aurora MySQL DB clusters only
|
|
47
|
+
* Default: ``0``
|
|
38
48
|
* Constraints:
|
|
39
|
-
* +
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
49
|
+
* + If specified, this value must be set to a number from 0 to 259,200 (72 hours).
|
|
50
|
+
*/
|
|
51
|
+
BacktrackWindow?: number;
|
|
52
|
+
/**
|
|
53
|
+
* The number of days for which automated backups are retained.
|
|
54
|
+
* Default: 1
|
|
55
|
+
* Constraints:
|
|
56
|
+
* + Must be a value from 1 to 35
|
|
43
57
|
*
|
|
44
|
-
* This property must be used with ``SourceDBClusterIdentifier`` property. The resulting cluster will have the identifier that matches the value of the ``DBclusterIdentifier`` property.
|
|
45
|
-
* Example: ``2015-03-07T23:45:00Z``
|
|
46
58
|
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
47
59
|
*/
|
|
48
|
-
|
|
60
|
+
BackupRetentionPeriod?: number;
|
|
61
|
+
ClusterScalabilityType?: string;
|
|
49
62
|
/**
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
* For information about limitations and requirements for Serverless DB clusters, see the following sections in the *Amazon Aurora User Guide*:
|
|
53
|
-
* + [Limitations of Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations)
|
|
54
|
-
* + [Requirements for Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html)
|
|
55
|
-
*
|
|
56
|
-
* Valid for Cluster Type: Aurora DB clusters only
|
|
63
|
+
* 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.
|
|
64
|
+
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
57
65
|
*/
|
|
58
|
-
|
|
66
|
+
CopyTagsToSnapshot?: boolean;
|
|
59
67
|
/**
|
|
60
|
-
* The
|
|
61
|
-
*
|
|
62
|
-
* + When ``EngineMode`` is ``provisioned``, ``3306`` (for both Aurora MySQL and Aurora PostgreSQL)
|
|
63
|
-
* + When ``EngineMode`` is ``serverless``:
|
|
64
|
-
* + ``3306`` when ``Engine`` is ``aurora`` or ``aurora-mysql``
|
|
65
|
-
* + ``5432`` when ``Engine`` is ``aurora-postgresql``
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
* 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.
|
|
69
|
-
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
68
|
+
* 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*.
|
|
69
|
+
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
70
70
|
*/
|
|
71
|
-
|
|
71
|
+
DatabaseName?: string;
|
|
72
|
+
DBClusterArn?: string;
|
|
73
|
+
/**
|
|
74
|
+
* 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.
|
|
75
|
+
* 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*.
|
|
76
|
+
* This setting is required to create a Multi-AZ DB cluster.
|
|
77
|
+
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
78
|
+
*/
|
|
79
|
+
DBClusterInstanceClass?: string;
|
|
80
|
+
DBClusterResourceId?: string;
|
|
81
|
+
/**
|
|
82
|
+
* The name of the DB parameter group to apply to all instances of the DB cluster.
|
|
83
|
+
* 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.
|
|
84
|
+
* Valid for Cluster Type: Aurora DB clusters only
|
|
85
|
+
* Default: The existing name setting
|
|
86
|
+
* Constraints:
|
|
87
|
+
* + The DB parameter group must be in the same DB parameter group family as this DB cluster.
|
|
88
|
+
* + The ``DBInstanceParameterGroupName`` parameter is valid in combination with the ``AllowMajorVersionUpgrade`` parameter for a major version upgrade only.
|
|
89
|
+
*/
|
|
90
|
+
DBInstanceParameterGroupName?: string;
|
|
91
|
+
/**
|
|
92
|
+
* Reserved for future use.
|
|
93
|
+
*/
|
|
94
|
+
DBSystemId?: string;
|
|
95
|
+
/**
|
|
96
|
+
* 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.
|
|
97
|
+
* If you aren't configuring a global database cluster, don't specify this property.
|
|
98
|
+
* To remove the DB cluster from a global database cluster, specify an empty value for the ``GlobalClusterIdentifier`` property.
|
|
99
|
+
* 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*.
|
|
100
|
+
* Valid for: Aurora DB clusters only
|
|
101
|
+
*/
|
|
102
|
+
GlobalClusterIdentifier?: string;
|
|
72
103
|
/**
|
|
73
104
|
* The DB cluster identifier. This parameter is stored as a lowercase string.
|
|
74
105
|
* Constraints:
|
|
@@ -80,21 +111,75 @@ export interface _AWS_RDS_DBCLUSTER {
|
|
|
80
111
|
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
81
112
|
*/
|
|
82
113
|
DBClusterIdentifier?: string;
|
|
83
|
-
StorageThroughput?: number;
|
|
84
114
|
/**
|
|
85
|
-
* The
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
115
|
+
* The name of the DB cluster parameter group to associate with this DB cluster.
|
|
116
|
+
* 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.
|
|
117
|
+
* 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.
|
|
118
|
+
* To list all of the available DB cluster parameter group names, use the following command:
|
|
119
|
+
* ``aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text``
|
|
120
|
+
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
90
121
|
*/
|
|
91
|
-
|
|
92
|
-
Endpoint?: Endpoint;
|
|
122
|
+
DBClusterParameterGroupName?: string;
|
|
93
123
|
/**
|
|
94
|
-
*
|
|
124
|
+
* A DB subnet group that you want to associate with this DB cluster.
|
|
125
|
+
* 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.
|
|
126
|
+
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
127
|
+
*/
|
|
128
|
+
DBSubnetGroupName?: string;
|
|
129
|
+
/**
|
|
130
|
+
* 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.
|
|
131
|
+
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
132
|
+
*/
|
|
133
|
+
DeletionProtection?: boolean;
|
|
134
|
+
/**
|
|
135
|
+
* Indicates the directory ID of the Active Directory to create the DB cluster.
|
|
136
|
+
* For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.
|
|
137
|
+
* For more information, see [Kerberos authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the *Amazon Aurora User Guide*.
|
|
95
138
|
* Valid for: Aurora DB clusters only
|
|
96
139
|
*/
|
|
97
|
-
|
|
140
|
+
Domain?: string;
|
|
141
|
+
/**
|
|
142
|
+
* Specifies the name of the IAM role to use when making API calls to the Directory Service.
|
|
143
|
+
* Valid for: Aurora DB clusters only
|
|
144
|
+
*/
|
|
145
|
+
DomainIAMRoleName?: string;
|
|
146
|
+
/**
|
|
147
|
+
* 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*.
|
|
148
|
+
* *Aurora MySQL*
|
|
149
|
+
* Valid values: ``audit``, ``error``, ``general``, ``slowquery``
|
|
150
|
+
* *Aurora PostgreSQL*
|
|
151
|
+
* Valid values: ``postgresql``
|
|
152
|
+
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
153
|
+
*/
|
|
154
|
+
EnableCloudwatchLogsExports?: string[];
|
|
155
|
+
/**
|
|
156
|
+
* 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.
|
|
157
|
+
* 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.
|
|
158
|
+
* Valid for Cluster Type: Aurora DB clusters only
|
|
159
|
+
*/
|
|
160
|
+
EnableGlobalWriteForwarding?: boolean;
|
|
161
|
+
/**
|
|
162
|
+
* Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
|
|
163
|
+
* 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.
|
|
164
|
+
* RDS Data API is supported with the following DB clusters:
|
|
165
|
+
* + Aurora PostgreSQL Serverless v2 and provisioned
|
|
166
|
+
* + Aurora PostgreSQL and Aurora MySQL Serverless v1
|
|
167
|
+
*
|
|
168
|
+
* 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*.
|
|
169
|
+
* Valid for Cluster Type: Aurora DB clusters only
|
|
170
|
+
*/
|
|
171
|
+
EnableHttpEndpoint?: boolean;
|
|
172
|
+
/**
|
|
173
|
+
* A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
|
|
174
|
+
* For more information, see [IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide.*
|
|
175
|
+
* Valid for: Aurora DB clusters only
|
|
176
|
+
*/
|
|
177
|
+
EnableIAMDatabaseAuthentication?: boolean;
|
|
178
|
+
/**
|
|
179
|
+
* 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.
|
|
180
|
+
* Valid for: Aurora DB clusters only
|
|
181
|
+
*/
|
|
182
|
+
EnableLocalWriteForwarding?: boolean;
|
|
98
183
|
/**
|
|
99
184
|
* The name of the database engine to be used for this DB cluster.
|
|
100
185
|
* Valid Values:
|
|
@@ -107,12 +192,27 @@ export interface _AWS_RDS_DBCLUSTER {
|
|
|
107
192
|
*/
|
|
108
193
|
Engine?: string;
|
|
109
194
|
/**
|
|
110
|
-
*
|
|
195
|
+
* The life cycle type for this DB cluster.
|
|
196
|
+
* 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.
|
|
197
|
+
* 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:
|
|
198
|
+
* + 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*
|
|
199
|
+
* + Amazon RDS - [Using Amazon RDS Extended Support](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide*
|
|
200
|
+
*
|
|
111
201
|
* Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
202
|
+
* Valid Values: ``open-source-rds-extended-support | open-source-rds-extended-support-disabled``
|
|
203
|
+
* Default: ``open-source-rds-extended-support``
|
|
204
|
+
*/
|
|
205
|
+
EngineLifecycleSupport?: string;
|
|
206
|
+
/**
|
|
207
|
+
* The DB engine mode of the DB cluster, either ``provisioned`` or ``serverless``.
|
|
208
|
+
* The ``serverless`` engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the ``provisioned`` engine mode.
|
|
209
|
+
* For information about limitations and requirements for Serverless DB clusters, see the following sections in the *Amazon Aurora User Guide*:
|
|
210
|
+
* + [Limitations of Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations)
|
|
211
|
+
* + [Requirements for Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html)
|
|
112
212
|
*
|
|
113
|
-
*
|
|
213
|
+
* Valid for Cluster Type: Aurora DB clusters only
|
|
114
214
|
*/
|
|
115
|
-
|
|
215
|
+
EngineMode?: string;
|
|
116
216
|
/**
|
|
117
217
|
* The version number of the database engine to use.
|
|
118
218
|
* 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:
|
|
@@ -136,22 +236,22 @@ export interface _AWS_RDS_DBCLUSTER {
|
|
|
136
236
|
*/
|
|
137
237
|
EngineVersion?: string;
|
|
138
238
|
/**
|
|
139
|
-
*
|
|
140
|
-
* For information
|
|
141
|
-
* This setting is required to create a Multi-AZ DB cluster.
|
|
142
|
-
* When specified for a Multi-AZ DB cluster, a value for the ``Iops`` parameter is required.
|
|
239
|
+
* Specifies whether to manage the master user password with AWS Secrets Manager.
|
|
240
|
+
* 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.*
|
|
143
241
|
* Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
144
|
-
*
|
|
145
|
-
* +
|
|
146
|
-
* + Multi-AZ DB clusters - ``io1 | io2 | gp3``
|
|
147
|
-
*
|
|
148
|
-
* Default:
|
|
149
|
-
* + Aurora DB clusters - ``aurora``
|
|
150
|
-
* + Multi-AZ DB clusters - ``io1``
|
|
151
|
-
*
|
|
152
|
-
* 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``.
|
|
242
|
+
* Constraints:
|
|
243
|
+
* + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified.
|
|
153
244
|
*/
|
|
154
|
-
|
|
245
|
+
ManageMasterUserPassword?: boolean;
|
|
246
|
+
/**
|
|
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
|
+
*/
|
|
254
|
+
Iops?: number;
|
|
155
255
|
/**
|
|
156
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``.
|
|
157
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.
|
|
@@ -159,52 +259,12 @@ export interface _AWS_RDS_DBCLUSTER {
|
|
|
159
259
|
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
160
260
|
*/
|
|
161
261
|
KmsKeyId?: string;
|
|
162
|
-
ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfiguration;
|
|
163
|
-
/**
|
|
164
|
-
* The number of days to retain Performance Insights data.
|
|
165
|
-
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
166
|
-
* Valid Values:
|
|
167
|
-
* + ``7``
|
|
168
|
-
* + *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)
|
|
169
|
-
* + ``731``
|
|
170
|
-
*
|
|
171
|
-
* Default: ``7`` days
|
|
172
|
-
* If you specify a retention period that isn't valid, such as ``94``, Amazon RDS issues an error.
|
|
173
|
-
*/
|
|
174
|
-
PerformanceInsightsRetentionPeriod?: number;
|
|
175
|
-
/**
|
|
176
|
-
* 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*.
|
|
177
|
-
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
178
|
-
*/
|
|
179
|
-
DatabaseName?: string;
|
|
180
|
-
/**
|
|
181
|
-
* 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.
|
|
182
|
-
* Valid for: Aurora DB clusters only
|
|
183
|
-
*/
|
|
184
|
-
EnableLocalWriteForwarding?: boolean;
|
|
185
|
-
DBClusterResourceId?: string;
|
|
186
|
-
/**
|
|
187
|
-
* Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
|
|
188
|
-
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
189
|
-
*/
|
|
190
|
-
AutoMinorVersionUpgrade?: boolean;
|
|
191
262
|
/**
|
|
192
|
-
*
|
|
193
|
-
*
|
|
194
|
-
*
|
|
195
|
-
*/
|
|
196
|
-
DBSubnetGroupName?: string;
|
|
197
|
-
/**
|
|
198
|
-
* 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.
|
|
199
|
-
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
200
|
-
*/
|
|
201
|
-
DeletionProtection?: boolean;
|
|
202
|
-
/**
|
|
203
|
-
* The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
|
|
204
|
-
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
205
|
-
* This setting is required to create a Multi-AZ DB cluster.
|
|
263
|
+
* The name of the master user for the DB cluster.
|
|
264
|
+
* 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.
|
|
265
|
+
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
206
266
|
*/
|
|
207
|
-
|
|
267
|
+
MasterUsername?: string;
|
|
208
268
|
/**
|
|
209
269
|
* The master password for the DB instance.
|
|
210
270
|
* 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.
|
|
@@ -213,117 +273,68 @@ export interface _AWS_RDS_DBCLUSTER {
|
|
|
213
273
|
MasterUserPassword?: string;
|
|
214
274
|
MasterUserSecret?: MasterUserSecret;
|
|
215
275
|
/**
|
|
216
|
-
*
|
|
217
|
-
*
|
|
218
|
-
* + Must match the identifier of an existing DBCluster.
|
|
219
|
-
*
|
|
220
|
-
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
221
|
-
*/
|
|
222
|
-
SourceDBClusterIdentifier?: string;
|
|
223
|
-
/**
|
|
224
|
-
* The name of the master user for the DB cluster.
|
|
225
|
-
* 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.
|
|
226
|
-
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
227
|
-
*/
|
|
228
|
-
MasterUsername?: string;
|
|
229
|
-
ScalingConfiguration?: ScalingConfiguration;
|
|
230
|
-
ReadEndpoint?: ReadEndpoint;
|
|
231
|
-
/**
|
|
232
|
-
* The AWS KMS key identifier for encryption of Performance Insights data.
|
|
233
|
-
* The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
234
|
-
* 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.
|
|
276
|
+
* 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``.
|
|
277
|
+
* If ``MonitoringRoleArn`` is specified, also set ``MonitoringInterval`` to a value other than ``0``.
|
|
235
278
|
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
279
|
+
* Valid Values: ``0 | 1 | 5 | 10 | 15 | 30 | 60``
|
|
280
|
+
* Default: ``0``
|
|
236
281
|
*/
|
|
237
|
-
|
|
282
|
+
MonitoringInterval?: number;
|
|
238
283
|
/**
|
|
239
|
-
*
|
|
240
|
-
*
|
|
241
|
-
* 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.
|
|
284
|
+
* 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*.
|
|
285
|
+
* If ``MonitoringInterval`` is set to a value other than ``0``, supply a ``MonitoringRoleArn`` value.
|
|
242
286
|
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
243
|
-
* Default: The default behavior varies depending on whether ``DBSubnetGroupName`` is specified.
|
|
244
|
-
* If ``DBSubnetGroupName`` isn't specified, and ``PubliclyAccessible`` isn't specified, the following applies:
|
|
245
|
-
* + If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
|
|
246
|
-
* + If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
|
|
247
|
-
*
|
|
248
|
-
* If ``DBSubnetGroupName`` is specified, and ``PubliclyAccessible`` isn't specified, the following applies:
|
|
249
|
-
* + If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
|
|
250
|
-
* + If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
|
|
251
287
|
*/
|
|
252
|
-
|
|
288
|
+
MonitoringRoleArn?: string;
|
|
253
289
|
/**
|
|
254
|
-
*
|
|
255
|
-
*
|
|
256
|
-
*
|
|
290
|
+
* The network type of the DB cluster.
|
|
291
|
+
* Valid values:
|
|
292
|
+
* + ``IPV4``
|
|
293
|
+
* + ``DUAL``
|
|
294
|
+
*
|
|
295
|
+
* 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``).
|
|
296
|
+
* 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.*
|
|
257
297
|
* Valid for: Aurora DB clusters only
|
|
258
298
|
*/
|
|
259
|
-
|
|
260
|
-
/**
|
|
261
|
-
* The target backtrack window, in seconds. To disable backtracking, set this value to ``0``.
|
|
262
|
-
* Valid for Cluster Type: Aurora MySQL DB clusters only
|
|
263
|
-
* Default: ``0``
|
|
264
|
-
* Constraints:
|
|
265
|
-
* + If specified, this value must be set to a number from 0 to 259,200 (72 hours).
|
|
266
|
-
*/
|
|
267
|
-
BacktrackWindow?: number;
|
|
268
|
-
/**
|
|
269
|
-
* The name of the DB parameter group to apply to all instances of the DB cluster.
|
|
270
|
-
* 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.
|
|
271
|
-
* Valid for Cluster Type: Aurora DB clusters only
|
|
272
|
-
* Default: The existing name setting
|
|
273
|
-
* Constraints:
|
|
274
|
-
* + The DB parameter group must be in the same DB parameter group family as this DB cluster.
|
|
275
|
-
* + The ``DBInstanceParameterGroupName`` parameter is valid in combination with the ``AllowMajorVersionUpgrade`` parameter for a major version upgrade only.
|
|
276
|
-
*/
|
|
277
|
-
DBInstanceParameterGroupName?: string;
|
|
278
|
-
/**
|
|
279
|
-
* 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.
|
|
280
|
-
* 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.
|
|
281
|
-
* Valid for Cluster Type: Aurora DB clusters only
|
|
282
|
-
*/
|
|
283
|
-
EnableGlobalWriteForwarding?: boolean;
|
|
299
|
+
NetworkType?: string;
|
|
284
300
|
/**
|
|
285
|
-
*
|
|
286
|
-
*
|
|
301
|
+
* Specifies whether to turn on Performance Insights for the DB cluster.
|
|
302
|
+
* 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*.
|
|
287
303
|
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
288
304
|
*/
|
|
289
|
-
|
|
305
|
+
PerformanceInsightsEnabled?: boolean;
|
|
290
306
|
/**
|
|
291
|
-
*
|
|
292
|
-
*
|
|
307
|
+
* The AWS KMS key identifier for encryption of Performance Insights data.
|
|
308
|
+
* The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
309
|
+
* 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.
|
|
310
|
+
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
293
311
|
*/
|
|
294
|
-
|
|
312
|
+
PerformanceInsightsKmsKeyId?: string;
|
|
295
313
|
/**
|
|
296
|
-
*
|
|
297
|
-
*
|
|
298
|
-
*
|
|
299
|
-
* +
|
|
300
|
-
* +
|
|
314
|
+
* The number of days to retain Performance Insights data.
|
|
315
|
+
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
316
|
+
* Valid Values:
|
|
317
|
+
* + ``7``
|
|
318
|
+
* + *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)
|
|
319
|
+
* + ``731``
|
|
301
320
|
*
|
|
302
|
-
*
|
|
303
|
-
*
|
|
321
|
+
* Default: ``7`` days
|
|
322
|
+
* If you specify a retention period that isn't valid, such as ``94``, Amazon RDS issues an error.
|
|
304
323
|
*/
|
|
305
|
-
|
|
324
|
+
PerformanceInsightsRetentionPeriod?: number;
|
|
306
325
|
/**
|
|
307
|
-
* The
|
|
308
|
-
*
|
|
309
|
-
*
|
|
310
|
-
*
|
|
311
|
-
* + ``
|
|
312
|
-
* + ``
|
|
313
|
-
* + ``MasterUserPassword``
|
|
314
|
-
* + ``ReplicationSourceIdentifier``
|
|
315
|
-
* + ``RestoreType``
|
|
316
|
-
* + ``SourceDBClusterIdentifier``
|
|
317
|
-
* + ``SourceRegion``
|
|
318
|
-
* + ``StorageEncrypted`` (for an encrypted snapshot)
|
|
319
|
-
* + ``UseLatestRestorableTime``
|
|
326
|
+
* The port number on which the DB instances in the DB cluster accept connections.
|
|
327
|
+
* Default:
|
|
328
|
+
* + When ``EngineMode`` is ``provisioned``, ``3306`` (for both Aurora MySQL and Aurora PostgreSQL)
|
|
329
|
+
* + When ``EngineMode`` is ``serverless``:
|
|
330
|
+
* + ``3306`` when ``Engine`` is ``aurora`` or ``aurora-mysql``
|
|
331
|
+
* + ``5432`` when ``Engine`` is ``aurora-postgresql``
|
|
320
332
|
*
|
|
321
|
-
* Constraints:
|
|
322
|
-
* + Must match the identifier of an existing Snapshot.
|
|
323
333
|
*
|
|
324
|
-
*
|
|
334
|
+
* 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.
|
|
335
|
+
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
325
336
|
*/
|
|
326
|
-
|
|
337
|
+
Port?: number;
|
|
327
338
|
/**
|
|
328
339
|
* 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.*
|
|
329
340
|
* Constraints:
|
|
@@ -336,149 +347,139 @@ export interface _AWS_RDS_DBCLUSTER {
|
|
|
336
347
|
*/
|
|
337
348
|
PreferredBackupWindow?: string;
|
|
338
349
|
/**
|
|
339
|
-
* The
|
|
340
|
-
*
|
|
341
|
-
*
|
|
342
|
-
*
|
|
343
|
-
*
|
|
344
|
-
* 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``).
|
|
345
|
-
* 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.*
|
|
346
|
-
* Valid for: Aurora DB clusters only
|
|
347
|
-
*/
|
|
348
|
-
NetworkType?: string;
|
|
349
|
-
/**
|
|
350
|
-
* A list of EC2 VPC security groups to associate with this DB cluster.
|
|
351
|
-
* If you plan to update the resource, don't specify VPC security groups in a shared VPC.
|
|
352
|
-
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
353
|
-
*/
|
|
354
|
-
VpcSecurityGroupIds?: string[];
|
|
355
|
-
/**
|
|
356
|
-
* 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.
|
|
357
|
-
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
358
|
-
*/
|
|
359
|
-
CopyTagsToSnapshot?: boolean;
|
|
360
|
-
/**
|
|
361
|
-
* 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.
|
|
362
|
-
* If you aren't configuring a global database cluster, don't specify this property.
|
|
363
|
-
* To remove the DB cluster from a global database cluster, specify an empty value for the ``GlobalClusterIdentifier`` property.
|
|
364
|
-
* 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*.
|
|
365
|
-
* Valid for: Aurora DB clusters only
|
|
366
|
-
*/
|
|
367
|
-
GlobalClusterIdentifier?: string;
|
|
368
|
-
/**
|
|
369
|
-
* The type of restore to be performed. You can specify one of the following values:
|
|
370
|
-
* + ``full-copy`` - The new DB cluster is restored as a full copy of the source DB cluster.
|
|
371
|
-
* + ``copy-on-write`` - The new DB cluster is restored as a clone of the source DB cluster.
|
|
372
|
-
*
|
|
373
|
-
* If you don't specify a ``RestoreType`` value, then the new DB cluster is restored as a full copy of the source DB cluster.
|
|
350
|
+
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
|
351
|
+
* Format: ``ddd:hh24:mi-ddd:hh24:mi``
|
|
352
|
+
* 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.*
|
|
353
|
+
* Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
|
|
354
|
+
* Constraints: Minimum 30-minute window.
|
|
374
355
|
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
375
356
|
*/
|
|
376
|
-
|
|
377
|
-
/**
|
|
378
|
-
* Specifies the name of the IAM role to use when making API calls to the Directory Service.
|
|
379
|
-
* Valid for: Aurora DB clusters only
|
|
380
|
-
*/
|
|
381
|
-
DomainIAMRoleName?: string;
|
|
382
|
-
/**
|
|
383
|
-
* The life cycle type for this DB cluster.
|
|
384
|
-
* 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.
|
|
385
|
-
* 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:
|
|
386
|
-
* + 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*
|
|
387
|
-
* + Amazon RDS - [Using Amazon RDS Extended Support](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide*
|
|
388
|
-
*
|
|
389
|
-
* Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
390
|
-
* Valid Values: ``open-source-rds-extended-support | open-source-rds-extended-support-disabled``
|
|
391
|
-
* Default: ``open-source-rds-extended-support``
|
|
392
|
-
*/
|
|
393
|
-
EngineLifecycleSupport?: string;
|
|
357
|
+
PreferredMaintenanceWindow?: string;
|
|
394
358
|
/**
|
|
395
|
-
*
|
|
396
|
-
*
|
|
397
|
-
*
|
|
359
|
+
* Specifies whether the DB cluster is publicly accessible.
|
|
360
|
+
* When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. 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.
|
|
361
|
+
* 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.
|
|
398
362
|
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
363
|
+
* Default: The default behavior varies depending on whether ``DBSubnetGroupName`` is specified.
|
|
364
|
+
* If ``DBSubnetGroupName`` isn't specified, and ``PubliclyAccessible`` isn't specified, the following applies:
|
|
365
|
+
* + If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
|
|
366
|
+
* + If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
|
|
367
|
+
*
|
|
368
|
+
* If ``DBSubnetGroupName`` is specified, and ``PubliclyAccessible`` isn't specified, the following applies:
|
|
369
|
+
* + If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
|
|
370
|
+
* + If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
|
|
399
371
|
*/
|
|
400
|
-
|
|
401
|
-
/**
|
|
402
|
-
* 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*.
|
|
403
|
-
* Valid for: Aurora DB clusters only
|
|
404
|
-
*/
|
|
405
|
-
AvailabilityZones?: string[];
|
|
406
|
-
DBClusterArn?: string;
|
|
372
|
+
PubliclyAccessible?: boolean;
|
|
407
373
|
/**
|
|
408
|
-
* The
|
|
409
|
-
*
|
|
410
|
-
* 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.*
|
|
411
|
-
* Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
|
|
412
|
-
* Constraints: Minimum 30-minute window.
|
|
413
|
-
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
374
|
+
* The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
|
|
375
|
+
* Valid for: Aurora DB clusters only
|
|
414
376
|
*/
|
|
415
|
-
|
|
377
|
+
ReplicationSourceIdentifier?: string;
|
|
416
378
|
/**
|
|
417
|
-
* The
|
|
418
|
-
*
|
|
419
|
-
* This setting is required to create a Multi-AZ DB cluster.
|
|
420
|
-
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
379
|
+
* The date and time to restore the DB cluster to.
|
|
380
|
+
* Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
|
|
421
381
|
* Constraints:
|
|
422
|
-
* + Must be
|
|
382
|
+
* + Must be before the latest restorable time for the DB instance
|
|
383
|
+
* + Must be specified if ``UseLatestRestorableTime`` parameter isn't provided
|
|
384
|
+
* + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled
|
|
385
|
+
* + Can't be specified if the ``RestoreType`` parameter is ``copy-on-write``
|
|
386
|
+
*
|
|
387
|
+
* This property must be used with ``SourceDBClusterIdentifier`` property. The resulting cluster will have the identifier that matches the value of the ``DBclusterIdentifier`` property.
|
|
388
|
+
* Example: ``2015-03-07T23:45:00Z``
|
|
389
|
+
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
423
390
|
*/
|
|
424
|
-
|
|
391
|
+
RestoreToTime?: string;
|
|
425
392
|
/**
|
|
426
|
-
* The
|
|
427
|
-
*
|
|
393
|
+
* The type of restore to be performed. You can specify one of the following values:
|
|
394
|
+
* + ``full-copy`` - The new DB cluster is restored as a full copy of the source DB cluster.
|
|
395
|
+
* + ``copy-on-write`` - The new DB cluster is restored as a clone of the source DB cluster.
|
|
396
|
+
*
|
|
397
|
+
* If you don't specify a ``RestoreType`` value, then the new DB cluster is restored as a full copy of the source DB cluster.
|
|
398
|
+
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
428
399
|
*/
|
|
429
|
-
|
|
400
|
+
RestoreType?: string;
|
|
401
|
+
ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfiguration;
|
|
402
|
+
ScalingConfiguration?: ScalingConfiguration;
|
|
430
403
|
/**
|
|
431
|
-
*
|
|
404
|
+
* The identifier for the DB snapshot or DB cluster snapshot to restore from.
|
|
405
|
+
* 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.
|
|
406
|
+
* 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.
|
|
407
|
+
* 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:
|
|
408
|
+
* + ``GlobalClusterIdentifier``
|
|
409
|
+
* + ``MasterUsername``
|
|
410
|
+
* + ``MasterUserPassword``
|
|
411
|
+
* + ``ReplicationSourceIdentifier``
|
|
412
|
+
* + ``RestoreType``
|
|
413
|
+
* + ``SourceDBClusterIdentifier``
|
|
414
|
+
* + ``SourceRegion``
|
|
415
|
+
* + ``StorageEncrypted`` (for an encrypted snapshot)
|
|
416
|
+
* + ``UseLatestRestorableTime``
|
|
417
|
+
*
|
|
418
|
+
* Constraints:
|
|
419
|
+
* + Must match the identifier of an existing Snapshot.
|
|
420
|
+
*
|
|
432
421
|
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
433
422
|
*/
|
|
434
|
-
|
|
423
|
+
SnapshotIdentifier?: string;
|
|
435
424
|
/**
|
|
436
|
-
*
|
|
437
|
-
* 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.*
|
|
438
|
-
* Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
425
|
+
* When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.
|
|
439
426
|
* Constraints:
|
|
440
|
-
* +
|
|
427
|
+
* + Must match the identifier of an existing DBCluster.
|
|
428
|
+
*
|
|
429
|
+
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
441
430
|
*/
|
|
442
|
-
|
|
431
|
+
SourceDBClusterIdentifier?: string;
|
|
443
432
|
/**
|
|
444
|
-
*
|
|
445
|
-
* For more information, see [IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide.*
|
|
433
|
+
* The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, ``us-east-1``.
|
|
446
434
|
* Valid for: Aurora DB clusters only
|
|
447
435
|
*/
|
|
448
|
-
|
|
436
|
+
SourceRegion?: string;
|
|
449
437
|
/**
|
|
450
|
-
*
|
|
451
|
-
*
|
|
452
|
-
* If you
|
|
453
|
-
*
|
|
454
|
-
*
|
|
455
|
-
*
|
|
438
|
+
* Indicates whether the DB cluster is encrypted.
|
|
439
|
+
* If you specify the ``KmsKeyId`` property, then you must enable encryption.
|
|
440
|
+
* 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.
|
|
441
|
+
* 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.
|
|
442
|
+
* 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``.
|
|
443
|
+
* 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.
|
|
444
|
+
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
456
445
|
*/
|
|
457
|
-
|
|
446
|
+
StorageEncrypted?: boolean;
|
|
447
|
+
StorageThroughput?: number;
|
|
458
448
|
/**
|
|
459
|
-
*
|
|
460
|
-
* For
|
|
461
|
-
*
|
|
449
|
+
* The storage type to associate with the DB cluster.
|
|
450
|
+
* 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).
|
|
451
|
+
* This setting is required to create a Multi-AZ DB cluster.
|
|
452
|
+
* When specified for a Multi-AZ DB cluster, a value for the ``Iops`` parameter is required.
|
|
453
|
+
* Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
454
|
+
* Valid Values:
|
|
455
|
+
* + Aurora DB clusters - ``aurora | aurora-iopt1``
|
|
456
|
+
* + Multi-AZ DB clusters - ``io1 | io2 | gp3``
|
|
457
|
+
*
|
|
458
|
+
* Default:
|
|
459
|
+
* + Aurora DB clusters - ``aurora``
|
|
460
|
+
* + Multi-AZ DB clusters - ``io1``
|
|
461
|
+
*
|
|
462
|
+
* 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``.
|
|
462
463
|
*/
|
|
463
|
-
|
|
464
|
+
StorageType?: string;
|
|
464
465
|
/**
|
|
465
|
-
*
|
|
466
|
-
*
|
|
467
|
-
* Constraints:
|
|
468
|
-
* + Must be a value from 1 to 35
|
|
466
|
+
* Tags to assign to the DB cluster.
|
|
467
|
+
* Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
469
468
|
*
|
|
469
|
+
* @maxItems 50
|
|
470
|
+
*/
|
|
471
|
+
Tags?: Tag[];
|
|
472
|
+
/**
|
|
473
|
+
* 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.
|
|
470
474
|
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
471
475
|
*/
|
|
472
|
-
|
|
476
|
+
UseLatestRestorableTime?: boolean;
|
|
473
477
|
/**
|
|
474
|
-
*
|
|
475
|
-
*
|
|
476
|
-
* Valid values: ``audit``, ``error``, ``general``, ``slowquery``
|
|
477
|
-
* *Aurora PostgreSQL*
|
|
478
|
-
* Valid values: ``postgresql``
|
|
478
|
+
* A list of EC2 VPC security groups to associate with this DB cluster.
|
|
479
|
+
* If you plan to update the resource, don't specify VPC security groups in a shared VPC.
|
|
479
480
|
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
480
481
|
*/
|
|
481
|
-
|
|
482
|
+
VpcSecurityGroupIds?: string[];
|
|
482
483
|
}
|
|
483
484
|
export interface Endpoint {
|
|
484
485
|
/**
|
|
@@ -491,35 +492,31 @@ export interface Endpoint {
|
|
|
491
492
|
Port?: string;
|
|
492
493
|
}
|
|
493
494
|
/**
|
|
494
|
-
*
|
|
495
|
-
*
|
|
495
|
+
* 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:
|
|
496
|
+
* + ``CreateDBInstance``
|
|
497
|
+
* + ``DescribeDBInstances``
|
|
498
|
+
* + ``DeleteDBInstance``
|
|
499
|
+
*
|
|
500
|
+
* For the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``.
|
|
496
501
|
*/
|
|
497
|
-
export interface
|
|
498
|
-
/**
|
|
499
|
-
* 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}_.:/=+\\-@]*)$").
|
|
500
|
-
*/
|
|
501
|
-
Value?: string;
|
|
502
|
+
export interface ReadEndpoint {
|
|
502
503
|
/**
|
|
503
|
-
*
|
|
504
|
+
* The host address of the reader endpoint.
|
|
504
505
|
*/
|
|
505
|
-
|
|
506
|
+
Address?: string;
|
|
506
507
|
}
|
|
507
508
|
/**
|
|
508
|
-
*
|
|
509
|
-
* This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, Use the ``ScalingConfiguration`` property.
|
|
510
|
-
* Valid for: Aurora Serverless v2 DB clusters only
|
|
509
|
+
* Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.
|
|
511
510
|
*/
|
|
512
|
-
export interface
|
|
511
|
+
export interface DBClusterRole {
|
|
513
512
|
/**
|
|
514
|
-
* The
|
|
513
|
+
* 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*.
|
|
515
514
|
*/
|
|
516
|
-
|
|
515
|
+
FeatureName?: string;
|
|
517
516
|
/**
|
|
518
|
-
* The
|
|
519
|
-
* 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*.
|
|
520
|
-
* 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.
|
|
517
|
+
* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
|
|
521
518
|
*/
|
|
522
|
-
|
|
519
|
+
RoleArn: string;
|
|
523
520
|
}
|
|
524
521
|
/**
|
|
525
522
|
* The secret managed by RDS in AWS Secrets Manager for the master user password.
|
|
@@ -536,34 +533,40 @@ export interface MasterUserSecret {
|
|
|
536
533
|
KmsKeyId?: string;
|
|
537
534
|
}
|
|
538
535
|
/**
|
|
539
|
-
* The scaling configuration of an Aurora Serverless
|
|
540
|
-
* This property is only supported for Aurora Serverless
|
|
541
|
-
* Valid for: Aurora Serverless
|
|
536
|
+
* The scaling configuration of an Aurora Serverless V2 DB cluster.
|
|
537
|
+
* This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, Use the ``ScalingConfiguration`` property.
|
|
538
|
+
* Valid for: Aurora Serverless v2 DB clusters only
|
|
542
539
|
*/
|
|
543
|
-
export interface
|
|
544
|
-
/**
|
|
545
|
-
* The action to take when the timeout is reached, either ``ForceApplyCapacityChange`` or ``RollbackCapacityChange``.
|
|
546
|
-
* ``ForceApplyCapacityChange`` sets the capacity to the specified value as soon as possible.
|
|
547
|
-
* ``RollbackCapacityChange``, the default, ignores the capacity change if a scaling point isn't found in the timeout period.
|
|
548
|
-
* If you specify ``ForceApplyCapacityChange``, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.
|
|
549
|
-
* 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*.
|
|
550
|
-
*/
|
|
551
|
-
TimeoutAction?: string;
|
|
540
|
+
export interface ServerlessV2ScalingConfiguration {
|
|
552
541
|
/**
|
|
553
|
-
* The
|
|
554
|
-
* Specify a value between 60 and 600 seconds.
|
|
542
|
+
* 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.
|
|
555
543
|
*/
|
|
556
|
-
|
|
544
|
+
MinCapacity?: number;
|
|
557
545
|
/**
|
|
558
|
-
* The
|
|
559
|
-
*
|
|
546
|
+
* 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.
|
|
547
|
+
* 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*.
|
|
548
|
+
* 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.
|
|
560
549
|
*/
|
|
561
|
-
|
|
550
|
+
MaxCapacity?: number;
|
|
551
|
+
}
|
|
552
|
+
/**
|
|
553
|
+
* The scaling configuration of an Aurora Serverless v1 DB cluster.
|
|
554
|
+
* This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ``ServerlessV2ScalingConfiguration`` property.
|
|
555
|
+
* Valid for: Aurora Serverless v1 DB clusters only
|
|
556
|
+
*/
|
|
557
|
+
export interface ScalingConfiguration {
|
|
562
558
|
/**
|
|
563
559
|
* 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).
|
|
564
560
|
* 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.
|
|
565
561
|
*/
|
|
566
562
|
AutoPause?: boolean;
|
|
563
|
+
/**
|
|
564
|
+
* The maximum capacity for an Aurora DB cluster in ``serverless`` DB engine mode.
|
|
565
|
+
* For Aurora MySQL, valid capacity values are ``1``, ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``128``, and ``256``.
|
|
566
|
+
* For Aurora PostgreSQL, valid capacity values are ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``192``, and ``384``.
|
|
567
|
+
* The maximum capacity must be greater than or equal to the minimum capacity.
|
|
568
|
+
*/
|
|
569
|
+
MaxCapacity?: number;
|
|
567
570
|
/**
|
|
568
571
|
* The minimum capacity for an Aurora DB cluster in ``serverless`` DB engine mode.
|
|
569
572
|
* For Aurora MySQL, valid capacity values are ``1``, ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``128``, and ``256``.
|
|
@@ -572,37 +575,35 @@ export interface ScalingConfiguration {
|
|
|
572
575
|
*/
|
|
573
576
|
MinCapacity?: number;
|
|
574
577
|
/**
|
|
575
|
-
* The
|
|
576
|
-
*
|
|
577
|
-
* For Aurora PostgreSQL, valid capacity values are ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``192``, and ``384``.
|
|
578
|
-
* The maximum capacity must be greater than or equal to the minimum capacity.
|
|
578
|
+
* 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.
|
|
579
|
+
* Specify a value between 60 and 600 seconds.
|
|
579
580
|
*/
|
|
580
|
-
|
|
581
|
-
}
|
|
582
|
-
/**
|
|
583
|
-
* 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:
|
|
584
|
-
* + ``CreateDBInstance``
|
|
585
|
-
* + ``DescribeDBInstances``
|
|
586
|
-
* + ``DeleteDBInstance``
|
|
587
|
-
*
|
|
588
|
-
* For the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``.
|
|
589
|
-
*/
|
|
590
|
-
export interface ReadEndpoint {
|
|
581
|
+
SecondsBeforeTimeout?: number;
|
|
591
582
|
/**
|
|
592
|
-
* The
|
|
583
|
+
* The time, in seconds, before an Aurora DB cluster in ``serverless`` mode is paused.
|
|
584
|
+
* Specify a value between 300 and 86,400 seconds.
|
|
593
585
|
*/
|
|
594
|
-
|
|
586
|
+
SecondsUntilAutoPause?: number;
|
|
587
|
+
/**
|
|
588
|
+
* The action to take when the timeout is reached, either ``ForceApplyCapacityChange`` or ``RollbackCapacityChange``.
|
|
589
|
+
* ``ForceApplyCapacityChange`` sets the capacity to the specified value as soon as possible.
|
|
590
|
+
* ``RollbackCapacityChange``, the default, ignores the capacity change if a scaling point isn't found in the timeout period.
|
|
591
|
+
* If you specify ``ForceApplyCapacityChange``, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.
|
|
592
|
+
* 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*.
|
|
593
|
+
*/
|
|
594
|
+
TimeoutAction?: string;
|
|
595
595
|
}
|
|
596
596
|
/**
|
|
597
|
-
*
|
|
597
|
+
* Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
|
|
598
|
+
* 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*.
|
|
598
599
|
*/
|
|
599
|
-
export interface
|
|
600
|
+
export interface Tag {
|
|
600
601
|
/**
|
|
601
|
-
*
|
|
602
|
+
* 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}_.:/=+\\-@]*)$").
|
|
602
603
|
*/
|
|
603
|
-
|
|
604
|
+
Key: string;
|
|
604
605
|
/**
|
|
605
|
-
*
|
|
606
|
+
* 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}_.:/=+\\-@]*)$").
|
|
606
607
|
*/
|
|
607
|
-
|
|
608
|
+
Value?: string;
|
|
608
609
|
}
|