CfnDBInstanceProps

class aws_cdk.aws_rds.CfnDBInstanceProps(*, db_instance_class, allocated_storage=None, allow_major_version_upgrade=None, associated_roles=None, auto_minor_version_upgrade=None, availability_zone=None, backup_retention_period=None, ca_certificate_identifier=None, character_set_name=None, copy_tags_to_snapshot=None, db_cluster_identifier=None, db_instance_identifier=None, db_name=None, db_parameter_group_name=None, db_security_groups=None, db_snapshot_identifier=None, db_subnet_group_name=None, delete_automated_backups=None, deletion_protection=None, domain=None, domain_iam_role_name=None, enable_cloudwatch_logs_exports=None, enable_iam_database_authentication=None, enable_performance_insights=None, engine=None, engine_version=None, iops=None, kms_key_id=None, license_model=None, master_username=None, master_user_password=None, max_allocated_storage=None, monitoring_interval=None, monitoring_role_arn=None, multi_az=None, option_group_name=None, performance_insights_kms_key_id=None, performance_insights_retention_period=None, port=None, preferred_backup_window=None, preferred_maintenance_window=None, processor_features=None, promotion_tier=None, publicly_accessible=None, source_db_instance_identifier=None, source_region=None, storage_encrypted=None, storage_type=None, tags=None, timezone=None, use_default_processor_features=None, vpc_security_groups=None)

Bases: object

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

Parameters
  • db_instance_class (str) – AWS::RDS::DBInstance.DBInstanceClass.

  • allocated_storage (Optional[str]) – AWS::RDS::DBInstance.AllocatedStorage.

  • allow_major_version_upgrade (Union[bool, IResolvable, None]) – AWS::RDS::DBInstance.AllowMajorVersionUpgrade.

  • associated_roles (Union[IResolvable, List[Union[IResolvable, DBInstanceRoleProperty]], None]) – AWS::RDS::DBInstance.AssociatedRoles.

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

  • availability_zone (Optional[str]) – AWS::RDS::DBInstance.AvailabilityZone.

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

  • ca_certificate_identifier (Optional[str]) – AWS::RDS::DBInstance.CACertificateIdentifier.

  • character_set_name (Optional[str]) – AWS::RDS::DBInstance.CharacterSetName.

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

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

  • db_instance_identifier (Optional[str]) – AWS::RDS::DBInstance.DBInstanceIdentifier.

  • db_name (Optional[str]) – AWS::RDS::DBInstance.DBName.

  • db_parameter_group_name (Optional[str]) – AWS::RDS::DBInstance.DBParameterGroupName.

  • db_security_groups (Optional[List[str]]) – AWS::RDS::DBInstance.DBSecurityGroups.

  • db_snapshot_identifier (Optional[str]) – AWS::RDS::DBInstance.DBSnapshotIdentifier.

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

  • delete_automated_backups (Union[bool, IResolvable, None]) – AWS::RDS::DBInstance.DeleteAutomatedBackups.

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

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

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

  • enable_cloudwatch_logs_exports (Optional[List[str]]) – AWS::RDS::DBInstance.EnableCloudwatchLogsExports.

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

  • enable_performance_insights (Union[bool, IResolvable, None]) – AWS::RDS::DBInstance.EnablePerformanceInsights.

  • engine (Optional[str]) – AWS::RDS::DBInstance.Engine.

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

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

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

  • license_model (Optional[str]) – AWS::RDS::DBInstance.LicenseModel.

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

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

  • max_allocated_storage (Union[int, float, None]) – AWS::RDS::DBInstance.MaxAllocatedStorage.

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

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

  • multi_az (Union[bool, IResolvable, None]) – AWS::RDS::DBInstance.MultiAZ.

  • option_group_name (Optional[str]) – AWS::RDS::DBInstance.OptionGroupName.

  • performance_insights_kms_key_id (Optional[str]) – AWS::RDS::DBInstance.PerformanceInsightsKMSKeyId.

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

  • port (Optional[str]) – AWS::RDS::DBInstance.Port.

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

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

  • processor_features (Union[IResolvable, List[Union[IResolvable, ProcessorFeatureProperty]], None]) – AWS::RDS::DBInstance.ProcessorFeatures.

  • promotion_tier (Union[int, float, None]) – AWS::RDS::DBInstance.PromotionTier.

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

  • source_db_instance_identifier (Optional[str]) – AWS::RDS::DBInstance.SourceDBInstanceIdentifier.

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

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

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

  • tags (Optional[List[CfnTag]]) – AWS::RDS::DBInstance.Tags.

  • timezone (Optional[str]) – AWS::RDS::DBInstance.Timezone.

  • use_default_processor_features (Union[bool, IResolvable, None]) – AWS::RDS::DBInstance.UseDefaultProcessorFeatures.

  • vpc_security_groups (Optional[List[str]]) – AWS::RDS::DBInstance.VPCSecurityGroups.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html

