CfnDBCluster

class aws_cdk.aws_rds.CfnDBCluster(scope, id, *, engine, 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, deletion_protection=None, domain=None, domain_iam_role_name=None, enable_cloudwatch_logs_exports=None, enable_http_endpoint=None, enable_iam_database_authentication=None, engine_mode=None, engine_version=None, global_cluster_identifier=None, iops=None, kms_key_id=None, master_username=None, master_user_password=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_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

A CloudFormation AWS::RDS::DBCluster.

The AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster. For more information, see Managing an Amazon Aurora DB Cluster in the Amazon Aurora User Guide . .. epigraph:

You can only create this resource in AWS Regions where Amazon Aurora is supported.

This topic covers the resource for Amazon Aurora DB clusters. For the documentation on the resource for Amazon RDS DB instances, see AWS::RDS::DBInstance .

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 about creating DB snapshots, 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 .

CloudformationResource

AWS::RDS::DBCluster

Link

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

ExampleMetadata

fixture=_generated

Example:

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

cfn_dBCluster = rds.CfnDBCluster(self, "MyCfnDBCluster",
    engine="engine",

    # the properties below are optional
    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",
    deletion_protection=False,
    domain="domain",
    domain_iam_role_name="domainIamRoleName",
    enable_cloudwatch_logs_exports=["enableCloudwatchLogsExports"],
    enable_http_endpoint=False,
    enable_iam_database_authentication=False,
    engine_mode="engineMode",
    engine_version="engineVersion",
    global_cluster_identifier="globalClusterIdentifier",
    iops=123,
    kms_key_id="kmsKeyId",
    master_username="masterUsername",
    master_user_password="masterUserPassword",
    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_type="restoreType",
    scaling_configuration=rds.CfnDBCluster.ScalingConfigurationProperty(
        auto_pause=False,
        max_capacity=123,
        min_capacity=123,
        seconds_until_auto_pause=123
    ),
    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"]
)

Create a new AWS::RDS::DBCluster.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • engine (str) – The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

  • allocated_storage (Union[int, float, None]) – AWS::RDS::DBCluster.AllocatedStorage.

  • associated_roles (Union[IResolvable, Sequence[Union[DBClusterRoleProperty, Dict[str, Any], IResolvable]], 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.

  • auto_minor_version_upgrade (Union[bool, IResolvable, None]) – AWS::RDS::DBCluster.AutoMinorVersionUpgrade.

  • 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 .

  • backtrack_window (Union[int, float, None]) – The target backtrack window, in seconds. To disable backtracking, set this value to 0. .. epigraph:: Currently, Backtrack is only supported for Aurora MySQL DB clusters. 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

  • 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.

  • 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 .

  • 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

  • db_cluster_instance_class (Optional[str]) – AWS::RDS::DBCluster.DBClusterInstanceClass.

  • 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

  • db_instance_parameter_group_name (Optional[str]) – AWS::RDS::DBCluster.DBInstanceParameterGroupName.

  • 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.

  • 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.

  • domain (Optional[str]) – AWS::RDS::DBCluster.Domain.

  • domain_iam_role_name (Optional[str]) – AWS::RDS::DBCluster.DomainIAMRoleName.

  • 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

  • enable_http_endpoint (Union[bool, IResolvable, None]) – A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled. When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor. For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide .

  • 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.

  • engine_mode (Optional[str]) – The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster . The serverless engine mode only supports Aurora Serverless v1. Currently, AWS CloudFormation doesn’t support Aurora Serverless v2. The parallelquery engine mode isn’t required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions. The global engine mode isn’t required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn’t required for any 2.x versions. The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a. For Aurora PostgreSQL, the global engine mode isn’t required, and both the parallelquery and the multimaster engine modes currently aren’t supported. Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide : - Limitations of Aurora Serverless - Limitations of Parallel Query - Limitations of Aurora Global Databases - Limitations of Multi-Master Clusters

  • engine_version (Optional[str]) – The version number of the database engine to use. To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion" 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"

  • 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 .

  • iops (Union[int, float, None]) – AWS::RDS::DBCluster.Iops.

  • 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.

  • 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.

  • 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.

  • monitoring_interval (Union[int, float, None]) – AWS::RDS::DBCluster.MonitoringInterval.

  • monitoring_role_arn (Optional[str]) – AWS::RDS::DBCluster.MonitoringRoleArn.

  • network_type (Optional[str]) – AWS::RDS::DBCluster.NetworkType.

  • performance_insights_enabled (Union[bool, IResolvable, None]) – AWS::RDS::DBCluster.PerformanceInsightsEnabled.

  • performance_insights_kms_key_id (Optional[str]) – AWS::RDS::DBCluster.PerformanceInsightsKmsKeyId.

  • performance_insights_retention_period (Union[int, float, None]) – AWS::RDS::DBCluster.PerformanceInsightsRetentionPeriod.

  • 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.

  • 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.

  • 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.

  • publicly_accessible (Union[bool, IResolvable, None]) – AWS::RDS::DBCluster.PubliclyAccessible.

  • 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.

  • 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. Constraints: You can’t specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11. If you don’t specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

  • scaling_configuration (Union[IResolvable, ScalingConfigurationProperty, Dict[str, Any], None]) – The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. Currently, AWS CloudFormation only supports Aurora Serverless v1. AWS CloudFormation doesn’t support Aurora Serverless v2.

  • serverless_v2_scaling_configuration (Union[IResolvable, ServerlessV2ScalingConfigurationProperty, Dict[str, Any], None]) – AWS::RDS::DBCluster.ServerlessV2ScalingConfiguration.

  • 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.

  • 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.

  • source_region (Optional[str]) – The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1 .

  • 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 .

  • storage_type (Optional[str]) – AWS::RDS::DBCluster.StorageType.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags to assign to the DB cluster.

  • 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.

  • 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.

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_depends_on(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_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

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.

Return type

None

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 intermdediate 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).

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 resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

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.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

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.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

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

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

AWS::RDS::DBCluster.AllocatedStorage.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-allocatedstorage

Return type

Union[int, float, None]

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-associatedroles

Return type

Union[IResolvable, List[Union[DBClusterRoleProperty, IResolvable]], None]

attr_endpoint_address

The connection endpoint for the DB cluster.

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

CloudformationAttribute

Endpoint.Address

Return type

str

attr_endpoint_port

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

For example: 3306

CloudformationAttribute

Endpoint.Port

Return type

str

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

Return type

str

auto_minor_version_upgrade

AWS::RDS::DBCluster.AutoMinorVersionUpgrade.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-autominorversionupgrade

Return type

Union[bool, IResolvable, None]

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 in the Amazon Aurora User Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-availabilityzones

Return type

Optional[List[str]]

backtrack_window

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backtrackwindow

Return type

Union[int, float, None]

backup_retention_period

The number of days for which automated backups are retained.

Default: 1

Constraints:

  • Must be a value from 1 to 35

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backupretentionperiod

Return type

Union[int, float, None]

cfn_options

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

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-copytagstosnapshot

Return type

Union[bool, IResolvable, None]

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.

Return type

List[str]

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 in the Amazon Aurora User Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-databasename

Return type

Optional[str]

db_cluster_identifier

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusteridentifier

Return type

Optional[str]

db_cluster_instance_class

AWS::RDS::DBCluster.DBClusterInstanceClass.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterinstanceclass

Return type

Optional[str]

db_cluster_parameter_group_name

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

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterparametergroupname

Return type

Optional[str]

db_instance_parameter_group_name

AWS::RDS::DBCluster.DBInstanceParameterGroupName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbinstanceparametergroupname

Return type

Optional[str]

db_subnet_group_name

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbsubnetgroupname

Return type

Optional[str]

deletion_protection

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-deletionprotection

Return type

Union[bool, IResolvable, None]

domain

AWS::RDS::DBCluster.Domain.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-domain

Return type

Optional[str]

domain_iam_role_name

AWS::RDS::DBCluster.DomainIAMRoleName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-domainiamrolename

Return type

Optional[str]

enable_cloudwatch_logs_exports

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablecloudwatchlogsexports

Return type

Optional[List[str]]

enable_http_endpoint

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.

By default, the HTTP endpoint is disabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablehttpendpoint

Return type

Union[bool, IResolvable, None]

enable_iam_database_authentication

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enableiamdatabaseauthentication

Return type

Union[bool, IResolvable, None]

engine

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

Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engine

Return type

str

engine_mode

The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .

The serverless engine mode only supports Aurora Serverless v1. Currently, AWS CloudFormation doesn’t support Aurora Serverless v2.

The parallelquery engine mode isn’t required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.

The global engine mode isn’t required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn’t required for any 2.x versions.

The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.

For Aurora PostgreSQL, the global engine mode isn’t required, and both the parallelquery and the multimaster engine modes currently aren’t supported.

Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide :

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enginemode

Return type

Optional[str]

engine_version

The version number of the database engine to use.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

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"

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engineversion

Return type

Optional[str]

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.

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-globalclusteridentifier

Return type

Optional[str]

iops

AWS::RDS::DBCluster.Iops.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-iops

Return type

Union[int, float, None]

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 .

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.

Link

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

Return type

Optional[str]

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).

Return type

str

Returns

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

master_user_password

The master password for the DB instance.

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masteruserpassword

Return type

Optional[str]

master_username

The name of the master user for the DB cluster.

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masterusername

Return type

Optional[str]

monitoring_interval

AWS::RDS::DBCluster.MonitoringInterval.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-monitoringinterval

Return type

Union[int, float, None]

monitoring_role_arn

AWS::RDS::DBCluster.MonitoringRoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-monitoringrolearn

Return type

Optional[str]

network_type

AWS::RDS::DBCluster.NetworkType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-networktype

Return type

Optional[str]

node

The construct tree node associated with this construct.

Return type

ConstructNode

performance_insights_enabled

AWS::RDS::DBCluster.PerformanceInsightsEnabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightsenabled

Return type

Union[bool, IResolvable, None]

performance_insights_kms_key_id

AWS::RDS::DBCluster.PerformanceInsightsKmsKeyId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightskmskeyid

Return type

Optional[str]

performance_insights_retention_period

AWS::RDS::DBCluster.PerformanceInsightsRetentionPeriod.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightsretentionperiod

Return type

Union[int, float, None]

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

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.

Link

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

Return type

Union[int, float, None]

preferred_backup_window

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredbackupwindow

Return type

Optional[str]

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 in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredmaintenancewindow

Return type

Optional[str]

publicly_accessible

AWS::RDS::DBCluster.PubliclyAccessible.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-publiclyaccessible

Return type

Union[bool, IResolvable, None]

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 }).

