CfnDBClusterProps

class aws_cdk.aws_rds.CfnDBClusterProps(*, associated_roles=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_parameter_group_name=None, db_subnet_group_name=None, deletion_protection=None, enable_cloudwatch_logs_exports=None, enable_http_endpoint=None, enable_iam_database_authentication=None, engine, engine_mode=None, engine_version=None, global_cluster_identifier=None, kms_key_id=None, master_username=None, master_user_password=None, port=None, preferred_backup_window=None, preferred_maintenance_window=None, replication_source_identifier=None, restore_type=None, scaling_configuration=None, snapshot_identifier=None, source_db_cluster_identifier=None, source_region=None, storage_encrypted=None, tags=None, use_latest_restorable_time=None, vpc_security_group_ids=None)

Bases: object

Properties for defining a AWS::RDS::DBCluster.

Parameters
  • associated_roles (Union[IResolvable, Sequence[Union[IResolvable, DBClusterRoleProperty]], None]) – AWS::RDS::DBCluster.AssociatedRoles.

  • availability_zones (Optional[Sequence[str]]) – AWS::RDS::DBCluster.AvailabilityZones.

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

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

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

  • database_name (Optional[str]) – AWS::RDS::DBCluster.DatabaseName.

  • db_cluster_identifier (Optional[str]) – AWS::RDS::DBCluster.DBClusterIdentifier.

  • db_cluster_parameter_group_name (Optional[str]) – AWS::RDS::DBCluster.DBClusterParameterGroupName.

  • db_subnet_group_name (Optional[str]) – AWS::RDS::DBCluster.DBSubnetGroupName.

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

  • enable_cloudwatch_logs_exports (Optional[Sequence[str]]) – AWS::RDS::DBCluster.EnableCloudwatchLogsExports.

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

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

  • engine (str) – AWS::RDS::DBCluster.Engine.

  • engine_mode (Optional[str]) – AWS::RDS::DBCluster.EngineMode.

  • engine_version (Optional[str]) – AWS::RDS::DBCluster.EngineVersion.

  • global_cluster_identifier (Optional[str]) – AWS::RDS::DBCluster.GlobalClusterIdentifier.

  • kms_key_id (Optional[str]) – AWS::RDS::DBCluster.KmsKeyId.

  • master_username (Optional[str]) – AWS::RDS::DBCluster.MasterUsername.

  • master_user_password (Optional[str]) – AWS::RDS::DBCluster.MasterUserPassword.

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

  • preferred_backup_window (Optional[str]) – AWS::RDS::DBCluster.PreferredBackupWindow.

  • preferred_maintenance_window (Optional[str]) – AWS::RDS::DBCluster.PreferredMaintenanceWindow.

  • replication_source_identifier (Optional[str]) – AWS::RDS::DBCluster.ReplicationSourceIdentifier.

  • restore_type (Optional[str]) – AWS::RDS::DBCluster.RestoreType.

  • scaling_configuration (Union[IResolvable, ScalingConfigurationProperty, None]) – AWS::RDS::DBCluster.ScalingConfiguration.

  • snapshot_identifier (Optional[str]) – AWS::RDS::DBCluster.SnapshotIdentifier.

  • source_db_cluster_identifier (Optional[str]) – AWS::RDS::DBCluster.SourceDBClusterIdentifier.

  • source_region (Optional[str]) – AWS::RDS::DBCluster.SourceRegion.

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

  • tags (Optional[Sequence[CfnTag]]) – AWS::RDS::DBCluster.Tags.

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

  • vpc_security_group_ids (Optional[Sequence[str]]) – AWS::RDS::DBCluster.VpcSecurityGroupIds.

