aws-cdk-lib 2.150.0__py3-none-any.whl → 2.151.1__py3-none-any.whl
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.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/__init__.py +4 -10
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.150.0.jsii.tgz → aws-cdk-lib@2.151.1.jsii.tgz} +0 -0
- aws_cdk/aws_apigatewayv2/__init__.py +94 -21
- aws_cdk/aws_appconfig/__init__.py +3 -3
- aws_cdk/aws_backup/__init__.py +3 -3
- aws_cdk/aws_bedrock/__init__.py +28 -20
- aws_cdk/aws_cleanrooms/__init__.py +5 -5
- aws_cdk/aws_cloudformation/__init__.py +2 -2
- aws_cdk/aws_cloudfront/__init__.py +102 -32
- aws_cdk/aws_cloudtrail/__init__.py +6 -2
- aws_cdk/aws_ec2/__init__.py +181 -3
- aws_cdk/aws_ecs/__init__.py +5 -1
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +104 -9
- aws_cdk/aws_entityresolution/__init__.py +27 -21
- aws_cdk/aws_events/__init__.py +83 -16
- aws_cdk/aws_iam/__init__.py +11 -24
- aws_cdk/aws_iotsitewise/__init__.py +8 -8
- aws_cdk/aws_lambda/__init__.py +2 -0
- aws_cdk/aws_mwaa/__init__.py +3 -3
- aws_cdk/aws_pipes/__init__.py +2 -2
- aws_cdk/aws_rds/__init__.py +237 -197
- aws_cdk/aws_s3/__init__.py +8 -2
- aws_cdk/aws_ses/__init__.py +3 -3
- aws_cdk/aws_sns/__init__.py +5 -2
- aws_cdk/aws_stepfunctions/__init__.py +5 -2
- aws_cdk/aws_stepfunctions_tasks/__init__.py +17 -0
- aws_cdk/aws_synthetics/__init__.py +159 -21
- {aws_cdk_lib-2.150.0.dist-info → aws_cdk_lib-2.151.1.dist-info}/METADATA +8 -8
- {aws_cdk_lib-2.150.0.dist-info → aws_cdk_lib-2.151.1.dist-info}/RECORD +34 -34
- {aws_cdk_lib-2.150.0.dist-info → aws_cdk_lib-2.151.1.dist-info}/WHEEL +1 -1
- {aws_cdk_lib-2.150.0.dist-info → aws_cdk_lib-2.151.1.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.150.0.dist-info → aws_cdk_lib-2.151.1.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.150.0.dist-info → aws_cdk_lib-2.151.1.dist-info}/top_level.txt +0 -0
aws_cdk/aws_rds/__init__.py
CHANGED
|
@@ -1150,6 +1150,7 @@ Data in S3 buckets can be imported to and exported from certain database engines
|
|
|
1150
1150
|
functionality, set the `s3ImportBuckets` and `s3ExportBuckets` properties for import and export respectively. When
|
|
1151
1151
|
configured, the CDK automatically creates and configures IAM roles as required.
|
|
1152
1152
|
Additionally, the `s3ImportRole` and `s3ExportRole` properties can be used to set this role directly.
|
|
1153
|
+
Note: To use `s3ImportRole` and `s3ExportRole` with Aurora PostgreSQL, you must also enable the S3 import and export features when you create the DatabaseClusterEngine.
|
|
1153
1154
|
|
|
1154
1155
|
You can read more about loading data to (or from) S3 here:
|
|
1155
1156
|
|
|
@@ -4452,7 +4453,7 @@ class CfnDBCluster(
|
|
|
4452
4453
|
We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB cluster. To preserve your data, perform the following procedure:
|
|
4453
4454
|
|
|
4454
4455
|
- Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.
|
|
4455
|
-
- Create a snapshot of the DB cluster. For more information, see `Creating a DB
|
|
4456
|
+
- Create a snapshot of the DB cluster. For more information, see `Creating a DB cluster snapshot <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CreateSnapshotCluster.html>`_ .
|
|
4456
4457
|
- If you want to restore your DB cluster using a DB cluster snapshot, modify the updated template with your DB cluster changes and add the ``SnapshotIdentifier`` property with the ID of the DB cluster snapshot that you want to use.
|
|
4457
4458
|
|
|
4458
4459
|
After you restore a DB cluster with a ``SnapshotIdentifier`` property, you must specify the same ``SnapshotIdentifier`` property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the DB cluster snapshot again, and the data in the database is not changed. However, if you don't specify the ``SnapshotIdentifier`` property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified ``SnapshotIdentifier`` property, and the original DB cluster is deleted.
|
|
@@ -4627,7 +4628,7 @@ class CfnDBCluster(
|
|
|
4627
4628
|
:param associated_roles: 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. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
4628
4629
|
:param auto_minor_version_upgrade: Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically. Valid for Cluster Type: Multi-AZ DB clusters only
|
|
4629
4630
|
:param availability_zones: 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* . Valid for: Aurora DB clusters only
|
|
4630
|
-
:param backtrack_window: The target backtrack window, in seconds. To disable backtracking, set this value to 0.
|
|
4631
|
+
:param backtrack_window: The target backtrack window, in seconds. To disable backtracking, set this value to ``0`` . Valid for Cluster Type: Aurora MySQL DB clusters only Default: ``0`` Constraints: - If specified, this value must be set to a number from 0 to 259,200 (72 hours). Default: - 0
|
|
4631
4632
|
:param backup_retention_period: The number of days for which automated backups are retained. Default: 1 Constraints: - Must be a value from 1 to 35 Valid for: Aurora DB clusters and Multi-AZ DB clusters Default: - 1
|
|
4632
4633
|
:param copy_tags_to_snapshot: 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. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
4633
4634
|
:param database_name: 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* . Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
@@ -4676,7 +4677,7 @@ class CfnDBCluster(
|
|
|
4676
4677
|
:param source_region: The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, ``us-east-1`` . Valid for: Aurora DB clusters only
|
|
4677
4678
|
:param storage_encrypted: Indicates whether the DB cluster is encrypted. If you specify the ``KmsKeyId`` property, then you must enable encryption. 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. 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. 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`` . .. epigraph:: 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. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
4678
4679
|
:param storage_type: The storage type to associate with the DB cluster. 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>`_ . This setting is required to create a Multi-AZ DB cluster. When specified for a Multi-AZ DB cluster, a value for the ``Iops`` parameter is required. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: - Aurora DB clusters - ``aurora | aurora-iopt1`` - Multi-AZ DB clusters - ``io1 | io2 | gp3`` Default: - Aurora DB clusters - ``aurora`` - Multi-AZ DB clusters - ``io1`` .. epigraph:: 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`` .
|
|
4679
|
-
:param tags:
|
|
4680
|
+
:param tags: Tags to assign to the DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
4680
4681
|
:param use_latest_restorable_time: 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. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
4681
4682
|
:param vpc_security_group_ids: A list of EC2 VPC security groups to associate with this DB cluster. If you plan to update the resource, don't specify VPC security groups in a shared VPC. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
4682
4683
|
'''
|
|
@@ -4947,7 +4948,7 @@ class CfnDBCluster(
|
|
|
4947
4948
|
def backtrack_window(self) -> typing.Optional[jsii.Number]:
|
|
4948
4949
|
'''The target backtrack window, in seconds.
|
|
4949
4950
|
|
|
4950
|
-
To disable backtracking, set this value to 0.
|
|
4951
|
+
To disable backtracking, set this value to ``0`` .
|
|
4951
4952
|
'''
|
|
4952
4953
|
return typing.cast(typing.Optional[jsii.Number], jsii.get(self, "backtrackWindow"))
|
|
4953
4954
|
|
|
@@ -5688,7 +5689,7 @@ class CfnDBCluster(
|
|
|
5688
5689
|
@builtins.property
|
|
5689
5690
|
@jsii.member(jsii_name="tagsRaw")
|
|
5690
5691
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
5691
|
-
'''
|
|
5692
|
+
'''Tags to assign to the DB cluster.'''
|
|
5692
5693
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
5693
5694
|
|
|
5694
5695
|
@tags_raw.setter
|
|
@@ -6285,7 +6286,7 @@ class CfnDBClusterParameterGroup(
|
|
|
6285
6286
|
|
|
6286
6287
|
If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.
|
|
6287
6288
|
|
|
6288
|
-
If you apply a change to parameter group associated with a stopped DB cluster, then the
|
|
6289
|
+
If you apply a change to parameter group associated with a stopped DB cluster, then the updated stack waits until the DB cluster is started.
|
|
6289
6290
|
|
|
6290
6291
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html
|
|
6291
6292
|
:cloudformationResource: AWS::RDS::DBClusterParameterGroup
|
|
@@ -6327,11 +6328,11 @@ class CfnDBClusterParameterGroup(
|
|
|
6327
6328
|
'''
|
|
6328
6329
|
:param scope: Scope in which this resource is defined.
|
|
6329
6330
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
6330
|
-
:param description:
|
|
6331
|
-
:param family: The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a
|
|
6331
|
+
:param description: The description for the DB cluster parameter group.
|
|
6332
|
+
:param family: The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. *Aurora MySQL* Example: ``aurora-mysql5.7`` , ``aurora-mysql8.0`` *Aurora PostgreSQL* Example: ``aurora-postgresql14`` *RDS for MySQL* Example: ``mysql8.0`` *RDS for PostgreSQL* Example: ``postgres13`` To list all of the available parameter group families for a DB engine, use the following command: ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>`` For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command: ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql`` .. epigraph:: The output contains duplicates. The following are the valid DB engine values: - ``aurora-mysql`` - ``aurora-postgresql`` - ``mysql`` - ``postgres``
|
|
6332
6333
|
:param parameters: Provides a list of parameters for the DB cluster parameter group.
|
|
6333
|
-
:param db_cluster_parameter_group_name: The name of the DB cluster parameter group. Constraints: - Must not match the name of an existing DB cluster parameter group.
|
|
6334
|
-
:param tags:
|
|
6334
|
+
:param db_cluster_parameter_group_name: The name of the DB cluster parameter group. Constraints: - Must not match the name of an existing DB cluster parameter group. .. epigraph:: This value is stored as a lowercase string.
|
|
6335
|
+
:param tags: Tags to assign to the DB cluster parameter group.
|
|
6335
6336
|
'''
|
|
6336
6337
|
if __debug__:
|
|
6337
6338
|
type_hints = typing.get_type_hints(_typecheckingstub__5d66d67784eaba0a01483098e06526f4c025b7ff96275fcc6e41e7d979aa520c)
|
|
@@ -6391,7 +6392,7 @@ class CfnDBClusterParameterGroup(
|
|
|
6391
6392
|
@builtins.property
|
|
6392
6393
|
@jsii.member(jsii_name="description")
|
|
6393
6394
|
def description(self) -> builtins.str:
|
|
6394
|
-
'''
|
|
6395
|
+
'''The description for the DB cluster parameter group.'''
|
|
6395
6396
|
return typing.cast(builtins.str, jsii.get(self, "description"))
|
|
6396
6397
|
|
|
6397
6398
|
@description.setter
|
|
@@ -6446,7 +6447,7 @@ class CfnDBClusterParameterGroup(
|
|
|
6446
6447
|
@builtins.property
|
|
6447
6448
|
@jsii.member(jsii_name="tagsRaw")
|
|
6448
6449
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
6449
|
-
'''
|
|
6450
|
+
'''Tags to assign to the DB cluster parameter group.'''
|
|
6450
6451
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
6451
6452
|
|
|
6452
6453
|
@tags_raw.setter
|
|
@@ -6480,11 +6481,11 @@ class CfnDBClusterParameterGroupProps:
|
|
|
6480
6481
|
) -> None:
|
|
6481
6482
|
'''Properties for defining a ``CfnDBClusterParameterGroup``.
|
|
6482
6483
|
|
|
6483
|
-
:param description:
|
|
6484
|
-
:param family: The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a
|
|
6484
|
+
:param description: The description for the DB cluster parameter group.
|
|
6485
|
+
:param family: The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. *Aurora MySQL* Example: ``aurora-mysql5.7`` , ``aurora-mysql8.0`` *Aurora PostgreSQL* Example: ``aurora-postgresql14`` *RDS for MySQL* Example: ``mysql8.0`` *RDS for PostgreSQL* Example: ``postgres13`` To list all of the available parameter group families for a DB engine, use the following command: ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>`` For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command: ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql`` .. epigraph:: The output contains duplicates. The following are the valid DB engine values: - ``aurora-mysql`` - ``aurora-postgresql`` - ``mysql`` - ``postgres``
|
|
6485
6486
|
:param parameters: Provides a list of parameters for the DB cluster parameter group.
|
|
6486
|
-
:param db_cluster_parameter_group_name: The name of the DB cluster parameter group. Constraints: - Must not match the name of an existing DB cluster parameter group.
|
|
6487
|
-
:param tags:
|
|
6487
|
+
:param db_cluster_parameter_group_name: The name of the DB cluster parameter group. Constraints: - Must not match the name of an existing DB cluster parameter group. .. epigraph:: This value is stored as a lowercase string.
|
|
6488
|
+
:param tags: Tags to assign to the DB cluster parameter group.
|
|
6488
6489
|
|
|
6489
6490
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html
|
|
6490
6491
|
:exampleMetadata: fixture=_generated
|
|
@@ -6529,7 +6530,7 @@ class CfnDBClusterParameterGroupProps:
|
|
|
6529
6530
|
|
|
6530
6531
|
@builtins.property
|
|
6531
6532
|
def description(self) -> builtins.str:
|
|
6532
|
-
'''
|
|
6533
|
+
'''The description for the DB cluster parameter group.
|
|
6533
6534
|
|
|
6534
6535
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-description
|
|
6535
6536
|
'''
|
|
@@ -6541,18 +6542,41 @@ class CfnDBClusterParameterGroupProps:
|
|
|
6541
6542
|
def family(self) -> builtins.str:
|
|
6542
6543
|
'''The DB cluster parameter group family name.
|
|
6543
6544
|
|
|
6544
|
-
A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a
|
|
6545
|
-
.. epigraph::
|
|
6545
|
+
A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
|
|
6546
6546
|
|
|
6547
|
-
|
|
6547
|
+
*Aurora MySQL*
|
|
6548
6548
|
|
|
6549
|
-
|
|
6549
|
+
Example: ``aurora-mysql5.7`` , ``aurora-mysql8.0``
|
|
6550
6550
|
|
|
6551
|
-
|
|
6551
|
+
*Aurora PostgreSQL*
|
|
6552
6552
|
|
|
6553
|
-
|
|
6553
|
+
Example: ``aurora-postgresql14``
|
|
6554
6554
|
|
|
6555
|
-
|
|
6555
|
+
*RDS for MySQL*
|
|
6556
|
+
|
|
6557
|
+
Example: ``mysql8.0``
|
|
6558
|
+
|
|
6559
|
+
*RDS for PostgreSQL*
|
|
6560
|
+
|
|
6561
|
+
Example: ``postgres13``
|
|
6562
|
+
|
|
6563
|
+
To list all of the available parameter group families for a DB engine, use the following command:
|
|
6564
|
+
|
|
6565
|
+
``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>``
|
|
6566
|
+
|
|
6567
|
+
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
|
|
6568
|
+
|
|
6569
|
+
``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql``
|
|
6570
|
+
.. epigraph::
|
|
6571
|
+
|
|
6572
|
+
The output contains duplicates.
|
|
6573
|
+
|
|
6574
|
+
The following are the valid DB engine values:
|
|
6575
|
+
|
|
6576
|
+
- ``aurora-mysql``
|
|
6577
|
+
- ``aurora-postgresql``
|
|
6578
|
+
- ``mysql``
|
|
6579
|
+
- ``postgres``
|
|
6556
6580
|
|
|
6557
6581
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-family
|
|
6558
6582
|
'''
|
|
@@ -6578,7 +6602,6 @@ class CfnDBClusterParameterGroupProps:
|
|
|
6578
6602
|
|
|
6579
6603
|
- Must not match the name of an existing DB cluster parameter group.
|
|
6580
6604
|
|
|
6581
|
-
If you don't specify a value for ``DBClusterParameterGroupName`` property, a name is automatically created for the DB cluster parameter group.
|
|
6582
6605
|
.. epigraph::
|
|
6583
6606
|
|
|
6584
6607
|
This value is stored as a lowercase string.
|
|
@@ -6590,7 +6613,7 @@ class CfnDBClusterParameterGroupProps:
|
|
|
6590
6613
|
|
|
6591
6614
|
@builtins.property
|
|
6592
6615
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
6593
|
-
'''
|
|
6616
|
+
'''Tags to assign to the DB cluster parameter group.
|
|
6594
6617
|
|
|
6595
6618
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-tags
|
|
6596
6619
|
'''
|
|
@@ -6738,7 +6761,7 @@ class CfnDBClusterProps:
|
|
|
6738
6761
|
:param associated_roles: 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. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
6739
6762
|
:param auto_minor_version_upgrade: Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically. Valid for Cluster Type: Multi-AZ DB clusters only
|
|
6740
6763
|
:param availability_zones: 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* . Valid for: Aurora DB clusters only
|
|
6741
|
-
:param backtrack_window: The target backtrack window, in seconds. To disable backtracking, set this value to 0.
|
|
6764
|
+
:param backtrack_window: The target backtrack window, in seconds. To disable backtracking, set this value to ``0`` . Valid for Cluster Type: Aurora MySQL DB clusters only Default: ``0`` Constraints: - If specified, this value must be set to a number from 0 to 259,200 (72 hours). Default: - 0
|
|
6742
6765
|
:param backup_retention_period: The number of days for which automated backups are retained. Default: 1 Constraints: - Must be a value from 1 to 35 Valid for: Aurora DB clusters and Multi-AZ DB clusters Default: - 1
|
|
6743
6766
|
:param copy_tags_to_snapshot: 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. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
6744
6767
|
:param database_name: 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* . Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
@@ -6787,7 +6810,7 @@ class CfnDBClusterProps:
|
|
|
6787
6810
|
:param source_region: The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, ``us-east-1`` . Valid for: Aurora DB clusters only
|
|
6788
6811
|
:param storage_encrypted: Indicates whether the DB cluster is encrypted. If you specify the ``KmsKeyId`` property, then you must enable encryption. 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. 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. 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`` . .. epigraph:: 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. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
6789
6812
|
:param storage_type: The storage type to associate with the DB cluster. 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>`_ . This setting is required to create a Multi-AZ DB cluster. When specified for a Multi-AZ DB cluster, a value for the ``Iops`` parameter is required. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: - Aurora DB clusters - ``aurora | aurora-iopt1`` - Multi-AZ DB clusters - ``io1 | io2 | gp3`` Default: - Aurora DB clusters - ``aurora`` - Multi-AZ DB clusters - ``io1`` .. epigraph:: 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`` .
|
|
6790
|
-
:param tags:
|
|
6813
|
+
:param tags: Tags to assign to the DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
6791
6814
|
:param use_latest_restorable_time: 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. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
6792
6815
|
:param vpc_security_group_ids: A list of EC2 VPC security groups to associate with this DB cluster. If you plan to update the resource, don't specify VPC security groups in a shared VPC. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
6793
6816
|
|
|
@@ -7110,20 +7133,16 @@ class CfnDBClusterProps:
|
|
|
7110
7133
|
|
|
7111
7134
|
@builtins.property
|
|
7112
7135
|
def backtrack_window(self) -> typing.Optional[jsii.Number]:
|
|
7113
|
-
'''The target backtrack window, in seconds. To disable backtracking, set this value to 0.
|
|
7114
|
-
|
|
7115
|
-
.. epigraph::
|
|
7136
|
+
'''The target backtrack window, in seconds. To disable backtracking, set this value to ``0`` .
|
|
7116
7137
|
|
|
7117
|
-
|
|
7138
|
+
Valid for Cluster Type: Aurora MySQL DB clusters only
|
|
7118
7139
|
|
|
7119
|
-
Default: 0
|
|
7140
|
+
Default: ``0``
|
|
7120
7141
|
|
|
7121
7142
|
Constraints:
|
|
7122
7143
|
|
|
7123
7144
|
- If specified, this value must be set to a number from 0 to 259,200 (72 hours).
|
|
7124
7145
|
|
|
7125
|
-
Valid for: Aurora MySQL DB clusters only
|
|
7126
|
-
|
|
7127
7146
|
:default: - 0
|
|
7128
7147
|
|
|
7129
7148
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backtrackwindow
|
|
@@ -8031,9 +8050,9 @@ class CfnDBClusterProps:
|
|
|
8031
8050
|
|
|
8032
8051
|
@builtins.property
|
|
8033
8052
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
8034
|
-
'''
|
|
8053
|
+
'''Tags to assign to the DB cluster.
|
|
8035
8054
|
|
|
8036
|
-
Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
8055
|
+
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
8037
8056
|
|
|
8038
8057
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-tags
|
|
8039
8058
|
'''
|
|
@@ -8337,18 +8356,18 @@ class CfnDBInstance(
|
|
|
8337
8356
|
:param character_set_name: For supported engines, indicates that the DB instance should be associated with the specified character set. *Amazon Aurora* Not applicable. The character set is managed by the DB cluster. For more information, see `AWS::RDS::DBCluster <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html>`_ .
|
|
8338
8357
|
:param copy_tags_to_snapshot: Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
|
|
8339
8358
|
:param custom_iam_instance_profile: The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints: - The profile must exist in your account. - The profile must have an IAM role that Amazon EC2 has permissions to assume. - The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom`` . For the list of permissions required for the IAM role, see `Configure IAM and your VPC <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc>`_ in the *Amazon RDS User Guide* .
|
|
8340
|
-
:param db_cluster_identifier: The identifier of the DB cluster that
|
|
8359
|
+
:param db_cluster_identifier: The identifier of the DB cluster that this DB instance will belong to. This setting doesn't apply to RDS Custom DB instances.
|
|
8341
8360
|
:param db_cluster_snapshot_identifier: The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see `Multi-AZ DB cluster deployments <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html>`_ in the *Amazon RDS User Guide* . Constraints: - Must match the identifier of an existing Multi-AZ DB cluster snapshot. - Can't be specified when ``DBSnapshotIdentifier`` is specified. - Must be specified when ``DBSnapshotIdentifier`` isn't specified. - If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot. - Can't be the identifier of an Aurora DB cluster snapshot.
|
|
8342
8361
|
:param db_instance_class: The compute and memory capacity of the DB instance, for example ``db.m5.large`` . Not all DB instance classes are available in all AWS Regions , or for all database engines. For the full list of DB instance classes, and availability for your engine, see `DB instance classes <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html>`_ in the *Amazon RDS User Guide* or `Aurora DB instance classes <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html>`_ in the *Amazon Aurora User Guide* .
|
|
8343
8362
|
:param db_instance_identifier: A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see `Name Type <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html>`_ . For information about constraints that apply to DB instance identifiers, see `Naming constraints in Amazon RDS <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints>`_ in the *Amazon RDS User Guide* . .. epigraph:: If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
|
|
8344
8363
|
:param db_name: The meaning of this parameter differs according to the database engine you use. .. epigraph:: If you specify the ``[DBSnapshotIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier)`` property, this property only applies to RDS for Oracle. *Amazon Aurora* Not applicable. The database name is managed by the DB cluster. *Db2* The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: - Must contain 1 to 64 letters or numbers. - Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). - Can't be a word reserved by the specified database engine. *MySQL* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: - Must contain 1 to 64 letters or numbers. - Can't be a word reserved by the specified database engine *MariaDB* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: - Must contain 1 to 64 letters or numbers. - Can't be a word reserved by the specified database engine *PostgreSQL* The name of the database to create when the DB instance is created. If this parameter is not specified, the default ``postgres`` database is created in the DB instance. Constraints: - Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). - Must contain 1 to 63 characters. - Can't be a word reserved by the specified database engine *Oracle* The Oracle System ID (SID) of the created DB instance. If you specify ``null`` , the default value ``ORCL`` is used. You can't specify the string NULL, or any other reserved word, for ``DBName`` . Default: ``ORCL`` Constraints: - Can't be longer than 8 characters *SQL Server* Not applicable. Must be null.
|
|
8345
8364
|
:param db_parameter_group_name: The name of an existing DB parameter group or a reference to an `AWS::RDS::DBParameterGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html>`_ resource created in the template. To list all of the available DB parameter group names, use the following command: ``aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text`` .. epigraph:: If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used.
|
|
8346
8365
|
:param db_security_groups: A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. .. epigraph:: If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: - ``AllocatedStorage`` - ``AutoMinorVersionUpgrade`` - ``AvailabilityZone`` - ``BackupRetentionPeriod`` - ``CharacterSetName`` - ``DBInstanceClass`` - ``DBName`` - ``DBParameterGroupName`` - ``DBSecurityGroups`` - ``DBSubnetGroupName`` - ``Engine`` - ``EngineVersion`` - ``Iops`` - ``LicenseModel`` - ``MasterUsername`` - ``MasterUserPassword`` - ``MultiAZ`` - ``OptionGroupName`` - ``PreferredBackupWindow`` - ``PreferredMaintenanceWindow`` All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as ``StorageType`` , ``StorageEncrypted`` , or ``KmsKeyId`` . If you're already using the ``DBSecurityGroups`` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.
|
|
8347
|
-
:param db_snapshot_identifier: The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazon RDS API Reference* . After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted. If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: - ``CharacterSetName`` - ``DBClusterIdentifier`` - ``DBName`` - ``DeleteAutomatedBackups`` - ``
|
|
8348
|
-
:param db_subnet_group_name: A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see `
|
|
8366
|
+
:param db_snapshot_identifier: The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazon RDS API Reference* . After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted. If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: - ``CharacterSetName`` - ``DBClusterIdentifier`` - ``DBName`` - ``DeleteAutomatedBackups`` - ``KmsKeyId`` - ``MasterUsername`` - ``MasterUserPassword`` - ``PerformanceInsightsKMSKeyId`` - ``PerformanceInsightsRetentionPeriod`` - ``PromotionTier`` - ``SourceDBInstanceIdentifier`` - ``SourceRegion`` - ``StorageEncrypted`` (for an encrypted snapshot) - ``Timezone`` *Amazon Aurora* Not applicable. Snapshot restore is managed by the DB cluster.
|
|
8367
|
+
:param db_subnet_group_name: A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see `Amazon VPC and Amazon RDS <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html>`_ in the *Amazon RDS User Guide* . This setting doesn't apply to Amazon Aurora DB instances. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
|
|
8349
8368
|
:param dedicated_log_volume: Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
|
|
8350
8369
|
:param delete_automated_backups: A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. *Amazon Aurora* Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
|
|
8351
|
-
:param deletion_protection:
|
|
8370
|
+
:param deletion_protection: Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see `Deleting a DB Instance <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html>`_ . This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster`` . DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
|
|
8352
8371
|
:param domain: The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see `Kerberos Authentication <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html>`_ in the *Amazon RDS User Guide* .
|
|
8353
8372
|
:param domain_auth_secret_arn: The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456``
|
|
8354
8373
|
:param domain_dns_ips: The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: - Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Example: ``123.124.125.126,234.235.236.237``
|
|
@@ -8370,15 +8389,15 @@ class CfnDBInstance(
|
|
|
8370
8389
|
:param master_user_password: The password for the master user. The password can include any printable ASCII character except "/", """, or "@". *Amazon Aurora* Not applicable. The password for the master user is managed by the DB cluster. *RDS for Db2* Must contain from 8 to 255 characters. *RDS for MariaDB* Constraints: Must contain from 8 to 41 characters. *RDS for Microsoft SQL Server* Constraints: Must contain from 8 to 128 characters. *RDS for MySQL* Constraints: Must contain from 8 to 41 characters. *RDS for Oracle* Constraints: Must contain from 8 to 30 characters. *RDS for PostgreSQL* Constraints: Must contain from 8 to 128 characters.
|
|
8371
8390
|
:param master_user_secret: The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see `Password management with AWS Secrets Manager <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html>`_ in the *Amazon RDS User Guide.*
|
|
8372
8391
|
:param max_allocated_storage: The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see `Managing capacity automatically with Amazon RDS storage autoscaling <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling>`_ in the *Amazon RDS User Guide* . This setting doesn't apply to the following DB instances: - Amazon Aurora (Storage is managed by the DB cluster.) - RDS Custom
|
|
8373
|
-
:param monitoring_interval: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0
|
|
8392
|
+
:param monitoring_interval: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify ``0`` . If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than ``0`` . This setting doesn't apply to RDS Custom DB instances. Valid Values: ``0 | 1 | 5 | 10 | 15 | 30 | 60`` Default: ``0`` Default: - 0
|
|
8374
8393
|
:param monitoring_role_arn: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, ``arn:aws:iam:123456789012:role/emaccess`` . For information on creating a monitoring role, see `Setting Up and Enabling Enhanced Monitoring <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling>`_ in the *Amazon RDS User Guide* . If ``MonitoringInterval`` is set to a value other than ``0`` , then you must supply a ``MonitoringRoleArn`` value. This setting doesn't apply to RDS Custom DB instances.
|
|
8375
|
-
:param multi_az: Specifies whether the
|
|
8394
|
+
:param multi_az: Specifies whether the DB instance is a Multi-AZ deployment. You can't set the ``AvailabilityZone`` parameter if the DB instance is a Multi-AZ deployment. This setting doesn't apply to the following DB instances: - Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.) - RDS Custom
|
|
8376
8395
|
:param nchar_character_set_name: The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.
|
|
8377
8396
|
:param network_type: The network type of the DB instance. Valid values: - ``IPV4`` - ``DUAL`` The network type is determined by the ``DBSubnetGroup`` specified for the DB instance. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols ( ``DUAL`` ). For more information, see `Working with a DB instance in a VPC <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html>`_ in the *Amazon RDS User Guide.*
|
|
8378
8397
|
:param option_group_name: Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
|
|
8379
8398
|
:param performance_insights_kms_key_id: The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for ``PerformanceInsightsKMSKeyId`` , then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see `EnablePerformanceInsights <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights>`_ .
|
|
8380
8399
|
:param performance_insights_retention_period: The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: - ``7`` - *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) - ``731`` Default: ``7`` days If you specify a retention period that isn't valid, such as ``94`` , Amazon RDS returns an error.
|
|
8381
|
-
:param port: The port number on which the database accepts connections.
|
|
8400
|
+
:param port: The port number on which the database accepts connections. This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster. Valid Values: ``1150-65535`` Default: - RDS for Db2 - ``50000`` - RDS for MariaDB - ``3306`` - RDS for Microsoft SQL Server - ``1433`` - RDS for MySQL - ``3306`` - RDS for Oracle - ``1521`` - RDS for PostgreSQL - ``5432`` Constraints: - For RDS for Microsoft SQL Server, the value can't be ``1234`` , ``1434`` , ``3260`` , ``3343`` , ``3389`` , ``47001`` , or ``49152-49156`` .
|
|
8382
8401
|
:param preferred_backup_window: The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see `Backup Window <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow>`_ in the *Amazon RDS User Guide.* Constraints: - Must be in the format ``hh24:mi-hh24:mi`` . - Must be in Universal Coordinated Time (UTC). - Must not conflict with the preferred maintenance window. - Must be at least 30 minutes. *Amazon Aurora* Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
|
|
8383
8402
|
:param preferred_maintenance_window: The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ``ddd:hh24:mi-ddd:hh24:mi`` 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 Instance Maintenance Window <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow>`_ in the *Amazon RDS User Guide.* .. epigraph:: This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window.
|
|
8384
8403
|
:param processor_features: The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
|
|
@@ -8394,7 +8413,7 @@ class CfnDBInstance(
|
|
|
8394
8413
|
:param storage_encrypted: A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the ``KmsKeyId`` property, then you must enable encryption. If you specify the ``SourceDBInstanceIdentifier`` or ``SourceDbiResourceId`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. If you specify the ``SourceDBInstanceAutomatedBackupsArn`` property, don't specify this property. The value is inherited from the source DB instance automated backup. If you specify ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the snapshot. *Amazon Aurora* Not applicable. The encryption for DB instances is managed by the DB cluster.
|
|
8395
8414
|
:param storage_throughput: Specifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. This setting doesn't apply to RDS Custom or Amazon Aurora.
|
|
8396
8415
|
:param storage_type: The storage type to associate with the DB instance. If you specify ``io1`` , ``io2`` , or ``gp3`` , you must also include a value for the ``Iops`` parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values: ``gp2 | gp3 | io1 | io2 | standard`` Default: ``io1`` , if the ``Iops`` parameter is specified. Otherwise, ``gp2`` .
|
|
8397
|
-
:param tags:
|
|
8416
|
+
:param tags: Tags to assign to the DB instance.
|
|
8398
8417
|
:param tde_credential_arn:
|
|
8399
8418
|
:param tde_credential_password:
|
|
8400
8419
|
:param timezone: The time zone of the DB instance. The time zone parameter is currently supported only by `RDS for Db2 <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone>`_ and `RDS for SQL Server <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone>`_ .
|
|
@@ -8844,7 +8863,7 @@ class CfnDBInstance(
|
|
|
8844
8863
|
@builtins.property
|
|
8845
8864
|
@jsii.member(jsii_name="dbClusterIdentifier")
|
|
8846
8865
|
def db_cluster_identifier(self) -> typing.Optional[builtins.str]:
|
|
8847
|
-
'''The identifier of the DB cluster that
|
|
8866
|
+
'''The identifier of the DB cluster that this DB instance will belong to.'''
|
|
8848
8867
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "dbClusterIdentifier"))
|
|
8849
8868
|
|
|
8850
8869
|
@db_cluster_identifier.setter
|
|
@@ -9005,7 +9024,7 @@ class CfnDBInstance(
|
|
|
9005
9024
|
def deletion_protection(
|
|
9006
9025
|
self,
|
|
9007
9026
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
9008
|
-
'''
|
|
9027
|
+
'''Specifies whether the DB instance has deletion protection enabled.'''
|
|
9009
9028
|
return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], jsii.get(self, "deletionProtection"))
|
|
9010
9029
|
|
|
9011
9030
|
@deletion_protection.setter
|
|
@@ -9355,7 +9374,7 @@ class CfnDBInstance(
|
|
|
9355
9374
|
def multi_az(
|
|
9356
9375
|
self,
|
|
9357
9376
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
9358
|
-
'''Specifies whether the
|
|
9377
|
+
'''Specifies whether the DB instance is a Multi-AZ deployment.'''
|
|
9359
9378
|
return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], jsii.get(self, "multiAz"))
|
|
9360
9379
|
|
|
9361
9380
|
@multi_az.setter
|
|
@@ -9683,7 +9702,7 @@ class CfnDBInstance(
|
|
|
9683
9702
|
@builtins.property
|
|
9684
9703
|
@jsii.member(jsii_name="tagsRaw")
|
|
9685
9704
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
9686
|
-
'''
|
|
9705
|
+
'''Tags to assign to the DB instance.'''
|
|
9687
9706
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
9688
9707
|
|
|
9689
9708
|
@tags_raw.setter
|
|
@@ -10364,18 +10383,18 @@ class CfnDBInstanceProps:
|
|
|
10364
10383
|
:param character_set_name: For supported engines, indicates that the DB instance should be associated with the specified character set. *Amazon Aurora* Not applicable. The character set is managed by the DB cluster. For more information, see `AWS::RDS::DBCluster <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html>`_ .
|
|
10365
10384
|
:param copy_tags_to_snapshot: Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
|
|
10366
10385
|
:param custom_iam_instance_profile: The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints: - The profile must exist in your account. - The profile must have an IAM role that Amazon EC2 has permissions to assume. - The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom`` . For the list of permissions required for the IAM role, see `Configure IAM and your VPC <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc>`_ in the *Amazon RDS User Guide* .
|
|
10367
|
-
:param db_cluster_identifier: The identifier of the DB cluster that
|
|
10386
|
+
:param db_cluster_identifier: The identifier of the DB cluster that this DB instance will belong to. This setting doesn't apply to RDS Custom DB instances.
|
|
10368
10387
|
:param db_cluster_snapshot_identifier: The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see `Multi-AZ DB cluster deployments <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html>`_ in the *Amazon RDS User Guide* . Constraints: - Must match the identifier of an existing Multi-AZ DB cluster snapshot. - Can't be specified when ``DBSnapshotIdentifier`` is specified. - Must be specified when ``DBSnapshotIdentifier`` isn't specified. - If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot. - Can't be the identifier of an Aurora DB cluster snapshot.
|
|
10369
10388
|
:param db_instance_class: The compute and memory capacity of the DB instance, for example ``db.m5.large`` . Not all DB instance classes are available in all AWS Regions , or for all database engines. For the full list of DB instance classes, and availability for your engine, see `DB instance classes <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html>`_ in the *Amazon RDS User Guide* or `Aurora DB instance classes <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html>`_ in the *Amazon Aurora User Guide* .
|
|
10370
10389
|
:param db_instance_identifier: A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see `Name Type <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html>`_ . For information about constraints that apply to DB instance identifiers, see `Naming constraints in Amazon RDS <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints>`_ in the *Amazon RDS User Guide* . .. epigraph:: If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
|
|
10371
10390
|
:param db_name: The meaning of this parameter differs according to the database engine you use. .. epigraph:: If you specify the ``[DBSnapshotIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier)`` property, this property only applies to RDS for Oracle. *Amazon Aurora* Not applicable. The database name is managed by the DB cluster. *Db2* The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: - Must contain 1 to 64 letters or numbers. - Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). - Can't be a word reserved by the specified database engine. *MySQL* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: - Must contain 1 to 64 letters or numbers. - Can't be a word reserved by the specified database engine *MariaDB* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: - Must contain 1 to 64 letters or numbers. - Can't be a word reserved by the specified database engine *PostgreSQL* The name of the database to create when the DB instance is created. If this parameter is not specified, the default ``postgres`` database is created in the DB instance. Constraints: - Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). - Must contain 1 to 63 characters. - Can't be a word reserved by the specified database engine *Oracle* The Oracle System ID (SID) of the created DB instance. If you specify ``null`` , the default value ``ORCL`` is used. You can't specify the string NULL, or any other reserved word, for ``DBName`` . Default: ``ORCL`` Constraints: - Can't be longer than 8 characters *SQL Server* Not applicable. Must be null.
|
|
10372
10391
|
:param db_parameter_group_name: The name of an existing DB parameter group or a reference to an `AWS::RDS::DBParameterGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html>`_ resource created in the template. To list all of the available DB parameter group names, use the following command: ``aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text`` .. epigraph:: If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used.
|
|
10373
10392
|
:param db_security_groups: A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. .. epigraph:: If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: - ``AllocatedStorage`` - ``AutoMinorVersionUpgrade`` - ``AvailabilityZone`` - ``BackupRetentionPeriod`` - ``CharacterSetName`` - ``DBInstanceClass`` - ``DBName`` - ``DBParameterGroupName`` - ``DBSecurityGroups`` - ``DBSubnetGroupName`` - ``Engine`` - ``EngineVersion`` - ``Iops`` - ``LicenseModel`` - ``MasterUsername`` - ``MasterUserPassword`` - ``MultiAZ`` - ``OptionGroupName`` - ``PreferredBackupWindow`` - ``PreferredMaintenanceWindow`` All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as ``StorageType`` , ``StorageEncrypted`` , or ``KmsKeyId`` . If you're already using the ``DBSecurityGroups`` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.
|
|
10374
|
-
:param db_snapshot_identifier: The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazon RDS API Reference* . After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted. If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: - ``CharacterSetName`` - ``DBClusterIdentifier`` - ``DBName`` - ``DeleteAutomatedBackups`` - ``
|
|
10375
|
-
:param db_subnet_group_name: A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see `
|
|
10393
|
+
:param db_snapshot_identifier: The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazon RDS API Reference* . After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted. If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: - ``CharacterSetName`` - ``DBClusterIdentifier`` - ``DBName`` - ``DeleteAutomatedBackups`` - ``KmsKeyId`` - ``MasterUsername`` - ``MasterUserPassword`` - ``PerformanceInsightsKMSKeyId`` - ``PerformanceInsightsRetentionPeriod`` - ``PromotionTier`` - ``SourceDBInstanceIdentifier`` - ``SourceRegion`` - ``StorageEncrypted`` (for an encrypted snapshot) - ``Timezone`` *Amazon Aurora* Not applicable. Snapshot restore is managed by the DB cluster.
|
|
10394
|
+
:param db_subnet_group_name: A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see `Amazon VPC and Amazon RDS <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html>`_ in the *Amazon RDS User Guide* . This setting doesn't apply to Amazon Aurora DB instances. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
|
|
10376
10395
|
:param dedicated_log_volume: Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
|
|
10377
10396
|
:param delete_automated_backups: A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. *Amazon Aurora* Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
|
|
10378
|
-
:param deletion_protection:
|
|
10397
|
+
:param deletion_protection: Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see `Deleting a DB Instance <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html>`_ . This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster`` . DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
|
|
10379
10398
|
:param domain: The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see `Kerberos Authentication <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html>`_ in the *Amazon RDS User Guide* .
|
|
10380
10399
|
:param domain_auth_secret_arn: The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456``
|
|
10381
10400
|
:param domain_dns_ips: The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: - Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Example: ``123.124.125.126,234.235.236.237``
|
|
@@ -10397,15 +10416,15 @@ class CfnDBInstanceProps:
|
|
|
10397
10416
|
:param master_user_password: The password for the master user. The password can include any printable ASCII character except "/", """, or "@". *Amazon Aurora* Not applicable. The password for the master user is managed by the DB cluster. *RDS for Db2* Must contain from 8 to 255 characters. *RDS for MariaDB* Constraints: Must contain from 8 to 41 characters. *RDS for Microsoft SQL Server* Constraints: Must contain from 8 to 128 characters. *RDS for MySQL* Constraints: Must contain from 8 to 41 characters. *RDS for Oracle* Constraints: Must contain from 8 to 30 characters. *RDS for PostgreSQL* Constraints: Must contain from 8 to 128 characters.
|
|
10398
10417
|
:param master_user_secret: The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see `Password management with AWS Secrets Manager <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html>`_ in the *Amazon RDS User Guide.*
|
|
10399
10418
|
:param max_allocated_storage: The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see `Managing capacity automatically with Amazon RDS storage autoscaling <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling>`_ in the *Amazon RDS User Guide* . This setting doesn't apply to the following DB instances: - Amazon Aurora (Storage is managed by the DB cluster.) - RDS Custom
|
|
10400
|
-
:param monitoring_interval: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0
|
|
10419
|
+
:param monitoring_interval: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify ``0`` . If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than ``0`` . This setting doesn't apply to RDS Custom DB instances. Valid Values: ``0 | 1 | 5 | 10 | 15 | 30 | 60`` Default: ``0`` Default: - 0
|
|
10401
10420
|
:param monitoring_role_arn: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, ``arn:aws:iam:123456789012:role/emaccess`` . For information on creating a monitoring role, see `Setting Up and Enabling Enhanced Monitoring <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling>`_ in the *Amazon RDS User Guide* . If ``MonitoringInterval`` is set to a value other than ``0`` , then you must supply a ``MonitoringRoleArn`` value. This setting doesn't apply to RDS Custom DB instances.
|
|
10402
|
-
:param multi_az: Specifies whether the
|
|
10421
|
+
:param multi_az: Specifies whether the DB instance is a Multi-AZ deployment. You can't set the ``AvailabilityZone`` parameter if the DB instance is a Multi-AZ deployment. This setting doesn't apply to the following DB instances: - Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.) - RDS Custom
|
|
10403
10422
|
:param nchar_character_set_name: The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.
|
|
10404
10423
|
:param network_type: The network type of the DB instance. Valid values: - ``IPV4`` - ``DUAL`` The network type is determined by the ``DBSubnetGroup`` specified for the DB instance. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols ( ``DUAL`` ). For more information, see `Working with a DB instance in a VPC <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html>`_ in the *Amazon RDS User Guide.*
|
|
10405
10424
|
:param option_group_name: Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
|
|
10406
10425
|
:param performance_insights_kms_key_id: The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for ``PerformanceInsightsKMSKeyId`` , then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see `EnablePerformanceInsights <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights>`_ .
|
|
10407
10426
|
:param performance_insights_retention_period: The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: - ``7`` - *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) - ``731`` Default: ``7`` days If you specify a retention period that isn't valid, such as ``94`` , Amazon RDS returns an error.
|
|
10408
|
-
:param port: The port number on which the database accepts connections.
|
|
10427
|
+
:param port: The port number on which the database accepts connections. This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster. Valid Values: ``1150-65535`` Default: - RDS for Db2 - ``50000`` - RDS for MariaDB - ``3306`` - RDS for Microsoft SQL Server - ``1433`` - RDS for MySQL - ``3306`` - RDS for Oracle - ``1521`` - RDS for PostgreSQL - ``5432`` Constraints: - For RDS for Microsoft SQL Server, the value can't be ``1234`` , ``1434`` , ``3260`` , ``3343`` , ``3389`` , ``47001`` , or ``49152-49156`` .
|
|
10409
10428
|
:param preferred_backup_window: The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see `Backup Window <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow>`_ in the *Amazon RDS User Guide.* Constraints: - Must be in the format ``hh24:mi-hh24:mi`` . - Must be in Universal Coordinated Time (UTC). - Must not conflict with the preferred maintenance window. - Must be at least 30 minutes. *Amazon Aurora* Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
|
|
10410
10429
|
:param preferred_maintenance_window: The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ``ddd:hh24:mi-ddd:hh24:mi`` 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 Instance Maintenance Window <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow>`_ in the *Amazon RDS User Guide.* .. epigraph:: This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window.
|
|
10411
10430
|
:param processor_features: The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
|
|
@@ -10421,7 +10440,7 @@ class CfnDBInstanceProps:
|
|
|
10421
10440
|
:param storage_encrypted: A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the ``KmsKeyId`` property, then you must enable encryption. If you specify the ``SourceDBInstanceIdentifier`` or ``SourceDbiResourceId`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. If you specify the ``SourceDBInstanceAutomatedBackupsArn`` property, don't specify this property. The value is inherited from the source DB instance automated backup. If you specify ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the snapshot. *Amazon Aurora* Not applicable. The encryption for DB instances is managed by the DB cluster.
|
|
10422
10441
|
:param storage_throughput: Specifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. This setting doesn't apply to RDS Custom or Amazon Aurora.
|
|
10423
10442
|
:param storage_type: The storage type to associate with the DB instance. If you specify ``io1`` , ``io2`` , or ``gp3`` , you must also include a value for the ``Iops`` parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values: ``gp2 | gp3 | io1 | io2 | standard`` Default: ``io1`` , if the ``Iops`` parameter is specified. Otherwise, ``gp2`` .
|
|
10424
|
-
:param tags:
|
|
10443
|
+
:param tags: Tags to assign to the DB instance.
|
|
10425
10444
|
:param tde_credential_arn:
|
|
10426
10445
|
:param tde_credential_password:
|
|
10427
10446
|
:param timezone: The time zone of the DB instance. The time zone parameter is currently supported only by `RDS for Db2 <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone>`_ and `RDS for SQL Server <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone>`_ .
|
|
@@ -11051,7 +11070,9 @@ class CfnDBInstanceProps:
|
|
|
11051
11070
|
|
|
11052
11071
|
@builtins.property
|
|
11053
11072
|
def db_cluster_identifier(self) -> typing.Optional[builtins.str]:
|
|
11054
|
-
'''The identifier of the DB cluster that
|
|
11073
|
+
'''The identifier of the DB cluster that this DB instance will belong to.
|
|
11074
|
+
|
|
11075
|
+
This setting doesn't apply to RDS Custom DB instances.
|
|
11055
11076
|
|
|
11056
11077
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbclusteridentifier
|
|
11057
11078
|
'''
|
|
@@ -11246,7 +11267,6 @@ class CfnDBInstanceProps:
|
|
|
11246
11267
|
- ``DBClusterIdentifier``
|
|
11247
11268
|
- ``DBName``
|
|
11248
11269
|
- ``DeleteAutomatedBackups``
|
|
11249
|
-
- ``EnablePerformanceInsights``
|
|
11250
11270
|
- ``KmsKeyId``
|
|
11251
11271
|
- ``MasterUsername``
|
|
11252
11272
|
- ``MasterUserPassword``
|
|
@@ -11275,11 +11295,9 @@ class CfnDBInstanceProps:
|
|
|
11275
11295
|
|
|
11276
11296
|
If there's no DB subnet group, then the DB instance isn't a VPC DB instance.
|
|
11277
11297
|
|
|
11278
|
-
For more information about using Amazon RDS in a VPC, see `
|
|
11298
|
+
For more information about using Amazon RDS in a VPC, see `Amazon VPC and Amazon RDS <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html>`_ in the *Amazon RDS User Guide* .
|
|
11279
11299
|
|
|
11280
|
-
|
|
11281
|
-
|
|
11282
|
-
Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
|
|
11300
|
+
This setting doesn't apply to Amazon Aurora DB instances. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
|
|
11283
11301
|
|
|
11284
11302
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbsubnetgroupname
|
|
11285
11303
|
'''
|
|
@@ -11318,13 +11336,11 @@ class CfnDBInstanceProps:
|
|
|
11318
11336
|
def deletion_protection(
|
|
11319
11337
|
self,
|
|
11320
11338
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
11321
|
-
'''
|
|
11322
|
-
|
|
11323
|
-
The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see `Deleting a DB Instance <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html>`_ .
|
|
11339
|
+
'''Specifies whether the DB instance has deletion protection enabled.
|
|
11324
11340
|
|
|
11325
|
-
|
|
11341
|
+
The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see `Deleting a DB Instance <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html>`_ .
|
|
11326
11342
|
|
|
11327
|
-
|
|
11343
|
+
This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster`` . DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
|
|
11328
11344
|
|
|
11329
11345
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-deletionprotection
|
|
11330
11346
|
'''
|
|
@@ -11829,13 +11845,15 @@ class CfnDBInstanceProps:
|
|
|
11829
11845
|
def monitoring_interval(self) -> typing.Optional[jsii.Number]:
|
|
11830
11846
|
'''The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
|
11831
11847
|
|
|
11832
|
-
To disable collection of Enhanced Monitoring metrics, specify 0
|
|
11848
|
+
To disable collection of Enhanced Monitoring metrics, specify ``0`` .
|
|
11833
11849
|
|
|
11834
|
-
If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than 0.
|
|
11850
|
+
If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than ``0`` .
|
|
11835
11851
|
|
|
11836
|
-
This setting doesn't apply to RDS Custom.
|
|
11852
|
+
This setting doesn't apply to RDS Custom DB instances.
|
|
11837
11853
|
|
|
11838
|
-
Valid Values: ``0
|
|
11854
|
+
Valid Values: ``0 | 1 | 5 | 10 | 15 | 30 | 60``
|
|
11855
|
+
|
|
11856
|
+
Default: ``0``
|
|
11839
11857
|
|
|
11840
11858
|
:default: - 0
|
|
11841
11859
|
|
|
@@ -11863,15 +11881,14 @@ class CfnDBInstanceProps:
|
|
|
11863
11881
|
def multi_az(
|
|
11864
11882
|
self,
|
|
11865
11883
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
11866
|
-
'''Specifies whether the
|
|
11884
|
+
'''Specifies whether the DB instance is a Multi-AZ deployment.
|
|
11867
11885
|
|
|
11868
|
-
You can't set the ``AvailabilityZone`` parameter if the
|
|
11886
|
+
You can't set the ``AvailabilityZone`` parameter if the DB instance is a Multi-AZ deployment.
|
|
11869
11887
|
|
|
11870
|
-
|
|
11871
|
-
|
|
11872
|
-
*Amazon Aurora*
|
|
11888
|
+
This setting doesn't apply to the following DB instances:
|
|
11873
11889
|
|
|
11874
|
-
|
|
11890
|
+
- Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
|
|
11891
|
+
- RDS Custom
|
|
11875
11892
|
|
|
11876
11893
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-multiaz
|
|
11877
11894
|
'''
|
|
@@ -11958,13 +11975,22 @@ class CfnDBInstanceProps:
|
|
|
11958
11975
|
def port(self) -> typing.Optional[builtins.str]:
|
|
11959
11976
|
'''The port number on which the database accepts connections.
|
|
11960
11977
|
|
|
11961
|
-
|
|
11978
|
+
This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.
|
|
11962
11979
|
|
|
11963
|
-
|
|
11980
|
+
Valid Values: ``1150-65535``
|
|
11964
11981
|
|
|
11965
|
-
|
|
11982
|
+
Default:
|
|
11983
|
+
|
|
11984
|
+
- RDS for Db2 - ``50000``
|
|
11985
|
+
- RDS for MariaDB - ``3306``
|
|
11986
|
+
- RDS for Microsoft SQL Server - ``1433``
|
|
11987
|
+
- RDS for MySQL - ``3306``
|
|
11988
|
+
- RDS for Oracle - ``1521``
|
|
11989
|
+
- RDS for PostgreSQL - ``5432``
|
|
11990
|
+
|
|
11991
|
+
Constraints:
|
|
11966
11992
|
|
|
11967
|
-
|
|
11993
|
+
- For RDS for Microsoft SQL Server, the value can't be ``1234`` , ``1434`` , ``3260`` , ``3343`` , ``3389`` , ``47001`` , or ``49152-49156`` .
|
|
11968
11994
|
|
|
11969
11995
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-port
|
|
11970
11996
|
'''
|
|
@@ -12217,7 +12243,7 @@ class CfnDBInstanceProps:
|
|
|
12217
12243
|
|
|
12218
12244
|
@builtins.property
|
|
12219
12245
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
12220
|
-
'''
|
|
12246
|
+
'''Tags to assign to the DB instance.
|
|
12221
12247
|
|
|
12222
12248
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-tags
|
|
12223
12249
|
'''
|
|
@@ -12385,10 +12411,10 @@ class CfnDBParameterGroup(
|
|
|
12385
12411
|
:param scope: Scope in which this resource is defined.
|
|
12386
12412
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
12387
12413
|
:param description: Provides the customer-specified description for this DB parameter group.
|
|
12388
|
-
:param family: The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a
|
|
12414
|
+
:param family: The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family. To list all of the available parameter group families for a DB engine, use the following command: ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>`` For example, to list all of the available parameter group families for the MySQL DB engine, use the following command: ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql`` .. epigraph:: The output contains duplicates. The following are the valid DB engine values: - ``aurora-mysql`` - ``aurora-postgresql`` - ``db2-ae`` - ``db2-se`` - ``mysql`` - ``oracle-ee`` - ``oracle-ee-cdb`` - ``oracle-se2`` - ``oracle-se2-cdb`` - ``postgres`` - ``sqlserver-ee`` - ``sqlserver-se`` - ``sqlserver-ex`` - ``sqlserver-web``
|
|
12389
12415
|
:param db_parameter_group_name: The name of the DB parameter group. Constraints: - Must be 1 to 255 letters, numbers, or hyphens. - First character must be a letter - Can't end with a hyphen or contain two consecutive hyphens If you don't specify a value for ``DBParameterGroupName`` property, a name is automatically created for the DB parameter group. .. epigraph:: This value is stored as a lowercase string.
|
|
12390
|
-
:param parameters: An array of parameter names and values for the parameter update.
|
|
12391
|
-
:param tags:
|
|
12416
|
+
:param parameters: An array of parameter names and values for the parameter update. You must specify at least one parameter name and value. For more information about parameter groups, see `Working with parameter groups <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html>`_ in the *Amazon RDS User Guide* , or `Working with parameter groups <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html>`_ in the *Amazon Aurora User Guide* . .. epigraph:: AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.
|
|
12417
|
+
:param tags: Tags to assign to the DB parameter group.
|
|
12392
12418
|
'''
|
|
12393
12419
|
if __debug__:
|
|
12394
12420
|
type_hints = typing.get_type_hints(_typecheckingstub__c10aa78132a0eae6199258b5e55e45968fdce240e932138b48918eafb4c5da7b)
|
|
@@ -12509,7 +12535,7 @@ class CfnDBParameterGroup(
|
|
|
12509
12535
|
@builtins.property
|
|
12510
12536
|
@jsii.member(jsii_name="tagsRaw")
|
|
12511
12537
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
12512
|
-
'''
|
|
12538
|
+
'''Tags to assign to the DB parameter group.'''
|
|
12513
12539
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
12514
12540
|
|
|
12515
12541
|
@tags_raw.setter
|
|
@@ -12544,10 +12570,10 @@ class CfnDBParameterGroupProps:
|
|
|
12544
12570
|
'''Properties for defining a ``CfnDBParameterGroup``.
|
|
12545
12571
|
|
|
12546
12572
|
:param description: Provides the customer-specified description for this DB parameter group.
|
|
12547
|
-
:param family: The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a
|
|
12573
|
+
:param family: The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family. To list all of the available parameter group families for a DB engine, use the following command: ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>`` For example, to list all of the available parameter group families for the MySQL DB engine, use the following command: ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql`` .. epigraph:: The output contains duplicates. The following are the valid DB engine values: - ``aurora-mysql`` - ``aurora-postgresql`` - ``db2-ae`` - ``db2-se`` - ``mysql`` - ``oracle-ee`` - ``oracle-ee-cdb`` - ``oracle-se2`` - ``oracle-se2-cdb`` - ``postgres`` - ``sqlserver-ee`` - ``sqlserver-se`` - ``sqlserver-ex`` - ``sqlserver-web``
|
|
12548
12574
|
:param db_parameter_group_name: The name of the DB parameter group. Constraints: - Must be 1 to 255 letters, numbers, or hyphens. - First character must be a letter - Can't end with a hyphen or contain two consecutive hyphens If you don't specify a value for ``DBParameterGroupName`` property, a name is automatically created for the DB parameter group. .. epigraph:: This value is stored as a lowercase string.
|
|
12549
|
-
:param parameters: An array of parameter names and values for the parameter update.
|
|
12550
|
-
:param tags:
|
|
12575
|
+
:param parameters: An array of parameter names and values for the parameter update. You must specify at least one parameter name and value. For more information about parameter groups, see `Working with parameter groups <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html>`_ in the *Amazon RDS User Guide* , or `Working with parameter groups <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html>`_ in the *Amazon Aurora User Guide* . .. epigraph:: AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.
|
|
12576
|
+
:param tags: Tags to assign to the DB parameter group.
|
|
12551
12577
|
|
|
12552
12578
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html
|
|
12553
12579
|
:exampleMetadata: fixture=_generated
|
|
@@ -12605,18 +12631,35 @@ class CfnDBParameterGroupProps:
|
|
|
12605
12631
|
def family(self) -> builtins.str:
|
|
12606
12632
|
'''The DB parameter group family name.
|
|
12607
12633
|
|
|
12608
|
-
A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a
|
|
12609
|
-
|
|
12634
|
+
A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
|
|
12635
|
+
|
|
12636
|
+
To list all of the available parameter group families for a DB engine, use the following command:
|
|
12610
12637
|
|
|
12611
|
-
|
|
12638
|
+
``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>``
|
|
12612
12639
|
|
|
12613
|
-
|
|
12640
|
+
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
|
|
12614
12641
|
|
|
12615
|
-
``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"``
|
|
12642
|
+
``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql``
|
|
12643
|
+
.. epigraph::
|
|
12616
12644
|
|
|
12617
|
-
|
|
12645
|
+
The output contains duplicates.
|
|
12618
12646
|
|
|
12619
|
-
|
|
12647
|
+
The following are the valid DB engine values:
|
|
12648
|
+
|
|
12649
|
+
- ``aurora-mysql``
|
|
12650
|
+
- ``aurora-postgresql``
|
|
12651
|
+
- ``db2-ae``
|
|
12652
|
+
- ``db2-se``
|
|
12653
|
+
- ``mysql``
|
|
12654
|
+
- ``oracle-ee``
|
|
12655
|
+
- ``oracle-ee-cdb``
|
|
12656
|
+
- ``oracle-se2``
|
|
12657
|
+
- ``oracle-se2-cdb``
|
|
12658
|
+
- ``postgres``
|
|
12659
|
+
- ``sqlserver-ee``
|
|
12660
|
+
- ``sqlserver-se``
|
|
12661
|
+
- ``sqlserver-ex``
|
|
12662
|
+
- ``sqlserver-web``
|
|
12620
12663
|
|
|
12621
12664
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-family
|
|
12622
12665
|
'''
|
|
@@ -12648,13 +12691,9 @@ class CfnDBParameterGroupProps:
|
|
|
12648
12691
|
def parameters(self) -> typing.Any:
|
|
12649
12692
|
'''An array of parameter names and values for the parameter update.
|
|
12650
12693
|
|
|
12651
|
-
|
|
12694
|
+
You must specify at least one parameter name and value.
|
|
12652
12695
|
|
|
12653
|
-
|
|
12654
|
-
|
|
12655
|
-
For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see `Working with DB Parameter Groups <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html>`_ in the *Amazon RDS User Guide* .
|
|
12656
|
-
|
|
12657
|
-
For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see `Working with DB Parameter Groups and DB Cluster Parameter Groups <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html>`_ in the *Amazon Aurora User Guide* .
|
|
12696
|
+
For more information about parameter groups, see `Working with parameter groups <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html>`_ in the *Amazon RDS User Guide* , or `Working with parameter groups <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html>`_ in the *Amazon Aurora User Guide* .
|
|
12658
12697
|
.. epigraph::
|
|
12659
12698
|
|
|
12660
12699
|
AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.
|
|
@@ -12666,11 +12705,7 @@ class CfnDBParameterGroupProps:
|
|
|
12666
12705
|
|
|
12667
12706
|
@builtins.property
|
|
12668
12707
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
12669
|
-
'''
|
|
12670
|
-
|
|
12671
|
-
.. epigraph::
|
|
12672
|
-
|
|
12673
|
-
Currently, this is the only property that supports drift detection.
|
|
12708
|
+
'''Tags to assign to the DB parameter group.
|
|
12674
12709
|
|
|
12675
12710
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-tags
|
|
12676
12711
|
'''
|
|
@@ -12764,7 +12799,7 @@ class CfnDBProxy(
|
|
|
12764
12799
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
12765
12800
|
:param auth: The authorization mechanism that the proxy uses.
|
|
12766
12801
|
:param db_proxy_name: The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region . An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
|
|
12767
|
-
:param engine_family: The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify ``MYSQL`` . For Aurora PostgreSQL and RDS for PostgreSQL databases, specify ``POSTGRESQL`` . For RDS for Microsoft SQL Server, specify ``SQLSERVER`` .
|
|
12802
|
+
:param engine_family: The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify ``MYSQL`` . For Aurora PostgreSQL and RDS for PostgreSQL databases, specify ``POSTGRESQL`` . For RDS for Microsoft SQL Server, specify ``SQLSERVER`` .
|
|
12768
12803
|
:param role_arn: The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
|
|
12769
12804
|
:param vpc_subnet_ids: One or more VPC subnet IDs to associate with the new proxy.
|
|
12770
12805
|
:param debug_logging: Specifies whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
|
|
@@ -12825,7 +12860,7 @@ class CfnDBProxy(
|
|
|
12825
12860
|
@builtins.property
|
|
12826
12861
|
@jsii.member(jsii_name="attrDbProxyArn")
|
|
12827
12862
|
def attr_db_proxy_arn(self) -> builtins.str:
|
|
12828
|
-
'''The Amazon Resource Name (ARN)
|
|
12863
|
+
'''The Amazon Resource Name (ARN) for the proxy.
|
|
12829
12864
|
|
|
12830
12865
|
:cloudformationAttribute: DBProxyArn
|
|
12831
12866
|
'''
|
|
@@ -12834,7 +12869,9 @@ class CfnDBProxy(
|
|
|
12834
12869
|
@builtins.property
|
|
12835
12870
|
@jsii.member(jsii_name="attrEndpoint")
|
|
12836
12871
|
def attr_endpoint(self) -> builtins.str:
|
|
12837
|
-
'''The
|
|
12872
|
+
'''The endpoint that you can use to connect to the DB proxy.
|
|
12873
|
+
|
|
12874
|
+
You include the endpoint value in the connection string for a database client application.
|
|
12838
12875
|
|
|
12839
12876
|
:cloudformationAttribute: Endpoint
|
|
12840
12877
|
'''
|
|
@@ -13034,10 +13071,10 @@ class CfnDBProxy(
|
|
|
13034
13071
|
) -> None:
|
|
13035
13072
|
'''Specifies the details of authentication used by a proxy to log in as a specific database user.
|
|
13036
13073
|
|
|
13037
|
-
:param auth_scheme: The type of authentication that the proxy uses for connections from the proxy to the underlying database.
|
|
13074
|
+
:param auth_scheme: The type of authentication that the proxy uses for connections from the proxy to the underlying database.
|
|
13038
13075
|
:param client_password_auth_type: Specifies the details of authentication used by a proxy to log in as a specific database user.
|
|
13039
13076
|
:param description: A user-specified description about the authentication used by a proxy to log in as a specific database user.
|
|
13040
|
-
:param iam_auth:
|
|
13077
|
+
:param iam_auth: A value that indicates whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy. The ``ENABLED`` value is valid only for proxies with RDS for Microsoft SQL Server.
|
|
13041
13078
|
:param secret_arn: The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
|
|
13042
13079
|
|
|
13043
13080
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html
|
|
@@ -13080,8 +13117,6 @@ class CfnDBProxy(
|
|
|
13080
13117
|
def auth_scheme(self) -> typing.Optional[builtins.str]:
|
|
13081
13118
|
'''The type of authentication that the proxy uses for connections from the proxy to the underlying database.
|
|
13082
13119
|
|
|
13083
|
-
Valid Values: ``SECRETS``
|
|
13084
|
-
|
|
13085
13120
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-authscheme
|
|
13086
13121
|
'''
|
|
13087
13122
|
result = self._values.get("auth_scheme")
|
|
@@ -13107,12 +13142,10 @@ class CfnDBProxy(
|
|
|
13107
13142
|
|
|
13108
13143
|
@builtins.property
|
|
13109
13144
|
def iam_auth(self) -> typing.Optional[builtins.str]:
|
|
13110
|
-
'''
|
|
13145
|
+
'''A value that indicates whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
|
|
13111
13146
|
|
|
13112
13147
|
The ``ENABLED`` value is valid only for proxies with RDS for Microsoft SQL Server.
|
|
13113
13148
|
|
|
13114
|
-
Valid Values: ``ENABLED | DISABLED | REQUIRED``
|
|
13115
|
-
|
|
13116
13149
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-iamauth
|
|
13117
13150
|
'''
|
|
13118
13151
|
result = self._values.get("iam_auth")
|
|
@@ -13152,10 +13185,12 @@ class CfnDBProxy(
|
|
|
13152
13185
|
key: typing.Optional[builtins.str] = None,
|
|
13153
13186
|
value: typing.Optional[builtins.str] = None,
|
|
13154
13187
|
) -> None:
|
|
13155
|
-
'''Metadata assigned to
|
|
13188
|
+
'''Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
|
|
13156
13189
|
|
|
13157
|
-
|
|
13158
|
-
|
|
13190
|
+
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* .
|
|
13191
|
+
|
|
13192
|
+
:param key: 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}*.:/=+\\-@]*)$").
|
|
13193
|
+
:param value: 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}*.:/=+\\-@]*)$").
|
|
13159
13194
|
|
|
13160
13195
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-tagformat.html
|
|
13161
13196
|
:exampleMetadata: fixture=_generated
|
|
@@ -13185,7 +13220,7 @@ class CfnDBProxy(
|
|
|
13185
13220
|
def key(self) -> typing.Optional[builtins.str]:
|
|
13186
13221
|
'''A key is the required name of the tag.
|
|
13187
13222
|
|
|
13188
|
-
The string value can be 1
|
|
13223
|
+
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}*.:/=+-@]*)$").
|
|
13189
13224
|
|
|
13190
13225
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-tagformat.html#cfn-rds-dbproxy-tagformat-key
|
|
13191
13226
|
'''
|
|
@@ -13196,7 +13231,7 @@ class CfnDBProxy(
|
|
|
13196
13231
|
def value(self) -> typing.Optional[builtins.str]:
|
|
13197
13232
|
'''A value is the optional value of the tag.
|
|
13198
13233
|
|
|
13199
|
-
The string value can be 1
|
|
13234
|
+
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}*.:/=+-@]*)$").
|
|
13200
13235
|
|
|
13201
13236
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-tagformat.html#cfn-rds-dbproxy-tagformat-value
|
|
13202
13237
|
'''
|
|
@@ -13271,7 +13306,7 @@ class CfnDBProxyEndpoint(
|
|
|
13271
13306
|
:param db_proxy_name: The name of the DB proxy associated with the DB proxy endpoint that you create.
|
|
13272
13307
|
:param vpc_subnet_ids: The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.
|
|
13273
13308
|
:param tags: An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
|
|
13274
|
-
:param target_role: A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
|
|
13309
|
+
:param target_role: A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
|
|
13275
13310
|
:param vpc_security_group_ids: The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.
|
|
13276
13311
|
'''
|
|
13277
13312
|
if __debug__:
|
|
@@ -13322,7 +13357,7 @@ class CfnDBProxyEndpoint(
|
|
|
13322
13357
|
@builtins.property
|
|
13323
13358
|
@jsii.member(jsii_name="attrDbProxyEndpointArn")
|
|
13324
13359
|
def attr_db_proxy_endpoint_arn(self) -> builtins.str:
|
|
13325
|
-
'''The Amazon Resource Name (ARN)
|
|
13360
|
+
'''The Amazon Resource Name (ARN) for the DB proxy endpoint.
|
|
13326
13361
|
|
|
13327
13362
|
:cloudformationAttribute: DBProxyEndpointArn
|
|
13328
13363
|
'''
|
|
@@ -13331,7 +13366,9 @@ class CfnDBProxyEndpoint(
|
|
|
13331
13366
|
@builtins.property
|
|
13332
13367
|
@jsii.member(jsii_name="attrEndpoint")
|
|
13333
13368
|
def attr_endpoint(self) -> builtins.str:
|
|
13334
|
-
'''The
|
|
13369
|
+
'''The endpoint that you can use to connect to the DB proxy.
|
|
13370
|
+
|
|
13371
|
+
You include the endpoint value in the connection string for a database client application.
|
|
13335
13372
|
|
|
13336
13373
|
:cloudformationAttribute: Endpoint
|
|
13337
13374
|
'''
|
|
@@ -13340,7 +13377,7 @@ class CfnDBProxyEndpoint(
|
|
|
13340
13377
|
@builtins.property
|
|
13341
13378
|
@jsii.member(jsii_name="attrIsDefault")
|
|
13342
13379
|
def attr_is_default(self) -> _IResolvable_da3f097b:
|
|
13343
|
-
'''
|
|
13380
|
+
'''Indicates whether this endpoint is the default endpoint for the associated DB proxy.
|
|
13344
13381
|
|
|
13345
13382
|
Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
|
|
13346
13383
|
|
|
@@ -13351,7 +13388,7 @@ class CfnDBProxyEndpoint(
|
|
|
13351
13388
|
@builtins.property
|
|
13352
13389
|
@jsii.member(jsii_name="attrVpcId")
|
|
13353
13390
|
def attr_vpc_id(self) -> builtins.str:
|
|
13354
|
-
'''
|
|
13391
|
+
'''Provides the VPC ID of the DB proxy endpoint.
|
|
13355
13392
|
|
|
13356
13393
|
:cloudformationAttribute: VpcId
|
|
13357
13394
|
'''
|
|
@@ -13466,10 +13503,12 @@ class CfnDBProxyEndpoint(
|
|
|
13466
13503
|
key: typing.Optional[builtins.str] = None,
|
|
13467
13504
|
value: typing.Optional[builtins.str] = None,
|
|
13468
13505
|
) -> None:
|
|
13469
|
-
'''Metadata assigned to
|
|
13506
|
+
'''Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
|
|
13507
|
+
|
|
13508
|
+
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* .
|
|
13470
13509
|
|
|
13471
|
-
:param key: A
|
|
13472
|
-
:param value:
|
|
13510
|
+
:param key: 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}*.:/=+\\-@]*)$").
|
|
13511
|
+
:param value: 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}*.:/=+\\-@]*)$").
|
|
13473
13512
|
|
|
13474
13513
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxyendpoint-tagformat.html
|
|
13475
13514
|
:exampleMetadata: fixture=_generated
|
|
@@ -13497,9 +13536,9 @@ class CfnDBProxyEndpoint(
|
|
|
13497
13536
|
|
|
13498
13537
|
@builtins.property
|
|
13499
13538
|
def key(self) -> typing.Optional[builtins.str]:
|
|
13500
|
-
'''A
|
|
13539
|
+
'''A key is the required name of the tag.
|
|
13501
13540
|
|
|
13502
|
-
The string value can be 1
|
|
13541
|
+
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}*.:/=+-@]*)$").
|
|
13503
13542
|
|
|
13504
13543
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxyendpoint-tagformat.html#cfn-rds-dbproxyendpoint-tagformat-key
|
|
13505
13544
|
'''
|
|
@@ -13508,7 +13547,9 @@ class CfnDBProxyEndpoint(
|
|
|
13508
13547
|
|
|
13509
13548
|
@builtins.property
|
|
13510
13549
|
def value(self) -> typing.Optional[builtins.str]:
|
|
13511
|
-
'''
|
|
13550
|
+
'''A value is the optional value of the tag.
|
|
13551
|
+
|
|
13552
|
+
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}*.:/=+-@]*)$").
|
|
13512
13553
|
|
|
13513
13554
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxyendpoint-tagformat.html#cfn-rds-dbproxyendpoint-tagformat-value
|
|
13514
13555
|
'''
|
|
@@ -13556,7 +13597,7 @@ class CfnDBProxyEndpointProps:
|
|
|
13556
13597
|
:param db_proxy_name: The name of the DB proxy associated with the DB proxy endpoint that you create.
|
|
13557
13598
|
:param vpc_subnet_ids: The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.
|
|
13558
13599
|
:param tags: An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
|
|
13559
|
-
:param target_role: A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
|
|
13600
|
+
:param target_role: A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
|
|
13560
13601
|
:param vpc_security_group_ids: The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.
|
|
13561
13602
|
|
|
13562
13603
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html
|
|
@@ -13649,8 +13690,6 @@ class CfnDBProxyEndpointProps:
|
|
|
13649
13690
|
def target_role(self) -> typing.Optional[builtins.str]:
|
|
13650
13691
|
'''A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
|
|
13651
13692
|
|
|
13652
|
-
Valid Values: ``READ_WRITE | READ_ONLY``
|
|
13653
|
-
|
|
13654
13693
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-targetrole
|
|
13655
13694
|
'''
|
|
13656
13695
|
result = self._values.get("target_role")
|
|
@@ -13714,7 +13753,7 @@ class CfnDBProxyProps:
|
|
|
13714
13753
|
|
|
13715
13754
|
:param auth: The authorization mechanism that the proxy uses.
|
|
13716
13755
|
:param db_proxy_name: The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region . An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
|
|
13717
|
-
:param engine_family: The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify ``MYSQL`` . For Aurora PostgreSQL and RDS for PostgreSQL databases, specify ``POSTGRESQL`` . For RDS for Microsoft SQL Server, specify ``SQLSERVER`` .
|
|
13756
|
+
:param engine_family: The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify ``MYSQL`` . For Aurora PostgreSQL and RDS for PostgreSQL databases, specify ``POSTGRESQL`` . For RDS for Microsoft SQL Server, specify ``SQLSERVER`` .
|
|
13718
13757
|
:param role_arn: The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
|
|
13719
13758
|
:param vpc_subnet_ids: One or more VPC subnet IDs to associate with the new proxy.
|
|
13720
13759
|
:param debug_logging: Specifies whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
|
|
@@ -13816,8 +13855,6 @@ class CfnDBProxyProps:
|
|
|
13816
13855
|
|
|
13817
13856
|
This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify ``MYSQL`` . For Aurora PostgreSQL and RDS for PostgreSQL databases, specify ``POSTGRESQL`` . For RDS for Microsoft SQL Server, specify ``SQLSERVER`` .
|
|
13818
13857
|
|
|
13819
|
-
*Valid Values* : ``MYSQL`` | ``POSTGRESQL`` | ``SQLSERVER``
|
|
13820
|
-
|
|
13821
13858
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-enginefamily
|
|
13822
13859
|
'''
|
|
13823
13860
|
result = self._values.get("engine_family")
|
|
@@ -13981,7 +14018,7 @@ class CfnDBProxyTargetGroup(
|
|
|
13981
14018
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
13982
14019
|
:param db_proxy_name: The identifier of the ``DBProxy`` that is associated with the ``DBProxyTargetGroup`` .
|
|
13983
14020
|
:param target_group_name: The identifier for the target group. .. epigraph:: Currently, this property must be set to ``default`` .
|
|
13984
|
-
:param connection_pool_configuration_info:
|
|
14021
|
+
:param connection_pool_configuration_info: Displays the settings that control the size and behavior of the connection pool associated with a ``DBProxyTarget`` .
|
|
13985
14022
|
:param db_cluster_identifiers: One or more DB cluster identifiers.
|
|
13986
14023
|
:param db_instance_identifiers: One or more DB instance identifiers.
|
|
13987
14024
|
'''
|
|
@@ -14074,7 +14111,7 @@ class CfnDBProxyTargetGroup(
|
|
|
14074
14111
|
def connection_pool_configuration_info(
|
|
14075
14112
|
self,
|
|
14076
14113
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty"]]:
|
|
14077
|
-
'''
|
|
14114
|
+
'''Displays the settings that control the size and behavior of the connection pool associated with a ``DBProxyTarget`` .'''
|
|
14078
14115
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty"]], jsii.get(self, "connectionPoolConfigurationInfo"))
|
|
14079
14116
|
|
|
14080
14117
|
@connection_pool_configuration_info.setter
|
|
@@ -14302,7 +14339,7 @@ class CfnDBProxyTargetGroupProps:
|
|
|
14302
14339
|
|
|
14303
14340
|
:param db_proxy_name: The identifier of the ``DBProxy`` that is associated with the ``DBProxyTargetGroup`` .
|
|
14304
14341
|
:param target_group_name: The identifier for the target group. .. epigraph:: Currently, this property must be set to ``default`` .
|
|
14305
|
-
:param connection_pool_configuration_info:
|
|
14342
|
+
:param connection_pool_configuration_info: Displays the settings that control the size and behavior of the connection pool associated with a ``DBProxyTarget`` .
|
|
14306
14343
|
:param db_cluster_identifiers: One or more DB cluster identifiers.
|
|
14307
14344
|
:param db_instance_identifiers: One or more DB instance identifiers.
|
|
14308
14345
|
|
|
@@ -14377,7 +14414,7 @@ class CfnDBProxyTargetGroupProps:
|
|
|
14377
14414
|
def connection_pool_configuration_info(
|
|
14378
14415
|
self,
|
|
14379
14416
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty]]:
|
|
14380
|
-
'''
|
|
14417
|
+
'''Displays the settings that control the size and behavior of the connection pool associated with a ``DBProxyTarget`` .
|
|
14381
14418
|
|
|
14382
14419
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html#cfn-rds-dbproxytargetgroup-connectionpoolconfigurationinfo
|
|
14383
14420
|
'''
|
|
@@ -14469,8 +14506,8 @@ class CfnDBSecurityGroup(
|
|
|
14469
14506
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
14470
14507
|
:param db_security_group_ingress: Ingress rules to be applied to the DB security group.
|
|
14471
14508
|
:param group_description: Provides the description of the DB security group.
|
|
14472
|
-
:param ec2_vpc_id: The identifier of an Amazon VPC. This property indicates the VPC that this DB security group belongs to. .. epigraph::
|
|
14473
|
-
:param tags:
|
|
14509
|
+
:param ec2_vpc_id: The identifier of an Amazon virtual private cloud (VPC). This property indicates the VPC that this DB security group belongs to. .. epigraph:: This property is included for backwards compatibility and is no longer recommended for providing security information to an RDS DB instance.
|
|
14510
|
+
:param tags: Metadata assigned to an Amazon RDS resource consisting of a key-value pair. 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* .
|
|
14474
14511
|
'''
|
|
14475
14512
|
if __debug__:
|
|
14476
14513
|
type_hints = typing.get_type_hints(_typecheckingstub__b692ab00b4d5e8d1153b5156b9ec79e26f77bbcf930e94b43eb9adff11e07a12)
|
|
@@ -14568,10 +14605,7 @@ class CfnDBSecurityGroup(
|
|
|
14568
14605
|
@builtins.property
|
|
14569
14606
|
@jsii.member(jsii_name="ec2VpcId")
|
|
14570
14607
|
def ec2_vpc_id(self) -> typing.Optional[builtins.str]:
|
|
14571
|
-
'''The identifier of an Amazon VPC.
|
|
14572
|
-
|
|
14573
|
-
This property indicates the VPC that this DB security group belongs to.
|
|
14574
|
-
'''
|
|
14608
|
+
'''The identifier of an Amazon virtual private cloud (VPC).'''
|
|
14575
14609
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "ec2VpcId"))
|
|
14576
14610
|
|
|
14577
14611
|
@ec2_vpc_id.setter
|
|
@@ -14584,7 +14618,7 @@ class CfnDBSecurityGroup(
|
|
|
14584
14618
|
@builtins.property
|
|
14585
14619
|
@jsii.member(jsii_name="tagsRaw")
|
|
14586
14620
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
14587
|
-
'''
|
|
14621
|
+
'''Metadata assigned to an Amazon RDS resource consisting of a key-value pair.'''
|
|
14588
14622
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
14589
14623
|
|
|
14590
14624
|
@tags_raw.setter
|
|
@@ -15045,8 +15079,8 @@ class CfnDBSecurityGroupProps:
|
|
|
15045
15079
|
|
|
15046
15080
|
:param db_security_group_ingress: Ingress rules to be applied to the DB security group.
|
|
15047
15081
|
:param group_description: Provides the description of the DB security group.
|
|
15048
|
-
:param ec2_vpc_id: The identifier of an Amazon VPC. This property indicates the VPC that this DB security group belongs to. .. epigraph::
|
|
15049
|
-
:param tags:
|
|
15082
|
+
:param ec2_vpc_id: The identifier of an Amazon virtual private cloud (VPC). This property indicates the VPC that this DB security group belongs to. .. epigraph:: This property is included for backwards compatibility and is no longer recommended for providing security information to an RDS DB instance.
|
|
15083
|
+
:param tags: Metadata assigned to an Amazon RDS resource consisting of a key-value pair. 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* .
|
|
15050
15084
|
|
|
15051
15085
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsecuritygroup.html
|
|
15052
15086
|
:exampleMetadata: fixture=_generated
|
|
@@ -15113,11 +15147,12 @@ class CfnDBSecurityGroupProps:
|
|
|
15113
15147
|
|
|
15114
15148
|
@builtins.property
|
|
15115
15149
|
def ec2_vpc_id(self) -> typing.Optional[builtins.str]:
|
|
15116
|
-
'''The identifier of an Amazon
|
|
15150
|
+
'''The identifier of an Amazon virtual private cloud (VPC).
|
|
15117
15151
|
|
|
15152
|
+
This property indicates the VPC that this DB security group belongs to.
|
|
15118
15153
|
.. epigraph::
|
|
15119
15154
|
|
|
15120
|
-
|
|
15155
|
+
This property is included for backwards compatibility and is no longer recommended for providing security information to an RDS DB instance.
|
|
15121
15156
|
|
|
15122
15157
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsecuritygroup.html#cfn-rds-dbsecuritygroup-ec2vpcid
|
|
15123
15158
|
'''
|
|
@@ -15126,7 +15161,9 @@ class CfnDBSecurityGroupProps:
|
|
|
15126
15161
|
|
|
15127
15162
|
@builtins.property
|
|
15128
15163
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
15129
|
-
'''
|
|
15164
|
+
'''Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
|
|
15165
|
+
|
|
15166
|
+
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* .
|
|
15130
15167
|
|
|
15131
15168
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsecuritygroup.html#cfn-rds-dbsecuritygroup-tags
|
|
15132
15169
|
'''
|
|
@@ -15195,8 +15232,8 @@ class CfnDBSubnetGroup(
|
|
|
15195
15232
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
15196
15233
|
:param db_subnet_group_description: The description for the DB subnet group.
|
|
15197
15234
|
:param subnet_ids: The EC2 Subnet IDs for the DB subnet group.
|
|
15198
|
-
:param db_subnet_group_name: The name for the DB subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255
|
|
15199
|
-
:param tags:
|
|
15235
|
+
:param db_subnet_group_name: The name for the DB subnet group. This value is stored as a lowercase string. Constraints: - Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. - Must not be default. - First character must be a letter. Example: ``mydbsubnetgroup``
|
|
15236
|
+
:param tags: Tags to assign to the DB subnet group.
|
|
15200
15237
|
'''
|
|
15201
15238
|
if __debug__:
|
|
15202
15239
|
type_hints = typing.get_type_hints(_typecheckingstub__3437b6f3359034732d6fbef14006ac020c94fa5b18aa95cb4c8bb7332cc58dc7)
|
|
@@ -15297,7 +15334,7 @@ class CfnDBSubnetGroup(
|
|
|
15297
15334
|
@builtins.property
|
|
15298
15335
|
@jsii.member(jsii_name="tagsRaw")
|
|
15299
15336
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
15300
|
-
'''
|
|
15337
|
+
'''Tags to assign to the DB subnet group.'''
|
|
15301
15338
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
15302
15339
|
|
|
15303
15340
|
@tags_raw.setter
|
|
@@ -15331,8 +15368,8 @@ class CfnDBSubnetGroupProps:
|
|
|
15331
15368
|
|
|
15332
15369
|
:param db_subnet_group_description: The description for the DB subnet group.
|
|
15333
15370
|
:param subnet_ids: The EC2 Subnet IDs for the DB subnet group.
|
|
15334
|
-
:param db_subnet_group_name: The name for the DB subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255
|
|
15335
|
-
:param tags:
|
|
15371
|
+
:param db_subnet_group_name: The name for the DB subnet group. This value is stored as a lowercase string. Constraints: - Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. - Must not be default. - First character must be a letter. Example: ``mydbsubnetgroup``
|
|
15372
|
+
:param tags: Tags to assign to the DB subnet group.
|
|
15336
15373
|
|
|
15337
15374
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html
|
|
15338
15375
|
:exampleMetadata: fixture=_generated
|
|
@@ -15394,9 +15431,13 @@ class CfnDBSubnetGroupProps:
|
|
|
15394
15431
|
def db_subnet_group_name(self) -> typing.Optional[builtins.str]:
|
|
15395
15432
|
'''The name for the DB subnet group. This value is stored as a lowercase string.
|
|
15396
15433
|
|
|
15397
|
-
Constraints:
|
|
15434
|
+
Constraints:
|
|
15435
|
+
|
|
15436
|
+
- Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
|
|
15437
|
+
- Must not be default.
|
|
15438
|
+
- First character must be a letter.
|
|
15398
15439
|
|
|
15399
|
-
Example: ``
|
|
15440
|
+
Example: ``mydbsubnetgroup``
|
|
15400
15441
|
|
|
15401
15442
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html#cfn-rds-dbsubnetgroup-dbsubnetgroupname
|
|
15402
15443
|
'''
|
|
@@ -15405,7 +15446,7 @@ class CfnDBSubnetGroupProps:
|
|
|
15405
15446
|
|
|
15406
15447
|
@builtins.property
|
|
15407
15448
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
15408
|
-
'''
|
|
15449
|
+
'''Tags to assign to the DB subnet group.
|
|
15409
15450
|
|
|
15410
15451
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html#cfn-rds-dbsubnetgroup-tags
|
|
15411
15452
|
'''
|
|
@@ -15479,8 +15520,8 @@ class CfnEventSubscription(
|
|
|
15479
15520
|
:param sns_topic_arn: The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it. .. epigraph:: RDS doesn't support FIFO (first in, first out) topics. For more information, see `Message ordering and deduplication (FIFO topics) <https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html>`_ in the *Amazon Simple Notification Service Developer Guide* .
|
|
15480
15521
|
:param enabled: Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active. Default: - true
|
|
15481
15522
|
:param event_categories: A list of event categories for a particular source type ( ``SourceType`` ) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the `*Amazon RDS User Guide* <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html>`_ or the `*Amazon Aurora User Guide* <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html>`_ . You can also see this list by using the ``DescribeEventCategories`` operation.
|
|
15482
|
-
:param source_ids: The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens. Constraints: - If
|
|
15483
|
-
:param source_type: The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, set this parameter to ``db-instance`` . If this value isn't specified, all events are returned. Valid
|
|
15523
|
+
:param source_ids: The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens. Constraints: - If ``SourceIds`` are supplied, ``SourceType`` must also be provided. - If the source type is a DB instance, a ``DBInstanceIdentifier`` value must be supplied. - If the source type is a DB cluster, a ``DBClusterIdentifier`` value must be supplied. - If the source type is a DB parameter group, a ``DBParameterGroupName`` value must be supplied. - If the source type is a DB security group, a ``DBSecurityGroupName`` value must be supplied. - If the source type is a DB snapshot, a ``DBSnapshotIdentifier`` value must be supplied. - If the source type is a DB cluster snapshot, a ``DBClusterSnapshotIdentifier`` value must be supplied. - If the source type is an RDS Proxy, a ``DBProxyName`` value must be supplied.
|
|
15524
|
+
:param source_type: The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to ``db-instance`` . For RDS Proxy events, specify ``db-proxy`` . If this value isn't specified, all events are returned. Valid Values: ``db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment``
|
|
15484
15525
|
:param subscription_name: The name of the subscription. Constraints: The name must be less than 255 characters.
|
|
15485
15526
|
:param tags: An optional array of key-value pairs to apply to this subscription.
|
|
15486
15527
|
'''
|
|
@@ -15671,8 +15712,8 @@ class CfnEventSubscriptionProps:
|
|
|
15671
15712
|
:param sns_topic_arn: The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it. .. epigraph:: RDS doesn't support FIFO (first in, first out) topics. For more information, see `Message ordering and deduplication (FIFO topics) <https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html>`_ in the *Amazon Simple Notification Service Developer Guide* .
|
|
15672
15713
|
:param enabled: Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active. Default: - true
|
|
15673
15714
|
:param event_categories: A list of event categories for a particular source type ( ``SourceType`` ) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the `*Amazon RDS User Guide* <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html>`_ or the `*Amazon Aurora User Guide* <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html>`_ . You can also see this list by using the ``DescribeEventCategories`` operation.
|
|
15674
|
-
:param source_ids: The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens. Constraints: - If
|
|
15675
|
-
:param source_type: The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, set this parameter to ``db-instance`` . If this value isn't specified, all events are returned. Valid
|
|
15715
|
+
:param source_ids: The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens. Constraints: - If ``SourceIds`` are supplied, ``SourceType`` must also be provided. - If the source type is a DB instance, a ``DBInstanceIdentifier`` value must be supplied. - If the source type is a DB cluster, a ``DBClusterIdentifier`` value must be supplied. - If the source type is a DB parameter group, a ``DBParameterGroupName`` value must be supplied. - If the source type is a DB security group, a ``DBSecurityGroupName`` value must be supplied. - If the source type is a DB snapshot, a ``DBSnapshotIdentifier`` value must be supplied. - If the source type is a DB cluster snapshot, a ``DBClusterSnapshotIdentifier`` value must be supplied. - If the source type is an RDS Proxy, a ``DBProxyName`` value must be supplied.
|
|
15716
|
+
:param source_type: The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to ``db-instance`` . For RDS Proxy events, specify ``db-proxy`` . If this value isn't specified, all events are returned. Valid Values: ``db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment``
|
|
15676
15717
|
:param subscription_name: The name of the subscription. Constraints: The name must be less than 255 characters.
|
|
15677
15718
|
:param tags: An optional array of key-value pairs to apply to this subscription.
|
|
15678
15719
|
|
|
@@ -15774,13 +15815,14 @@ class CfnEventSubscriptionProps:
|
|
|
15774
15815
|
|
|
15775
15816
|
Constraints:
|
|
15776
15817
|
|
|
15777
|
-
- If
|
|
15818
|
+
- If ``SourceIds`` are supplied, ``SourceType`` must also be provided.
|
|
15778
15819
|
- If the source type is a DB instance, a ``DBInstanceIdentifier`` value must be supplied.
|
|
15779
15820
|
- If the source type is a DB cluster, a ``DBClusterIdentifier`` value must be supplied.
|
|
15780
15821
|
- If the source type is a DB parameter group, a ``DBParameterGroupName`` value must be supplied.
|
|
15781
15822
|
- If the source type is a DB security group, a ``DBSecurityGroupName`` value must be supplied.
|
|
15782
15823
|
- If the source type is a DB snapshot, a ``DBSnapshotIdentifier`` value must be supplied.
|
|
15783
15824
|
- If the source type is a DB cluster snapshot, a ``DBClusterSnapshotIdentifier`` value must be supplied.
|
|
15825
|
+
- If the source type is an RDS Proxy, a ``DBProxyName`` value must be supplied.
|
|
15784
15826
|
|
|
15785
15827
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-sourceids
|
|
15786
15828
|
'''
|
|
@@ -15791,9 +15833,9 @@ class CfnEventSubscriptionProps:
|
|
|
15791
15833
|
def source_type(self) -> typing.Optional[builtins.str]:
|
|
15792
15834
|
'''The type of source that is generating the events.
|
|
15793
15835
|
|
|
15794
|
-
For example, if you want to be notified of events generated by a DB instance, set this parameter to ``db-instance`` . If this value isn't specified, all events are returned.
|
|
15836
|
+
For example, if you want to be notified of events generated by a DB instance, you set this parameter to ``db-instance`` . For RDS Proxy events, specify ``db-proxy`` . If this value isn't specified, all events are returned.
|
|
15795
15837
|
|
|
15796
|
-
Valid
|
|
15838
|
+
Valid Values: ``db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment``
|
|
15797
15839
|
|
|
15798
15840
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-sourcetype
|
|
15799
15841
|
'''
|
|
@@ -16303,7 +16345,7 @@ class CfnIntegration(
|
|
|
16303
16345
|
:param description: A description of the integration.
|
|
16304
16346
|
:param integration_name: The name of the integration.
|
|
16305
16347
|
:param kms_key_id: The AWS Key Management System ( AWS KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default AWS owned key.
|
|
16306
|
-
:param tags:
|
|
16348
|
+
:param tags: An optional array of key-value pairs to apply to this integration.
|
|
16307
16349
|
'''
|
|
16308
16350
|
if __debug__:
|
|
16309
16351
|
type_hints = typing.get_type_hints(_typecheckingstub__0596ec891883071cc8cc2bad7e4e8120eefe68f759bfc17fdbfc1a525466ae6e)
|
|
@@ -16480,7 +16522,7 @@ class CfnIntegration(
|
|
|
16480
16522
|
@builtins.property
|
|
16481
16523
|
@jsii.member(jsii_name="tags")
|
|
16482
16524
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
16483
|
-
'''
|
|
16525
|
+
'''An optional array of key-value pairs to apply to this integration.'''
|
|
16484
16526
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
|
|
16485
16527
|
|
|
16486
16528
|
@tags.setter
|
|
@@ -16527,7 +16569,7 @@ class CfnIntegrationProps:
|
|
|
16527
16569
|
:param description: A description of the integration.
|
|
16528
16570
|
:param integration_name: The name of the integration.
|
|
16529
16571
|
:param kms_key_id: The AWS Key Management System ( AWS KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default AWS owned key.
|
|
16530
|
-
:param tags:
|
|
16572
|
+
:param tags: An optional array of key-value pairs to apply to this integration.
|
|
16531
16573
|
|
|
16532
16574
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html
|
|
16533
16575
|
:exampleMetadata: fixture=_generated
|
|
@@ -16660,9 +16702,7 @@ class CfnIntegrationProps:
|
|
|
16660
16702
|
|
|
16661
16703
|
@builtins.property
|
|
16662
16704
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
16663
|
-
'''
|
|
16664
|
-
|
|
16665
|
-
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.* .
|
|
16705
|
+
'''An optional array of key-value pairs to apply to this integration.
|
|
16666
16706
|
|
|
16667
16707
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html#cfn-rds-integration-tags
|
|
16668
16708
|
'''
|
|
@@ -16744,9 +16784,9 @@ class CfnOptionGroup(
|
|
|
16744
16784
|
:param engine_name: Specifies the name of the engine that this option group should be associated with. Valid Values: - ``mariadb`` - ``mysql`` - ``oracle-ee`` - ``oracle-ee-cdb`` - ``oracle-se2`` - ``oracle-se2-cdb`` - ``postgres`` - ``sqlserver-ee`` - ``sqlserver-se`` - ``sqlserver-ex`` - ``sqlserver-web``
|
|
16745
16785
|
:param major_engine_version: Specifies the major version of the engine that this option group should be associated with.
|
|
16746
16786
|
:param option_group_description: The description of the option group.
|
|
16747
|
-
:param option_configurations: A list of
|
|
16787
|
+
:param option_configurations: A list of all available options.
|
|
16748
16788
|
:param option_group_name: The name of the option group to be created. Constraints: - Must be 1 to 255 letters, numbers, or hyphens - First character must be a letter - Can't end with a hyphen or contain two consecutive hyphens Example: ``myoptiongroup`` If you don't specify a value for ``OptionGroupName`` property, a name is automatically created for the option group. .. epigraph:: This value is stored as a lowercase string.
|
|
16749
|
-
:param tags:
|
|
16789
|
+
:param tags: Tags to assign to the option group.
|
|
16750
16790
|
'''
|
|
16751
16791
|
if __debug__:
|
|
16752
16792
|
type_hints = typing.get_type_hints(_typecheckingstub__160a45fe55c01086901039aa8bde8bd5ace11ff967acd2154abcc9137622aea0)
|
|
@@ -16848,7 +16888,7 @@ class CfnOptionGroup(
|
|
|
16848
16888
|
def option_configurations(
|
|
16849
16889
|
self,
|
|
16850
16890
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnOptionGroup.OptionConfigurationProperty"]]]]:
|
|
16851
|
-
'''A list of
|
|
16891
|
+
'''A list of all available options.'''
|
|
16852
16892
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnOptionGroup.OptionConfigurationProperty"]]]], jsii.get(self, "optionConfigurations"))
|
|
16853
16893
|
|
|
16854
16894
|
@option_configurations.setter
|
|
@@ -16877,7 +16917,7 @@ class CfnOptionGroup(
|
|
|
16877
16917
|
@builtins.property
|
|
16878
16918
|
@jsii.member(jsii_name="tagsRaw")
|
|
16879
16919
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
16880
|
-
'''
|
|
16920
|
+
'''Tags to assign to the option group.'''
|
|
16881
16921
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
16882
16922
|
|
|
16883
16923
|
@tags_raw.setter
|
|
@@ -17135,9 +17175,9 @@ class CfnOptionGroupProps:
|
|
|
17135
17175
|
:param engine_name: Specifies the name of the engine that this option group should be associated with. Valid Values: - ``mariadb`` - ``mysql`` - ``oracle-ee`` - ``oracle-ee-cdb`` - ``oracle-se2`` - ``oracle-se2-cdb`` - ``postgres`` - ``sqlserver-ee`` - ``sqlserver-se`` - ``sqlserver-ex`` - ``sqlserver-web``
|
|
17136
17176
|
:param major_engine_version: Specifies the major version of the engine that this option group should be associated with.
|
|
17137
17177
|
:param option_group_description: The description of the option group.
|
|
17138
|
-
:param option_configurations: A list of
|
|
17178
|
+
:param option_configurations: A list of all available options.
|
|
17139
17179
|
:param option_group_name: The name of the option group to be created. Constraints: - Must be 1 to 255 letters, numbers, or hyphens - First character must be a letter - Can't end with a hyphen or contain two consecutive hyphens Example: ``myoptiongroup`` If you don't specify a value for ``OptionGroupName`` property, a name is automatically created for the option group. .. epigraph:: This value is stored as a lowercase string.
|
|
17140
|
-
:param tags:
|
|
17180
|
+
:param tags: Tags to assign to the option group.
|
|
17141
17181
|
|
|
17142
17182
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html
|
|
17143
17183
|
:exampleMetadata: fixture=_generated
|
|
@@ -17242,7 +17282,7 @@ class CfnOptionGroupProps:
|
|
|
17242
17282
|
def option_configurations(
|
|
17243
17283
|
self,
|
|
17244
17284
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnOptionGroup.OptionConfigurationProperty]]]]:
|
|
17245
|
-
'''A list of
|
|
17285
|
+
'''A list of all available options.
|
|
17246
17286
|
|
|
17247
17287
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optionconfigurations
|
|
17248
17288
|
'''
|
|
@@ -17273,7 +17313,7 @@ class CfnOptionGroupProps:
|
|
|
17273
17313
|
|
|
17274
17314
|
@builtins.property
|
|
17275
17315
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
17276
|
-
'''
|
|
17316
|
+
'''Tags to assign to the option group.
|
|
17277
17317
|
|
|
17278
17318
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-tags
|
|
17279
17319
|
'''
|
|
@@ -19678,9 +19718,9 @@ class DatabaseClusterFromSnapshotProps:
|
|
|
19678
19718
|
:param readers: A list of instances to create as cluster reader instances. Default: - no readers are created. The cluster will have a single writer/reader
|
|
19679
19719
|
:param removal_policy: The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update. Default: - RemovalPolicy.SNAPSHOT (remove the cluster and instances, but retain a snapshot of the data)
|
|
19680
19720
|
:param s3_export_buckets: S3 buckets that you want to load data into. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ExportRole`` is used. For MySQL: Default: - None
|
|
19681
|
-
:param s3_export_role: Role that will be associated with this DB cluster to enable S3 export. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ExportBuckets`` is used. For MySQL: Default: - New role is created if ``s3ExportBuckets`` is set, no role is defined otherwise
|
|
19721
|
+
:param s3_export_role: Role that will be associated with this DB cluster to enable S3 export. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ExportBuckets`` is used. To use this property with Aurora PostgreSQL, it must be configured with the S3 export feature enabled when creating the DatabaseClusterEngine For MySQL: Default: - New role is created if ``s3ExportBuckets`` is set, no role is defined otherwise
|
|
19682
19722
|
:param s3_import_buckets: S3 buckets that you want to load data from. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ImportRole`` is used. For MySQL: Default: - None
|
|
19683
|
-
:param s3_import_role: Role that will be associated with this DB cluster to enable S3 import. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ImportBuckets`` is used. For MySQL: Default: - New role is created if ``s3ImportBuckets`` is set, no role is defined otherwise
|
|
19723
|
+
:param s3_import_role: Role that will be associated with this DB cluster to enable S3 import. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ImportBuckets`` is used. To use this property with Aurora PostgreSQL, it must be configured with the S3 import feature enabled when creating the DatabaseClusterEngine For MySQL: Default: - New role is created if ``s3ImportBuckets`` is set, no role is defined otherwise
|
|
19684
19724
|
:param security_groups: Security group. Default: a new security group is created.
|
|
19685
19725
|
:param serverless_v2_max_capacity: 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 (256GB). The maximum capacity must be higher than 0.5 ACUs. Default: 2
|
|
19686
19726
|
:param serverless_v2_min_capacity: 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. Default: 0.5
|
|
@@ -20189,7 +20229,7 @@ class DatabaseClusterFromSnapshotProps:
|
|
|
20189
20229
|
This feature is only supported by the Aurora database engine.
|
|
20190
20230
|
|
|
20191
20231
|
This property must not be used if ``s3ExportBuckets`` is used.
|
|
20192
|
-
|
|
20232
|
+
To use this property with Aurora PostgreSQL, it must be configured with the S3 export feature enabled when creating the DatabaseClusterEngine
|
|
20193
20233
|
For MySQL:
|
|
20194
20234
|
|
|
20195
20235
|
:default: - New role is created if ``s3ExportBuckets`` is set, no role is defined otherwise
|
|
@@ -20221,7 +20261,7 @@ class DatabaseClusterFromSnapshotProps:
|
|
|
20221
20261
|
This feature is only supported by the Aurora database engine.
|
|
20222
20262
|
|
|
20223
20263
|
This property must not be used if ``s3ImportBuckets`` is used.
|
|
20224
|
-
|
|
20264
|
+
To use this property with Aurora PostgreSQL, it must be configured with the S3 import feature enabled when creating the DatabaseClusterEngine
|
|
20225
20265
|
For MySQL:
|
|
20226
20266
|
|
|
20227
20267
|
:default: - New role is created if ``s3ImportBuckets`` is set, no role is defined otherwise
|
|
@@ -20485,9 +20525,9 @@ class DatabaseClusterProps:
|
|
|
20485
20525
|
:param readers: A list of instances to create as cluster reader instances. Default: - no readers are created. The cluster will have a single writer/reader
|
|
20486
20526
|
:param removal_policy: The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update. Default: - RemovalPolicy.SNAPSHOT (remove the cluster and instances, but retain a snapshot of the data)
|
|
20487
20527
|
:param s3_export_buckets: S3 buckets that you want to load data into. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ExportRole`` is used. For MySQL: Default: - None
|
|
20488
|
-
:param s3_export_role: Role that will be associated with this DB cluster to enable S3 export. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ExportBuckets`` is used. For MySQL: Default: - New role is created if ``s3ExportBuckets`` is set, no role is defined otherwise
|
|
20528
|
+
:param s3_export_role: Role that will be associated with this DB cluster to enable S3 export. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ExportBuckets`` is used. To use this property with Aurora PostgreSQL, it must be configured with the S3 export feature enabled when creating the DatabaseClusterEngine For MySQL: Default: - New role is created if ``s3ExportBuckets`` is set, no role is defined otherwise
|
|
20489
20529
|
:param s3_import_buckets: S3 buckets that you want to load data from. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ImportRole`` is used. For MySQL: Default: - None
|
|
20490
|
-
:param s3_import_role: Role that will be associated with this DB cluster to enable S3 import. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ImportBuckets`` is used. For MySQL: Default: - New role is created if ``s3ImportBuckets`` is set, no role is defined otherwise
|
|
20530
|
+
:param s3_import_role: Role that will be associated with this DB cluster to enable S3 import. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ImportBuckets`` is used. To use this property with Aurora PostgreSQL, it must be configured with the S3 import feature enabled when creating the DatabaseClusterEngine For MySQL: Default: - New role is created if ``s3ImportBuckets`` is set, no role is defined otherwise
|
|
20491
20531
|
:param security_groups: Security group. Default: a new security group is created.
|
|
20492
20532
|
:param serverless_v2_max_capacity: 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 (256GB). The maximum capacity must be higher than 0.5 ACUs. Default: 2
|
|
20493
20533
|
:param serverless_v2_min_capacity: 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. Default: 0.5
|
|
@@ -20976,7 +21016,7 @@ class DatabaseClusterProps:
|
|
|
20976
21016
|
This feature is only supported by the Aurora database engine.
|
|
20977
21017
|
|
|
20978
21018
|
This property must not be used if ``s3ExportBuckets`` is used.
|
|
20979
|
-
|
|
21019
|
+
To use this property with Aurora PostgreSQL, it must be configured with the S3 export feature enabled when creating the DatabaseClusterEngine
|
|
20980
21020
|
For MySQL:
|
|
20981
21021
|
|
|
20982
21022
|
:default: - New role is created if ``s3ExportBuckets`` is set, no role is defined otherwise
|
|
@@ -21008,7 +21048,7 @@ class DatabaseClusterProps:
|
|
|
21008
21048
|
This feature is only supported by the Aurora database engine.
|
|
21009
21049
|
|
|
21010
21050
|
This property must not be used if ``s3ImportBuckets`` is used.
|
|
21011
|
-
|
|
21051
|
+
To use this property with Aurora PostgreSQL, it must be configured with the S3 import feature enabled when creating the DatabaseClusterEngine
|
|
21012
21052
|
For MySQL:
|
|
21013
21053
|
|
|
21014
21054
|
:default: - New role is created if ``s3ImportBuckets`` is set, no role is defined otherwise
|
|
@@ -39287,9 +39327,9 @@ class DatabaseClusterFromSnapshot(
|
|
|
39287
39327
|
:param readers: A list of instances to create as cluster reader instances. Default: - no readers are created. The cluster will have a single writer/reader
|
|
39288
39328
|
:param removal_policy: The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update. Default: - RemovalPolicy.SNAPSHOT (remove the cluster and instances, but retain a snapshot of the data)
|
|
39289
39329
|
:param s3_export_buckets: S3 buckets that you want to load data into. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ExportRole`` is used. For MySQL: Default: - None
|
|
39290
|
-
:param s3_export_role: Role that will be associated with this DB cluster to enable S3 export. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ExportBuckets`` is used. For MySQL: Default: - New role is created if ``s3ExportBuckets`` is set, no role is defined otherwise
|
|
39330
|
+
:param s3_export_role: Role that will be associated with this DB cluster to enable S3 export. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ExportBuckets`` is used. To use this property with Aurora PostgreSQL, it must be configured with the S3 export feature enabled when creating the DatabaseClusterEngine For MySQL: Default: - New role is created if ``s3ExportBuckets`` is set, no role is defined otherwise
|
|
39291
39331
|
:param s3_import_buckets: S3 buckets that you want to load data from. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ImportRole`` is used. For MySQL: Default: - None
|
|
39292
|
-
:param s3_import_role: Role that will be associated with this DB cluster to enable S3 import. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ImportBuckets`` is used. For MySQL: Default: - New role is created if ``s3ImportBuckets`` is set, no role is defined otherwise
|
|
39332
|
+
:param s3_import_role: Role that will be associated with this DB cluster to enable S3 import. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ImportBuckets`` is used. To use this property with Aurora PostgreSQL, it must be configured with the S3 import feature enabled when creating the DatabaseClusterEngine For MySQL: Default: - New role is created if ``s3ImportBuckets`` is set, no role is defined otherwise
|
|
39293
39333
|
:param security_groups: Security group. Default: a new security group is created.
|
|
39294
39334
|
:param serverless_v2_max_capacity: 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 (256GB). The maximum capacity must be higher than 0.5 ACUs. Default: 2
|
|
39295
39335
|
:param serverless_v2_min_capacity: 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. Default: 0.5
|
|
@@ -43282,9 +43322,9 @@ class DatabaseCluster(
|
|
|
43282
43322
|
:param readers: A list of instances to create as cluster reader instances. Default: - no readers are created. The cluster will have a single writer/reader
|
|
43283
43323
|
:param removal_policy: The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update. Default: - RemovalPolicy.SNAPSHOT (remove the cluster and instances, but retain a snapshot of the data)
|
|
43284
43324
|
:param s3_export_buckets: S3 buckets that you want to load data into. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ExportRole`` is used. For MySQL: Default: - None
|
|
43285
|
-
:param s3_export_role: Role that will be associated with this DB cluster to enable S3 export. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ExportBuckets`` is used. For MySQL: Default: - New role is created if ``s3ExportBuckets`` is set, no role is defined otherwise
|
|
43325
|
+
:param s3_export_role: Role that will be associated with this DB cluster to enable S3 export. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ExportBuckets`` is used. To use this property with Aurora PostgreSQL, it must be configured with the S3 export feature enabled when creating the DatabaseClusterEngine For MySQL: Default: - New role is created if ``s3ExportBuckets`` is set, no role is defined otherwise
|
|
43286
43326
|
:param s3_import_buckets: S3 buckets that you want to load data from. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ImportRole`` is used. For MySQL: Default: - None
|
|
43287
|
-
:param s3_import_role: Role that will be associated with this DB cluster to enable S3 import. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ImportBuckets`` is used. For MySQL: Default: - New role is created if ``s3ImportBuckets`` is set, no role is defined otherwise
|
|
43327
|
+
:param s3_import_role: Role that will be associated with this DB cluster to enable S3 import. This feature is only supported by the Aurora database engine. This property must not be used if ``s3ImportBuckets`` is used. To use this property with Aurora PostgreSQL, it must be configured with the S3 import feature enabled when creating the DatabaseClusterEngine For MySQL: Default: - New role is created if ``s3ImportBuckets`` is set, no role is defined otherwise
|
|
43288
43328
|
:param security_groups: Security group. Default: a new security group is created.
|
|
43289
43329
|
:param serverless_v2_max_capacity: 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 (256GB). The maximum capacity must be higher than 0.5 ACUs. Default: 2
|
|
43290
43330
|
:param serverless_v2_min_capacity: 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. Default: 0.5
|