Return type

str

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-replicationsourceidentifier

Return type

Optional[str]

restore_type

.

  • 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.

Constraints: You can’t specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

If you don’t specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-restoretype

Type

The type of restore to be performed. You can specify one of the following values

Return type

Optional[str]

scaling_configuration

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

Currently, AWS CloudFormation only supports Aurora Serverless v1. AWS CloudFormation doesn’t support Aurora Serverless v2.

Link

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

Return type

Union[IResolvable, ScalingConfigurationProperty, None]

serverless_v2_scaling_configuration

AWS::RDS::DBCluster.ServerlessV2ScalingConfiguration.

Link

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

Return type

Union[IResolvable, ServerlessV2ScalingConfigurationProperty, None]

snapshot_identifier

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-snapshotidentifier

Return type

Optional[str]

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.

Constraints:

  • Must match the identifier of an existing DBCluster.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourcedbclusteridentifier

Return type

Optional[str]

source_region

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

For example, us-east-1 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourceregion

Return type

Optional[str]

stack

The stack in which this element is defined.

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

Return type

Stack

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storageencrypted

Return type

Union[bool, IResolvable, None]

storage_type

AWS::RDS::DBCluster.StorageType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storagetype

Return type

Optional[str]

tags

Tags to assign to the DB cluster.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-tags

