CfnDBCluster

class aws_cdk.aws_rds.CfnDBCluster(scope, id, *, allocated_storage=None, associated_roles=None, auto_minor_version_upgrade=None, availability_zones=None, backtrack_window=None, backup_retention_period=None, copy_tags_to_snapshot=None, database_name=None, db_cluster_identifier=None, db_cluster_instance_class=None, db_cluster_parameter_group_name=None, db_instance_parameter_group_name=None, db_subnet_group_name=None, db_system_id=None, deletion_protection=None, domain=None, domain_iam_role_name=None, enable_cloudwatch_logs_exports=None, enable_global_write_forwarding=None, enable_http_endpoint=None, enable_iam_database_authentication=None, enable_local_write_forwarding=None, engine=None, engine_lifecycle_support=None, engine_mode=None, engine_version=None, global_cluster_identifier=None, iops=None, kms_key_id=None, manage_master_user_password=None, master_username=None, master_user_password=None, master_user_secret=None, monitoring_interval=None, monitoring_role_arn=None, network_type=None, performance_insights_enabled=None, performance_insights_kms_key_id=None, performance_insights_retention_period=None, port=None, preferred_backup_window=None, preferred_maintenance_window=None, publicly_accessible=None, replication_source_identifier=None, restore_to_time=None, restore_type=None, scaling_configuration=None, serverless_v2_scaling_configuration=None, snapshot_identifier=None, source_db_cluster_identifier=None, source_region=None, storage_encrypted=None, storage_type=None, tags=None, use_latest_restorable_time=None, vpc_security_group_ids=None)

Bases: CfnResource

The AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster or Multi-AZ DB cluster.

For more information about creating an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide .

For more information about creating a Multi-AZ DB cluster, see Creating a Multi-AZ DB cluster in the Amazon RDS User Guide . .. epigraph:

You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported.

Updating DB clusters

When properties labeled “ Update requires: Replacement “ are updated, AWS CloudFormation first creates a replacement DB cluster, then changes references from other dependent resources to point to the replacement DB cluster, and finally deletes the old DB cluster. .. epigraph:

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:

- Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.
- 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>`_ .
- 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.

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.

- Update the stack.

Currently, when you are updating the stack for an Aurora Serverless DB cluster, you can’t include changes to any other properties when you specify one of the following properties: PreferredBackupWindow , PreferredMaintenanceWindow , and Port . This limitation doesn’t apply to provisioned DB clusters.

For more information about updating other properties of this resource, see [ModifyDBCluster](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_ModifyDBCluster.html) . For more information about updating stacks, see AWS CloudFormation Stacks Updates .

Deleting DB clusters

The default DeletionPolicy for AWS::RDS::DBCluster resources is Snapshot . For more information about how AWS CloudFormation deletes resources, see DeletionPolicy Attribute .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html
CloudformationResource:: AWS::RDS::DBCluster
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_rds as rds

cfn_dBCluster = rds.CfnDBCluster(self, "MyCfnDBCluster",
    allocated_storage=123,
    associated_roles=[rds.CfnDBCluster.DBClusterRoleProperty(
        role_arn="roleArn",

        # the properties below are optional
        feature_name="featureName"
    )],
    auto_minor_version_upgrade=False,
    availability_zones=["availabilityZones"],
    backtrack_window=123,
    backup_retention_period=123,
    copy_tags_to_snapshot=False,
    database_name="databaseName",
    db_cluster_identifier="dbClusterIdentifier",
    db_cluster_instance_class="dbClusterInstanceClass",
    db_cluster_parameter_group_name="dbClusterParameterGroupName",
    db_instance_parameter_group_name="dbInstanceParameterGroupName",
    db_subnet_group_name="dbSubnetGroupName",
    db_system_id="dbSystemId",
    deletion_protection=False,
    domain="domain",
    domain_iam_role_name="domainIamRoleName",
    enable_cloudwatch_logs_exports=["enableCloudwatchLogsExports"],
    enable_global_write_forwarding=False,
    enable_http_endpoint=False,
    enable_iam_database_authentication=False,
    enable_local_write_forwarding=False,
    engine="engine",
    engine_lifecycle_support="engineLifecycleSupport",
    engine_mode="engineMode",
    engine_version="engineVersion",
    global_cluster_identifier="globalClusterIdentifier",
    iops=123,
    kms_key_id="kmsKeyId",
    manage_master_user_password=False,
    master_username="masterUsername",
    master_user_password="masterUserPassword",
    master_user_secret=rds.CfnDBCluster.MasterUserSecretProperty(
        kms_key_id="kmsKeyId",
        secret_arn="secretArn"
    ),
    monitoring_interval=123,
    monitoring_role_arn="monitoringRoleArn",
    network_type="networkType",
    performance_insights_enabled=False,
    performance_insights_kms_key_id="performanceInsightsKmsKeyId",
    performance_insights_retention_period=123,
    port=123,
    preferred_backup_window="preferredBackupWindow",
    preferred_maintenance_window="preferredMaintenanceWindow",
    publicly_accessible=False,
    replication_source_identifier="replicationSourceIdentifier",
    restore_to_time="restoreToTime",
    restore_type="restoreType",
    scaling_configuration=rds.CfnDBCluster.ScalingConfigurationProperty(
        auto_pause=False,
        max_capacity=123,
        min_capacity=123,
        seconds_before_timeout=123,
        seconds_until_auto_pause=123,
        timeout_action="timeoutAction"
    ),
    serverless_v2_scaling_configuration=rds.CfnDBCluster.ServerlessV2ScalingConfigurationProperty(
        max_capacity=123,
        min_capacity=123
    ),
    snapshot_identifier="snapshotIdentifier",
    source_db_cluster_identifier="sourceDbClusterIdentifier",
    source_region="sourceRegion",
    storage_encrypted=False,
    storage_type="storageType",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    use_latest_restorable_time=False,
    vpc_security_group_ids=["vpcSecurityGroupIds"]
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
allocated_storage (Union[int, float, None]) – The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters only This setting is required to create a Multi-AZ DB cluster.
associated_roles (Union[IResolvable, Sequence[Union[IResolvable, DBClusterRoleProperty, Dict[str, Any]]], None]) – 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
auto_minor_version_upgrade (Union[bool, IResolvable, None]) – 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
availability_zones (Optional[Sequence[str]]) – 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 in the Amazon Aurora User Guide . Valid for: Aurora DB clusters only
backtrack_window (Union[int, float, None]) – 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).
backup_retention_period (Union[int, float, None]) – 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
copy_tags_to_snapshot (Union[bool, IResolvable, None]) – 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
database_name (Optional[str]) – 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 in the Amazon Aurora User Guide . Valid for: Aurora DB clusters and Multi-AZ DB clusters
db_cluster_identifier (Optional[str]) – The DB cluster identifier. This parameter is stored as a lowercase string. Constraints: - Must contain from 1 to 63 letters, numbers, or hyphens. - First character must be a letter. - Can’t end with a hyphen or contain two consecutive hyphens. Example: my-cluster1 Valid for: Aurora DB clusters and Multi-AZ DB clusters
db_cluster_instance_class (Optional[str]) – The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge . Not all DB instance classes are available in all AWS Regions , or for all database engines. For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide . This setting is required to create a Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters only
db_cluster_parameter_group_name (Optional[str]) – The name of the DB cluster parameter group to associate with this DB cluster. .. epigraph:: If you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting. If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started. To list all of the available DB cluster parameter group names, use the following command: aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text Valid for: Aurora DB clusters and Multi-AZ DB clusters
db_instance_parameter_group_name (Optional[str]) – The name of the DB parameter group to apply to all instances of the DB cluster. .. epigraph:: When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn’t rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window. Valid for Cluster Type: Aurora DB clusters only Default: The existing name setting Constraints: - The DB parameter group must be in the same DB parameter group family as this DB cluster. - The DBInstanceParameterGroupName parameter is valid in combination with the AllowMajorVersionUpgrade parameter for a major version upgrade only.
db_subnet_group_name (Optional[str]) – A DB subnet group that you want to associate with this DB cluster. If you are restoring a DB cluster to a point in time with RestoreType set to copy-on-write , and don’t specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group. Valid for: Aurora DB clusters and Multi-AZ DB clusters
db_system_id (Optional[str]) – Reserved for future use.
deletion_protection (Union[bool, IResolvable, None]) – A value that indicates whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection is disabled. Valid for: Aurora DB clusters and Multi-AZ DB clusters
domain (Optional[str]) – Indicates the directory ID of the Active Directory to create the DB cluster. For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos authentication in the Amazon Aurora User Guide . Valid for: Aurora DB clusters only
domain_iam_role_name (Optional[str]) – Specifies the name of the IAM role to use when making API calls to the Directory Service. Valid for: Aurora DB clusters only
enable_cloudwatch_logs_exports (Optional[Sequence[str]]) – The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide . Aurora MySQL Valid values: audit , error , general , slowquery Aurora PostgreSQL Valid values: postgresql Valid for: Aurora DB clusters and Multi-AZ DB clusters
enable_global_write_forwarding (Union[bool, IResolvable, None]) – Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then. Valid for Cluster Type: Aurora DB clusters only
enable_http_endpoint (Union[bool, IResolvable, None]) – Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn’t enabled. When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor. RDS Data API is supported with the following DB clusters: - Aurora PostgreSQL Serverless v2 and provisioned - Aurora PostgreSQL and Aurora MySQL Serverless v1 For more information, see Using RDS Data API in the Amazon Aurora User Guide . Valid for Cluster Type: Aurora DB clusters only
enable_iam_database_authentication (Union[bool, IResolvable, None]) – A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
enable_local_write_forwarding (Union[bool, IResolvable, None]) – Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren’t allowed on reader DB instances. Valid for: Aurora DB clusters only
engine (Optional[str]) – The name of the database engine to be used for this DB cluster. Valid Values: - aurora-mysql - aurora-postgresql - mysql - postgres Valid for: Aurora DB clusters and Multi-AZ DB clusters
engine_lifecycle_support (Optional[str]) –
The life cycle type for this DB cluster. .. epigraph:: By default, this value is set to open-source-rds-extended-support , which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled . In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: - Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide - Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support
engine_mode (Optional[str]) – The DB engine mode of the DB cluster, either provisioned or serverless . The serverless engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the provisioned engine mode. For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide : - Limitations of Aurora Serverless v1 - Requirements for Aurora Serverless v2 Valid for Cluster Type: Aurora DB clusters only
engine_version (Optional[str]) – The version number of the database engine to use. To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (8.0-compatible), use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion" You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or version 3, respectively. To list all of the available engine versions for Aurora PostgreSQL, use the following command: aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for RDS for MySQL, use the following command: aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for RDS for PostgreSQL, use the following command: aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion" Aurora MySQL For information, see Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide . Aurora PostgreSQL For information, see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide . MySQL For information, see Amazon RDS for MySQL in the Amazon RDS User Guide . PostgreSQL For information, see Amazon RDS for PostgreSQL in the Amazon RDS User Guide . Valid for: Aurora DB clusters and Multi-AZ DB clusters
global_cluster_identifier (Optional[str]) – If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource. If you aren’t configuring a global database cluster, don’t specify this property. .. epigraph:: To remove the DB cluster from a global database cluster, specify an empty value for the GlobalClusterIdentifier property. For information about Aurora global databases, see Working with Amazon Aurora Global Databases in the Amazon Aurora User Guide . Valid for: Aurora DB clusters only
iops (Union[int, float, None]) – The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS User Guide . This setting is required to create a Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters only Constraints: - Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
kms_key_id (Optional[str]) – The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef . If you enable the StorageEncrypted property but don’t specify this property, the default KMS key is used. If you specify this property, you must set the StorageEncrypted property to true . If you specify the SnapshotIdentifier property, the StorageEncrypted property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified KmsKeyId property is used. If you create a read replica of an encrypted DB cluster in another AWS Region, make sure to set KmsKeyId to a KMS key identifier that is valid in the destination AWS Region. This KMS key is used to encrypt the read replica in that AWS Region. Valid for: Aurora DB clusters and Multi-AZ DB clusters
manage_master_user_password (Union[bool, IResolvable, None]) –
Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with AWS Secrets Manager in the Amazon RDS User Guide and Password management with AWS Secrets Manager in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints: - Can’t manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
master_username (Optional[str]) – The name of the master user for the DB cluster. .. epigraph:: If you specify the SourceDBClusterIdentifier , SnapshotIdentifier , or GlobalClusterIdentifier property, don’t specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively. Valid for: Aurora DB clusters and Multi-AZ DB clusters
master_user_password (Optional[str]) – The master password for the DB instance. .. epigraph:: If you specify the SourceDBClusterIdentifier , SnapshotIdentifier , or GlobalClusterIdentifier property, don’t specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively. Valid for: Aurora DB clusters and Multi-AZ DB clusters
master_user_secret (Union[IResolvable, MasterUserSecretProperty, Dict[str, Any], None]) –
The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with AWS Secrets Manager in the Amazon RDS User Guide and Password management with AWS Secrets Manager in the Amazon Aurora User Guide.
monitoring_interval (Union[int, float, None]) – The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0 . If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0 . Valid for Cluster Type: Multi-AZ DB clusters only Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 Default: 0
monitoring_role_arn (Optional[str]) – The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, see Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide . If MonitoringInterval is set to a value other than 0 , supply a MonitoringRoleArn value. Valid for Cluster Type: Multi-AZ DB clusters only
network_type (Optional[str]) – The network type of the DB cluster. Valid values: - IPV4 - DUAL The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and IPv6 protocols ( DUAL ). For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
performance_insights_enabled (Union[bool, IResolvable, None]) – Specifies whether to turn on Performance Insights for the DB cluster. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide . Valid for Cluster Type: Multi-AZ DB clusters only
performance_insights_kms_key_id (Optional[str]) – The AWS KMS key identifier for encryption of Performance Insights data. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you don’t specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account . Your AWS account has a different default KMS key for each AWS Region . Valid for Cluster Type: Multi-AZ DB clusters only
performance_insights_retention_period (Union[int, float, None]) – The number of days to retain Performance Insights data. Valid for Cluster Type: Multi-AZ DB clusters only 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 issues an error.
port (Union[int, float, None]) – 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 for the AWS::RDS::DBInstance resource. Valid for: Aurora DB clusters and Multi-AZ DB clusters
preferred_backup_window (Optional[str]) – The daily time range during which automated backups are created. For more information, see Backup Window 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
preferred_maintenance_window (Optional[str]) – 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 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
publicly_accessible (Union[bool, IResolvable, None]) – 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.
replication_source_identifier (Optional[str]) – 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
restore_to_time (Optional[str]) – 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
restore_type (Optional[str]) – 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
scaling_configuration (Union[IResolvable, ScalingConfigurationProperty, Dict[str, Any], None]) – The scaling configuration of an Aurora Serverless v1 DB cluster. This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ServerlessV2ScalingConfiguration property. Valid for: Aurora Serverless v1 DB clusters only
serverless_v2_scaling_configuration (Union[IResolvable, ServerlessV2ScalingConfigurationProperty, Dict[str, Any], None]) – The scaling configuration of an Aurora Serverless V2 DB cluster. This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, Use the ScalingConfiguration property. Valid for: Aurora Serverless v2 DB clusters only
snapshot_identifier (Optional[str]) – The identifier for the DB snapshot or DB cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don’t specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted. If you specify the SnapshotIdentifier property to restore a DB cluster (as opposed to specifying it for DB cluster updates), then don’t specify the following properties: - GlobalClusterIdentifier - MasterUsername - MasterUserPassword - ReplicationSourceIdentifier - RestoreType - SourceDBClusterIdentifier - SourceRegion - StorageEncrypted (for an encrypted snapshot) - UseLatestRestorableTime Constraints: - Must match the identifier of an existing Snapshot. Valid for: Aurora DB clusters and Multi-AZ DB clusters
source_db_cluster_identifier (Optional[str]) – When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore. Constraints: - Must match the identifier of an existing DBCluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters
source_region (Optional[str]) – 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
storage_encrypted (Union[bool, IResolvable, None]) – 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
storage_type (Optional[str]) – 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 . For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters . 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 .
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags to assign to the DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
use_latest_restorable_time (Union[bool, IResolvable, None]) – 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
vpc_security_group_ids (Optional[Sequence[str]]) – 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

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::RDS::DBCluster'

allocated_storage: The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

associated_roles: Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.

attr_db_cluster_arn

The Amazon Resource Name (ARN) for the DB cluster.

CloudformationAttribute:: DBClusterArn

attr_db_cluster_resource_id

The AWS Region -unique, immutable identifier for the DB cluster.

This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

CloudformationAttribute:: DBClusterResourceId

attr_endpoint

The Endpoint return value specifies the connection endpoint for the primary instance of the DB cluster.

CloudformationAttribute:: Endpoint

attr_endpoint_address

The connection endpoint for the DB cluster.

For example: mystack-mydbcluster-123456789012.us-east-2.rds.amazonaws.com

CloudformationAttribute:: Endpoint.Address

attr_endpoint_port

The port number that will accept connections on this DB cluster.

For example: 3306

CloudformationAttribute:: Endpoint.Port

attr_master_user_secret_secret_arn

The Amazon Resource Name (ARN) of the secret.

CloudformationAttribute:: MasterUserSecret.SecretArn

attr_read_endpoint

The ReadEndpoint return value specifies the reader endpoint for the DB cluster.

The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster. If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint. For more information about Aurora endpoints, see Amazon Aurora connection management in the Amazon Aurora User Guide.

CloudformationAttribute:: ReadEndpoint

attr_read_endpoint_address

The reader endpoint for the DB cluster.

For example: mystack-mydbcluster-ro-123456789012.us-east-2.rds.amazonaws.com

CloudformationAttribute:: ReadEndpoint.Address

attr_storage_throughput

The storage throughput for the DB cluster.

The throughput is automatically set based on the IOPS that you provision, and is not configurable.

This setting is only for non-Aurora Multi-AZ DB clusters.

CloudformationAttribute:: StorageThroughput

auto_minor_version_upgrade: Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.

availability_zones: A list of Availability Zones (AZs) where instances in the DB cluster can be created.

backtrack_window

The target backtrack window, in seconds.

To disable backtracking, set this value to 0 .

backup_retention_period: The number of days for which automated backups are retained.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

copy_tags_to_snapshot: A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

database_name: The name of your database.

db_cluster_identifier

The DB cluster identifier.

This parameter is stored as a lowercase string.

db_cluster_instance_class: The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge . Not all DB instance classes are available in all AWS Regions , or for all database engines.

db_cluster_parameter_group_name: The name of the DB cluster parameter group to associate with this DB cluster.

db_instance_parameter_group_name: The name of the DB parameter group to apply to all instances of the DB cluster.

db_subnet_group_name: A DB subnet group that you want to associate with this DB cluster.

db_system_id: Reserved for future use.

deletion_protection: A value that indicates whether the DB cluster has deletion protection enabled.

domain: Indicates the directory ID of the Active Directory to create the DB cluster.

domain_iam_role_name: Specifies the name of the IAM role to use when making API calls to the Directory Service.

enable_cloudwatch_logs_exports: The list of log types that need to be enabled for exporting to CloudWatch Logs.

enable_global_write_forwarding: Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database).

enable_http_endpoint

Specifies whether to enable the HTTP endpoint for the DB cluster.

By default, the HTTP endpoint isn’t enabled.

enable_iam_database_authentication: A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

enable_local_write_forwarding: Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.

engine: The name of the database engine to be used for this DB cluster.

engine_lifecycle_support: The life cycle type for this DB cluster.

engine_mode: The DB engine mode of the DB cluster, either provisioned or serverless .

engine_version: The version number of the database engine to use.

global_cluster_identifier: If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster.

iops: The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

kms_key_id: The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef .

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

manage_master_user_password: Specifies whether to manage the master user password with AWS Secrets Manager.

master_user_password: The master password for the DB instance.

master_user_secret: The secret managed by RDS in AWS Secrets Manager for the master user password.

master_username: The name of the master user for the DB cluster.

monitoring_interval: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

monitoring_role_arn: The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

network_type: The network type of the DB cluster.

node: The tree node.

performance_insights_enabled: Specifies whether to turn on Performance Insights for the DB cluster.

performance_insights_kms_key_id: The AWS KMS key identifier for encryption of Performance Insights data.

performance_insights_retention_period: The number of days to retain Performance Insights data.

port: The port number on which the DB instances in the DB cluster accept connections.

preferred_backup_window: The daily time range during which automated backups are created.

preferred_maintenance_window: The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

publicly_accessible: Specifies whether the DB cluster is publicly accessible.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

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.

restore_to_time: The date and time to restore the DB cluster to.

restore_type

The type of restore to be performed.

You can specify one of the following values:.

scaling_configuration: The scaling configuration of an Aurora Serverless v1 DB cluster.

serverless_v2_scaling_configuration: The scaling configuration of an Aurora Serverless V2 DB cluster.

snapshot_identifier: The identifier for the DB snapshot or DB cluster snapshot to restore from.

source_db_cluster_identifier: When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.

source_region

The AWS Region which contains the source DB cluster when replicating a DB cluster.

For example, us-east-1 .

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

storage_encrypted: Indicates whether the DB cluster is encrypted.

storage_type: The storage type to associate with the DB cluster.

tags: Tag Manager which manages the tags for this resource.

tags_raw: Tags to assign to the DB cluster.

use_latest_restorable_time: A value that indicates whether to restore the DB cluster to the latest restorable backup time.

vpc_security_group_ids: A list of EC2 VPC security groups to associate with this DB cluster.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

DBClusterRoleProperty

class CfnDBCluster.DBClusterRoleProperty(*, role_arn, feature_name=None)

Bases: object

Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.

Parameters:

role_arn (str) – The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
feature_name (Optional[str]) – The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_rds as rds

d_bCluster_role_property = rds.CfnDBCluster.DBClusterRoleProperty(
    role_arn="roleArn",

    # the properties below are optional
    feature_name="featureName"
)

Attributes

feature_name

The name of the feature associated with the AWS Identity and Access Management (IAM) role.

IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html#cfn-rds-dbcluster-dbclusterrole-featurename

role_arn

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html#cfn-rds-dbcluster-dbclusterrole-rolearn

EndpointProperty

class CfnDBCluster.EndpointProperty(*, address=None, port=None)

Bases: object

The Endpoint return value specifies the connection endpoint for the primary instance of the DB cluster.

Parameters:

address (Optional[str]) – Specifies the connection endpoint for the primary instance of the DB cluster.
port (Optional[str]) – Specifies the port that the database engine is listening on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-endpoint.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_rds as rds

endpoint_property = rds.CfnDBCluster.EndpointProperty(
    address="address",
    port="port"
)

Attributes

address

Specifies the connection endpoint for the primary instance of the DB cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-endpoint.html#cfn-rds-dbcluster-endpoint-address

port

Specifies the port that the database engine is listening on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-endpoint.html#cfn-rds-dbcluster-endpoint-port

MasterUserSecretProperty

class CfnDBCluster.MasterUserSecretProperty(*, kms_key_id=None, secret_arn=None)

Bases: object

The MasterUserSecret return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password.

For more information, see Password management with AWS Secrets Manager in the Amazon RDS User Guide and Password management with AWS Secrets Manager in the Amazon Aurora User Guide.

Parameters:

kms_key_id (Optional[str]) – The AWS KMS key identifier that is used to encrypt the secret.
secret_arn (Optional[str]) – 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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_rds as rds

master_user_secret_property = rds.CfnDBCluster.MasterUserSecretProperty(
    kms_key_id="kmsKeyId",
    secret_arn="secretArn"
)

Attributes

kms_key_id

The AWS KMS key identifier that is used to encrypt the secret.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html#cfn-rds-dbcluster-masterusersecret-kmskeyid

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html#cfn-rds-dbcluster-masterusersecret-secretarn

ReadEndpointProperty

class CfnDBCluster.ReadEndpointProperty(*, address=None)

Bases: object

The ReadEndpoint return value specifies the reader endpoint for the DB cluster.

The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

For more information about Aurora endpoints, see Amazon Aurora connection management in the Amazon Aurora User Guide .

Parameters:: address (Optional[str]) – The host address of the reader endpoint.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-readendpoint.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_rds as rds

read_endpoint_property = rds.CfnDBCluster.ReadEndpointProperty(
    address="address"
)

Attributes

address

The host address of the reader endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-readendpoint.html#cfn-rds-dbcluster-readendpoint-address

ScalingConfigurationProperty

class CfnDBCluster.ScalingConfigurationProperty(*, auto_pause=None, max_capacity=None, min_capacity=None, seconds_before_timeout=None, seconds_until_auto_pause=None, timeout_action=None)

Bases: object

The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless v1 DB cluster.

For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .

This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ServerlessV2ScalingConfiguration property.

Valid for: Aurora Serverless v1 DB clusters only

Parameters:

auto_pause (Union[bool, IResolvable, None]) – Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it’s idle (it has no connections). .. epigraph:: If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
max_capacity (Union[int, float, None]) – The maximum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 . For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 . The maximum capacity must be greater than or equal to the minimum capacity.
min_capacity (Union[int, float, None]) – The minimum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 . For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 . The minimum capacity must be less than or equal to the maximum capacity.
seconds_before_timeout (Union[int, float, None]) – The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300. Specify a value between 60 and 600 seconds.
seconds_until_auto_pause (Union[int, float, None]) – The time, in seconds, before an Aurora DB cluster in serverless mode is paused. Specify a value between 300 and 86,400 seconds.
timeout_action (Optional[str]) – The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange . ForceApplyCapacityChange sets the capacity to the specified value as soon as possible. RollbackCapacityChange , the default, ignores the capacity change if a scaling point isn’t found in the timeout period. .. epigraph:: If you specify ForceApplyCapacityChange , connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_rds as rds

scaling_configuration_property = rds.CfnDBCluster.ScalingConfigurationProperty(
    auto_pause=False,
    max_capacity=123,
    min_capacity=123,
    seconds_before_timeout=123,
    seconds_until_auto_pause=123,
    timeout_action="timeoutAction"
)

Attributes

auto_pause

Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.

A DB cluster can be paused only when it’s idle (it has no connections). .. epigraph:

If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-autopause

max_capacity

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .

For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .

The maximum capacity must be greater than or equal to the minimum capacity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-maxcapacity

min_capacity

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .

For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .

The minimum capacity must be less than or equal to the maximum capacity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-mincapacity

seconds_before_timeout

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action.

The default is 300.

Specify a value between 60 and 600 seconds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-secondsbeforetimeout

seconds_until_auto_pause

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

Specify a value between 300 and 86,400 seconds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-secondsuntilautopause

timeout_action

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange .

ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

RollbackCapacityChange , the default, ignores the capacity change if a scaling point isn’t found in the timeout period. .. epigraph:

If you specify ``ForceApplyCapacityChange`` , connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.

For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-timeoutaction

ServerlessV2ScalingConfigurationProperty

class CfnDBCluster.ServerlessV2ScalingConfigurationProperty(*, max_capacity=None, min_capacity=None)

Bases: object

The ServerlessV2ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless V2 DB cluster.

For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide .

If you have an Aurora cluster, you must set this attribute before you add a DB instance that uses the db.serverless DB instance class. For more information, see Clusters that use Aurora Serverless v2 must have a capacity range specified in the Amazon Aurora User Guide .

This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, use the ScalingConfiguration property.

Valid for: Aurora Serverless v2 DB clusters

Parameters:

max_capacity (Union[int, float, None]) – 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. The maximum capacity must be higher than 0.5 ACUs. For more information, see Choosing the maximum Aurora Serverless v2 capacity setting for a cluster in the Amazon Aurora User Guide . Aurora automatically sets certain parameters for Aurora Serverless V2 DB instances to values that depend on the maximum ACU value in the capacity range. When you update the maximum capacity value, the ParameterApplyStatus value for the DB instance changes to pending-reboot . You can update the parameter values by rebooting the DB instance after changing the capacity range.
min_capacity (Union[int, float, None]) – 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-serverlessv2scalingconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_rds as rds

serverless_v2_scaling_configuration_property = rds.CfnDBCluster.ServerlessV2ScalingConfigurationProperty(
    max_capacity=123,
    min_capacity=123
)

Attributes

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.

The maximum capacity must be higher than 0.5 ACUs. For more information, see Choosing the maximum Aurora Serverless v2 capacity setting for a cluster in the Amazon Aurora User Guide .

Aurora automatically sets certain parameters for Aurora Serverless V2 DB instances to values that depend on the maximum ACU value in the capacity range. When you update the maximum capacity value, the ParameterApplyStatus value for the DB instance changes to pending-reboot . You can update the parameter values by rebooting the DB instance after changing the capacity range.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-serverlessv2scalingconfiguration.html#cfn-rds-dbcluster-serverlessv2scalingconfiguration-maxcapacity

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-serverlessv2scalingconfiguration.html#cfn-rds-dbcluster-serverlessv2scalingconfiguration-mincapacity