Attributes

allocated_storage

AWS::RDS::DBInstance.AllocatedStorage.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-allocatedstorage

Return type

Optional[str]

allow_major_version_upgrade

AWS::RDS::DBInstance.AllowMajorVersionUpgrade.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-allowmajorversionupgrade

Return type

Union[bool, IResolvable, None]

associated_roles

AWS::RDS::DBInstance.AssociatedRoles.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-associatedroles

Return type

Union[IResolvable, List[Union[IResolvable, DBInstanceRoleProperty]], None]

auto_minor_version_upgrade

AWS::RDS::DBInstance.AutoMinorVersionUpgrade.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-autominorversionupgrade

Return type

Union[bool, IResolvable, None]

availability_zone

AWS::RDS::DBInstance.AvailabilityZone.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-availabilityzone

Return type

Optional[str]

backup_retention_period

AWS::RDS::DBInstance.BackupRetentionPeriod.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-backupretentionperiod

Return type

Union[int, float, None]

ca_certificate_identifier

AWS::RDS::DBInstance.CACertificateIdentifier.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-cacertificateidentifier

Return type

Optional[str]

character_set_name

AWS::RDS::DBInstance.CharacterSetName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-charactersetname

Return type

Optional[str]

copy_tags_to_snapshot

AWS::RDS::DBInstance.CopyTagsToSnapshot.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-copytagstosnapshot

Return type

Union[bool, IResolvable, None]

db_cluster_identifier

AWS::RDS::DBInstance.DBClusterIdentifier.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbclusteridentifier

Return type

Optional[str]

db_instance_class

AWS::RDS::DBInstance.DBInstanceClass.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbinstanceclass

Return type

str

db_instance_identifier

AWS::RDS::DBInstance.DBInstanceIdentifier.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbinstanceidentifier

Return type

Optional[str]

db_name

AWS::RDS::DBInstance.DBName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbname

Return type

Optional[str]

db_parameter_group_name

AWS::RDS::DBInstance.DBParameterGroupName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbparametergroupname

Return type

Optional[str]

db_security_groups

AWS::RDS::DBInstance.DBSecurityGroups.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups

Return type

Optional[List[str]]

db_snapshot_identifier

AWS::RDS::DBInstance.DBSnapshotIdentifier.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier

Return type

Optional[str]

db_subnet_group_name

AWS::RDS::DBInstance.DBSubnetGroupName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsubnetgroupname

Return type

Optional[str]

delete_automated_backups

AWS::RDS::DBInstance.DeleteAutomatedBackups.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-deleteautomatedbackups

Return type

Union[bool, IResolvable, None]

deletion_protection

AWS::RDS::DBInstance.DeletionProtection.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-deletionprotection

Return type

Union[bool, IResolvable, None]

domain

AWS::RDS::DBInstance.Domain.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-domain

Return type

Optional[str]

domain_iam_role_name

AWS::RDS::DBInstance.DomainIAMRoleName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-domainiamrolename

Return type

Optional[str]

enable_cloudwatch_logs_exports

AWS::RDS::DBInstance.EnableCloudwatchLogsExports.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enablecloudwatchlogsexports

Return type

Optional[List[str]]

enable_iam_database_authentication