Return type

TagManager

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-uselatestrestorabletime

Return type

Union[bool, IResolvable, None]

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-vpcsecuritygroupids

Return type

Optional[List[str]]

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(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

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 .

Link

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.
import aws_cdk.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 .

Link

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

Return type

Optional[str]

role_arn

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

Link

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

Return type

str

ReadEndpointProperty

class CfnDBCluster.ReadEndpointProperty(*, address=None)

Bases: object

Parameters

address (Optional[str]) – CfnDBCluster.ReadEndpointProperty.Address.

Link

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.
import aws_cdk.aws_rds as rds

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

Attributes

address

CfnDBCluster.ReadEndpointProperty.Address.

Link

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

Return type

Optional[str]

ScalingConfigurationProperty

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

Bases: object

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

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

Currently, AWS CloudFormation only supports Aurora Serverless v1. AWS CloudFormation doesn’t support Aurora Serverless v2.

Parameters
  • auto_pause (Union[bool, IResolvable, None]) – A value that 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_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.

Link

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.
import aws_cdk.aws_rds as rds

scaling_configuration_property = rds.CfnDBCluster.ScalingConfigurationProperty(
    auto_pause=False,
    max_capacity=123,
    min_capacity=123,
    seconds_until_auto_pause=123
)

Attributes

auto_pause

A value that 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.
Link

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

Return type

Union[bool, IResolvable, None]

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.

Link

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

Return type

Union[int, float, None]

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.

Link

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

Return type

Union[int, float, None]

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.

Link

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

Return type

Union[int, float, None]

ServerlessV2ScalingConfigurationProperty

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

Bases: object

Parameters
  • max_capacity (Union[int, float, None]) – CfnDBCluster.ServerlessV2ScalingConfigurationProperty.MaxCapacity.

  • min_capacity (Union[int, float, None]) – CfnDBCluster.ServerlessV2ScalingConfigurationProperty.MinCapacity.

Link

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.
import aws_cdk.aws_rds as rds

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

Attributes

max_capacity

CfnDBCluster.ServerlessV2ScalingConfigurationProperty.MaxCapacity.

Link

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

Return type

Union[int, float, None]

min_capacity

CfnDBCluster.ServerlessV2ScalingConfigurationProperty.MinCapacity.

Link

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

Return type

Union[int, float, None]