Link

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

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_props = rds.CfnDBClusterProps(
    engine="engine",

    # the properties below are optional
    associated_roles=[rds.CfnDBCluster.DBClusterRoleProperty(
        role_arn="roleArn",

        # the properties below are optional
        feature_name="featureName"
    )],
    availability_zones=["availabilityZones"],
    backtrack_window=123,
    backup_retention_period=123,
    copy_tags_to_snapshot=False,
    database_name="databaseName",
    db_cluster_identifier="dbClusterIdentifier",
    db_cluster_parameter_group_name="dbClusterParameterGroupName",
    db_subnet_group_name="dbSubnetGroupName",
    deletion_protection=False,
    enable_cloudwatch_logs_exports=["enableCloudwatchLogsExports"],
    enable_http_endpoint=False,
    enable_iam_database_authentication=False,
    engine_mode="engineMode",
    engine_version="engineVersion",
    global_cluster_identifier="globalClusterIdentifier",
    kms_key_id="kmsKeyId",
    master_username="masterUsername",
    master_user_password="masterUserPassword",
    port=123,
    preferred_backup_window="preferredBackupWindow",
    preferred_maintenance_window="preferredMaintenanceWindow",
    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
    ),
    snapshot_identifier="snapshotIdentifier",
    source_db_cluster_identifier="sourceDbClusterIdentifier",
    source_region="sourceRegion",
    storage_encrypted=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    use_latest_restorable_time=False,
    vpc_security_group_ids=["vpcSecurityGroupIds"]
)

Attributes

associated_roles

AWS::RDS::DBCluster.AssociatedRoles.

Link

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

Return type

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

availability_zones

AWS::RDS::DBCluster.AvailabilityZones.

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

AWS::RDS::DBCluster.BacktrackWindow.

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

AWS::RDS::DBCluster.BackupRetentionPeriod.

Link

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

Return type

Union[int, float, None]

copy_tags_to_snapshot

AWS::RDS::DBCluster.CopyTagsToSnapshot.

Link

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

Return type

Union[bool, IResolvable, None]

database_name

AWS::RDS::DBCluster.DatabaseName.

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

AWS::RDS::DBCluster.DBClusterIdentifier.

Link

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

Return type

Optional[str]

db_cluster_parameter_group_name

AWS::RDS::DBCluster.DBClusterParameterGroupName.

Link

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

Return type

Optional[str]

db_subnet_group_name

AWS::RDS::DBCluster.DBSubnetGroupName.

Link

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

Return type

Optional[str]

deletion_protection

AWS::RDS::DBCluster.DeletionProtection.

Link

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

Return type

Union[bool, IResolvable, None]

enable_cloudwatch_logs_exports

AWS::RDS::DBCluster.EnableCloudwatchLogsExports.

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

AWS::RDS::DBCluster.EnableHttpEndpoint.

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

AWS::RDS::DBCluster.EnableIAMDatabaseAuthentication.

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

AWS::RDS::DBCluster.Engine.

Link

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

Return type

str

engine_mode

AWS::RDS::DBCluster.EngineMode.

Link

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

Return type

Optional[str]

engine_version

AWS::RDS::DBCluster.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

AWS::RDS::DBCluster.GlobalClusterIdentifier.

Link

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

Return type

Optional[str]

kms_key_id

AWS::RDS::DBCluster.KmsKeyId.

Link

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

Return type

Optional[str]

master_user_password

AWS::RDS::DBCluster.MasterUserPassword.

Link

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

Return type

Optional[str]

master_username

AWS::RDS::DBCluster.MasterUsername.

Link

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

Return type

Optional[str]

port

AWS::RDS::DBCluster.Port.

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

AWS::RDS::DBCluster.PreferredBackupWindow.

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

AWS::RDS::DBCluster.PreferredMaintenanceWindow.

Link

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

Return type

Optional[str]

replication_source_identifier

AWS::RDS::DBCluster.ReplicationSourceIdentifier.

Link

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

Return type

Optional[str]

restore_type

AWS::RDS::DBCluster.RestoreType.

Link

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

Return type

Optional[str]

scaling_configuration

AWS::RDS::DBCluster.ScalingConfiguration.

Link

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

Return type

Union[IResolvable, ScalingConfigurationProperty, None]

snapshot_identifier

AWS::RDS::DBCluster.SnapshotIdentifier.

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

AWS::RDS::DBCluster.SourceDBClusterIdentifier.

Link

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

Return type

Optional[str]

source_region

AWS::RDS::DBCluster.SourceRegion.

Link

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

Return type

Optional[str]

storage_encrypted

AWS::RDS::DBCluster.StorageEncrypted.

Link

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

Return type

Union[bool, IResolvable, None]

tags

AWS::RDS::DBCluster.Tags.

Link

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

Return type

Optional[List[CfnTag]]

use_latest_restorable_time

AWS::RDS::DBCluster.UseLatestRestorableTime.

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

AWS::RDS::DBCluster.VpcSecurityGroupIds.

Link

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

Return type

Optional[List[str]]