aws-cdk-lib 2.149.0__py3-none-any.whl → 2.151.0__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 +6 -16
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.149.0.jsii.tgz → aws-cdk-lib@2.151.0.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 +58 -46
- aws_cdk/aws_cleanrooms/__init__.py +5 -5
- aws_cdk/aws_cloudformation/__init__.py +4 -8
- aws_cdk/aws_cloudfront/__init__.py +102 -32
- aws_cdk/aws_cloudtrail/__init__.py +34 -558
- aws_cdk/aws_cloudwatch/__init__.py +1 -1
- aws_cdk/aws_codepipeline/__init__.py +11 -5
- aws_cdk/aws_cognito/__init__.py +1 -2
- aws_cdk/aws_ec2/__init__.py +263 -7
- aws_cdk/aws_ecs/__init__.py +16 -10
- aws_cdk/aws_eks/__init__.py +26 -20
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +106 -11
- aws_cdk/aws_emr/__init__.py +18 -20
- aws_cdk/aws_entityresolution/__init__.py +27 -21
- aws_cdk/aws_events/__init__.py +83 -16
- aws_cdk/aws_fsx/__init__.py +25 -23
- aws_cdk/aws_glue/__init__.py +3 -3
- aws_cdk/aws_guardduty/__init__.py +6 -4
- aws_cdk/aws_iam/__init__.py +19 -29
- aws_cdk/aws_iotsitewise/__init__.py +8 -8
- aws_cdk/aws_lambda/__init__.py +21 -2
- aws_cdk/aws_logs/__init__.py +9 -0
- aws_cdk/aws_mwaa/__init__.py +3 -3
- aws_cdk/aws_pipes/__init__.py +2 -2
- aws_cdk/aws_qbusiness/__init__.py +21 -7
- aws_cdk/aws_rds/__init__.py +252 -206
- aws_cdk/aws_s3/__init__.py +8 -2
- aws_cdk/aws_sagemaker/__init__.py +10 -10
- 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 +23 -8
- aws_cdk/aws_synthetics/__init__.py +174 -22
- aws_cdk/custom_resources/__init__.py +91 -23
- aws_cdk/pipelines/__init__.py +1 -1
- aws_cdk/region_info/__init__.py +32 -12
- {aws_cdk_lib-2.149.0.dist-info → aws_cdk_lib-2.151.0.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.149.0.dist-info → aws_cdk_lib-2.151.0.dist-info}/RECORD +48 -48
- {aws_cdk_lib-2.149.0.dist-info → aws_cdk_lib-2.151.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.149.0.dist-info → aws_cdk_lib-2.151.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.149.0.dist-info → aws_cdk_lib-2.151.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.149.0.dist-info → aws_cdk_lib-2.151.0.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
|
|
@@ -4665,7 +4666,7 @@ class CfnDBCluster(
|
|
|
4665
4666
|
:param port: The port number on which the DB instances in the DB cluster accept connections. Default: - When ``EngineMode`` is ``provisioned`` , ``3306`` (for both Aurora MySQL and Aurora PostgreSQL) - When ``EngineMode`` is ``serverless`` : - ``3306`` when ``Engine`` is ``aurora`` or ``aurora-mysql`` - ``5432`` when ``Engine`` is ``aurora-postgresql`` .. epigraph:: The ``No interruption`` on update behavior only applies to DB clusters. If you are updating a DB instance, see `Port <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port>`_ for the AWS::RDS::DBInstance resource. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
4666
4667
|
:param preferred_backup_window: The daily time range during which automated backups are created. For more information, see `Backup Window <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow>`_ in the *Amazon Aurora User Guide.* 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. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
4667
4668
|
: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 Cluster Maintenance Window <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora>`_ in the *Amazon Aurora User Guide.* Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
4668
|
-
:param publicly_accessible: Specifies whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the
|
|
4669
|
+
:param publicly_accessible: Specifies whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. Valid for Cluster Type: Multi-AZ DB clusters only Default: The default behavior varies depending on whether ``DBSubnetGroupName`` is specified. If ``DBSubnetGroupName`` isn't specified, and ``PubliclyAccessible`` isn't specified, the following applies: - If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private. - If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public. If ``DBSubnetGroupName`` is specified, and ``PubliclyAccessible`` isn't specified, the following applies: - If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private. - If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
|
|
4669
4670
|
:param replication_source_identifier: The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica. Valid for: Aurora DB clusters only
|
|
4670
4671
|
:param restore_to_time: The date and time to restore the DB cluster to. Valid Values: Value must be a time in Universal Coordinated Time (UTC) format Constraints: - Must be before the latest restorable time for the DB instance - Must be specified if ``UseLatestRestorableTime`` parameter isn't provided - Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled - Can't be specified if the ``RestoreType`` parameter is ``copy-on-write`` This property must be used with ``SourceDBClusterIdentifier`` property. The resulting cluster will have the identifier that matches the value of the ``DBclusterIdentifier`` property. Example: ``2015-03-07T23:45:00Z`` Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
4671
4672
|
:param restore_type: The type of restore to be performed. You can specify one of the following values:. - ``full-copy`` - The new DB cluster is restored as a full copy of the source DB cluster. - ``copy-on-write`` - The new DB cluster is restored as a clone of the source DB cluster. If you don't specify a ``RestoreType`` value, then the new DB cluster is restored as a full copy of the source DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters Default: - "full-copy"
|
|
@@ -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
|
|
@@ -5894,7 +5895,7 @@ class CfnDBCluster(
|
|
|
5894
5895
|
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* and `Password management with AWS Secrets Manager <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html>`_ in the *Amazon Aurora User Guide.*
|
|
5895
5896
|
|
|
5896
5897
|
:param kms_key_id: The AWS KMS key identifier that is used to encrypt the secret.
|
|
5897
|
-
:param secret_arn: The Amazon Resource Name (ARN) of the secret.
|
|
5898
|
+
:param secret_arn: The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the ``Fn::GetAtt`` intrinsic function. For more information, see `Return values <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#aws-resource-rds-dbcluster-return-values>`_ .
|
|
5898
5899
|
|
|
5899
5900
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html
|
|
5900
5901
|
:exampleMetadata: fixture=_generated
|
|
@@ -5933,6 +5934,8 @@ class CfnDBCluster(
|
|
|
5933
5934
|
def secret_arn(self) -> typing.Optional[builtins.str]:
|
|
5934
5935
|
'''The Amazon Resource Name (ARN) of the secret.
|
|
5935
5936
|
|
|
5937
|
+
This parameter is a return value that you can retrieve using the ``Fn::GetAtt`` intrinsic function. For more information, see `Return values <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#aws-resource-rds-dbcluster-return-values>`_ .
|
|
5938
|
+
|
|
5936
5939
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html#cfn-rds-dbcluster-masterusersecret-secretarn
|
|
5937
5940
|
'''
|
|
5938
5941
|
result = self._values.get("secret_arn")
|
|
@@ -6283,7 +6286,7 @@ class CfnDBClusterParameterGroup(
|
|
|
6283
6286
|
|
|
6284
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.
|
|
6285
6288
|
|
|
6286
|
-
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.
|
|
6287
6290
|
|
|
6288
6291
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html
|
|
6289
6292
|
:cloudformationResource: AWS::RDS::DBClusterParameterGroup
|
|
@@ -6325,11 +6328,11 @@ class CfnDBClusterParameterGroup(
|
|
|
6325
6328
|
'''
|
|
6326
6329
|
:param scope: Scope in which this resource is defined.
|
|
6327
6330
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
6328
|
-
:param description:
|
|
6329
|
-
: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``
|
|
6330
6333
|
:param parameters: Provides a list of parameters for the DB cluster parameter group.
|
|
6331
|
-
: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.
|
|
6332
|
-
: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.
|
|
6333
6336
|
'''
|
|
6334
6337
|
if __debug__:
|
|
6335
6338
|
type_hints = typing.get_type_hints(_typecheckingstub__5d66d67784eaba0a01483098e06526f4c025b7ff96275fcc6e41e7d979aa520c)
|
|
@@ -6389,7 +6392,7 @@ class CfnDBClusterParameterGroup(
|
|
|
6389
6392
|
@builtins.property
|
|
6390
6393
|
@jsii.member(jsii_name="description")
|
|
6391
6394
|
def description(self) -> builtins.str:
|
|
6392
|
-
'''
|
|
6395
|
+
'''The description for the DB cluster parameter group.'''
|
|
6393
6396
|
return typing.cast(builtins.str, jsii.get(self, "description"))
|
|
6394
6397
|
|
|
6395
6398
|
@description.setter
|
|
@@ -6444,7 +6447,7 @@ class CfnDBClusterParameterGroup(
|
|
|
6444
6447
|
@builtins.property
|
|
6445
6448
|
@jsii.member(jsii_name="tagsRaw")
|
|
6446
6449
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
6447
|
-
'''
|
|
6450
|
+
'''Tags to assign to the DB cluster parameter group.'''
|
|
6448
6451
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
6449
6452
|
|
|
6450
6453
|
@tags_raw.setter
|
|
@@ -6478,11 +6481,11 @@ class CfnDBClusterParameterGroupProps:
|
|
|
6478
6481
|
) -> None:
|
|
6479
6482
|
'''Properties for defining a ``CfnDBClusterParameterGroup``.
|
|
6480
6483
|
|
|
6481
|
-
:param description:
|
|
6482
|
-
: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``
|
|
6483
6486
|
:param parameters: Provides a list of parameters for the DB cluster parameter group.
|
|
6484
|
-
: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.
|
|
6485
|
-
: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.
|
|
6486
6489
|
|
|
6487
6490
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html
|
|
6488
6491
|
:exampleMetadata: fixture=_generated
|
|
@@ -6527,7 +6530,7 @@ class CfnDBClusterParameterGroupProps:
|
|
|
6527
6530
|
|
|
6528
6531
|
@builtins.property
|
|
6529
6532
|
def description(self) -> builtins.str:
|
|
6530
|
-
'''
|
|
6533
|
+
'''The description for the DB cluster parameter group.
|
|
6531
6534
|
|
|
6532
6535
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-description
|
|
6533
6536
|
'''
|
|
@@ -6539,18 +6542,41 @@ class CfnDBClusterParameterGroupProps:
|
|
|
6539
6542
|
def family(self) -> builtins.str:
|
|
6540
6543
|
'''The DB cluster parameter group family name.
|
|
6541
6544
|
|
|
6542
|
-
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
|
|
6543
|
-
|
|
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
|
+
|
|
6547
|
+
*Aurora MySQL*
|
|
6548
|
+
|
|
6549
|
+
Example: ``aurora-mysql5.7`` , ``aurora-mysql8.0``
|
|
6550
|
+
|
|
6551
|
+
*Aurora PostgreSQL*
|
|
6552
|
+
|
|
6553
|
+
Example: ``aurora-postgresql14``
|
|
6554
|
+
|
|
6555
|
+
*RDS for MySQL*
|
|
6556
|
+
|
|
6557
|
+
Example: ``mysql8.0``
|
|
6558
|
+
|
|
6559
|
+
*RDS for PostgreSQL*
|
|
6544
6560
|
|
|
6545
|
-
|
|
6561
|
+
Example: ``postgres13``
|
|
6546
6562
|
|
|
6547
|
-
To list all of the available parameter group families, use the following command:
|
|
6563
|
+
To list all of the available parameter group families for a DB engine, use the following command:
|
|
6548
6564
|
|
|
6549
|
-
``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"
|
|
6565
|
+
``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>``
|
|
6550
6566
|
|
|
6551
|
-
|
|
6567
|
+
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
|
|
6552
6568
|
|
|
6553
|
-
|
|
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``
|
|
6554
6580
|
|
|
6555
6581
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-family
|
|
6556
6582
|
'''
|
|
@@ -6576,7 +6602,6 @@ class CfnDBClusterParameterGroupProps:
|
|
|
6576
6602
|
|
|
6577
6603
|
- Must not match the name of an existing DB cluster parameter group.
|
|
6578
6604
|
|
|
6579
|
-
If you don't specify a value for ``DBClusterParameterGroupName`` property, a name is automatically created for the DB cluster parameter group.
|
|
6580
6605
|
.. epigraph::
|
|
6581
6606
|
|
|
6582
6607
|
This value is stored as a lowercase string.
|
|
@@ -6588,7 +6613,7 @@ class CfnDBClusterParameterGroupProps:
|
|
|
6588
6613
|
|
|
6589
6614
|
@builtins.property
|
|
6590
6615
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
6591
|
-
'''
|
|
6616
|
+
'''Tags to assign to the DB cluster parameter group.
|
|
6592
6617
|
|
|
6593
6618
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-tags
|
|
6594
6619
|
'''
|
|
@@ -6736,7 +6761,7 @@ class CfnDBClusterProps:
|
|
|
6736
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
|
|
6737
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
|
|
6738
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
|
|
6739
|
-
: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
|
|
6740
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
|
|
6741
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
|
|
6742
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
|
|
@@ -6774,7 +6799,7 @@ class CfnDBClusterProps:
|
|
|
6774
6799
|
:param port: The port number on which the DB instances in the DB cluster accept connections. Default: - When ``EngineMode`` is ``provisioned`` , ``3306`` (for both Aurora MySQL and Aurora PostgreSQL) - When ``EngineMode`` is ``serverless`` : - ``3306`` when ``Engine`` is ``aurora`` or ``aurora-mysql`` - ``5432`` when ``Engine`` is ``aurora-postgresql`` .. epigraph:: The ``No interruption`` on update behavior only applies to DB clusters. If you are updating a DB instance, see `Port <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port>`_ for the AWS::RDS::DBInstance resource. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
6775
6800
|
:param preferred_backup_window: The daily time range during which automated backups are created. For more information, see `Backup Window <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow>`_ in the *Amazon Aurora User Guide.* 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. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
6776
6801
|
: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 Cluster Maintenance Window <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora>`_ in the *Amazon Aurora User Guide.* Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
6777
|
-
:param publicly_accessible: Specifies whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the
|
|
6802
|
+
:param publicly_accessible: Specifies whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. Valid for Cluster Type: Multi-AZ DB clusters only Default: The default behavior varies depending on whether ``DBSubnetGroupName`` is specified. If ``DBSubnetGroupName`` isn't specified, and ``PubliclyAccessible`` isn't specified, the following applies: - If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private. - If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public. If ``DBSubnetGroupName`` is specified, and ``PubliclyAccessible`` isn't specified, the following applies: - If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private. - If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
|
|
6778
6803
|
:param replication_source_identifier: The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica. Valid for: Aurora DB clusters only
|
|
6779
6804
|
:param restore_to_time: The date and time to restore the DB cluster to. Valid Values: Value must be a time in Universal Coordinated Time (UTC) format Constraints: - Must be before the latest restorable time for the DB instance - Must be specified if ``UseLatestRestorableTime`` parameter isn't provided - Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled - Can't be specified if the ``RestoreType`` parameter is ``copy-on-write`` This property must be used with ``SourceDBClusterIdentifier`` property. The resulting cluster will have the identifier that matches the value of the ``DBclusterIdentifier`` property. Example: ``2015-03-07T23:45:00Z`` Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
6780
6805
|
:param restore_type: The type of restore to be performed. You can specify one of the following values:. - ``full-copy`` - The new DB cluster is restored as a full copy of the source DB cluster. - ``copy-on-write`` - The new DB cluster is restored as a clone of the source DB cluster. If you don't specify a ``RestoreType`` value, then the new DB cluster is restored as a full copy of the source DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters Default: - "full-copy"
|
|
@@ -6785,7 +6810,7 @@ class CfnDBClusterProps:
|
|
|
6785
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
|
|
6786
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
|
|
6787
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`` .
|
|
6788
|
-
:param tags:
|
|
6813
|
+
:param tags: Tags to assign to the DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
6789
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
|
|
6790
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
|
|
6791
6816
|
|
|
@@ -7108,20 +7133,16 @@ class CfnDBClusterProps:
|
|
|
7108
7133
|
|
|
7109
7134
|
@builtins.property
|
|
7110
7135
|
def backtrack_window(self) -> typing.Optional[jsii.Number]:
|
|
7111
|
-
'''The target backtrack window, in seconds. To disable backtracking, set this value to 0.
|
|
7112
|
-
|
|
7113
|
-
.. epigraph::
|
|
7136
|
+
'''The target backtrack window, in seconds. To disable backtracking, set this value to ``0`` .
|
|
7114
7137
|
|
|
7115
|
-
|
|
7138
|
+
Valid for Cluster Type: Aurora MySQL DB clusters only
|
|
7116
7139
|
|
|
7117
|
-
Default: 0
|
|
7140
|
+
Default: ``0``
|
|
7118
7141
|
|
|
7119
7142
|
Constraints:
|
|
7120
7143
|
|
|
7121
7144
|
- If specified, this value must be set to a number from 0 to 259,200 (72 hours).
|
|
7122
7145
|
|
|
7123
|
-
Valid for: Aurora MySQL DB clusters only
|
|
7124
|
-
|
|
7125
7146
|
:default: - 0
|
|
7126
7147
|
|
|
7127
7148
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backtrackwindow
|
|
@@ -7809,7 +7830,7 @@ class CfnDBClusterProps:
|
|
|
7809
7830
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
7810
7831
|
'''Specifies whether the DB cluster is publicly accessible.
|
|
7811
7832
|
|
|
7812
|
-
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the
|
|
7833
|
+
When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
|
|
7813
7834
|
|
|
7814
7835
|
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
|
|
7815
7836
|
|
|
@@ -8029,9 +8050,9 @@ class CfnDBClusterProps:
|
|
|
8029
8050
|
|
|
8030
8051
|
@builtins.property
|
|
8031
8052
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
8032
|
-
'''
|
|
8053
|
+
'''Tags to assign to the DB cluster.
|
|
8033
8054
|
|
|
8034
|
-
Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
8055
|
+
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
8035
8056
|
|
|
8036
8057
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-tags
|
|
8037
8058
|
'''
|
|
@@ -8325,7 +8346,7 @@ class CfnDBInstance(
|
|
|
8325
8346
|
:param allow_major_version_upgrade: A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version.
|
|
8326
8347
|
:param associated_roles: The AWS Identity and Access Management (IAM) roles associated with the DB instance. *Amazon Aurora* Not applicable. The associated roles are managed by the DB cluster.
|
|
8327
8348
|
:param automatic_backup_replication_kms_key_id: The AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS Region , for example, ``arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE`` .
|
|
8328
|
-
:param automatic_backup_replication_region: The destination region for the backup replication of the DB instance. For more info, see `Replicating automated backups to another
|
|
8349
|
+
:param automatic_backup_replication_region: The destination region for the backup replication of the DB instance. For more info, see `Replicating automated backups to another Region <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html>`_ in the *Amazon RDS User Guide*.
|
|
8329
8350
|
:param auto_minor_version_upgrade: A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
|
|
8330
8351
|
:param availability_zone: The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see `Regions and Availability Zones <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html>`_ . For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region . Constraints: - The ``AvailabilityZone`` parameter can't be specified if the DB instance is a Multi-AZ deployment. - The specified Availability Zone must be in the same AWS Region as the current endpoint. Example: ``us-east-1d``
|
|
8331
8352
|
:param backup_retention_period: The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. *Amazon Aurora* Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: - Must be a value from 0 to 35 - Can't be set to 0 if the DB instance is a source to read replicas Default: - 1
|
|
@@ -8335,18 +8356,18 @@ class CfnDBInstance(
|
|
|
8335
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>`_ .
|
|
8336
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.
|
|
8337
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* .
|
|
8338
|
-
: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.
|
|
8339
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.
|
|
8340
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* .
|
|
8341
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.
|
|
8342
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.
|
|
8343
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.
|
|
8344
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.
|
|
8345
|
-
: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`` - ``
|
|
8346
|
-
: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.
|
|
8347
8368
|
:param dedicated_log_volume: Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
|
|
8348
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.
|
|
8349
|
-
: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.
|
|
8350
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* .
|
|
8351
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``
|
|
8352
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``
|
|
@@ -8368,15 +8389,15 @@ class CfnDBInstance(
|
|
|
8368
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.
|
|
8369
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.*
|
|
8370
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
|
|
8371
|
-
: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
|
|
8372
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.
|
|
8373
|
-
: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
|
|
8374
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.
|
|
8375
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.*
|
|
8376
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.
|
|
8377
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>`_ .
|
|
8378
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.
|
|
8379
|
-
: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`` .
|
|
8380
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.
|
|
8381
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.
|
|
8382
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.
|
|
@@ -8392,7 +8413,7 @@ class CfnDBInstance(
|
|
|
8392
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.
|
|
8393
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.
|
|
8394
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`` .
|
|
8395
|
-
:param tags:
|
|
8416
|
+
:param tags: Tags to assign to the DB instance.
|
|
8396
8417
|
:param tde_credential_arn:
|
|
8397
8418
|
:param tde_credential_password:
|
|
8398
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>`_ .
|
|
@@ -8604,6 +8625,8 @@ class CfnDBInstance(
|
|
|
8604
8625
|
def attr_master_user_secret_secret_arn(self) -> builtins.str:
|
|
8605
8626
|
'''The Amazon Resource Name (ARN) of the secret.
|
|
8606
8627
|
|
|
8628
|
+
This parameter is a return value that you can retrieve using the ``Fn::GetAtt`` intrinsic function. For more information, see `Return values <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#aws-resource-rds-dbinstance-return-values>`_ .
|
|
8629
|
+
|
|
8607
8630
|
:cloudformationAttribute: MasterUserSecret.SecretArn
|
|
8608
8631
|
'''
|
|
8609
8632
|
return typing.cast(builtins.str, jsii.get(self, "attrMasterUserSecretSecretArn"))
|
|
@@ -8840,7 +8863,7 @@ class CfnDBInstance(
|
|
|
8840
8863
|
@builtins.property
|
|
8841
8864
|
@jsii.member(jsii_name="dbClusterIdentifier")
|
|
8842
8865
|
def db_cluster_identifier(self) -> typing.Optional[builtins.str]:
|
|
8843
|
-
'''The identifier of the DB cluster that
|
|
8866
|
+
'''The identifier of the DB cluster that this DB instance will belong to.'''
|
|
8844
8867
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "dbClusterIdentifier"))
|
|
8845
8868
|
|
|
8846
8869
|
@db_cluster_identifier.setter
|
|
@@ -9001,7 +9024,7 @@ class CfnDBInstance(
|
|
|
9001
9024
|
def deletion_protection(
|
|
9002
9025
|
self,
|
|
9003
9026
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
9004
|
-
'''
|
|
9027
|
+
'''Specifies whether the DB instance has deletion protection enabled.'''
|
|
9005
9028
|
return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], jsii.get(self, "deletionProtection"))
|
|
9006
9029
|
|
|
9007
9030
|
@deletion_protection.setter
|
|
@@ -9351,7 +9374,7 @@ class CfnDBInstance(
|
|
|
9351
9374
|
def multi_az(
|
|
9352
9375
|
self,
|
|
9353
9376
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
9354
|
-
'''Specifies whether the
|
|
9377
|
+
'''Specifies whether the DB instance is a Multi-AZ deployment.'''
|
|
9355
9378
|
return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], jsii.get(self, "multiAz"))
|
|
9356
9379
|
|
|
9357
9380
|
@multi_az.setter
|
|
@@ -9679,7 +9702,7 @@ class CfnDBInstance(
|
|
|
9679
9702
|
@builtins.property
|
|
9680
9703
|
@jsii.member(jsii_name="tagsRaw")
|
|
9681
9704
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
9682
|
-
'''
|
|
9705
|
+
'''Tags to assign to the DB instance.'''
|
|
9683
9706
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
9684
9707
|
|
|
9685
9708
|
@tags_raw.setter
|
|
@@ -10047,7 +10070,7 @@ class CfnDBInstance(
|
|
|
10047
10070
|
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* and `Password management with AWS Secrets Manager <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html>`_ in the *Amazon Aurora User Guide.*
|
|
10048
10071
|
|
|
10049
10072
|
:param kms_key_id: The AWS KMS key identifier that is used to encrypt the secret.
|
|
10050
|
-
:param secret_arn: The Amazon Resource Name (ARN) of the secret.
|
|
10073
|
+
:param secret_arn: The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the ``Fn::GetAtt`` intrinsic function. For more information, see `Return values <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#aws-resource-rds-dbinstance-return-values>`_ .
|
|
10051
10074
|
|
|
10052
10075
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-masterusersecret.html
|
|
10053
10076
|
:exampleMetadata: fixture=_generated
|
|
@@ -10086,6 +10109,8 @@ class CfnDBInstance(
|
|
|
10086
10109
|
def secret_arn(self) -> typing.Optional[builtins.str]:
|
|
10087
10110
|
'''The Amazon Resource Name (ARN) of the secret.
|
|
10088
10111
|
|
|
10112
|
+
This parameter is a return value that you can retrieve using the ``Fn::GetAtt`` intrinsic function. For more information, see `Return values <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#aws-resource-rds-dbinstance-return-values>`_ .
|
|
10113
|
+
|
|
10089
10114
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-masterusersecret.html#cfn-rds-dbinstance-masterusersecret-secretarn
|
|
10090
10115
|
'''
|
|
10091
10116
|
result = self._values.get("secret_arn")
|
|
@@ -10114,7 +10139,7 @@ class CfnDBInstance(
|
|
|
10114
10139
|
name: typing.Optional[builtins.str] = None,
|
|
10115
10140
|
value: typing.Optional[builtins.str] = None,
|
|
10116
10141
|
) -> None:
|
|
10117
|
-
'''The ``ProcessorFeature`` property type specifies the processor features of a DB instance class
|
|
10142
|
+
'''The ``ProcessorFeature`` property type specifies the processor features of a DB instance class.
|
|
10118
10143
|
|
|
10119
10144
|
:param name: The name of the processor feature. Valid names are ``coreCount`` and ``threadsPerCore`` .
|
|
10120
10145
|
:param value: The value of a processor feature.
|
|
@@ -10348,7 +10373,7 @@ class CfnDBInstanceProps:
|
|
|
10348
10373
|
:param allow_major_version_upgrade: A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version.
|
|
10349
10374
|
:param associated_roles: The AWS Identity and Access Management (IAM) roles associated with the DB instance. *Amazon Aurora* Not applicable. The associated roles are managed by the DB cluster.
|
|
10350
10375
|
:param automatic_backup_replication_kms_key_id: The AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS Region , for example, ``arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE`` .
|
|
10351
|
-
:param automatic_backup_replication_region: The destination region for the backup replication of the DB instance. For more info, see `Replicating automated backups to another
|
|
10376
|
+
:param automatic_backup_replication_region: The destination region for the backup replication of the DB instance. For more info, see `Replicating automated backups to another Region <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html>`_ in the *Amazon RDS User Guide*.
|
|
10352
10377
|
:param auto_minor_version_upgrade: A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
|
|
10353
10378
|
:param availability_zone: The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see `Regions and Availability Zones <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html>`_ . For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region . Constraints: - The ``AvailabilityZone`` parameter can't be specified if the DB instance is a Multi-AZ deployment. - The specified Availability Zone must be in the same AWS Region as the current endpoint. Example: ``us-east-1d``
|
|
10354
10379
|
:param backup_retention_period: The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. *Amazon Aurora* Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: - Must be a value from 0 to 35 - Can't be set to 0 if the DB instance is a source to read replicas Default: - 1
|
|
@@ -10358,18 +10383,18 @@ class CfnDBInstanceProps:
|
|
|
10358
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>`_ .
|
|
10359
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.
|
|
10360
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* .
|
|
10361
|
-
: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.
|
|
10362
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.
|
|
10363
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* .
|
|
10364
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.
|
|
10365
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.
|
|
10366
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.
|
|
10367
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.
|
|
10368
|
-
: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`` - ``
|
|
10369
|
-
: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.
|
|
10370
10395
|
:param dedicated_log_volume: Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
|
|
10371
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.
|
|
10372
|
-
: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.
|
|
10373
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* .
|
|
10374
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``
|
|
10375
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``
|
|
@@ -10391,15 +10416,15 @@ class CfnDBInstanceProps:
|
|
|
10391
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.
|
|
10392
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.*
|
|
10393
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
|
|
10394
|
-
: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
|
|
10395
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.
|
|
10396
|
-
: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
|
|
10397
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.
|
|
10398
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.*
|
|
10399
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.
|
|
10400
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>`_ .
|
|
10401
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.
|
|
10402
|
-
: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`` .
|
|
10403
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.
|
|
10404
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.
|
|
10405
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.
|
|
@@ -10415,7 +10440,7 @@ class CfnDBInstanceProps:
|
|
|
10415
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.
|
|
10416
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.
|
|
10417
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`` .
|
|
10418
|
-
:param tags:
|
|
10443
|
+
:param tags: Tags to assign to the DB instance.
|
|
10419
10444
|
:param tde_credential_arn:
|
|
10420
10445
|
:param tde_credential_password:
|
|
10421
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>`_ .
|
|
@@ -10885,7 +10910,7 @@ class CfnDBInstanceProps:
|
|
|
10885
10910
|
def automatic_backup_replication_region(self) -> typing.Optional[builtins.str]:
|
|
10886
10911
|
'''The destination region for the backup replication of the DB instance.
|
|
10887
10912
|
|
|
10888
|
-
For more info, see `Replicating automated backups to another
|
|
10913
|
+
For more info, see `Replicating automated backups to another Region <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html>`_ in the *Amazon RDS User Guide*.
|
|
10889
10914
|
|
|
10890
10915
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-automaticbackupreplicationregion
|
|
10891
10916
|
'''
|
|
@@ -11045,7 +11070,9 @@ class CfnDBInstanceProps:
|
|
|
11045
11070
|
|
|
11046
11071
|
@builtins.property
|
|
11047
11072
|
def db_cluster_identifier(self) -> typing.Optional[builtins.str]:
|
|
11048
|
-
'''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.
|
|
11049
11076
|
|
|
11050
11077
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbclusteridentifier
|
|
11051
11078
|
'''
|
|
@@ -11240,7 +11267,6 @@ class CfnDBInstanceProps:
|
|
|
11240
11267
|
- ``DBClusterIdentifier``
|
|
11241
11268
|
- ``DBName``
|
|
11242
11269
|
- ``DeleteAutomatedBackups``
|
|
11243
|
-
- ``EnablePerformanceInsights``
|
|
11244
11270
|
- ``KmsKeyId``
|
|
11245
11271
|
- ``MasterUsername``
|
|
11246
11272
|
- ``MasterUserPassword``
|
|
@@ -11269,11 +11295,9 @@ class CfnDBInstanceProps:
|
|
|
11269
11295
|
|
|
11270
11296
|
If there's no DB subnet group, then the DB instance isn't a VPC DB instance.
|
|
11271
11297
|
|
|
11272
|
-
For more information about using Amazon RDS in a VPC, see `
|
|
11273
|
-
|
|
11274
|
-
*Amazon Aurora*
|
|
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* .
|
|
11275
11299
|
|
|
11276
|
-
|
|
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.
|
|
11277
11301
|
|
|
11278
11302
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbsubnetgroupname
|
|
11279
11303
|
'''
|
|
@@ -11312,13 +11336,11 @@ class CfnDBInstanceProps:
|
|
|
11312
11336
|
def deletion_protection(
|
|
11313
11337
|
self,
|
|
11314
11338
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
11315
|
-
'''
|
|
11339
|
+
'''Specifies whether the DB instance has deletion protection enabled.
|
|
11316
11340
|
|
|
11317
|
-
The database can't be deleted when deletion protection is enabled. By default, deletion protection
|
|
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>`_ .
|
|
11318
11342
|
|
|
11319
|
-
|
|
11320
|
-
|
|
11321
|
-
Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster`` . DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
|
|
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.
|
|
11322
11344
|
|
|
11323
11345
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-deletionprotection
|
|
11324
11346
|
'''
|
|
@@ -11823,13 +11845,15 @@ class CfnDBInstanceProps:
|
|
|
11823
11845
|
def monitoring_interval(self) -> typing.Optional[jsii.Number]:
|
|
11824
11846
|
'''The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
|
11825
11847
|
|
|
11826
|
-
To disable collection of Enhanced Monitoring metrics, specify 0
|
|
11848
|
+
To disable collection of Enhanced Monitoring metrics, specify ``0`` .
|
|
11827
11849
|
|
|
11828
|
-
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`` .
|
|
11829
11851
|
|
|
11830
|
-
This setting doesn't apply to RDS Custom.
|
|
11852
|
+
This setting doesn't apply to RDS Custom DB instances.
|
|
11831
11853
|
|
|
11832
|
-
Valid Values: ``0
|
|
11854
|
+
Valid Values: ``0 | 1 | 5 | 10 | 15 | 30 | 60``
|
|
11855
|
+
|
|
11856
|
+
Default: ``0``
|
|
11833
11857
|
|
|
11834
11858
|
:default: - 0
|
|
11835
11859
|
|
|
@@ -11857,15 +11881,14 @@ class CfnDBInstanceProps:
|
|
|
11857
11881
|
def multi_az(
|
|
11858
11882
|
self,
|
|
11859
11883
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
11860
|
-
'''Specifies whether the
|
|
11861
|
-
|
|
11862
|
-
You can't set the ``AvailabilityZone`` parameter if the ``MultiAZ`` parameter is set to true.
|
|
11884
|
+
'''Specifies whether the DB instance is a Multi-AZ deployment.
|
|
11863
11885
|
|
|
11864
|
-
|
|
11886
|
+
You can't set the ``AvailabilityZone`` parameter if the DB instance is a Multi-AZ deployment.
|
|
11865
11887
|
|
|
11866
|
-
|
|
11888
|
+
This setting doesn't apply to the following DB instances:
|
|
11867
11889
|
|
|
11868
|
-
|
|
11890
|
+
- Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
|
|
11891
|
+
- RDS Custom
|
|
11869
11892
|
|
|
11870
11893
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-multiaz
|
|
11871
11894
|
'''
|
|
@@ -11952,13 +11975,22 @@ class CfnDBInstanceProps:
|
|
|
11952
11975
|
def port(self) -> typing.Optional[builtins.str]:
|
|
11953
11976
|
'''The port number on which the database accepts connections.
|
|
11954
11977
|
|
|
11955
|
-
|
|
11978
|
+
This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.
|
|
11956
11979
|
|
|
11957
|
-
|
|
11980
|
+
Valid Values: ``1150-65535``
|
|
11958
11981
|
|
|
11959
|
-
|
|
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``
|
|
11960
11990
|
|
|
11961
|
-
|
|
11991
|
+
Constraints:
|
|
11992
|
+
|
|
11993
|
+
- For RDS for Microsoft SQL Server, the value can't be ``1234`` , ``1434`` , ``3260`` , ``3343`` , ``3389`` , ``47001`` , or ``49152-49156`` .
|
|
11962
11994
|
|
|
11963
11995
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-port
|
|
11964
11996
|
'''
|
|
@@ -12211,7 +12243,7 @@ class CfnDBInstanceProps:
|
|
|
12211
12243
|
|
|
12212
12244
|
@builtins.property
|
|
12213
12245
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
12214
|
-
'''
|
|
12246
|
+
'''Tags to assign to the DB instance.
|
|
12215
12247
|
|
|
12216
12248
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-tags
|
|
12217
12249
|
'''
|
|
@@ -12379,10 +12411,10 @@ class CfnDBParameterGroup(
|
|
|
12379
12411
|
:param scope: Scope in which this resource is defined.
|
|
12380
12412
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
12381
12413
|
:param description: Provides the customer-specified description for this DB parameter group.
|
|
12382
|
-
: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``
|
|
12383
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.
|
|
12384
|
-
:param parameters: An array of parameter names and values for the parameter update.
|
|
12385
|
-
: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.
|
|
12386
12418
|
'''
|
|
12387
12419
|
if __debug__:
|
|
12388
12420
|
type_hints = typing.get_type_hints(_typecheckingstub__c10aa78132a0eae6199258b5e55e45968fdce240e932138b48918eafb4c5da7b)
|
|
@@ -12503,7 +12535,7 @@ class CfnDBParameterGroup(
|
|
|
12503
12535
|
@builtins.property
|
|
12504
12536
|
@jsii.member(jsii_name="tagsRaw")
|
|
12505
12537
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
12506
|
-
'''
|
|
12538
|
+
'''Tags to assign to the DB parameter group.'''
|
|
12507
12539
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
12508
12540
|
|
|
12509
12541
|
@tags_raw.setter
|
|
@@ -12538,10 +12570,10 @@ class CfnDBParameterGroupProps:
|
|
|
12538
12570
|
'''Properties for defining a ``CfnDBParameterGroup``.
|
|
12539
12571
|
|
|
12540
12572
|
:param description: Provides the customer-specified description for this DB parameter group.
|
|
12541
|
-
: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``
|
|
12542
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.
|
|
12543
|
-
:param parameters: An array of parameter names and values for the parameter update.
|
|
12544
|
-
: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.
|
|
12545
12577
|
|
|
12546
12578
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html
|
|
12547
12579
|
:exampleMetadata: fixture=_generated
|
|
@@ -12599,18 +12631,35 @@ class CfnDBParameterGroupProps:
|
|
|
12599
12631
|
def family(self) -> builtins.str:
|
|
12600
12632
|
'''The DB parameter group family name.
|
|
12601
12633
|
|
|
12602
|
-
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
|
|
12603
|
-
.. epigraph::
|
|
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.
|
|
12604
12635
|
|
|
12605
|
-
|
|
12636
|
+
To list all of the available parameter group families for a DB engine, use the following command:
|
|
12606
12637
|
|
|
12607
|
-
|
|
12638
|
+
``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>``
|
|
12608
12639
|
|
|
12609
|
-
|
|
12640
|
+
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
|
|
12610
12641
|
|
|
12611
|
-
|
|
12642
|
+
``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql``
|
|
12643
|
+
.. epigraph::
|
|
12644
|
+
|
|
12645
|
+
The output contains duplicates.
|
|
12612
12646
|
|
|
12613
|
-
|
|
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``
|
|
12614
12663
|
|
|
12615
12664
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-family
|
|
12616
12665
|
'''
|
|
@@ -12642,13 +12691,9 @@ class CfnDBParameterGroupProps:
|
|
|
12642
12691
|
def parameters(self) -> typing.Any:
|
|
12643
12692
|
'''An array of parameter names and values for the parameter update.
|
|
12644
12693
|
|
|
12645
|
-
|
|
12646
|
-
|
|
12647
|
-
RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID ( ``rds.ibm_customer_id`` ) and site number ( ``rds.ibm_site_id`` ) before starting a Db2 instance.
|
|
12648
|
-
|
|
12649
|
-
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* .
|
|
12694
|
+
You must specify at least one parameter name and value.
|
|
12650
12695
|
|
|
12651
|
-
For more information about
|
|
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* .
|
|
12652
12697
|
.. epigraph::
|
|
12653
12698
|
|
|
12654
12699
|
AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.
|
|
@@ -12660,11 +12705,7 @@ class CfnDBParameterGroupProps:
|
|
|
12660
12705
|
|
|
12661
12706
|
@builtins.property
|
|
12662
12707
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
12663
|
-
'''
|
|
12664
|
-
|
|
12665
|
-
.. epigraph::
|
|
12666
|
-
|
|
12667
|
-
Currently, this is the only property that supports drift detection.
|
|
12708
|
+
'''Tags to assign to the DB parameter group.
|
|
12668
12709
|
|
|
12669
12710
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-tags
|
|
12670
12711
|
'''
|
|
@@ -12758,7 +12799,7 @@ class CfnDBProxy(
|
|
|
12758
12799
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
12759
12800
|
:param auth: The authorization mechanism that the proxy uses.
|
|
12760
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.
|
|
12761
|
-
: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`` .
|
|
12762
12803
|
:param role_arn: The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
|
|
12763
12804
|
:param vpc_subnet_ids: One or more VPC subnet IDs to associate with the new proxy.
|
|
12764
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.
|
|
@@ -12819,7 +12860,7 @@ class CfnDBProxy(
|
|
|
12819
12860
|
@builtins.property
|
|
12820
12861
|
@jsii.member(jsii_name="attrDbProxyArn")
|
|
12821
12862
|
def attr_db_proxy_arn(self) -> builtins.str:
|
|
12822
|
-
'''The Amazon Resource Name (ARN)
|
|
12863
|
+
'''The Amazon Resource Name (ARN) for the proxy.
|
|
12823
12864
|
|
|
12824
12865
|
:cloudformationAttribute: DBProxyArn
|
|
12825
12866
|
'''
|
|
@@ -12828,7 +12869,9 @@ class CfnDBProxy(
|
|
|
12828
12869
|
@builtins.property
|
|
12829
12870
|
@jsii.member(jsii_name="attrEndpoint")
|
|
12830
12871
|
def attr_endpoint(self) -> builtins.str:
|
|
12831
|
-
'''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.
|
|
12832
12875
|
|
|
12833
12876
|
:cloudformationAttribute: Endpoint
|
|
12834
12877
|
'''
|
|
@@ -13028,10 +13071,10 @@ class CfnDBProxy(
|
|
|
13028
13071
|
) -> None:
|
|
13029
13072
|
'''Specifies the details of authentication used by a proxy to log in as a specific database user.
|
|
13030
13073
|
|
|
13031
|
-
: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.
|
|
13032
13075
|
:param client_password_auth_type: Specifies the details of authentication used by a proxy to log in as a specific database user.
|
|
13033
13076
|
:param description: A user-specified description about the authentication used by a proxy to log in as a specific database user.
|
|
13034
|
-
: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.
|
|
13035
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.
|
|
13036
13079
|
|
|
13037
13080
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html
|
|
@@ -13074,8 +13117,6 @@ class CfnDBProxy(
|
|
|
13074
13117
|
def auth_scheme(self) -> typing.Optional[builtins.str]:
|
|
13075
13118
|
'''The type of authentication that the proxy uses for connections from the proxy to the underlying database.
|
|
13076
13119
|
|
|
13077
|
-
Valid Values: ``SECRETS``
|
|
13078
|
-
|
|
13079
13120
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-authscheme
|
|
13080
13121
|
'''
|
|
13081
13122
|
result = self._values.get("auth_scheme")
|
|
@@ -13101,12 +13142,10 @@ class CfnDBProxy(
|
|
|
13101
13142
|
|
|
13102
13143
|
@builtins.property
|
|
13103
13144
|
def iam_auth(self) -> typing.Optional[builtins.str]:
|
|
13104
|
-
'''
|
|
13145
|
+
'''A value that indicates whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
|
|
13105
13146
|
|
|
13106
13147
|
The ``ENABLED`` value is valid only for proxies with RDS for Microsoft SQL Server.
|
|
13107
13148
|
|
|
13108
|
-
Valid Values: ``ENABLED | DISABLED | REQUIRED``
|
|
13109
|
-
|
|
13110
13149
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-iamauth
|
|
13111
13150
|
'''
|
|
13112
13151
|
result = self._values.get("iam_auth")
|
|
@@ -13146,10 +13185,12 @@ class CfnDBProxy(
|
|
|
13146
13185
|
key: typing.Optional[builtins.str] = None,
|
|
13147
13186
|
value: typing.Optional[builtins.str] = None,
|
|
13148
13187
|
) -> None:
|
|
13149
|
-
'''Metadata assigned to
|
|
13188
|
+
'''Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
|
|
13189
|
+
|
|
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* .
|
|
13150
13191
|
|
|
13151
|
-
:param key: A key is the required name of the tag. The string value can be 1
|
|
13152
|
-
:param value: A value is the optional value of the tag. The string value can be 1
|
|
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}*.:/=+\\-@]*)$").
|
|
13153
13194
|
|
|
13154
13195
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-tagformat.html
|
|
13155
13196
|
:exampleMetadata: fixture=_generated
|
|
@@ -13179,7 +13220,7 @@ class CfnDBProxy(
|
|
|
13179
13220
|
def key(self) -> typing.Optional[builtins.str]:
|
|
13180
13221
|
'''A key is the required name of the tag.
|
|
13181
13222
|
|
|
13182
|
-
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}*.:/=+-@]*)$").
|
|
13183
13224
|
|
|
13184
13225
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-tagformat.html#cfn-rds-dbproxy-tagformat-key
|
|
13185
13226
|
'''
|
|
@@ -13190,7 +13231,7 @@ class CfnDBProxy(
|
|
|
13190
13231
|
def value(self) -> typing.Optional[builtins.str]:
|
|
13191
13232
|
'''A value is the optional value of the tag.
|
|
13192
13233
|
|
|
13193
|
-
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}*.:/=+-@]*)$").
|
|
13194
13235
|
|
|
13195
13236
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-tagformat.html#cfn-rds-dbproxy-tagformat-value
|
|
13196
13237
|
'''
|
|
@@ -13265,7 +13306,7 @@ class CfnDBProxyEndpoint(
|
|
|
13265
13306
|
:param db_proxy_name: The name of the DB proxy associated with the DB proxy endpoint that you create.
|
|
13266
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.
|
|
13267
13308
|
:param tags: An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
|
|
13268
|
-
: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.
|
|
13269
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.
|
|
13270
13311
|
'''
|
|
13271
13312
|
if __debug__:
|
|
@@ -13316,7 +13357,7 @@ class CfnDBProxyEndpoint(
|
|
|
13316
13357
|
@builtins.property
|
|
13317
13358
|
@jsii.member(jsii_name="attrDbProxyEndpointArn")
|
|
13318
13359
|
def attr_db_proxy_endpoint_arn(self) -> builtins.str:
|
|
13319
|
-
'''The Amazon Resource Name (ARN)
|
|
13360
|
+
'''The Amazon Resource Name (ARN) for the DB proxy endpoint.
|
|
13320
13361
|
|
|
13321
13362
|
:cloudformationAttribute: DBProxyEndpointArn
|
|
13322
13363
|
'''
|
|
@@ -13325,7 +13366,9 @@ class CfnDBProxyEndpoint(
|
|
|
13325
13366
|
@builtins.property
|
|
13326
13367
|
@jsii.member(jsii_name="attrEndpoint")
|
|
13327
13368
|
def attr_endpoint(self) -> builtins.str:
|
|
13328
|
-
'''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.
|
|
13329
13372
|
|
|
13330
13373
|
:cloudformationAttribute: Endpoint
|
|
13331
13374
|
'''
|
|
@@ -13334,7 +13377,7 @@ class CfnDBProxyEndpoint(
|
|
|
13334
13377
|
@builtins.property
|
|
13335
13378
|
@jsii.member(jsii_name="attrIsDefault")
|
|
13336
13379
|
def attr_is_default(self) -> _IResolvable_da3f097b:
|
|
13337
|
-
'''
|
|
13380
|
+
'''Indicates whether this endpoint is the default endpoint for the associated DB proxy.
|
|
13338
13381
|
|
|
13339
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.
|
|
13340
13383
|
|
|
@@ -13345,7 +13388,7 @@ class CfnDBProxyEndpoint(
|
|
|
13345
13388
|
@builtins.property
|
|
13346
13389
|
@jsii.member(jsii_name="attrVpcId")
|
|
13347
13390
|
def attr_vpc_id(self) -> builtins.str:
|
|
13348
|
-
'''
|
|
13391
|
+
'''Provides the VPC ID of the DB proxy endpoint.
|
|
13349
13392
|
|
|
13350
13393
|
:cloudformationAttribute: VpcId
|
|
13351
13394
|
'''
|
|
@@ -13460,10 +13503,12 @@ class CfnDBProxyEndpoint(
|
|
|
13460
13503
|
key: typing.Optional[builtins.str] = None,
|
|
13461
13504
|
value: typing.Optional[builtins.str] = None,
|
|
13462
13505
|
) -> None:
|
|
13463
|
-
'''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* .
|
|
13464
13509
|
|
|
13465
|
-
:param key: A
|
|
13466
|
-
: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}*.:/=+\\-@]*)$").
|
|
13467
13512
|
|
|
13468
13513
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxyendpoint-tagformat.html
|
|
13469
13514
|
:exampleMetadata: fixture=_generated
|
|
@@ -13491,9 +13536,9 @@ class CfnDBProxyEndpoint(
|
|
|
13491
13536
|
|
|
13492
13537
|
@builtins.property
|
|
13493
13538
|
def key(self) -> typing.Optional[builtins.str]:
|
|
13494
|
-
'''A
|
|
13539
|
+
'''A key is the required name of the tag.
|
|
13495
13540
|
|
|
13496
|
-
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}*.:/=+-@]*)$").
|
|
13497
13542
|
|
|
13498
13543
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxyendpoint-tagformat.html#cfn-rds-dbproxyendpoint-tagformat-key
|
|
13499
13544
|
'''
|
|
@@ -13502,7 +13547,9 @@ class CfnDBProxyEndpoint(
|
|
|
13502
13547
|
|
|
13503
13548
|
@builtins.property
|
|
13504
13549
|
def value(self) -> typing.Optional[builtins.str]:
|
|
13505
|
-
'''
|
|
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}*.:/=+-@]*)$").
|
|
13506
13553
|
|
|
13507
13554
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxyendpoint-tagformat.html#cfn-rds-dbproxyendpoint-tagformat-value
|
|
13508
13555
|
'''
|
|
@@ -13550,7 +13597,7 @@ class CfnDBProxyEndpointProps:
|
|
|
13550
13597
|
:param db_proxy_name: The name of the DB proxy associated with the DB proxy endpoint that you create.
|
|
13551
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.
|
|
13552
13599
|
:param tags: An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
|
|
13553
|
-
: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.
|
|
13554
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.
|
|
13555
13602
|
|
|
13556
13603
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html
|
|
@@ -13643,8 +13690,6 @@ class CfnDBProxyEndpointProps:
|
|
|
13643
13690
|
def target_role(self) -> typing.Optional[builtins.str]:
|
|
13644
13691
|
'''A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
|
|
13645
13692
|
|
|
13646
|
-
Valid Values: ``READ_WRITE | READ_ONLY``
|
|
13647
|
-
|
|
13648
13693
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-targetrole
|
|
13649
13694
|
'''
|
|
13650
13695
|
result = self._values.get("target_role")
|
|
@@ -13708,7 +13753,7 @@ class CfnDBProxyProps:
|
|
|
13708
13753
|
|
|
13709
13754
|
:param auth: The authorization mechanism that the proxy uses.
|
|
13710
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.
|
|
13711
|
-
: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`` .
|
|
13712
13757
|
:param role_arn: The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
|
|
13713
13758
|
:param vpc_subnet_ids: One or more VPC subnet IDs to associate with the new proxy.
|
|
13714
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.
|
|
@@ -13810,8 +13855,6 @@ class CfnDBProxyProps:
|
|
|
13810
13855
|
|
|
13811
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`` .
|
|
13812
13857
|
|
|
13813
|
-
*Valid Values* : ``MYSQL`` | ``POSTGRESQL`` | ``SQLSERVER``
|
|
13814
|
-
|
|
13815
13858
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-enginefamily
|
|
13816
13859
|
'''
|
|
13817
13860
|
result = self._values.get("engine_family")
|
|
@@ -13975,7 +14018,7 @@ class CfnDBProxyTargetGroup(
|
|
|
13975
14018
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
13976
14019
|
:param db_proxy_name: The identifier of the ``DBProxy`` that is associated with the ``DBProxyTargetGroup`` .
|
|
13977
14020
|
:param target_group_name: The identifier for the target group. .. epigraph:: Currently, this property must be set to ``default`` .
|
|
13978
|
-
: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`` .
|
|
13979
14022
|
:param db_cluster_identifiers: One or more DB cluster identifiers.
|
|
13980
14023
|
:param db_instance_identifiers: One or more DB instance identifiers.
|
|
13981
14024
|
'''
|
|
@@ -14068,7 +14111,7 @@ class CfnDBProxyTargetGroup(
|
|
|
14068
14111
|
def connection_pool_configuration_info(
|
|
14069
14112
|
self,
|
|
14070
14113
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty"]]:
|
|
14071
|
-
'''
|
|
14114
|
+
'''Displays the settings that control the size and behavior of the connection pool associated with a ``DBProxyTarget`` .'''
|
|
14072
14115
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty"]], jsii.get(self, "connectionPoolConfigurationInfo"))
|
|
14073
14116
|
|
|
14074
14117
|
@connection_pool_configuration_info.setter
|
|
@@ -14296,7 +14339,7 @@ class CfnDBProxyTargetGroupProps:
|
|
|
14296
14339
|
|
|
14297
14340
|
:param db_proxy_name: The identifier of the ``DBProxy`` that is associated with the ``DBProxyTargetGroup`` .
|
|
14298
14341
|
:param target_group_name: The identifier for the target group. .. epigraph:: Currently, this property must be set to ``default`` .
|
|
14299
|
-
: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`` .
|
|
14300
14343
|
:param db_cluster_identifiers: One or more DB cluster identifiers.
|
|
14301
14344
|
:param db_instance_identifiers: One or more DB instance identifiers.
|
|
14302
14345
|
|
|
@@ -14371,7 +14414,7 @@ class CfnDBProxyTargetGroupProps:
|
|
|
14371
14414
|
def connection_pool_configuration_info(
|
|
14372
14415
|
self,
|
|
14373
14416
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty]]:
|
|
14374
|
-
'''
|
|
14417
|
+
'''Displays the settings that control the size and behavior of the connection pool associated with a ``DBProxyTarget`` .
|
|
14375
14418
|
|
|
14376
14419
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html#cfn-rds-dbproxytargetgroup-connectionpoolconfigurationinfo
|
|
14377
14420
|
'''
|
|
@@ -14463,8 +14506,8 @@ class CfnDBSecurityGroup(
|
|
|
14463
14506
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
14464
14507
|
:param db_security_group_ingress: Ingress rules to be applied to the DB security group.
|
|
14465
14508
|
:param group_description: Provides the description of the DB security group.
|
|
14466
|
-
:param ec2_vpc_id: The identifier of an Amazon VPC. This property indicates the VPC that this DB security group belongs to. .. epigraph::
|
|
14467
|
-
: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* .
|
|
14468
14511
|
'''
|
|
14469
14512
|
if __debug__:
|
|
14470
14513
|
type_hints = typing.get_type_hints(_typecheckingstub__b692ab00b4d5e8d1153b5156b9ec79e26f77bbcf930e94b43eb9adff11e07a12)
|
|
@@ -14562,10 +14605,7 @@ class CfnDBSecurityGroup(
|
|
|
14562
14605
|
@builtins.property
|
|
14563
14606
|
@jsii.member(jsii_name="ec2VpcId")
|
|
14564
14607
|
def ec2_vpc_id(self) -> typing.Optional[builtins.str]:
|
|
14565
|
-
'''The identifier of an Amazon VPC.
|
|
14566
|
-
|
|
14567
|
-
This property indicates the VPC that this DB security group belongs to.
|
|
14568
|
-
'''
|
|
14608
|
+
'''The identifier of an Amazon virtual private cloud (VPC).'''
|
|
14569
14609
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "ec2VpcId"))
|
|
14570
14610
|
|
|
14571
14611
|
@ec2_vpc_id.setter
|
|
@@ -14578,7 +14618,7 @@ class CfnDBSecurityGroup(
|
|
|
14578
14618
|
@builtins.property
|
|
14579
14619
|
@jsii.member(jsii_name="tagsRaw")
|
|
14580
14620
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
14581
|
-
'''
|
|
14621
|
+
'''Metadata assigned to an Amazon RDS resource consisting of a key-value pair.'''
|
|
14582
14622
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
14583
14623
|
|
|
14584
14624
|
@tags_raw.setter
|
|
@@ -15039,8 +15079,8 @@ class CfnDBSecurityGroupProps:
|
|
|
15039
15079
|
|
|
15040
15080
|
:param db_security_group_ingress: Ingress rules to be applied to the DB security group.
|
|
15041
15081
|
:param group_description: Provides the description of the DB security group.
|
|
15042
|
-
:param ec2_vpc_id: The identifier of an Amazon VPC. This property indicates the VPC that this DB security group belongs to. .. epigraph::
|
|
15043
|
-
: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* .
|
|
15044
15084
|
|
|
15045
15085
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsecuritygroup.html
|
|
15046
15086
|
:exampleMetadata: fixture=_generated
|
|
@@ -15107,11 +15147,12 @@ class CfnDBSecurityGroupProps:
|
|
|
15107
15147
|
|
|
15108
15148
|
@builtins.property
|
|
15109
15149
|
def ec2_vpc_id(self) -> typing.Optional[builtins.str]:
|
|
15110
|
-
'''The identifier of an Amazon
|
|
15150
|
+
'''The identifier of an Amazon virtual private cloud (VPC).
|
|
15111
15151
|
|
|
15152
|
+
This property indicates the VPC that this DB security group belongs to.
|
|
15112
15153
|
.. epigraph::
|
|
15113
15154
|
|
|
15114
|
-
|
|
15155
|
+
This property is included for backwards compatibility and is no longer recommended for providing security information to an RDS DB instance.
|
|
15115
15156
|
|
|
15116
15157
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsecuritygroup.html#cfn-rds-dbsecuritygroup-ec2vpcid
|
|
15117
15158
|
'''
|
|
@@ -15120,7 +15161,9 @@ class CfnDBSecurityGroupProps:
|
|
|
15120
15161
|
|
|
15121
15162
|
@builtins.property
|
|
15122
15163
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
15123
|
-
'''
|
|
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* .
|
|
15124
15167
|
|
|
15125
15168
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsecuritygroup.html#cfn-rds-dbsecuritygroup-tags
|
|
15126
15169
|
'''
|
|
@@ -15189,8 +15232,8 @@ class CfnDBSubnetGroup(
|
|
|
15189
15232
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
15190
15233
|
:param db_subnet_group_description: The description for the DB subnet group.
|
|
15191
15234
|
:param subnet_ids: The EC2 Subnet IDs for the DB subnet group.
|
|
15192
|
-
: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
|
|
15193
|
-
: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.
|
|
15194
15237
|
'''
|
|
15195
15238
|
if __debug__:
|
|
15196
15239
|
type_hints = typing.get_type_hints(_typecheckingstub__3437b6f3359034732d6fbef14006ac020c94fa5b18aa95cb4c8bb7332cc58dc7)
|
|
@@ -15291,7 +15334,7 @@ class CfnDBSubnetGroup(
|
|
|
15291
15334
|
@builtins.property
|
|
15292
15335
|
@jsii.member(jsii_name="tagsRaw")
|
|
15293
15336
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
15294
|
-
'''
|
|
15337
|
+
'''Tags to assign to the DB subnet group.'''
|
|
15295
15338
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
15296
15339
|
|
|
15297
15340
|
@tags_raw.setter
|
|
@@ -15325,8 +15368,8 @@ class CfnDBSubnetGroupProps:
|
|
|
15325
15368
|
|
|
15326
15369
|
:param db_subnet_group_description: The description for the DB subnet group.
|
|
15327
15370
|
:param subnet_ids: The EC2 Subnet IDs for the DB subnet group.
|
|
15328
|
-
: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
|
|
15329
|
-
: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.
|
|
15330
15373
|
|
|
15331
15374
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html
|
|
15332
15375
|
:exampleMetadata: fixture=_generated
|
|
@@ -15388,9 +15431,13 @@ class CfnDBSubnetGroupProps:
|
|
|
15388
15431
|
def db_subnet_group_name(self) -> typing.Optional[builtins.str]:
|
|
15389
15432
|
'''The name for the DB subnet group. This value is stored as a lowercase string.
|
|
15390
15433
|
|
|
15391
|
-
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.
|
|
15392
15439
|
|
|
15393
|
-
Example: ``
|
|
15440
|
+
Example: ``mydbsubnetgroup``
|
|
15394
15441
|
|
|
15395
15442
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html#cfn-rds-dbsubnetgroup-dbsubnetgroupname
|
|
15396
15443
|
'''
|
|
@@ -15399,7 +15446,7 @@ class CfnDBSubnetGroupProps:
|
|
|
15399
15446
|
|
|
15400
15447
|
@builtins.property
|
|
15401
15448
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
15402
|
-
'''
|
|
15449
|
+
'''Tags to assign to the DB subnet group.
|
|
15403
15450
|
|
|
15404
15451
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html#cfn-rds-dbsubnetgroup-tags
|
|
15405
15452
|
'''
|
|
@@ -15473,8 +15520,8 @@ class CfnEventSubscription(
|
|
|
15473
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* .
|
|
15474
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
|
|
15475
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.
|
|
15476
|
-
: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
|
|
15477
|
-
: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``
|
|
15478
15525
|
:param subscription_name: The name of the subscription. Constraints: The name must be less than 255 characters.
|
|
15479
15526
|
:param tags: An optional array of key-value pairs to apply to this subscription.
|
|
15480
15527
|
'''
|
|
@@ -15665,8 +15712,8 @@ class CfnEventSubscriptionProps:
|
|
|
15665
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* .
|
|
15666
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
|
|
15667
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.
|
|
15668
|
-
: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
|
|
15669
|
-
: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``
|
|
15670
15717
|
:param subscription_name: The name of the subscription. Constraints: The name must be less than 255 characters.
|
|
15671
15718
|
:param tags: An optional array of key-value pairs to apply to this subscription.
|
|
15672
15719
|
|
|
@@ -15768,13 +15815,14 @@ class CfnEventSubscriptionProps:
|
|
|
15768
15815
|
|
|
15769
15816
|
Constraints:
|
|
15770
15817
|
|
|
15771
|
-
- If
|
|
15818
|
+
- If ``SourceIds`` are supplied, ``SourceType`` must also be provided.
|
|
15772
15819
|
- If the source type is a DB instance, a ``DBInstanceIdentifier`` value must be supplied.
|
|
15773
15820
|
- If the source type is a DB cluster, a ``DBClusterIdentifier`` value must be supplied.
|
|
15774
15821
|
- If the source type is a DB parameter group, a ``DBParameterGroupName`` value must be supplied.
|
|
15775
15822
|
- If the source type is a DB security group, a ``DBSecurityGroupName`` value must be supplied.
|
|
15776
15823
|
- If the source type is a DB snapshot, a ``DBSnapshotIdentifier`` value must be supplied.
|
|
15777
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.
|
|
15778
15826
|
|
|
15779
15827
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-sourceids
|
|
15780
15828
|
'''
|
|
@@ -15785,9 +15833,9 @@ class CfnEventSubscriptionProps:
|
|
|
15785
15833
|
def source_type(self) -> typing.Optional[builtins.str]:
|
|
15786
15834
|
'''The type of source that is generating the events.
|
|
15787
15835
|
|
|
15788
|
-
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.
|
|
15789
15837
|
|
|
15790
|
-
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``
|
|
15791
15839
|
|
|
15792
15840
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-sourcetype
|
|
15793
15841
|
'''
|
|
@@ -16297,7 +16345,7 @@ class CfnIntegration(
|
|
|
16297
16345
|
:param description: A description of the integration.
|
|
16298
16346
|
:param integration_name: The name of the integration.
|
|
16299
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.
|
|
16300
|
-
:param tags:
|
|
16348
|
+
:param tags: An optional array of key-value pairs to apply to this integration.
|
|
16301
16349
|
'''
|
|
16302
16350
|
if __debug__:
|
|
16303
16351
|
type_hints = typing.get_type_hints(_typecheckingstub__0596ec891883071cc8cc2bad7e4e8120eefe68f759bfc17fdbfc1a525466ae6e)
|
|
@@ -16474,7 +16522,7 @@ class CfnIntegration(
|
|
|
16474
16522
|
@builtins.property
|
|
16475
16523
|
@jsii.member(jsii_name="tags")
|
|
16476
16524
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
16477
|
-
'''
|
|
16525
|
+
'''An optional array of key-value pairs to apply to this integration.'''
|
|
16478
16526
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
|
|
16479
16527
|
|
|
16480
16528
|
@tags.setter
|
|
@@ -16521,7 +16569,7 @@ class CfnIntegrationProps:
|
|
|
16521
16569
|
:param description: A description of the integration.
|
|
16522
16570
|
:param integration_name: The name of the integration.
|
|
16523
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.
|
|
16524
|
-
:param tags:
|
|
16572
|
+
:param tags: An optional array of key-value pairs to apply to this integration.
|
|
16525
16573
|
|
|
16526
16574
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html
|
|
16527
16575
|
:exampleMetadata: fixture=_generated
|
|
@@ -16654,9 +16702,7 @@ class CfnIntegrationProps:
|
|
|
16654
16702
|
|
|
16655
16703
|
@builtins.property
|
|
16656
16704
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
16657
|
-
'''
|
|
16658
|
-
|
|
16659
|
-
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.
|
|
16660
16706
|
|
|
16661
16707
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-integration.html#cfn-rds-integration-tags
|
|
16662
16708
|
'''
|
|
@@ -16738,9 +16784,9 @@ class CfnOptionGroup(
|
|
|
16738
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``
|
|
16739
16785
|
:param major_engine_version: Specifies the major version of the engine that this option group should be associated with.
|
|
16740
16786
|
:param option_group_description: The description of the option group.
|
|
16741
|
-
:param option_configurations: A list of
|
|
16787
|
+
:param option_configurations: A list of all available options.
|
|
16742
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.
|
|
16743
|
-
:param tags:
|
|
16789
|
+
:param tags: Tags to assign to the option group.
|
|
16744
16790
|
'''
|
|
16745
16791
|
if __debug__:
|
|
16746
16792
|
type_hints = typing.get_type_hints(_typecheckingstub__160a45fe55c01086901039aa8bde8bd5ace11ff967acd2154abcc9137622aea0)
|
|
@@ -16842,7 +16888,7 @@ class CfnOptionGroup(
|
|
|
16842
16888
|
def option_configurations(
|
|
16843
16889
|
self,
|
|
16844
16890
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnOptionGroup.OptionConfigurationProperty"]]]]:
|
|
16845
|
-
'''A list of
|
|
16891
|
+
'''A list of all available options.'''
|
|
16846
16892
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnOptionGroup.OptionConfigurationProperty"]]]], jsii.get(self, "optionConfigurations"))
|
|
16847
16893
|
|
|
16848
16894
|
@option_configurations.setter
|
|
@@ -16871,7 +16917,7 @@ class CfnOptionGroup(
|
|
|
16871
16917
|
@builtins.property
|
|
16872
16918
|
@jsii.member(jsii_name="tagsRaw")
|
|
16873
16919
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
16874
|
-
'''
|
|
16920
|
+
'''Tags to assign to the option group.'''
|
|
16875
16921
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
16876
16922
|
|
|
16877
16923
|
@tags_raw.setter
|
|
@@ -17129,9 +17175,9 @@ class CfnOptionGroupProps:
|
|
|
17129
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``
|
|
17130
17176
|
:param major_engine_version: Specifies the major version of the engine that this option group should be associated with.
|
|
17131
17177
|
:param option_group_description: The description of the option group.
|
|
17132
|
-
:param option_configurations: A list of
|
|
17178
|
+
:param option_configurations: A list of all available options.
|
|
17133
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.
|
|
17134
|
-
:param tags:
|
|
17180
|
+
:param tags: Tags to assign to the option group.
|
|
17135
17181
|
|
|
17136
17182
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html
|
|
17137
17183
|
:exampleMetadata: fixture=_generated
|
|
@@ -17236,7 +17282,7 @@ class CfnOptionGroupProps:
|
|
|
17236
17282
|
def option_configurations(
|
|
17237
17283
|
self,
|
|
17238
17284
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnOptionGroup.OptionConfigurationProperty]]]]:
|
|
17239
|
-
'''A list of
|
|
17285
|
+
'''A list of all available options.
|
|
17240
17286
|
|
|
17241
17287
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optionconfigurations
|
|
17242
17288
|
'''
|
|
@@ -17267,7 +17313,7 @@ class CfnOptionGroupProps:
|
|
|
17267
17313
|
|
|
17268
17314
|
@builtins.property
|
|
17269
17315
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
17270
|
-
'''
|
|
17316
|
+
'''Tags to assign to the option group.
|
|
17271
17317
|
|
|
17272
17318
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-tags
|
|
17273
17319
|
'''
|
|
@@ -19672,9 +19718,9 @@ class DatabaseClusterFromSnapshotProps:
|
|
|
19672
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
|
|
19673
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)
|
|
19674
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
|
|
19675
|
-
: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
|
|
19676
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
|
|
19677
|
-
: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
|
|
19678
19724
|
:param security_groups: Security group. Default: a new security group is created.
|
|
19679
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
|
|
19680
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
|
|
@@ -20183,7 +20229,7 @@ class DatabaseClusterFromSnapshotProps:
|
|
|
20183
20229
|
This feature is only supported by the Aurora database engine.
|
|
20184
20230
|
|
|
20185
20231
|
This property must not be used if ``s3ExportBuckets`` is used.
|
|
20186
|
-
|
|
20232
|
+
To use this property with Aurora PostgreSQL, it must be configured with the S3 export feature enabled when creating the DatabaseClusterEngine
|
|
20187
20233
|
For MySQL:
|
|
20188
20234
|
|
|
20189
20235
|
:default: - New role is created if ``s3ExportBuckets`` is set, no role is defined otherwise
|
|
@@ -20215,7 +20261,7 @@ class DatabaseClusterFromSnapshotProps:
|
|
|
20215
20261
|
This feature is only supported by the Aurora database engine.
|
|
20216
20262
|
|
|
20217
20263
|
This property must not be used if ``s3ImportBuckets`` is used.
|
|
20218
|
-
|
|
20264
|
+
To use this property with Aurora PostgreSQL, it must be configured with the S3 import feature enabled when creating the DatabaseClusterEngine
|
|
20219
20265
|
For MySQL:
|
|
20220
20266
|
|
|
20221
20267
|
:default: - New role is created if ``s3ImportBuckets`` is set, no role is defined otherwise
|
|
@@ -20479,9 +20525,9 @@ class DatabaseClusterProps:
|
|
|
20479
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
|
|
20480
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)
|
|
20481
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
|
|
20482
|
-
: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
|
|
20483
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
|
|
20484
|
-
: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
|
|
20485
20531
|
:param security_groups: Security group. Default: a new security group is created.
|
|
20486
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
|
|
20487
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
|
|
@@ -20970,7 +21016,7 @@ class DatabaseClusterProps:
|
|
|
20970
21016
|
This feature is only supported by the Aurora database engine.
|
|
20971
21017
|
|
|
20972
21018
|
This property must not be used if ``s3ExportBuckets`` is used.
|
|
20973
|
-
|
|
21019
|
+
To use this property with Aurora PostgreSQL, it must be configured with the S3 export feature enabled when creating the DatabaseClusterEngine
|
|
20974
21020
|
For MySQL:
|
|
20975
21021
|
|
|
20976
21022
|
:default: - New role is created if ``s3ExportBuckets`` is set, no role is defined otherwise
|
|
@@ -21002,7 +21048,7 @@ class DatabaseClusterProps:
|
|
|
21002
21048
|
This feature is only supported by the Aurora database engine.
|
|
21003
21049
|
|
|
21004
21050
|
This property must not be used if ``s3ImportBuckets`` is used.
|
|
21005
|
-
|
|
21051
|
+
To use this property with Aurora PostgreSQL, it must be configured with the S3 import feature enabled when creating the DatabaseClusterEngine
|
|
21006
21052
|
For MySQL:
|
|
21007
21053
|
|
|
21008
21054
|
:default: - New role is created if ``s3ImportBuckets`` is set, no role is defined otherwise
|
|
@@ -39281,9 +39327,9 @@ class DatabaseClusterFromSnapshot(
|
|
|
39281
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
|
|
39282
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)
|
|
39283
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
|
|
39284
|
-
: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
|
|
39285
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
|
|
39286
|
-
: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
|
|
39287
39333
|
:param security_groups: Security group. Default: a new security group is created.
|
|
39288
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
|
|
39289
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
|
|
@@ -43276,9 +43322,9 @@ class DatabaseCluster(
|
|
|
43276
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
|
|
43277
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)
|
|
43278
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
|
|
43279
|
-
: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
|
|
43280
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
|
|
43281
|
-
: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
|
|
43282
43328
|
:param security_groups: Security group. Default: a new security group is created.
|
|
43283
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
|
|
43284
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
|