@horietakehiro/aws-cdk-utul 0.10.2 → 0.11.3
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/stack-manager.d.ts +41 -0
- package/lib/stack-manager.js +132 -0
- package/lib/types/cfn-resource-types/aws-amazonmq-configuration.d.ts +35 -5
- package/lib/types/cfn-resource-types/aws-amazonmq-configuration.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigateway-vpclink.d.ts +0 -9
- package/lib/types/cfn-resource-types/aws-apigateway-vpclink.js +1 -1
- package/lib/types/cfn-resource-types/aws-apigatewayv2-domainname.d.ts +2 -2
- package/lib/types/cfn-resource-types/aws-apigatewayv2-domainname.js +1 -1
- package/lib/types/cfn-resource-types/aws-appconfig-deploymentstrategy.d.ts +56 -8
- package/lib/types/cfn-resource-types/aws-appconfig-deploymentstrategy.js +1 -1
- package/lib/types/cfn-resource-types/aws-appsync-datasource.d.ts +151 -31
- package/lib/types/cfn-resource-types/aws-appsync-datasource.js +1 -1
- package/lib/types/cfn-resource-types/aws-appsync-graphqlapi.d.ts +225 -36
- package/lib/types/cfn-resource-types/aws-appsync-graphqlapi.js +1 -1
- package/lib/types/cfn-resource-types/aws-autoscaling-autoscalinggroup.d.ts +6 -1
- package/lib/types/cfn-resource-types/aws-autoscaling-autoscalinggroup.js +1 -1
- package/lib/types/cfn-resource-types/aws-b2bi-capability.d.ts +2 -0
- package/lib/types/cfn-resource-types/aws-b2bi-capability.js +1 -1
- package/lib/types/cfn-resource-types/aws-b2bi-partnership.d.ts +37 -1
- package/lib/types/cfn-resource-types/aws-b2bi-partnership.js +1 -1
- package/lib/types/cfn-resource-types/aws-b2bi-transformer.d.ts +41 -4
- package/lib/types/cfn-resource-types/aws-b2bi-transformer.js +1 -1
- package/lib/types/cfn-resource-types/aws-backup-logicallyairgappedbackupvault.d.ts +28 -0
- package/lib/types/cfn-resource-types/aws-backup-logicallyairgappedbackupvault.js +3 -0
- package/lib/types/cfn-resource-types/aws-bedrock-agent.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-bedrock-agent.js +1 -1
- package/lib/types/cfn-resource-types/aws-bedrock-flow.d.ts +17 -6
- package/lib/types/cfn-resource-types/aws-bedrock-flow.js +1 -1
- package/lib/types/cfn-resource-types/aws-bedrock-flowversion.d.ts +17 -6
- package/lib/types/cfn-resource-types/aws-bedrock-flowversion.js +1 -1
- package/lib/types/cfn-resource-types/aws-bedrock-prompt.d.ts +3 -7
- package/lib/types/cfn-resource-types/aws-bedrock-prompt.js +1 -1
- package/lib/types/cfn-resource-types/aws-bedrock-promptversion.d.ts +4 -8
- package/lib/types/cfn-resource-types/aws-bedrock-promptversion.js +1 -1
- package/lib/types/cfn-resource-types/aws-cloudformation-customresource.d.ts +2 -1
- package/lib/types/cfn-resource-types/aws-cloudformation-customresource.js +1 -1
- package/lib/types/cfn-resource-types/aws-codepipeline-pipeline.d.ts +23 -2
- package/lib/types/cfn-resource-types/aws-codepipeline-pipeline.js +1 -1
- package/lib/types/cfn-resource-types/aws-cognito-userpool.d.ts +2 -0
- package/lib/types/cfn-resource-types/aws-cognito-userpool.js +1 -1
- package/lib/types/cfn-resource-types/aws-cognito-userpoolidentityprovider.d.ts +15 -8
- package/lib/types/cfn-resource-types/aws-cognito-userpoolidentityprovider.js +1 -1
- package/lib/types/cfn-resource-types/aws-connect-contactflow.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-connect-contactflow.js +1 -1
- package/lib/types/cfn-resource-types/aws-connect-hoursofoperation.d.ts +18 -18
- package/lib/types/cfn-resource-types/aws-connect-hoursofoperation.js +1 -1
- package/lib/types/cfn-resource-types/aws-datasync-task.d.ts +96 -96
- package/lib/types/cfn-resource-types/aws-datasync-task.js +1 -1
- package/lib/types/cfn-resource-types/aws-dms-datamigration.d.ts +90 -0
- package/lib/types/cfn-resource-types/aws-dms-datamigration.js +3 -0
- package/lib/types/cfn-resource-types/aws-dms-replicationinstance.d.ts +1 -0
- package/lib/types/cfn-resource-types/aws-dms-replicationinstance.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-capacityreservation.d.ts +1 -0
- package/lib/types/cfn-resource-types/aws-ec2-capacityreservation.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-eip.d.ts +2 -0
- package/lib/types/cfn-resource-types/aws-ec2-eip.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-natgateway.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-natgateway.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-transitgateway.d.ts +6 -5
- package/lib/types/cfn-resource-types/aws-ec2-transitgateway.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-transitgatewayattachment.d.ts +4 -0
- package/lib/types/cfn-resource-types/aws-ec2-transitgatewayattachment.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-transitgatewayvpcattachment.d.ts +14 -10
- package/lib/types/cfn-resource-types/aws-ec2-transitgatewayvpcattachment.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-vpc.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-vpc.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-vpcendpoint.d.ts +2 -1
- package/lib/types/cfn-resource-types/aws-ec2-vpcendpoint.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-vpcendpointconnectionnotification.d.ts +8 -8
- package/lib/types/cfn-resource-types/aws-ec2-vpcendpointconnectionnotification.js +1 -1
- package/lib/types/cfn-resource-types/aws-ec2-vpnconnection.d.ts +213 -3
- package/lib/types/cfn-resource-types/aws-ec2-vpnconnection.js +1 -1
- package/lib/types/cfn-resource-types/aws-ecs-capacityprovider.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-ecs-capacityprovider.js +1 -1
- package/lib/types/cfn-resource-types/aws-ecs-service.d.ts +10 -1
- package/lib/types/cfn-resource-types/aws-ecs-service.js +1 -1
- package/lib/types/cfn-resource-types/aws-ecs-taskset.d.ts +57 -51
- package/lib/types/cfn-resource-types/aws-ecs-taskset.js +1 -1
- package/lib/types/cfn-resource-types/aws-eks-cluster.d.ts +11 -1
- package/lib/types/cfn-resource-types/aws-eks-cluster.js +1 -1
- package/lib/types/cfn-resource-types/aws-elasticache-globalreplicationgroup.d.ts +4 -0
- package/lib/types/cfn-resource-types/aws-elasticache-globalreplicationgroup.js +1 -1
- package/lib/types/cfn-resource-types/aws-elasticloadbalancingv2-listener.d.ts +79 -63
- package/lib/types/cfn-resource-types/aws-elasticloadbalancingv2-listener.js +1 -1
- package/lib/types/cfn-resource-types/aws-elasticloadbalancingv2-listenerrule.d.ts +65 -63
- package/lib/types/cfn-resource-types/aws-elasticloadbalancingv2-listenerrule.js +1 -1
- package/lib/types/cfn-resource-types/aws-emr-cluster.d.ts +35 -14
- package/lib/types/cfn-resource-types/aws-emr-cluster.js +1 -1
- package/lib/types/cfn-resource-types/aws-emr-instancefleetconfig.d.ts +21 -0
- package/lib/types/cfn-resource-types/aws-emr-instancefleetconfig.js +1 -1
- package/lib/types/cfn-resource-types/aws-fis-experimenttemplate.d.ts +81 -81
- package/lib/types/cfn-resource-types/aws-fis-experimenttemplate.js +1 -1
- package/lib/types/cfn-resource-types/aws-gamelift-containergroupdefinition.d.ts +19 -0
- package/lib/types/cfn-resource-types/aws-gamelift-containergroupdefinition.js +1 -1
- package/lib/types/cfn-resource-types/aws-glue-crawler.d.ts +179 -1
- package/lib/types/cfn-resource-types/aws-glue-crawler.js +1 -1
- package/lib/types/cfn-resource-types/aws-glue-job.d.ts +96 -6
- package/lib/types/cfn-resource-types/aws-glue-job.js +1 -1
- package/lib/types/cfn-resource-types/aws-glue-schema.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-glue-schema.js +1 -1
- package/lib/types/cfn-resource-types/aws-glue-usageprofile.d.ts +64 -0
- package/lib/types/cfn-resource-types/aws-glue-usageprofile.js +3 -0
- package/lib/types/cfn-resource-types/aws-iam-policy.d.ts +4 -1
- package/lib/types/cfn-resource-types/aws-iam-policy.js +1 -1
- package/lib/types/cfn-resource-types/aws-iam-role.d.ts +3 -2
- package/lib/types/cfn-resource-types/aws-iam-role.js +1 -1
- package/lib/types/cfn-resource-types/aws-imagebuilder-component.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-imagebuilder-component.js +1 -1
- package/lib/types/cfn-resource-types/aws-imagebuilder-infrastructureconfiguration.d.ts +22 -0
- package/lib/types/cfn-resource-types/aws-imagebuilder-infrastructureconfiguration.js +1 -1
- package/lib/types/cfn-resource-types/aws-iot-domainconfiguration.d.ts +6 -0
- package/lib/types/cfn-resource-types/aws-iot-domainconfiguration.js +1 -1
- package/lib/types/cfn-resource-types/aws-iotevents-alarmmodel.d.ts +195 -79
- package/lib/types/cfn-resource-types/aws-iotevents-alarmmodel.js +1 -1
- package/lib/types/cfn-resource-types/aws-iotevents-detectormodel.d.ts +177 -85
- package/lib/types/cfn-resource-types/aws-iotevents-detectormodel.js +1 -1
- package/lib/types/cfn-resource-types/aws-iotevents-input.d.ts +9 -11
- package/lib/types/cfn-resource-types/aws-iotevents-input.js +1 -1
- package/lib/types/cfn-resource-types/aws-ivs-encoderconfiguration.d.ts +2 -2
- package/lib/types/cfn-resource-types/aws-ivs-encoderconfiguration.js +1 -1
- package/lib/types/cfn-resource-types/aws-kinesis-resourcepolicy.d.ts +17 -0
- package/lib/types/cfn-resource-types/aws-kinesis-resourcepolicy.js +3 -0
- package/lib/types/cfn-resource-types/aws-lakeformation-principalpermissions.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-lakeformation-principalpermissions.js +1 -1
- package/lib/types/cfn-resource-types/aws-lakeformation-tag.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-lakeformation-tag.js +1 -1
- package/lib/types/cfn-resource-types/aws-lambda-eventsourcemapping.d.ts +115 -108
- package/lib/types/cfn-resource-types/aws-lambda-eventsourcemapping.js +1 -1
- package/lib/types/cfn-resource-types/aws-medialive-channel.d.ts +2 -0
- package/lib/types/cfn-resource-types/aws-medialive-channel.js +1 -1
- package/lib/types/cfn-resource-types/aws-memorydb-cluster.d.ts +4 -0
- package/lib/types/cfn-resource-types/aws-memorydb-cluster.js +1 -1
- package/lib/types/cfn-resource-types/aws-networkfirewall-firewallpolicy.d.ts +3 -0
- package/lib/types/cfn-resource-types/aws-networkfirewall-firewallpolicy.js +1 -1
- package/lib/types/cfn-resource-types/aws-organizations-policy.d.ts +2 -2
- package/lib/types/cfn-resource-types/aws-organizations-policy.js +1 -1
- package/lib/types/cfn-resource-types/aws-qbusiness-webexperience.d.ts +6 -0
- package/lib/types/cfn-resource-types/aws-qbusiness-webexperience.js +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-analysis.d.ts +13 -0
- package/lib/types/cfn-resource-types/aws-quicksight-analysis.js +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-dashboard.d.ts +13 -0
- package/lib/types/cfn-resource-types/aws-quicksight-dashboard.js +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-dataset.d.ts +2 -2
- package/lib/types/cfn-resource-types/aws-quicksight-dataset.js +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-datasource.d.ts +247 -242
- package/lib/types/cfn-resource-types/aws-quicksight-datasource.js +1 -1
- package/lib/types/cfn-resource-types/aws-quicksight-folder.d.ts +79 -0
- package/lib/types/cfn-resource-types/aws-quicksight-folder.js +3 -0
- package/lib/types/cfn-resource-types/aws-quicksight-template.d.ts +8 -0
- package/lib/types/cfn-resource-types/aws-quicksight-template.js +1 -1
- package/lib/types/cfn-resource-types/aws-rds-dbcluster.d.ts +366 -366
- package/lib/types/cfn-resource-types/aws-rds-dbcluster.js +1 -1
- package/lib/types/cfn-resource-types/aws-rds-dbinstance.d.ts +1 -4
- package/lib/types/cfn-resource-types/aws-rds-dbinstance.js +1 -1
- package/lib/types/cfn-resource-types/aws-rds-globalcluster.d.ts +19 -0
- package/lib/types/cfn-resource-types/aws-rds-globalcluster.js +1 -1
- package/lib/types/cfn-resource-types/aws-redshift-integration.d.ts +61 -0
- package/lib/types/cfn-resource-types/aws-redshift-integration.js +3 -0
- package/lib/types/cfn-resource-types/aws-refactorspaces-environment.d.ts +2 -2
- package/lib/types/cfn-resource-types/aws-refactorspaces-environment.js +1 -1
- package/lib/types/cfn-resource-types/aws-route53profiles-profileassociation.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-route53profiles-profileassociation.js +1 -1
- package/lib/types/cfn-resource-types/aws-route53resolver-resolverrule.d.ts +4 -4
- package/lib/types/cfn-resource-types/aws-route53resolver-resolverrule.js +1 -1
- package/lib/types/cfn-resource-types/aws-s3-bucket.d.ts +599 -591
- package/lib/types/cfn-resource-types/aws-s3-bucket.js +1 -1
- package/lib/types/cfn-resource-types/aws-s3express-directorybucket.d.ts +34 -3
- package/lib/types/cfn-resource-types/aws-s3express-directorybucket.js +1 -1
- package/lib/types/cfn-resource-types/aws-sagemaker-domain.d.ts +8 -0
- package/lib/types/cfn-resource-types/aws-sagemaker-domain.js +1 -1
- package/lib/types/cfn-resource-types/aws-sagemaker-endpoint.d.ts +137 -20
- package/lib/types/cfn-resource-types/aws-sagemaker-endpoint.js +1 -1
- package/lib/types/cfn-resource-types/aws-secretsmanager-secret.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-secretsmanager-secret.js +1 -1
- package/lib/types/cfn-resource-types/aws-securityhub-automationrule.d.ts +4 -4
- package/lib/types/cfn-resource-types/aws-securityhub-automationrule.js +1 -1
- package/lib/types/cfn-resource-types/aws-securityhub-findingaggregator.d.ts +2 -2
- package/lib/types/cfn-resource-types/aws-securityhub-findingaggregator.js +1 -1
- package/lib/types/cfn-resource-types/aws-ses-mailmanagerruleset.d.ts +4 -1
- package/lib/types/cfn-resource-types/aws-ses-mailmanagerruleset.js +1 -1
- package/lib/types/cfn-resource-types/aws-sns-topic.d.ts +2 -6
- package/lib/types/cfn-resource-types/aws-sns-topic.js +1 -1
- package/lib/types/cfn-resource-types/aws-sqs-queue.d.ts +12 -12
- package/lib/types/cfn-resource-types/aws-sqs-queue.js +1 -1
- package/lib/types/cfn-resource-types/aws-sqs-queuepolicy.d.ts +1 -3
- package/lib/types/cfn-resource-types/aws-sqs-queuepolicy.js +1 -1
- package/lib/types/cfn-resource-types/aws-ssmquicksetup-configurationmanager.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-ssmquicksetup-configurationmanager.js +1 -1
- package/lib/types/cfn-resource-types/aws-transfer-server.d.ts +70 -36
- package/lib/types/cfn-resource-types/aws-transfer-server.js +1 -1
- package/lib/types/cfn-resource-types/aws-wisdom-aiprompt.d.ts +34 -0
- package/lib/types/cfn-resource-types/aws-wisdom-aiprompt.js +3 -0
- package/lib/types/cfn-resource-types/aws-wisdom-knowledgebase.d.ts +1 -1
- package/lib/types/cfn-resource-types/aws-wisdom-knowledgebase.js +1 -1
- package/lib/types/cfn-resource-types/aws-workspacesweb-identityprovider.d.ts +9 -0
- package/lib/types/cfn-resource-types/aws-workspacesweb-identityprovider.js +1 -1
- package/lib/types/cfn-resource-types.d.ts +14 -0
- package/lib/types/cfn-resource-types.js +40 -26
- package/package.json +11 -7
|
@@ -18,87 +18,57 @@
|
|
|
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;
|
|
23
|
-
/**
|
|
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.
|
|
27
|
-
*/
|
|
28
|
-
AllocatedStorage?: number;
|
|
29
|
-
/**
|
|
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
|
|
32
|
-
*/
|
|
33
|
-
AssociatedRoles?: DBClusterRole[];
|
|
34
|
-
/**
|
|
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
21
|
/**
|
|
40
|
-
*
|
|
41
|
-
*
|
|
22
|
+
* Indicates whether the DB cluster is encrypted.
|
|
23
|
+
* If you specify the ``KmsKeyId`` property, then you must enable encryption.
|
|
24
|
+
* 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.
|
|
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
|
|
42
29
|
*/
|
|
43
|
-
|
|
30
|
+
StorageEncrypted?: boolean;
|
|
44
31
|
/**
|
|
45
|
-
*
|
|
46
|
-
* Valid for Cluster Type: Aurora MySQL DB clusters only
|
|
47
|
-
* Default: ``0``
|
|
48
|
-
* Constraints:
|
|
49
|
-
* + If specified, this value must be set to a number from 0 to 259,200 (72 hours).
|
|
32
|
+
* Reserved for future use.
|
|
50
33
|
*/
|
|
51
|
-
|
|
34
|
+
DBSystemId?: string;
|
|
52
35
|
/**
|
|
53
|
-
* The
|
|
54
|
-
*
|
|
36
|
+
* The date and time to restore the DB cluster to.
|
|
37
|
+
* Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
|
|
55
38
|
* Constraints:
|
|
56
|
-
* + Must be
|
|
39
|
+
* + Must be before the latest restorable time for the DB instance
|
|
40
|
+
* + Must be specified if ``UseLatestRestorableTime`` parameter isn't provided
|
|
41
|
+
* + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled
|
|
42
|
+
* + Can't be specified if the ``RestoreType`` parameter is ``copy-on-write``
|
|
57
43
|
*
|
|
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``
|
|
58
46
|
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
59
47
|
*/
|
|
60
|
-
|
|
61
|
-
/**
|
|
62
|
-
* 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.
|
|
63
|
-
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
64
|
-
*/
|
|
65
|
-
CopyTagsToSnapshot?: boolean;
|
|
66
|
-
/**
|
|
67
|
-
* 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*.
|
|
68
|
-
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
69
|
-
*/
|
|
70
|
-
DatabaseName?: string;
|
|
71
|
-
DBClusterArn?: string;
|
|
72
|
-
/**
|
|
73
|
-
* 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.
|
|
74
|
-
* 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*.
|
|
75
|
-
* This setting is required to create a Multi-AZ DB cluster.
|
|
76
|
-
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
77
|
-
*/
|
|
78
|
-
DBClusterInstanceClass?: string;
|
|
79
|
-
DBClusterResourceId?: string;
|
|
80
|
-
/**
|
|
81
|
-
* The name of the DB parameter group to apply to all instances of the DB cluster.
|
|
82
|
-
* 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.
|
|
83
|
-
* Valid for Cluster Type: Aurora DB clusters only
|
|
84
|
-
* Default: The existing name setting
|
|
85
|
-
* Constraints:
|
|
86
|
-
* + The DB parameter group must be in the same DB parameter group family as this DB cluster.
|
|
87
|
-
* + The ``DBInstanceParameterGroupName`` parameter is valid in combination with the ``AllowMajorVersionUpgrade`` parameter for a major version upgrade only.
|
|
88
|
-
*/
|
|
89
|
-
DBInstanceParameterGroupName?: string;
|
|
48
|
+
RestoreToTime?: string;
|
|
90
49
|
/**
|
|
91
|
-
*
|
|
50
|
+
* The DB engine mode of the DB cluster, either ``provisioned`` or ``serverless``.
|
|
51
|
+
* The ``serverless`` engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the ``provisioned`` engine mode.
|
|
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
|
|
92
57
|
*/
|
|
93
|
-
|
|
58
|
+
EngineMode?: string;
|
|
94
59
|
/**
|
|
95
|
-
*
|
|
96
|
-
*
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
60
|
+
* The port number on which the DB instances in the DB cluster accept connections.
|
|
61
|
+
* Default:
|
|
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
|
|
100
70
|
*/
|
|
101
|
-
|
|
71
|
+
Port?: number;
|
|
102
72
|
/**
|
|
103
73
|
* The DB cluster identifier. This parameter is stored as a lowercase string.
|
|
104
74
|
* Constraints:
|
|
@@ -110,75 +80,21 @@ export interface _AWS_RDS_DBCLUSTER {
|
|
|
110
80
|
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
111
81
|
*/
|
|
112
82
|
DBClusterIdentifier?: string;
|
|
83
|
+
StorageThroughput?: number;
|
|
113
84
|
/**
|
|
114
|
-
* The
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
120
|
-
*/
|
|
121
|
-
DBClusterParameterGroupName?: string;
|
|
122
|
-
/**
|
|
123
|
-
* A DB subnet group that you want to associate with this DB cluster.
|
|
124
|
-
* 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.
|
|
125
|
-
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
126
|
-
*/
|
|
127
|
-
DBSubnetGroupName?: string;
|
|
128
|
-
/**
|
|
129
|
-
* 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.
|
|
130
|
-
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
131
|
-
*/
|
|
132
|
-
DeletionProtection?: boolean;
|
|
133
|
-
/**
|
|
134
|
-
* Indicates the directory ID of the Active Directory to create the DB cluster.
|
|
135
|
-
* For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.
|
|
136
|
-
* For more information, see [Kerberos authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the *Amazon Aurora User Guide*.
|
|
137
|
-
* Valid for: Aurora DB clusters only
|
|
138
|
-
*/
|
|
139
|
-
Domain?: string;
|
|
140
|
-
/**
|
|
141
|
-
* Specifies the name of the IAM role to use when making API calls to the Directory Service.
|
|
142
|
-
* Valid for: Aurora DB clusters only
|
|
143
|
-
*/
|
|
144
|
-
DomainIAMRoleName?: string;
|
|
145
|
-
/**
|
|
146
|
-
* 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*.
|
|
147
|
-
* *Aurora MySQL*
|
|
148
|
-
* Valid values: ``audit``, ``error``, ``general``, ``slowquery``
|
|
149
|
-
* *Aurora PostgreSQL*
|
|
150
|
-
* Valid values: ``postgresql``
|
|
151
|
-
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
152
|
-
*/
|
|
153
|
-
EnableCloudwatchLogsExports?: string[];
|
|
154
|
-
/**
|
|
155
|
-
* 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.
|
|
156
|
-
* 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.
|
|
157
|
-
* Valid for Cluster Type: Aurora DB clusters only
|
|
158
|
-
*/
|
|
159
|
-
EnableGlobalWriteForwarding?: boolean;
|
|
160
|
-
/**
|
|
161
|
-
* Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
|
|
162
|
-
* 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.
|
|
163
|
-
* RDS Data API is supported with the following DB clusters:
|
|
164
|
-
* + Aurora PostgreSQL Serverless v2 and provisioned
|
|
165
|
-
* + Aurora PostgreSQL and Aurora MySQL Serverless v1
|
|
166
|
-
*
|
|
167
|
-
* 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*.
|
|
168
|
-
* Valid for Cluster Type: Aurora DB clusters only
|
|
169
|
-
*/
|
|
170
|
-
EnableHttpEndpoint?: boolean;
|
|
171
|
-
/**
|
|
172
|
-
* A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
|
|
173
|
-
* For more information, see [IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide.*
|
|
174
|
-
* Valid for: Aurora DB clusters only
|
|
85
|
+
* 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``.
|
|
86
|
+
* If ``MonitoringRoleArn`` is specified, also set ``MonitoringInterval`` to a value other than ``0``.
|
|
87
|
+
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
88
|
+
* Valid Values: ``0 | 1 | 5 | 10 | 15 | 30 | 60``
|
|
89
|
+
* Default: ``0``
|
|
175
90
|
*/
|
|
176
|
-
|
|
91
|
+
MonitoringInterval?: number;
|
|
92
|
+
Endpoint?: Endpoint;
|
|
177
93
|
/**
|
|
178
|
-
*
|
|
94
|
+
* The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
|
|
179
95
|
* Valid for: Aurora DB clusters only
|
|
180
96
|
*/
|
|
181
|
-
|
|
97
|
+
ReplicationSourceIdentifier?: string;
|
|
182
98
|
/**
|
|
183
99
|
* The name of the database engine to be used for this DB cluster.
|
|
184
100
|
* Valid Values:
|
|
@@ -191,27 +107,12 @@ export interface _AWS_RDS_DBCLUSTER {
|
|
|
191
107
|
*/
|
|
192
108
|
Engine?: string;
|
|
193
109
|
/**
|
|
194
|
-
*
|
|
195
|
-
* 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.
|
|
196
|
-
* 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:
|
|
197
|
-
* + 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*
|
|
198
|
-
* + Amazon RDS - [Using Amazon RDS Extended Support](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html) in the *Amazon RDS User Guide*
|
|
199
|
-
*
|
|
110
|
+
* Tags to assign to the DB cluster.
|
|
200
111
|
* Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
201
|
-
* Valid Values: ``open-source-rds-extended-support | open-source-rds-extended-support-disabled``
|
|
202
|
-
* Default: ``open-source-rds-extended-support``
|
|
203
|
-
*/
|
|
204
|
-
EngineLifecycleSupport?: string;
|
|
205
|
-
/**
|
|
206
|
-
* The DB engine mode of the DB cluster, either ``provisioned`` or ``serverless``.
|
|
207
|
-
* The ``serverless`` engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the ``provisioned`` engine mode.
|
|
208
|
-
* For information about limitations and requirements for Serverless DB clusters, see the following sections in the *Amazon Aurora User Guide*:
|
|
209
|
-
* + [Limitations of Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations)
|
|
210
|
-
* + [Requirements for Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html)
|
|
211
112
|
*
|
|
212
|
-
*
|
|
113
|
+
* @maxItems 50
|
|
213
114
|
*/
|
|
214
|
-
|
|
115
|
+
Tags?: Tag[];
|
|
215
116
|
/**
|
|
216
117
|
* The version number of the database engine to use.
|
|
217
118
|
* 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:
|
|
@@ -235,22 +136,22 @@ export interface _AWS_RDS_DBCLUSTER {
|
|
|
235
136
|
*/
|
|
236
137
|
EngineVersion?: string;
|
|
237
138
|
/**
|
|
238
|
-
*
|
|
239
|
-
* For
|
|
240
|
-
* Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
241
|
-
* Constraints:
|
|
242
|
-
* + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified.
|
|
243
|
-
*/
|
|
244
|
-
ManageMasterUserPassword?: boolean;
|
|
245
|
-
/**
|
|
246
|
-
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
|
|
247
|
-
* 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*.
|
|
139
|
+
* The storage type to associate with the DB cluster.
|
|
140
|
+
* 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).
|
|
248
141
|
* This setting is required to create a Multi-AZ DB cluster.
|
|
249
|
-
*
|
|
250
|
-
*
|
|
251
|
-
*
|
|
142
|
+
* When specified for a Multi-AZ DB cluster, a value for the ``Iops`` parameter is required.
|
|
143
|
+
* Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
144
|
+
* Valid Values:
|
|
145
|
+
* + Aurora DB clusters - ``aurora | aurora-iopt1``
|
|
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``.
|
|
252
153
|
*/
|
|
253
|
-
|
|
154
|
+
StorageType?: string;
|
|
254
155
|
/**
|
|
255
156
|
* 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``.
|
|
256
157
|
* If you specify the ``SnapshotIdentifier`` property, the ``StorageEncrypted`` property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified ``KmsKeyId`` property is used.
|
|
@@ -258,50 +159,75 @@ export interface _AWS_RDS_DBCLUSTER {
|
|
|
258
159
|
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
259
160
|
*/
|
|
260
161
|
KmsKeyId?: string;
|
|
162
|
+
ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfiguration;
|
|
261
163
|
/**
|
|
262
|
-
* The
|
|
263
|
-
*
|
|
264
|
-
*
|
|
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.
|
|
265
173
|
*/
|
|
266
|
-
|
|
174
|
+
PerformanceInsightsRetentionPeriod?: number;
|
|
267
175
|
/**
|
|
268
|
-
* The
|
|
269
|
-
*
|
|
270
|
-
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
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
|
|
271
178
|
*/
|
|
272
|
-
|
|
273
|
-
MasterUserSecret?: MasterUserSecret;
|
|
179
|
+
DatabaseName?: string;
|
|
274
180
|
/**
|
|
275
|
-
*
|
|
276
|
-
*
|
|
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.
|
|
277
188
|
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
278
|
-
* Valid Values: ``0 | 1 | 5 | 10 | 15 | 30 | 60``
|
|
279
|
-
* Default: ``0``
|
|
280
189
|
*/
|
|
281
|
-
|
|
190
|
+
AutoMinorVersionUpgrade?: boolean;
|
|
282
191
|
/**
|
|
283
|
-
*
|
|
284
|
-
* If
|
|
192
|
+
* A DB subnet group that you want to associate with this DB cluster.
|
|
193
|
+
* 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.
|
|
194
|
+
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
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.
|
|
285
204
|
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
205
|
+
* This setting is required to create a Multi-AZ DB cluster.
|
|
286
206
|
*/
|
|
287
|
-
|
|
207
|
+
AllocatedStorage?: number;
|
|
288
208
|
/**
|
|
289
|
-
* The
|
|
290
|
-
*
|
|
291
|
-
*
|
|
292
|
-
|
|
209
|
+
* The master password for the DB instance.
|
|
210
|
+
* 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.
|
|
211
|
+
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
212
|
+
*/
|
|
213
|
+
MasterUserPassword?: string;
|
|
214
|
+
MasterUserSecret?: MasterUserSecret;
|
|
215
|
+
/**
|
|
216
|
+
* When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.
|
|
217
|
+
* Constraints:
|
|
218
|
+
* + Must match the identifier of an existing DBCluster.
|
|
293
219
|
*
|
|
294
|
-
*
|
|
295
|
-
* 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.*
|
|
296
|
-
* Valid for: Aurora DB clusters only
|
|
220
|
+
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
297
221
|
*/
|
|
298
|
-
|
|
222
|
+
SourceDBClusterIdentifier?: string;
|
|
299
223
|
/**
|
|
300
|
-
*
|
|
301
|
-
*
|
|
302
|
-
*
|
|
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
|
|
303
227
|
*/
|
|
304
|
-
|
|
228
|
+
MasterUsername?: string;
|
|
229
|
+
ScalingConfiguration?: ScalingConfiguration;
|
|
230
|
+
ReadEndpoint?: ReadEndpoint;
|
|
305
231
|
/**
|
|
306
232
|
* The AWS KMS key identifier for encryption of Performance Insights data.
|
|
307
233
|
* The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
@@ -310,30 +236,94 @@ export interface _AWS_RDS_DBCLUSTER {
|
|
|
310
236
|
*/
|
|
311
237
|
PerformanceInsightsKmsKeyId?: string;
|
|
312
238
|
/**
|
|
313
|
-
*
|
|
239
|
+
* Specifies whether the DB cluster is publicly accessible.
|
|
240
|
+
* 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.
|
|
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.
|
|
314
242
|
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
315
|
-
*
|
|
316
|
-
*
|
|
317
|
-
* +
|
|
318
|
-
* +
|
|
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.
|
|
319
247
|
*
|
|
320
|
-
*
|
|
321
|
-
* If
|
|
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.
|
|
322
251
|
*/
|
|
323
|
-
|
|
252
|
+
PubliclyAccessible?: boolean;
|
|
324
253
|
/**
|
|
325
|
-
*
|
|
326
|
-
*
|
|
327
|
-
*
|
|
328
|
-
*
|
|
329
|
-
|
|
330
|
-
|
|
254
|
+
* Indicates the directory ID of the Active Directory to create the DB cluster.
|
|
255
|
+
* For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.
|
|
256
|
+
* For more information, see [Kerberos authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the *Amazon Aurora User Guide*.
|
|
257
|
+
* Valid for: Aurora DB clusters only
|
|
258
|
+
*/
|
|
259
|
+
Domain?: string;
|
|
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;
|
|
284
|
+
/**
|
|
285
|
+
* 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*.
|
|
286
|
+
* If ``MonitoringInterval`` is set to a value other than ``0``, supply a ``MonitoringRoleArn`` value.
|
|
287
|
+
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
288
|
+
*/
|
|
289
|
+
MonitoringRoleArn?: string;
|
|
290
|
+
/**
|
|
291
|
+
* 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.
|
|
292
|
+
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
293
|
+
*/
|
|
294
|
+
AssociatedRoles?: DBClusterRole[];
|
|
295
|
+
/**
|
|
296
|
+
* Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
|
|
297
|
+
* 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.
|
|
298
|
+
* RDS Data API is supported with the following DB clusters:
|
|
299
|
+
* + Aurora PostgreSQL Serverless v2 and provisioned
|
|
300
|
+
* + Aurora PostgreSQL and Aurora MySQL Serverless v1
|
|
301
|
+
*
|
|
302
|
+
* 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*.
|
|
303
|
+
* Valid for Cluster Type: Aurora DB clusters only
|
|
304
|
+
*/
|
|
305
|
+
EnableHttpEndpoint?: boolean;
|
|
306
|
+
/**
|
|
307
|
+
* The identifier for the DB snapshot or DB cluster snapshot to restore from.
|
|
308
|
+
* 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.
|
|
309
|
+
* 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.
|
|
310
|
+
* 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:
|
|
311
|
+
* + ``GlobalClusterIdentifier``
|
|
312
|
+
* + ``MasterUsername``
|
|
313
|
+
* + ``MasterUserPassword``
|
|
314
|
+
* + ``ReplicationSourceIdentifier``
|
|
315
|
+
* + ``RestoreType``
|
|
316
|
+
* + ``SourceDBClusterIdentifier``
|
|
317
|
+
* + ``SourceRegion``
|
|
318
|
+
* + ``StorageEncrypted`` (for an encrypted snapshot)
|
|
319
|
+
* + ``UseLatestRestorableTime``
|
|
331
320
|
*
|
|
321
|
+
* Constraints:
|
|
322
|
+
* + Must match the identifier of an existing Snapshot.
|
|
332
323
|
*
|
|
333
|
-
*
|
|
334
|
-
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
324
|
+
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
335
325
|
*/
|
|
336
|
-
|
|
326
|
+
SnapshotIdentifier?: string;
|
|
337
327
|
/**
|
|
338
328
|
* 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.*
|
|
339
329
|
* Constraints:
|
|
@@ -346,139 +336,149 @@ export interface _AWS_RDS_DBCLUSTER {
|
|
|
346
336
|
*/
|
|
347
337
|
PreferredBackupWindow?: string;
|
|
348
338
|
/**
|
|
349
|
-
* The
|
|
350
|
-
*
|
|
351
|
-
*
|
|
352
|
-
*
|
|
353
|
-
*
|
|
339
|
+
* The network type of the DB cluster.
|
|
340
|
+
* Valid values:
|
|
341
|
+
* + ``IPV4``
|
|
342
|
+
* + ``DUAL``
|
|
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.
|
|
354
352
|
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
355
353
|
*/
|
|
356
|
-
|
|
354
|
+
VpcSecurityGroupIds?: string[];
|
|
357
355
|
/**
|
|
358
|
-
*
|
|
359
|
-
*
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
*
|
|
364
|
-
*
|
|
365
|
-
*
|
|
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.
|
|
366
372
|
*
|
|
367
|
-
* If ``
|
|
368
|
-
*
|
|
369
|
-
* + If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
|
|
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.
|
|
374
|
+
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
370
375
|
*/
|
|
371
|
-
|
|
376
|
+
RestoreType?: string;
|
|
372
377
|
/**
|
|
373
|
-
*
|
|
378
|
+
* Specifies the name of the IAM role to use when making API calls to the Directory Service.
|
|
374
379
|
* Valid for: Aurora DB clusters only
|
|
375
380
|
*/
|
|
376
|
-
|
|
381
|
+
DomainIAMRoleName?: string;
|
|
377
382
|
/**
|
|
378
|
-
* The
|
|
379
|
-
*
|
|
380
|
-
*
|
|
381
|
-
* +
|
|
382
|
-
* +
|
|
383
|
-
* + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled
|
|
384
|
-
* + Can't be specified if the ``RestoreType`` parameter is ``copy-on-write``
|
|
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*
|
|
385
388
|
*
|
|
386
|
-
*
|
|
387
|
-
*
|
|
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``
|
|
389
392
|
*/
|
|
390
|
-
|
|
393
|
+
EngineLifecycleSupport?: string;
|
|
391
394
|
/**
|
|
392
|
-
* The
|
|
393
|
-
*
|
|
394
|
-
*
|
|
395
|
-
*
|
|
396
|
-
* If you don't specify a ``RestoreType`` value, then the new DB cluster is restored as a full copy of the source DB cluster.
|
|
397
|
-
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
395
|
+
* 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.
|
|
396
|
+
* 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*.
|
|
397
|
+
* This setting is required to create a Multi-AZ DB cluster.
|
|
398
|
+
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
398
399
|
*/
|
|
399
|
-
|
|
400
|
-
ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfiguration;
|
|
401
|
-
ScalingConfiguration?: ScalingConfiguration;
|
|
400
|
+
DBClusterInstanceClass?: string;
|
|
402
401
|
/**
|
|
403
|
-
*
|
|
404
|
-
*
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
*
|
|
410
|
-
*
|
|
411
|
-
*
|
|
412
|
-
*
|
|
413
|
-
*
|
|
414
|
-
* + ``StorageEncrypted`` (for an encrypted snapshot)
|
|
415
|
-
* + ``UseLatestRestorableTime``
|
|
416
|
-
*
|
|
417
|
-
* Constraints:
|
|
418
|
-
* + Must match the identifier of an existing Snapshot.
|
|
419
|
-
*
|
|
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;
|
|
407
|
+
/**
|
|
408
|
+
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
|
409
|
+
* Format: ``ddd:hh24:mi-ddd:hh24:mi``
|
|
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.
|
|
420
413
|
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
421
414
|
*/
|
|
422
|
-
|
|
415
|
+
PreferredMaintenanceWindow?: string;
|
|
423
416
|
/**
|
|
424
|
-
*
|
|
417
|
+
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
|
|
418
|
+
* 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*.
|
|
419
|
+
* This setting is required to create a Multi-AZ DB cluster.
|
|
420
|
+
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
425
421
|
* Constraints:
|
|
426
|
-
* + Must
|
|
427
|
-
*
|
|
428
|
-
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
422
|
+
* + Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
|
|
429
423
|
*/
|
|
430
|
-
|
|
424
|
+
Iops?: number;
|
|
431
425
|
/**
|
|
432
426
|
* The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, ``us-east-1``.
|
|
433
427
|
* Valid for: Aurora DB clusters only
|
|
434
428
|
*/
|
|
435
429
|
SourceRegion?: string;
|
|
436
430
|
/**
|
|
437
|
-
*
|
|
438
|
-
*
|
|
439
|
-
* 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.
|
|
440
|
-
* 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.
|
|
441
|
-
* 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``.
|
|
442
|
-
* 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.
|
|
443
|
-
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
431
|
+
* 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.
|
|
432
|
+
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
444
433
|
*/
|
|
445
|
-
|
|
446
|
-
StorageThroughput?: number;
|
|
434
|
+
UseLatestRestorableTime?: boolean;
|
|
447
435
|
/**
|
|
448
|
-
*
|
|
449
|
-
* For information
|
|
450
|
-
* This setting is required to create a Multi-AZ DB cluster.
|
|
451
|
-
* When specified for a Multi-AZ DB cluster, a value for the ``Iops`` parameter is required.
|
|
436
|
+
* Specifies whether to manage the master user password with AWS Secrets Manager.
|
|
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.*
|
|
452
438
|
* Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
453
|
-
*
|
|
454
|
-
* +
|
|
455
|
-
* + Multi-AZ DB clusters - ``io1 | io2 | gp3``
|
|
456
|
-
*
|
|
457
|
-
* Default:
|
|
458
|
-
* + Aurora DB clusters - ``aurora``
|
|
459
|
-
* + Multi-AZ DB clusters - ``io1``
|
|
460
|
-
*
|
|
461
|
-
* 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``.
|
|
439
|
+
* Constraints:
|
|
440
|
+
* + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified.
|
|
462
441
|
*/
|
|
463
|
-
|
|
442
|
+
ManageMasterUserPassword?: boolean;
|
|
464
443
|
/**
|
|
465
|
-
*
|
|
466
|
-
*
|
|
467
|
-
*
|
|
468
|
-
* @maxItems 50
|
|
444
|
+
* A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
|
|
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.*
|
|
446
|
+
* Valid for: Aurora DB clusters only
|
|
469
447
|
*/
|
|
470
|
-
|
|
448
|
+
EnableIAMDatabaseAuthentication?: boolean;
|
|
471
449
|
/**
|
|
472
|
-
*
|
|
450
|
+
* The name of the DB cluster parameter group to associate with this DB cluster.
|
|
451
|
+
* 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.
|
|
452
|
+
* 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.
|
|
453
|
+
* To list all of the available DB cluster parameter group names, use the following command:
|
|
454
|
+
* ``aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text``
|
|
473
455
|
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
474
456
|
*/
|
|
475
|
-
|
|
457
|
+
DBClusterParameterGroupName?: string;
|
|
476
458
|
/**
|
|
477
|
-
*
|
|
478
|
-
*
|
|
459
|
+
* Specifies whether to turn on Performance Insights for the DB cluster.
|
|
460
|
+
* 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*.
|
|
461
|
+
* Valid for Cluster Type: Multi-AZ DB clusters only
|
|
462
|
+
*/
|
|
463
|
+
PerformanceInsightsEnabled?: boolean;
|
|
464
|
+
/**
|
|
465
|
+
* The number of days for which automated backups are retained.
|
|
466
|
+
* Default: 1
|
|
467
|
+
* Constraints:
|
|
468
|
+
* + Must be a value from 1 to 35
|
|
469
|
+
*
|
|
479
470
|
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
480
471
|
*/
|
|
481
|
-
|
|
472
|
+
BackupRetentionPeriod?: number;
|
|
473
|
+
/**
|
|
474
|
+
* 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*.
|
|
475
|
+
* *Aurora MySQL*
|
|
476
|
+
* Valid values: ``audit``, ``error``, ``general``, ``slowquery``
|
|
477
|
+
* *Aurora PostgreSQL*
|
|
478
|
+
* Valid values: ``postgresql``
|
|
479
|
+
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
480
|
+
*/
|
|
481
|
+
EnableCloudwatchLogsExports?: string[];
|
|
482
482
|
}
|
|
483
483
|
export interface Endpoint {
|
|
484
484
|
/**
|
|
@@ -491,31 +491,35 @@ export interface Endpoint {
|
|
|
491
491
|
Port?: string;
|
|
492
492
|
}
|
|
493
493
|
/**
|
|
494
|
-
*
|
|
495
|
-
*
|
|
496
|
-
* + ``DescribeDBInstances``
|
|
497
|
-
* + ``DeleteDBInstance``
|
|
498
|
-
*
|
|
499
|
-
* For the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``.
|
|
494
|
+
* Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
|
|
495
|
+
* 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*.
|
|
500
496
|
*/
|
|
501
|
-
export interface
|
|
497
|
+
export interface Tag {
|
|
502
498
|
/**
|
|
503
|
-
*
|
|
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}_.:/=+\\-@]*)$").
|
|
504
500
|
*/
|
|
505
|
-
|
|
501
|
+
Value?: string;
|
|
502
|
+
/**
|
|
503
|
+
* 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}_.:/=+\\-@]*)$").
|
|
504
|
+
*/
|
|
505
|
+
Key: string;
|
|
506
506
|
}
|
|
507
507
|
/**
|
|
508
|
-
*
|
|
508
|
+
* The scaling configuration of an Aurora Serverless V2 DB cluster.
|
|
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
511
|
*/
|
|
510
|
-
export interface
|
|
512
|
+
export interface ServerlessV2ScalingConfiguration {
|
|
511
513
|
/**
|
|
512
|
-
* The
|
|
514
|
+
* 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.
|
|
513
515
|
*/
|
|
514
|
-
|
|
516
|
+
MinCapacity?: number;
|
|
515
517
|
/**
|
|
516
|
-
* The
|
|
518
|
+
* 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.
|
|
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
521
|
*/
|
|
518
|
-
|
|
522
|
+
MaxCapacity?: number;
|
|
519
523
|
}
|
|
520
524
|
/**
|
|
521
525
|
* The secret managed by RDS in AWS Secrets Manager for the master user password.
|
|
@@ -531,41 +535,35 @@ export interface MasterUserSecret {
|
|
|
531
535
|
*/
|
|
532
536
|
KmsKeyId?: string;
|
|
533
537
|
}
|
|
534
|
-
/**
|
|
535
|
-
* The scaling configuration of an Aurora Serverless V2 DB cluster.
|
|
536
|
-
* This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, Use the ``ScalingConfiguration`` property.
|
|
537
|
-
* Valid for: Aurora Serverless v2 DB clusters only
|
|
538
|
-
*/
|
|
539
|
-
export interface ServerlessV2ScalingConfiguration {
|
|
540
|
-
/**
|
|
541
|
-
* 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.
|
|
542
|
-
*/
|
|
543
|
-
MinCapacity?: number;
|
|
544
|
-
/**
|
|
545
|
-
* 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.
|
|
546
|
-
* 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*.
|
|
547
|
-
* 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.
|
|
548
|
-
*/
|
|
549
|
-
MaxCapacity?: number;
|
|
550
|
-
}
|
|
551
538
|
/**
|
|
552
539
|
* The scaling configuration of an Aurora Serverless v1 DB cluster.
|
|
553
540
|
* This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ``ServerlessV2ScalingConfiguration`` property.
|
|
554
541
|
* Valid for: Aurora Serverless v1 DB clusters only
|
|
555
542
|
*/
|
|
556
543
|
export interface ScalingConfiguration {
|
|
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;
|
|
552
|
+
/**
|
|
553
|
+
* 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.
|
|
554
|
+
* Specify a value between 60 and 600 seconds.
|
|
555
|
+
*/
|
|
556
|
+
SecondsBeforeTimeout?: number;
|
|
557
|
+
/**
|
|
558
|
+
* The time, in seconds, before an Aurora DB cluster in ``serverless`` mode is paused.
|
|
559
|
+
* Specify a value between 300 and 86,400 seconds.
|
|
560
|
+
*/
|
|
561
|
+
SecondsUntilAutoPause?: number;
|
|
557
562
|
/**
|
|
558
563
|
* 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).
|
|
559
564
|
* 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.
|
|
560
565
|
*/
|
|
561
566
|
AutoPause?: boolean;
|
|
562
|
-
/**
|
|
563
|
-
* The maximum capacity for an Aurora DB cluster in ``serverless`` DB engine mode.
|
|
564
|
-
* For Aurora MySQL, valid capacity values are ``1``, ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``128``, and ``256``.
|
|
565
|
-
* For Aurora PostgreSQL, valid capacity values are ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``192``, and ``384``.
|
|
566
|
-
* The maximum capacity must be greater than or equal to the minimum capacity.
|
|
567
|
-
*/
|
|
568
|
-
MaxCapacity?: number;
|
|
569
567
|
/**
|
|
570
568
|
* The minimum capacity for an Aurora DB cluster in ``serverless`` DB engine mode.
|
|
571
569
|
* For Aurora MySQL, valid capacity values are ``1``, ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``128``, and ``256``.
|
|
@@ -574,35 +572,37 @@ export interface ScalingConfiguration {
|
|
|
574
572
|
*/
|
|
575
573
|
MinCapacity?: number;
|
|
576
574
|
/**
|
|
577
|
-
* The
|
|
578
|
-
*
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
/**
|
|
582
|
-
* The time, in seconds, before an Aurora DB cluster in ``serverless`` mode is paused.
|
|
583
|
-
* Specify a value between 300 and 86,400 seconds.
|
|
575
|
+
* The maximum capacity for an Aurora DB cluster in ``serverless`` DB engine mode.
|
|
576
|
+
* For Aurora MySQL, valid capacity values are ``1``, ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``128``, and ``256``.
|
|
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.
|
|
584
579
|
*/
|
|
585
|
-
|
|
580
|
+
MaxCapacity?: number;
|
|
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 {
|
|
586
591
|
/**
|
|
587
|
-
* The
|
|
588
|
-
* ``ForceApplyCapacityChange`` sets the capacity to the specified value as soon as possible.
|
|
589
|
-
* ``RollbackCapacityChange``, the default, ignores the capacity change if a scaling point isn't found in the timeout period.
|
|
590
|
-
* If you specify ``ForceApplyCapacityChange``, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.
|
|
591
|
-
* 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*.
|
|
592
|
+
* The host address of the reader endpoint.
|
|
592
593
|
*/
|
|
593
|
-
|
|
594
|
+
Address?: string;
|
|
594
595
|
}
|
|
595
596
|
/**
|
|
596
|
-
*
|
|
597
|
-
* 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*.
|
|
597
|
+
* Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.
|
|
598
598
|
*/
|
|
599
|
-
export interface
|
|
599
|
+
export interface DBClusterRole {
|
|
600
600
|
/**
|
|
601
|
-
*
|
|
601
|
+
* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
|
|
602
602
|
*/
|
|
603
|
-
|
|
603
|
+
RoleArn: string;
|
|
604
604
|
/**
|
|
605
|
-
*
|
|
605
|
+
* 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*.
|
|
606
606
|
*/
|
|
607
|
-
|
|
607
|
+
FeatureName?: string;
|
|
608
608
|
}
|