CfnDBClusterProps

class aws_cdk.aws_docdb.CfnDBClusterProps(*, master_username, master_user_password, availability_zones=None, backup_retention_period=None, db_cluster_identifier=None, db_cluster_parameter_group_name=None, db_subnet_group_name=None, deletion_protection=None, enable_cloudwatch_logs_exports=None, engine_version=None, kms_key_id=None, port=None, preferred_backup_window=None, preferred_maintenance_window=None, snapshot_identifier=None, storage_encrypted=None, tags=None, vpc_security_group_ids=None)

Bases: object

__init__(*, master_username, master_user_password, availability_zones=None, backup_retention_period=None, db_cluster_identifier=None, db_cluster_parameter_group_name=None, db_subnet_group_name=None, deletion_protection=None, enable_cloudwatch_logs_exports=None, engine_version=None, kms_key_id=None, port=None, preferred_backup_window=None, preferred_maintenance_window=None, snapshot_identifier=None, storage_encrypted=None, tags=None, vpc_security_group_ids=None)

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

Parameters
  • master_username (str) – AWS::DocDB::DBCluster.MasterUsername.

  • master_user_password (str) – AWS::DocDB::DBCluster.MasterUserPassword.

  • availability_zones (Optional[List[str]]) – AWS::DocDB::DBCluster.AvailabilityZones.

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

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

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

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

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

  • enable_cloudwatch_logs_exports (Optional[List[str]]) – AWS::DocDB::DBCluster.EnableCloudwatchLogsExports.

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

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

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

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

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

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

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

  • tags (Optional[List[CfnTag]]) – AWS::DocDB::DBCluster.Tags.

  • vpc_security_group_ids (Optional[List[str]]) – AWS::DocDB::DBCluster.VpcSecurityGroupIds.

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

Return type

None

Attributes

availability_zones

AWS::DocDB::DBCluster.AvailabilityZones.

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

Return type

Optional[List[str]]

backup_retention_period

AWS::DocDB::DBCluster.BackupRetentionPeriod.

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

Return type

Union[int, float, None]

db_cluster_identifier

AWS::DocDB::DBCluster.DBClusterIdentifier.

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

Return type

Optional[str]

db_cluster_parameter_group_name

AWS::DocDB::DBCluster.DBClusterParameterGroupName.

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

Return type

Optional[str]

db_subnet_group_name

AWS::DocDB::DBCluster.DBSubnetGroupName.

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

Return type

Optional[str]

deletion_protection

AWS::DocDB::DBCluster.DeletionProtection.

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

Return type

Union[bool, IResolvable, None]

enable_cloudwatch_logs_exports

AWS::DocDB::DBCluster.EnableCloudwatchLogsExports.

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

Return type

Optional[List[str]]

engine_version

AWS::DocDB::DBCluster.EngineVersion.

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

Return type

Optional[str]

kms_key_id

AWS::DocDB::DBCluster.KmsKeyId.

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

Return type

Optional[str]

master_user_password

AWS::DocDB::DBCluster.MasterUserPassword.

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

Return type

str

master_username

AWS::DocDB::DBCluster.MasterUsername.

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

Return type

str

port

AWS::DocDB::DBCluster.Port.

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

Return type

Union[int, float, None]

preferred_backup_window

AWS::DocDB::DBCluster.PreferredBackupWindow.

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

Return type

Optional[str]

preferred_maintenance_window

AWS::DocDB::DBCluster.PreferredMaintenanceWindow.

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

Return type

Optional[str]

snapshot_identifier

AWS::DocDB::DBCluster.SnapshotIdentifier.

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

Return type

Optional[str]

storage_encrypted

AWS::DocDB::DBCluster.StorageEncrypted.

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

Return type

Union[bool, IResolvable, None]

tags

AWS::DocDB::DBCluster.Tags.

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

Return type

Optional[List[CfnTag]]

vpc_security_group_ids

AWS::DocDB::DBCluster.VpcSecurityGroupIds.

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

Return type

Optional[List[str]]