AWS::RDS::DBInstance.EnableIAMDatabaseAuthentication.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableiamdatabaseauthentication

Return type

Union[bool, IResolvable, None]

enable_performance_insights

AWS::RDS::DBInstance.EnablePerformanceInsights.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights

Return type

Union[bool, IResolvable, None]

engine

AWS::RDS::DBInstance.Engine.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-engine

Return type

Optional[str]

engine_version

AWS::RDS::DBInstance.EngineVersion.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-engineversion

Return type

Optional[str]

iops

AWS::RDS::DBInstance.Iops.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-iops

Return type

Union[int, float, None]

kms_key_id

AWS::RDS::DBInstance.KmsKeyId.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-kmskeyid

Return type

Optional[str]

license_model

AWS::RDS::DBInstance.LicenseModel.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-licensemodel

Return type

Optional[str]

master_user_password

AWS::RDS::DBInstance.MasterUserPassword.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-masteruserpassword

Return type

Optional[str]

master_username

AWS::RDS::DBInstance.MasterUsername.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-masterusername

Return type

Optional[str]

max_allocated_storage

AWS::RDS::DBInstance.MaxAllocatedStorage.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-maxallocatedstorage

Return type

Union[int, float, None]

monitoring_interval

AWS::RDS::DBInstance.MonitoringInterval.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-monitoringinterval

Return type

Union[int, float, None]

monitoring_role_arn

AWS::RDS::DBInstance.MonitoringRoleArn.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-monitoringrolearn

Return type

Optional[str]

multi_az

AWS::RDS::DBInstance.MultiAZ.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-multiaz

Return type

Union[bool, IResolvable, None]

option_group_name

AWS::RDS::DBInstance.OptionGroupName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-optiongroupname

Return type

Optional[str]

performance_insights_kms_key_id

AWS::RDS::DBInstance.PerformanceInsightsKMSKeyId.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-performanceinsightskmskeyid

Return type

Optional[str]

performance_insights_retention_period

AWS::RDS::DBInstance.PerformanceInsightsRetentionPeriod.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-performanceinsightsretentionperiod

Return type

Union[int, float, None]

port

AWS::RDS::DBInstance.Port.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port

Return type

Optional[str]

preferred_backup_window

AWS::RDS::DBInstance.PreferredBackupWindow.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-preferredbackupwindow

Return type

Optional[str]

preferred_maintenance_window

AWS::RDS::DBInstance.PreferredMaintenanceWindow.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-preferredmaintenancewindow

Return type

Optional[str]

processor_features

AWS::RDS::DBInstance.ProcessorFeatures.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-processorfeatures

Return type

Union[IResolvable, List[Union[IResolvable, ProcessorFeatureProperty]], None]

promotion_tier

AWS::RDS::DBInstance.PromotionTier.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-promotiontier

Return type

Union[int, float, None]

publicly_accessible

AWS::RDS::DBInstance.PubliclyAccessible.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-publiclyaccessible

Return type

Union[bool, IResolvable, None]

source_db_instance_identifier

AWS::RDS::DBInstance.SourceDBInstanceIdentifier.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-sourcedbinstanceidentifier

Return type

Optional[str]

source_region

AWS::RDS::DBInstance.SourceRegion.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-sourceregion

Return type

Optional[str]

storage_encrypted

AWS::RDS::DBInstance.StorageEncrypted.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-storageencrypted

Return type

Union[bool, IResolvable, None]

storage_type

AWS::RDS::DBInstance.StorageType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-storagetype

Return type

Optional[str]

tags

AWS::RDS::DBInstance.Tags.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-tags

Return type

Optional[List[CfnTag]]

timezone

AWS::RDS::DBInstance.Timezone.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-timezone

Return type

Optional[str]

use_default_processor_features

AWS::RDS::DBInstance.UseDefaultProcessorFeatures.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-usedefaultprocessorfeatures

Return type

Union[bool, IResolvable, None]

vpc_security_groups

AWS::RDS::DBInstance.VPCSecurityGroups.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-vpcsecuritygroups

Return type

Optional[List[str]]