Class: AWSCDK::RDS::CfnDBInstanceProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
rds/cfn_db_instance_props.rb

Overview

Properties for defining a CfnDBInstance.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(additional_storage_volumes: nil, allocated_storage: nil, allow_major_version_upgrade: nil, apply_immediately: nil, associated_roles: nil, automatic_backup_replication_kms_key_id: nil, automatic_backup_replication_region: nil, automatic_backup_replication_retention_period: nil, auto_minor_version_upgrade: nil, availability_zone: nil, backup_retention_period: nil, backup_target: nil, ca_certificate_identifier: nil, certificate_rotation_restart: nil, character_set_name: nil, copy_tags_to_snapshot: nil, custom_iam_instance_profile: nil, database_insights_mode: nil, db_cluster_identifier: nil, db_cluster_snapshot_identifier: nil, db_instance_class: nil, db_instance_identifier: nil, db_name: nil, db_parameter_group_name: nil, db_security_groups: nil, db_snapshot_identifier: nil, db_subnet_group_name: nil, db_system_id: nil, dedicated_log_volume: nil, delete_automated_backups: nil, deletion_protection: nil, domain: nil, domain_auth_secret_arn: nil, domain_dns_ips: nil, domain_fqdn: nil, domain_iam_role_name: nil, domain_ou: nil, enable_cloudwatch_logs_exports: nil, enable_iam_database_authentication: nil, enable_performance_insights: nil, engine: nil, engine_lifecycle_support: nil, engine_version: nil, iops: nil, kms_key_id: nil, license_model: nil, manage_master_user_password: nil, master_user_authentication_type: nil, master_username: nil, master_user_password: nil, master_user_secret: nil, max_allocated_storage: nil, monitoring_interval: nil, monitoring_role_arn: nil, multi_az: nil, nchar_character_set_name: nil, network_type: nil, option_group_name: nil, performance_insights_kms_key_id: nil, performance_insights_retention_period: nil, port: nil, preferred_backup_window: nil, preferred_maintenance_window: nil, processor_features: nil, promotion_tier: nil, publicly_accessible: nil, replica_mode: nil, restore_time: nil, source_db_cluster_identifier: nil, source_db_instance_automated_backups_arn: nil, source_db_instance_identifier: nil, source_dbi_resource_id: nil, source_region: nil, storage_encrypted: nil, storage_throughput: nil, storage_type: nil, tags: nil, tde_credential_arn: nil, tde_credential_password: nil, timezone: nil, use_default_processor_features: nil, use_latest_restorable_time: nil, vpc_security_groups: nil) ⇒ CfnDBInstanceProps

Returns a new instance of CfnDBInstanceProps.

Parameters:

  • additional_storage_volumes (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::RDS::CfnDBInstance::AdditionalStorageVolumeProperty>, nil) (defaults to: nil) —

    The additional storage volumes associated with the DB instance.

  • allocated_storage (String, nil) (defaults to: nil) —

    The amount of storage in gibibytes (GiB) to be initially allocated for the database instance.

  • allow_major_version_upgrade (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    A value that indicates whether major version upgrades are allowed.

  • apply_immediately (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether changes to the DB instance and any pending modifications are applied immediately, regardless of the PreferredMaintenanceWindow setting.

  • associated_roles (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::RDS::CfnDBInstance::DBInstanceRoleProperty>, nil) (defaults to: nil) —

    The AWS Identity and Access Management (IAM) roles associated with the DB instance.

  • automatic_backup_replication_kms_key_id (String, nil) (defaults to: nil) —

    The AWS KMS key identifier for encryption of the replicated automated backups.

  • automatic_backup_replication_region (String, nil) (defaults to: nil) —

    The AWS Region associated with the automated backup.

  • automatic_backup_replication_retention_period (Numeric, nil) (defaults to: nil) —

    The retention period for automated backups in a different AWS Region.

  • auto_minor_version_upgrade (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window.

  • availability_zone (String, nil) (defaults to: nil) —

    The Availability Zone (AZ) where the database will be created.

  • backup_retention_period (Numeric, nil) (defaults to: nil) —

    The number of days for which automated backups are retained.

  • backup_target (String, nil) (defaults to: nil) —

    The location for storing automated backups and manual snapshots.

  • ca_certificate_identifier (String, nil) (defaults to: nil) —

    The identifier of the CA certificate for this DB instance.

  • certificate_rotation_restart (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

  • character_set_name (String, nil) (defaults to: nil) —

    For supported engines, indicates that the DB instance should be associated with the specified character set.

  • copy_tags_to_snapshot (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether to copy tags from the DB instance to snapshots of the DB instance.

  • custom_iam_instance_profile (String, nil) (defaults to: nil) —

    The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

  • database_insights_mode (String, nil) (defaults to: nil) —

    The mode of Database Insights to enable for the DB instance.

  • db_cluster_identifier (String, AWSCDK::Interfaces::AWSRDS::IDBClusterRef, nil) (defaults to: nil) —

    The identifier of the DB cluster that this DB instance will belong to.

  • db_cluster_snapshot_identifier (String, nil) (defaults to: nil) —

    The identifier for the Multi-AZ DB cluster snapshot to restore from.

  • db_instance_class (String, nil) (defaults to: nil) —

    The compute and memory capacity of the DB instance, for example db.m5.large . Not all DB instance classes are available in all AWS Regions , or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide .

  • db_instance_identifier (String, nil) (defaults to: nil) —

    A name for the DB instance.

  • db_name (String, nil) (defaults to: nil) —

    The meaning of this parameter differs according to the database engine you use.

  • db_parameter_group_name (String, AWSCDK::Interfaces::AWSRDS::IDBParameterGroupRef, nil) (defaults to: nil) —

    The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template.

  • db_security_groups (Array<String>, nil) (defaults to: nil) —

    A list of the DB security groups to assign to the DB instance.

  • db_snapshot_identifier (String, nil) (defaults to: nil) —

    The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance.

  • db_subnet_group_name (String, AWSCDK::Interfaces::AWSRDS::IDBSubnetGroupRef, nil) (defaults to: nil) —

    A DB subnet group to associate with the DB instance.

  • db_system_id (String, nil) (defaults to: nil) —

    The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files.

  • dedicated_log_volume (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

  • delete_automated_backups (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    A value that indicates whether to remove automated backups immediately after the DB instance is deleted.

  • deletion_protection (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether the DB instance has deletion protection enabled.

  • domain (String, nil) (defaults to: nil) —

    The Active Directory directory ID to create the DB instance in.

  • domain_auth_secret_arn (String, nil) (defaults to: nil) —

    The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

  • domain_dns_ips (Array<String>, nil) (defaults to: nil) —

    The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

  • domain_fqdn (String, nil) (defaults to: nil) —

    The fully qualified domain name (FQDN) of an Active Directory domain.

  • domain_iam_role_name (String, nil) (defaults to: nil) —

    The name of the IAM role to use when making API calls to the Directory Service.

  • domain_ou (String, nil) (defaults to: nil) —

    The Active Directory organizational unit for your DB instance to join.

  • enable_cloudwatch_logs_exports (Array<String>, nil) (defaults to: nil) —

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

  • enable_iam_database_authentication (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • enable_performance_insights (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether to enable Performance Insights for the DB instance.

  • engine (String, nil) (defaults to: nil) —

    The name of the database engine to use for this DB instance.

  • engine_lifecycle_support (String, nil) (defaults to: nil) —

    The life cycle type for this DB instance.

  • engine_version (String, nil) (defaults to: nil) —

    The version number of the database engine to use.

  • iops (Numeric, nil) (defaults to: nil) —

    The number of I/O operations per second (IOPS) that the database provisions.

  • kms_key_id (String, AWSCDK::Interfaces::AWSKMS::IKeyRef, nil) (defaults to: nil) —

    The ARN of the AWS KMS key that's used to encrypt the DB instance, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef .

  • license_model (String, nil) (defaults to: nil) —

    License model information for this DB instance.

  • manage_master_user_password (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • master_user_authentication_type (String, nil) (defaults to: nil) —

    Specifies the authentication type for the master user.

  • master_username (String, nil) (defaults to: nil) —

    The master user name for the DB instance.

  • master_user_password (String, nil) (defaults to: nil) —

    The password for the master user. The password can include any printable ASCII character except "/", """, or "@".

  • master_user_secret (AWSCDK::IResolvable, AWSCDK::RDS::CfnDBInstance::MasterUserSecretProperty, nil) (defaults to: nil) —

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

  • max_allocated_storage (Numeric, nil) (defaults to: nil) —

    The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

  • monitoring_interval (Numeric, nil) (defaults to: nil) —

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

  • monitoring_role_arn (String, AWSCDK::Interfaces::AWSIAM::IRoleRef, nil) (defaults to: nil) —

    The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.

  • multi_az (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether the DB instance is a Multi-AZ deployment.

  • nchar_character_set_name (String, nil) (defaults to: nil) —

    The name of the NCHAR character set for the Oracle DB instance.

  • network_type (String, nil) (defaults to: nil) —

    The network type of the DB instance.

  • option_group_name (String, nil) (defaults to: nil) —

    Indicates that the DB instance should be associated with the specified option group.

  • performance_insights_kms_key_id (String, AWSCDK::Interfaces::AWSKMS::IKeyRef, nil) (defaults to: nil) —

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

  • performance_insights_retention_period (Numeric, nil) (defaults to: nil) —

    The number of days to retain Performance Insights data.

  • port (String, nil) (defaults to: nil) —

    The port number on which the database accepts connections.

  • preferred_backup_window (String, nil) (defaults to: nil) —

    The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

  • preferred_maintenance_window (String, nil) (defaults to: nil) —

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

  • processor_features (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::RDS::CfnDBInstance::ProcessorFeatureProperty>, nil) (defaults to: nil) —

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

  • promotion_tier (Numeric, nil) (defaults to: nil) —

    The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.

  • publicly_accessible (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Indicates whether the DB instance is an internet-facing instance.

  • replica_mode (String, nil) (defaults to: nil) —

    The open mode of an Oracle read replica.

  • restore_time (String, nil) (defaults to: nil) —

    The date and time to restore from.

  • source_db_cluster_identifier (String, nil) (defaults to: nil) —

    The identifier of the Multi-AZ DB cluster that will act as the source for the read replica.

  • source_db_instance_automated_backups_arn (String, nil) (defaults to: nil) —

    The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE .

  • source_db_instance_identifier (String, AWSCDK::Interfaces::AWSRDS::IDBInstanceRef, nil) (defaults to: nil) —

    If you want to create a read replica DB instance, specify the ID of the source DB instance.

  • source_dbi_resource_id (String, nil) (defaults to: nil) —

    The resource ID of the source DB instance from which to restore.

  • source_region (String, nil) (defaults to: nil) —

    The ID of the region that contains the source DB instance for the read replica.

  • storage_encrypted (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

  • storage_throughput (Numeric, nil) (defaults to: nil) —

    Specifies the storage throughput value, in mebibyte per second (MiBps), for the DB instance.

  • storage_type (String, nil) (defaults to: nil) —

    The storage type to associate with the DB instance.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    Tags to assign to the DB instance.

  • tde_credential_arn (String, nil) (defaults to: nil)
  • tde_credential_password (String, nil) (defaults to: nil)
  • timezone (String, nil) (defaults to: nil) —

    The time zone of the DB instance.

  • use_default_processor_features (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether the DB instance class of the DB instance uses its default processor features.

  • use_latest_restorable_time (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether the DB instance is restored from the latest backup time.

  • vpc_security_groups (Array<String, AWSCDK::Interfaces::AWSEC2::ISecurityGroupRef>, nil) (defaults to: nil) —

    A list of the VPC security group IDs to assign to the DB instance.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'rds/cfn_db_instance_props.rb', line 92

def initialize(additional_storage_volumes: nil, allocated_storage: nil, allow_major_version_upgrade: nil, apply_immediately: nil, associated_roles: nil, automatic_backup_replication_kms_key_id: nil, automatic_backup_replication_region: nil, automatic_backup_replication_retention_period: nil, auto_minor_version_upgrade: nil, availability_zone: nil, backup_retention_period: nil, backup_target: nil, ca_certificate_identifier: nil, certificate_rotation_restart: nil, character_set_name: nil, copy_tags_to_snapshot: nil, custom_iam_instance_profile: nil, database_insights_mode: nil, db_cluster_identifier: nil, db_cluster_snapshot_identifier: nil, db_instance_class: nil, db_instance_identifier: nil, db_name: nil, db_parameter_group_name: nil, db_security_groups: nil, db_snapshot_identifier: nil, db_subnet_group_name: nil, db_system_id: nil, dedicated_log_volume: nil, delete_automated_backups: nil, deletion_protection: nil, domain: nil, domain_auth_secret_arn: nil, domain_dns_ips: nil, domain_fqdn: nil, domain_iam_role_name: nil, domain_ou: nil, enable_cloudwatch_logs_exports: nil, enable_iam_database_authentication: nil, enable_performance_insights: nil, engine: nil, engine_lifecycle_support: nil, engine_version: nil, iops: nil, kms_key_id: nil, license_model: nil, manage_master_user_password: nil, master_user_authentication_type: nil, master_username: nil, master_user_password: nil, master_user_secret: nil, max_allocated_storage: nil, monitoring_interval: nil, monitoring_role_arn: nil, multi_az: nil, nchar_character_set_name: nil, network_type: nil, option_group_name: nil, performance_insights_kms_key_id: nil, performance_insights_retention_period: nil, port: nil, preferred_backup_window: nil, preferred_maintenance_window: nil, processor_features: nil, promotion_tier: nil, publicly_accessible: nil, replica_mode: nil, restore_time: nil, source_db_cluster_identifier: nil, source_db_instance_automated_backups_arn: nil, source_db_instance_identifier: nil, source_dbi_resource_id: nil, source_region: nil, storage_encrypted: nil, storage_throughput: nil, storage_type: nil, tags: nil, tde_credential_arn: nil, tde_credential_password: nil, timezone: nil, use_default_processor_features: nil, use_latest_restorable_time: nil, vpc_security_groups: nil)
  @additional_storage_volumes = additional_storage_volumes
  Jsii::Type.check_type(@additional_storage_volumes, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLkNmbkRCSW5zdGFuY2UuQWRkaXRpb25hbFN0b3JhZ2VWb2x1bWVQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "additionalStorageVolumes") unless @additional_storage_volumes.nil?
  @allocated_storage = allocated_storage
  Jsii::Type.check_type(@allocated_storage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "allocatedStorage") unless @allocated_storage.nil?
  @allow_major_version_upgrade = allow_major_version_upgrade
  Jsii::Type.check_type(@allow_major_version_upgrade, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "allowMajorVersionUpgrade") unless @allow_major_version_upgrade.nil?
  @apply_immediately = apply_immediately
  Jsii::Type.check_type(@apply_immediately, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "applyImmediately") unless @apply_immediately.nil?
  @associated_roles = associated_roles
  Jsii::Type.check_type(@associated_roles, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLkNmbkRCSW5zdGFuY2UuREJJbnN0YW5jZVJvbGVQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "associatedRoles") unless @associated_roles.nil?
  @automatic_backup_replication_kms_key_id = automatic_backup_replication_kms_key_id
  Jsii::Type.check_type(@automatic_backup_replication_kms_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "automaticBackupReplicationKmsKeyId") unless @automatic_backup_replication_kms_key_id.nil?
  @automatic_backup_replication_region = automatic_backup_replication_region
  Jsii::Type.check_type(@automatic_backup_replication_region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "automaticBackupReplicationRegion") unless @automatic_backup_replication_region.nil?
  @automatic_backup_replication_retention_period = automatic_backup_replication_retention_period
  Jsii::Type.check_type(@automatic_backup_replication_retention_period, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "automaticBackupReplicationRetentionPeriod") unless @automatic_backup_replication_retention_period.nil?
  @auto_minor_version_upgrade = auto_minor_version_upgrade
  Jsii::Type.check_type(@auto_minor_version_upgrade, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "autoMinorVersionUpgrade") unless @auto_minor_version_upgrade.nil?
  @availability_zone = availability_zone
  Jsii::Type.check_type(@availability_zone, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "availabilityZone") unless @availability_zone.nil?
  @backup_retention_period = backup_retention_period
  Jsii::Type.check_type(@backup_retention_period, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "backupRetentionPeriod") unless @backup_retention_period.nil?
  @backup_target = backup_target
  Jsii::Type.check_type(@backup_target, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "backupTarget") unless @backup_target.nil?
  @ca_certificate_identifier = ca_certificate_identifier
  Jsii::Type.check_type(@ca_certificate_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "caCertificateIdentifier") unless @ca_certificate_identifier.nil?
  @certificate_rotation_restart = certificate_rotation_restart
  Jsii::Type.check_type(@certificate_rotation_restart, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "certificateRotationRestart") unless @certificate_rotation_restart.nil?
  @character_set_name = character_set_name
  Jsii::Type.check_type(@character_set_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "characterSetName") unless @character_set_name.nil?
  @copy_tags_to_snapshot = copy_tags_to_snapshot
  Jsii::Type.check_type(@copy_tags_to_snapshot, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "copyTagsToSnapshot") unless @copy_tags_to_snapshot.nil?
  @custom_iam_instance_profile = custom_iam_instance_profile
  Jsii::Type.check_type(@custom_iam_instance_profile, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customIamInstanceProfile") unless @custom_iam_instance_profile.nil?
  @database_insights_mode = database_insights_mode
  Jsii::Type.check_type(@database_insights_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "databaseInsightsMode") unless @database_insights_mode.nil?
  @db_cluster_identifier = db_cluster_identifier
  Jsii::Type.check_type(@db_cluster_identifier, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19yZHMuSURCQ2x1c3RlclJlZiJ9XX19")), "dbClusterIdentifier") unless @db_cluster_identifier.nil?
  @db_cluster_snapshot_identifier = db_cluster_snapshot_identifier
  Jsii::Type.check_type(@db_cluster_snapshot_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbClusterSnapshotIdentifier") unless @db_cluster_snapshot_identifier.nil?
  @db_instance_class = db_instance_class
  Jsii::Type.check_type(@db_instance_class, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbInstanceClass") unless @db_instance_class.nil?
  @db_instance_identifier = db_instance_identifier
  Jsii::Type.check_type(@db_instance_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbInstanceIdentifier") unless @db_instance_identifier.nil?
  @db_name = db_name
  Jsii::Type.check_type(@db_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbName") unless @db_name.nil?
  @db_parameter_group_name = db_parameter_group_name
  Jsii::Type.check_type(@db_parameter_group_name, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19yZHMuSURCUGFyYW1ldGVyR3JvdXBSZWYifV19fQ==")), "dbParameterGroupName") unless @db_parameter_group_name.nil?
  @db_security_groups = db_security_groups
  Jsii::Type.check_type(@db_security_groups, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "dbSecurityGroups") unless @db_security_groups.nil?
  @db_snapshot_identifier = db_snapshot_identifier
  Jsii::Type.check_type(@db_snapshot_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbSnapshotIdentifier") unless @db_snapshot_identifier.nil?
  @db_subnet_group_name = db_subnet_group_name
  Jsii::Type.check_type(@db_subnet_group_name, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19yZHMuSURCU3VibmV0R3JvdXBSZWYifV19fQ==")), "dbSubnetGroupName") unless @db_subnet_group_name.nil?
  @db_system_id = db_system_id
  Jsii::Type.check_type(@db_system_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbSystemId") unless @db_system_id.nil?
  @dedicated_log_volume = dedicated_log_volume
  Jsii::Type.check_type(@dedicated_log_volume, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "dedicatedLogVolume") unless @dedicated_log_volume.nil?
  @delete_automated_backups = delete_automated_backups
  Jsii::Type.check_type(@delete_automated_backups, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "deleteAutomatedBackups") unless @delete_automated_backups.nil?
  @deletion_protection = deletion_protection
  Jsii::Type.check_type(@deletion_protection, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "deletionProtection") unless @deletion_protection.nil?
  @domain = domain
  Jsii::Type.check_type(@domain, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domain") unless @domain.nil?
  @domain_auth_secret_arn = domain_auth_secret_arn
  Jsii::Type.check_type(@domain_auth_secret_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainAuthSecretArn") unless @domain_auth_secret_arn.nil?
  @domain_dns_ips = domain_dns_ips
  Jsii::Type.check_type(@domain_dns_ips, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "domainDnsIps") unless @domain_dns_ips.nil?
  @domain_fqdn = domain_fqdn
  Jsii::Type.check_type(@domain_fqdn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainFqdn") unless @domain_fqdn.nil?
  @domain_iam_role_name = domain_iam_role_name
  Jsii::Type.check_type(@domain_iam_role_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainIamRoleName") unless @domain_iam_role_name.nil?
  @domain_ou = domain_ou
  Jsii::Type.check_type(@domain_ou, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainOu") unless @domain_ou.nil?
  @enable_cloudwatch_logs_exports = enable_cloudwatch_logs_exports
  Jsii::Type.check_type(@enable_cloudwatch_logs_exports, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "enableCloudwatchLogsExports") unless @enable_cloudwatch_logs_exports.nil?
  @enable_iam_database_authentication = enable_iam_database_authentication
  Jsii::Type.check_type(@enable_iam_database_authentication, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableIamDatabaseAuthentication") unless @enable_iam_database_authentication.nil?
  @enable_performance_insights = enable_performance_insights
  Jsii::Type.check_type(@enable_performance_insights, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enablePerformanceInsights") unless @enable_performance_insights.nil?
  @engine = engine
  Jsii::Type.check_type(@engine, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engine") unless @engine.nil?
  @engine_lifecycle_support = engine_lifecycle_support
  Jsii::Type.check_type(@engine_lifecycle_support, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engineLifecycleSupport") unless @engine_lifecycle_support.nil?
  @engine_version = engine_version
  Jsii::Type.check_type(@engine_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engineVersion") unless @engine_version.nil?
  @iops = iops
  Jsii::Type.check_type(@iops, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "iops") unless @iops.nil?
  @kms_key_id = kms_key_id
  Jsii::Type.check_type(@kms_key_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19rbXMuSUtleVJlZiJ9XX19")), "kmsKeyId") unless @kms_key_id.nil?
  @license_model = license_model
  Jsii::Type.check_type(@license_model, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "licenseModel") unless @license_model.nil?
  @manage_master_user_password = manage_master_user_password
  Jsii::Type.check_type(@manage_master_user_password, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "manageMasterUserPassword") unless @manage_master_user_password.nil?
  @master_user_authentication_type = master_user_authentication_type
  Jsii::Type.check_type(@master_user_authentication_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "masterUserAuthenticationType") unless @master_user_authentication_type.nil?
  @master_username = master_username
  Jsii::Type.check_type(@master_username, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "masterUsername") unless @master_username.nil?
  @master_user_password = master_user_password
  Jsii::Type.check_type(@master_user_password, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "masterUserPassword") unless @master_user_password.nil?
  @master_user_secret = master_user_secret.is_a?(Hash) ? ::AWSCDK::RDS::CfnDBInstance::MasterUserSecretProperty.new(**master_user_secret.transform_keys(&:to_sym)) : master_user_secret
  Jsii::Type.check_type(@master_user_secret, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yZHMuQ2ZuREJJbnN0YW5jZS5NYXN0ZXJVc2VyU2VjcmV0UHJvcGVydHkifV19fQ==")), "masterUserSecret") unless @master_user_secret.nil?
  @max_allocated_storage = max_allocated_storage
  Jsii::Type.check_type(@max_allocated_storage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxAllocatedStorage") unless @max_allocated_storage.nil?
  @monitoring_interval = monitoring_interval
  Jsii::Type.check_type(@monitoring_interval, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "monitoringInterval") unless @monitoring_interval.nil?
  @monitoring_role_arn = monitoring_role_arn
  Jsii::Type.check_type(@monitoring_role_arn, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pYW0uSVJvbGVSZWYifV19fQ==")), "monitoringRoleArn") unless @monitoring_role_arn.nil?
  @multi_az = multi_az
  Jsii::Type.check_type(@multi_az, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "multiAz") unless @multi_az.nil?
  @nchar_character_set_name = nchar_character_set_name
  Jsii::Type.check_type(@nchar_character_set_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ncharCharacterSetName") unless @nchar_character_set_name.nil?
  @network_type = network_type
  Jsii::Type.check_type(@network_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "networkType") unless @network_type.nil?
  @option_group_name = option_group_name
  Jsii::Type.check_type(@option_group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "optionGroupName") unless @option_group_name.nil?
  @performance_insights_kms_key_id = performance_insights_kms_key_id
  Jsii::Type.check_type(@performance_insights_kms_key_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19rbXMuSUtleVJlZiJ9XX19")), "performanceInsightsKmsKeyId") unless @performance_insights_kms_key_id.nil?
  @performance_insights_retention_period = performance_insights_retention_period
  Jsii::Type.check_type(@performance_insights_retention_period, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "performanceInsightsRetentionPeriod") unless @performance_insights_retention_period.nil?
  @port = port
  Jsii::Type.check_type(@port, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "port") unless @port.nil?
  @preferred_backup_window = preferred_backup_window
  Jsii::Type.check_type(@preferred_backup_window, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "preferredBackupWindow") unless @preferred_backup_window.nil?
  @preferred_maintenance_window = preferred_maintenance_window
  Jsii::Type.check_type(@preferred_maintenance_window, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "preferredMaintenanceWindow") unless @preferred_maintenance_window.nil?
  @processor_features = processor_features
  Jsii::Type.check_type(@processor_features, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLkNmbkRCSW5zdGFuY2UuUHJvY2Vzc29yRmVhdHVyZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "processorFeatures") unless @processor_features.nil?
  @promotion_tier = promotion_tier
  Jsii::Type.check_type(@promotion_tier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "promotionTier") unless @promotion_tier.nil?
  @publicly_accessible = publicly_accessible
  Jsii::Type.check_type(@publicly_accessible, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "publiclyAccessible") unless @publicly_accessible.nil?
  @replica_mode = replica_mode
  Jsii::Type.check_type(@replica_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "replicaMode") unless @replica_mode.nil?
  @restore_time = restore_time
  Jsii::Type.check_type(@restore_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "restoreTime") unless @restore_time.nil?
  @source_db_cluster_identifier = source_db_cluster_identifier
  Jsii::Type.check_type(@source_db_cluster_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceDbClusterIdentifier") unless @source_db_cluster_identifier.nil?
  @source_db_instance_automated_backups_arn = source_db_instance_automated_backups_arn
  Jsii::Type.check_type(@source_db_instance_automated_backups_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceDbInstanceAutomatedBackupsArn") unless @source_db_instance_automated_backups_arn.nil?
  @source_db_instance_identifier = source_db_instance_identifier
  Jsii::Type.check_type(@source_db_instance_identifier, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19yZHMuSURCSW5zdGFuY2VSZWYifV19fQ==")), "sourceDbInstanceIdentifier") unless @source_db_instance_identifier.nil?
  @source_dbi_resource_id = source_dbi_resource_id
  Jsii::Type.check_type(@source_dbi_resource_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceDbiResourceId") unless @source_dbi_resource_id.nil?
  @source_region = source_region
  Jsii::Type.check_type(@source_region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceRegion") unless @source_region.nil?
  @storage_encrypted = storage_encrypted
  Jsii::Type.check_type(@storage_encrypted, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "storageEncrypted") unless @storage_encrypted.nil?
  @storage_throughput = storage_throughput
  Jsii::Type.check_type(@storage_throughput, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "storageThroughput") unless @storage_throughput.nil?
  @storage_type = storage_type
  Jsii::Type.check_type(@storage_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "storageType") unless @storage_type.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @tde_credential_arn = tde_credential_arn
  Jsii::Type.check_type(@tde_credential_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tdeCredentialArn") unless @tde_credential_arn.nil?
  @tde_credential_password = tde_credential_password
  Jsii::Type.check_type(@tde_credential_password, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tdeCredentialPassword") unless @tde_credential_password.nil?
  @timezone = timezone
  Jsii::Type.check_type(@timezone, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timezone") unless @timezone.nil?
  @use_default_processor_features = use_default_processor_features
  Jsii::Type.check_type(@use_default_processor_features, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "useDefaultProcessorFeatures") unless @use_default_processor_features.nil?
  @use_latest_restorable_time = use_latest_restorable_time
  Jsii::Type.check_type(@use_latest_restorable_time, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "useLatestRestorableTime") unless @use_latest_restorable_time.nil?
  @vpc_security_groups = vpc_security_groups
  Jsii::Type.check_type(@vpc_security_groups, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InVuaW9uIjp7InR5cGVzIjpbeyJwcmltaXRpdmUiOiJzdHJpbmcifSx7ImZxbiI6ImF3cy1jZGstbGliLmludGVyZmFjZXMuYXdzX2VjMi5JU2VjdXJpdHlHcm91cFJlZiJ9XX19LCJraW5kIjoiYXJyYXkifX0=")), "vpcSecurityGroups") unless @vpc_security_groups.nil?
end

Instance Attribute Details

#additional_storage_volumes ⇒ AWSCDK::IResolvable, ... (readonly)

The additional storage volumes associated with the DB instance.

RDS supports additional storage volumes for RDS for Oracle and RDS for SQL Server.

Returns:

See Also:



267
268
269
 
# File 'rds/cfn_db_instance_props.rb', line 267

def additional_storage_volumes
  @additional_storage_volumes
end

#allocated_storage ⇒ String? (readonly)

The amount of storage in gibibytes (GiB) to be initially allocated for the database instance.

If any value is set in the Iops parameter, AllocatedStorage must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the Iops value (in 1,000 IOPS increments), then you must also increase the AllocatedStorage value (in 100-GiB increments).

Amazon Aurora

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.

Db2

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.

MySQL

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.

MariaDB

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.

PostgreSQL

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.

Oracle

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 10 to 3072.

SQL Server

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2):
  • Enterprise and Standard editions: Must be an integer from 20 to 16384.
  • Web and Express editions: Must be an integer from 20 to 16384.
  • Provisioned IOPS storage (io1):
  • Enterprise and Standard editions: Must be an integer from 20 to 16384.
  • Web and Express editions: Must be an integer from 20 to 16384.
  • Magnetic storage (standard):
  • Enterprise and Standard editions: Must be an integer from 20 to 1024.
  • Web and Express editions: Must be an integer from 20 to 1024.

Returns:

  • (String, nil)

See Also:



331
332
333
 
# File 'rds/cfn_db_instance_props.rb', line 331

def allocated_storage
  @allocated_storage
end

#allow_major_version_upgrade ⇒ Boolean, ... (readonly)

A value that indicates whether major version upgrades are allowed.

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

Returns:

See Also:



340
341
342
 
# File 'rds/cfn_db_instance_props.rb', line 340

def allow_major_version_upgrade
  @allow_major_version_upgrade
end

#apply_immediately ⇒ Boolean, ... (readonly)

Specifies whether changes to the DB instance and any pending modifications are applied immediately, regardless of the PreferredMaintenanceWindow setting.

If set to false , changes are applied during the next maintenance window. Until RDS applies the changes, the DB instance remains in a drift state. As a result, the configuration doesn't fully reflect the requested modifications and temporarily diverges from the intended state.

In addition to the settings described in Modifying a DB instance , this property also determines whether the DB instance reboots when a static parameter is modified in the associated DB parameter group.

Default: true

Returns:

See Also:



351
352
353
 
# File 'rds/cfn_db_instance_props.rb', line 351

def apply_immediately
  @apply_immediately
end

#associated_roles ⇒ AWSCDK::IResolvable, ... (readonly)

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

Amazon Aurora

Not applicable. The associated roles are managed by the DB cluster.

Returns:

See Also:



360
361
362
 
# File 'rds/cfn_db_instance_props.rb', line 360

def associated_roles
  @associated_roles
end

#auto_minor_version_upgrade ⇒ Boolean, ... (readonly)

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window.

By default, minor engine upgrades are applied automatically.

Returns:

See Also:



388
389
390
 
# File 'rds/cfn_db_instance_props.rb', line 388

def auto_minor_version_upgrade
  @auto_minor_version_upgrade
end

#automatic_backup_replication_kms_key_id ⇒ String? (readonly)

The AWS KMS key identifier for encryption of the replicated automated backups.

The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS Region , for example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE .

Returns:

  • (String, nil)

See Also:



367
368
369
 
# File 'rds/cfn_db_instance_props.rb', line 367

def automatic_backup_replication_kms_key_id
  @automatic_backup_replication_kms_key_id
end

#automatic_backup_replication_region ⇒ String? (readonly)

The AWS Region associated with the automated backup.

Returns:

  • (String, nil)

See Also:



372
373
374
 
# File 'rds/cfn_db_instance_props.rb', line 372

def automatic_backup_replication_region
  @automatic_backup_replication_region
end

#automatic_backup_replication_retention_period ⇒ Numeric? (readonly)

The retention period for automated backups in a different AWS Region.

Use this parameter to set a unique retention period that only applies to cross-Region automated backups. To enable automated backups in a different Region, specify a positive value for the AutomaticBackupReplicationRegion parameter.

If not specified, this parameter defaults to the value of the BackupRetentionPeriod parameter. The maximum allowed value is 35.

Returns:

  • (Numeric, nil)

See Also:



381
382
383
 
# File 'rds/cfn_db_instance_props.rb', line 381

def automatic_backup_replication_retention_period
  @automatic_backup_replication_retention_period
end

#availability_zone ⇒ String? (readonly)

The Availability Zone (AZ) where the database will be created.

For information on AWS Regions and Availability Zones, see Regions and Availability Zones .

For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region .

Constraints:

  • The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
  • The specified Availability Zone must be in the same AWS Region as the current endpoint.

Example: us-east-1d

Returns:

  • (String, nil)

See Also:



406
407
408
 
# File 'rds/cfn_db_instance_props.rb', line 406

def availability_zone
  @availability_zone
end

#backup_retention_period ⇒ Numeric? (readonly)

The number of days for which automated backups are retained.

Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster.

Default: 1

Constraints:

  • Must be a value from 0 to 35
  • Can't be set to 0 if the DB instance is a source to read replicas

Returns:

  • (Numeric, nil)

See Also:



424
425
426
 
# File 'rds/cfn_db_instance_props.rb', line 424

def backup_retention_period
  @backup_retention_period
end

#backup_target ⇒ String? (readonly)

The location for storing automated backups and manual snapshots.

Valid Values:

  • local (Dedicated Local Zone)
  • outposts ( AWS Outposts)
  • region ( AWS Region )

Default: region

For more information, see Working with Amazon RDS on AWS Outposts in the Amazon RDS User Guide .

Returns:

  • (String, nil)

See Also:



439
440
441
 
# File 'rds/cfn_db_instance_props.rb', line 439

def backup_target
  @backup_target
end

#ca_certificate_identifier ⇒ String? (readonly)

The identifier of the CA certificate for this DB instance.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide .

Returns:

  • (String, nil)

See Also:



446
447
448
 
# File 'rds/cfn_db_instance_props.rb', line 446

def ca_certificate_identifier
  @ca_certificate_identifier
end

#certificate_rotation_restart ⇒ Boolean, ... (readonly)

Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:

This setting doesn't apply to RDS Custom DB instances.

Returns:

See Also:



462
463
464
 
# File 'rds/cfn_db_instance_props.rb', line 462

def certificate_rotation_restart
  @certificate_rotation_restart
end

#character_set_name ⇒ String? (readonly)

For supported engines, indicates that the DB instance should be associated with the specified character set.

Amazon Aurora

Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster .

Returns:

  • (String, nil)

See Also:



471
472
473
 
# File 'rds/cfn_db_instance_props.rb', line 471

def character_set_name
  @character_set_name
end

#copy_tags_to_snapshot ⇒ Boolean, ... (readonly)

Specifies whether to copy tags from the DB instance to snapshots of the DB instance.

By default, tags are not copied.

This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.

Returns:

See Also:



480
481
482
 
# File 'rds/cfn_db_instance_props.rb', line 480

def copy_tags_to_snapshot
  @copy_tags_to_snapshot
end

#custom_iam_instance_profile ⇒ String? (readonly)

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

This setting is required for RDS Custom.

Constraints:

  • The profile must exist in your account.
  • The profile must have an IAM role that Amazon EC2 has permissions to assume.
  • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom .

For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .

Returns:

  • (String, nil)

See Also:



495
496
497
 
# File 'rds/cfn_db_instance_props.rb', line 495

def custom_iam_instance_profile
  @custom_iam_instance_profile
end

#database_insights_mode ⇒ String? (readonly)

The mode of Database Insights to enable for the DB instance.

Aurora DB instances inherit this value from the DB cluster, so you can't change this value.

Returns:

  • (String, nil)

See Also:



502
503
504
 
# File 'rds/cfn_db_instance_props.rb', line 502

def database_insights_mode
  @database_insights_mode
end

#db_cluster_identifier ⇒ String, ... (readonly)

The identifier of the DB cluster that this DB instance will belong to.

This setting doesn't apply to RDS Custom DB instances.

Returns:

See Also:



509
510
511
 
# File 'rds/cfn_db_instance_props.rb', line 509

def db_cluster_identifier
  @db_cluster_identifier
end

#db_cluster_snapshot_identifier ⇒ String? (readonly)

The identifier for the Multi-AZ DB cluster snapshot to restore from.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide .

Constraints:

  • Must match the identifier of an existing Multi-AZ DB cluster snapshot.
  • Can't be specified when DBSnapshotIdentifier is specified.
  • Must be specified when DBSnapshotIdentifier isn't specified.
  • If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
  • Can't be the identifier of an Aurora DB cluster snapshot.

Returns:

  • (String, nil)

See Also:



524
525
526
 
# File 'rds/cfn_db_instance_props.rb', line 524

def db_cluster_snapshot_identifier
  @db_cluster_snapshot_identifier
end

#db_instance_class ⇒ String? (readonly)

The compute and memory capacity of the DB instance, for example db.m5.large . Not all DB instance classes are available in all AWS Regions , or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide .

Returns:

  • (String, nil)

See Also:



529
530
531
 
# File 'rds/cfn_db_instance_props.rb', line 529

def db_instance_class
  @db_instance_class
end

#db_instance_identifier ⇒ String? (readonly)

A name for the DB instance.

If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type .

For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide .

If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Returns:

  • (String, nil)

See Also:



540
541
542
 
# File 'rds/cfn_db_instance_props.rb', line 540

def db_instance_identifier
  @db_instance_identifier
end

#db_name ⇒ String? (readonly)

The meaning of this parameter differs according to the database engine you use.

If you specify the [DBSnapshotIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier) property, this property only applies to RDS for Oracle.

Amazon Aurora

Not applicable. The database name is managed by the DB cluster.

Db2

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.
  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
  • Can't be a word reserved by the specified database engine.

MySQL

The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.
  • Can't be a word reserved by the specified database engine

MariaDB

The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.
  • Can't be a word reserved by the specified database engine

PostgreSQL

The name of the database to create when the DB instance is created. If this parameter is not specified, the default postgres database is created in the DB instance.

Constraints:

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
  • Must contain 1 to 63 characters.
  • Can't be a word reserved by the specified database engine

Oracle

The Oracle System ID (SID) of the created DB instance. If you specify null , the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName .

Default: ORCL

Constraints:

  • Can't be longer than 8 characters

SQL Server

Not applicable. Must be null.

Returns:

  • (String, nil)

See Also:



603
604
605
 
# File 'rds/cfn_db_instance_props.rb', line 603

def db_name
  @db_name
end

#db_parameter_group_name ⇒ String, ... (readonly)

The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template.

To list all of the available DB parameter group names, use the following command:

aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text

If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.

If you don't specify a value for DBParameterGroupName property, the default DB parameter group for the specified engine and engine version is used.

Returns:

See Also:



616
617
618
 
# File 'rds/cfn_db_instance_props.rb', line 616

def db_parameter_group_name
  @db_parameter_group_name
end

#db_security_groups ⇒ Array<String>? (readonly)

A list of the DB security groups to assign to the DB instance.

The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template.

If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups.

If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:

  • AllocatedStorage
  • AutoMinorVersionUpgrade
  • AvailabilityZone
  • BackupRetentionPeriod
  • CharacterSetName
  • DBInstanceClass
  • DBName
  • DBParameterGroupName
  • DBSecurityGroups
  • DBSubnetGroupName
  • Engine
  • EngineVersion
  • Iops
  • LicenseModel
  • MasterUsername
  • MasterUserPassword
  • MultiAZ
  • OptionGroupName
  • PreferredBackupWindow
  • PreferredMaintenanceWindow

All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as StorageType , StorageEncrypted , or KmsKeyId . If you're already using the DBSecurityGroups property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.

Returns:

  • (Array<String>, nil)

See Also:



650
651
652
 
# File 'rds/cfn_db_instance_props.rb', line 650

def db_security_groups
  @db_security_groups
end

#db_snapshot_identifier ⇒ String? (readonly)

The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance.

If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.

By specifying this property, you can create a DB instance from the specified DB snapshot. If the DBSnapshotIdentifier property is an empty string or the AWS::RDS::DBInstance declaration has no DBSnapshotIdentifier property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack.

Some DB instance properties aren't valid when you restore from a snapshot, such as the MasterUsername and MasterUserPassword properties, and the point-in-time recovery properties RestoreTime and UseLatestRestorableTime . For information about the properties that you can specify, see the RestoreDBInstanceFromDBSnapshot action in the Amazon RDS API Reference .

After you restore a DB instance with a DBSnapshotIdentifier property, you must specify the same DBSnapshotIdentifier property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the DBSnapshotIdentifier property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified DBSnapshotIdentifier property, and the original DB instance is deleted.

If you specify the DBSnapshotIdentifier property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties:

  • CharacterSetName
  • DBClusterIdentifier
  • DBName
  • KmsKeyId
  • MasterUsername
  • MasterUserPassword
  • PromotionTier
  • SourceDBInstanceIdentifier
  • SourceRegion
  • StorageEncrypted (for an unencrypted snapshot)
  • Timezone

Amazon Aurora

Not applicable. Snapshot restore is managed by the DB cluster.

Returns:

  • (String, nil)

See Also:



681
682
683
 
# File 'rds/cfn_db_instance_props.rb', line 681

def db_snapshot_identifier
  @db_snapshot_identifier
end

#db_subnet_group_name ⇒ String, ... (readonly)

A DB subnet group to associate with the DB instance.

If you update this value, the new subnet group must be a subnet group in a new VPC.

If you don't specify a DB subnet group, RDS uses the default DB subnet group if one exists. If a default DB subnet group does not exist, and you don't specify a DBSubnetGroupName , the DB instance fails to launch.

For more information about using Amazon RDS in a VPC, see Amazon VPC and Amazon RDS in the Amazon RDS User Guide .

This setting doesn't apply to Amazon Aurora DB instances. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.

Returns:

See Also:



694
695
696
 
# File 'rds/cfn_db_instance_props.rb', line 694

def db_subnet_group_name
  @db_subnet_group_name
end

#db_system_id ⇒ String? (readonly)

The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files.

In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to RDSCDB . The Oracle SID is also the name of your CDB.

Returns:

  • (String, nil)

See Also:



701
702
703
 
# File 'rds/cfn_db_instance_props.rb', line 701

def db_system_id
  @db_system_id
end

#dedicated_log_volume ⇒ Boolean, ... (readonly)

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

Returns:

See Also:



706
707
708
 
# File 'rds/cfn_db_instance_props.rb', line 706

def dedicated_log_volume
  @dedicated_log_volume
end

#delete_automated_backups ⇒ Boolean, ... (readonly)

A value that indicates whether to remove automated backups immediately after the DB instance is deleted.

This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

Amazon Aurora

Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.

Returns:

See Also:



717
718
719
 
# File 'rds/cfn_db_instance_props.rb', line 717

def delete_automated_backups
  @delete_automated_backups
end

#deletion_protection ⇒ Boolean, ... (readonly)

Specifies whether the DB instance has deletion protection enabled.

The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance .

This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster . DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.

Returns:

See Also:



726
727
728
 
# File 'rds/cfn_db_instance_props.rb', line 726

def deletion_protection
  @deletion_protection
end

#domain ⇒ String? (readonly)

The Active Directory directory ID to create the DB instance in.

Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide .

Returns:

  • (String, nil)

See Also:



735
736
737
 
# File 'rds/cfn_db_instance_props.rb', line 735

def domain
  @domain
end

#domain_auth_secret_arn ⇒ String? (readonly)

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456

Returns:

  • (String, nil)

See Also:



742
743
744
 
# File 'rds/cfn_db_instance_props.rb', line 742

def domain_auth_secret_arn
  @domain_auth_secret_arn
end

#domain_dns_ips ⇒ Array<String>? (readonly)

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

Constraints:

  • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

Example: 123.124.125.126,234.235.236.237

Returns:

  • (Array<String>, nil)

See Also:



753
754
755
 
# File 'rds/cfn_db_instance_props.rb', line 753

def domain_dns_ips
  @domain_dns_ips
end

#domain_fqdn ⇒ String? (readonly)

The fully qualified domain name (FQDN) of an Active Directory domain.

Constraints:

  • Can't be longer than 64 characters.

Example: mymanagedADtest.mymanagedAD.mydomain

Returns:

  • (String, nil)

See Also:



764
765
766
 
# File 'rds/cfn_db_instance_props.rb', line 764

def domain_fqdn
  @domain_fqdn
end

#domain_iam_role_name ⇒ String? (readonly)

The name of the IAM role to use when making API calls to the Directory Service.

This setting doesn't apply to the following DB instances:

  • Amazon Aurora (The domain is managed by the DB cluster.)
  • RDS Custom

Returns:

  • (String, nil)

See Also:



774
775
776
 
# File 'rds/cfn_db_instance_props.rb', line 774

def domain_iam_role_name
  @domain_iam_role_name
end

#domain_ou ⇒ String? (readonly)

The Active Directory organizational unit for your DB instance to join.

Constraints:

  • Must be in the distinguished name format.
  • Can't be longer than 64 characters.

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

Returns:

  • (String, nil)

See Also:



786
787
788
 
# File 'rds/cfn_db_instance_props.rb', line 786

def domain_ou
  @domain_ou
end

#enable_cloudwatch_logs_exports ⇒ Array<String>? (readonly)

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 Relational Database Service User Guide .

Amazon Aurora

Not applicable. CloudWatch Logs exports are managed by the DB cluster.

Db2

Valid values: diag.log , notify.log

MariaDB

Valid values: audit , error , general , slowquery

Microsoft SQL Server

Valid values: agent , error

MySQL

Valid values: audit , error , general , slowquery

Oracle

Valid values: alert , audit , listener , trace , oemagent

PostgreSQL

Valid values: postgresql , upgrade

Returns:

  • (Array<String>, nil)

See Also:



821
822
823
 
# File 'rds/cfn_db_instance_props.rb', line 821

def enable_cloudwatch_logs_exports
  @enable_cloudwatch_logs_exports
end

#enable_iam_database_authentication ⇒ Boolean, ... (readonly)

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

By default, mapping is disabled.

This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see IAM Database Authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.

Returns:

See Also:



834
835
836
 
# File 'rds/cfn_db_instance_props.rb', line 834

def enable_iam_database_authentication
  @enable_iam_database_authentication
end

#enable_performance_insights ⇒ Boolean, ... (readonly)

Specifies whether to enable Performance Insights for the DB instance.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .

This setting doesn't apply to RDS Custom DB instances.

Returns:

See Also:



843
844
845
 
# File 'rds/cfn_db_instance_props.rb', line 843

def enable_performance_insights
  @enable_performance_insights
end

#engine ⇒ String? (readonly)

The name of the database engine to use for this DB instance.

Not every database engine is available in every AWS Region.

This property is required when creating a DB instance.

You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the Engine value in your templates from oracle-ee to oracle-ee-cdb or from oracle-se2 to oracle-se2-cdb . Converting to the CDB architecture requires an interruption.

Valid Values:

  • aurora-mysql (for Aurora MySQL DB instances)
  • aurora-postgresql (for Aurora PostgreSQL DB instances)
  • custom-oracle-ee (for RDS Custom for Oracle DB instances)
  • custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
  • custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
  • custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
  • custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
  • db2-ae
  • db2-se
  • mariadb
  • mysql
  • oracle-ee
  • oracle-ee-cdb
  • oracle-se2
  • oracle-se2-cdb
  • postgres
  • sqlserver-ee
  • sqlserver-se
  • sqlserver-ex
  • sqlserver-web

Returns:

  • (String, nil)

See Also:



877
878
879
 
# File 'rds/cfn_db_instance_props.rb', line 877

def engine
  @engine
end

#engine_lifecycle_support ⇒ String? (readonly)

The life cycle type for this DB instance.

By default, this value is set to open-source-rds-extended-support , which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled . In this case, creating the DB instance will fail if the DB major version is past its end of standard support date.

This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.

You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide .

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

Default: open-source-rds-extended-support

Returns:

  • (String, nil)

See Also:



892
893
894
 
# File 'rds/cfn_db_instance_props.rb', line 892

def engine_lifecycle_support
  @engine_lifecycle_support
end

#engine_version ⇒ String? (readonly)

The version number of the database engine to use.

For a list of valid engine versions, use the DescribeDBEngineVersions action.

The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.

Amazon Aurora

Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.

Db2

See Amazon RDS for Db2 in the Amazon RDS User Guide.

MariaDB

See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.

Microsoft SQL Server

See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.

MySQL

See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

Oracle

See Oracle Database Engine Release Notes in the Amazon RDS User Guide.

PostgreSQL

See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.

Returns:

  • (String, nil)

See Also:



929
930
931
 
# File 'rds/cfn_db_instance_props.rb', line 929

def engine_version
  @engine_version
end

#iops ⇒ Numeric? (readonly)

The number of I/O operations per second (IOPS) that the database provisions.

The value must be equal to or greater than 1000.

If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide .

If you specify io1 for the StorageType property, then you must also specify the Iops property.

Constraints:

  • For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.
  • For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.

Returns:

  • (Numeric, nil)

See Also:



945
946
947
 
# File 'rds/cfn_db_instance_props.rb', line 945

def iops
  @iops
end

#kms_key_id ⇒ String, ... (readonly)

The ARN of the AWS KMS key that's used to encrypt the DB instance, 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, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true.

If you specify the SourceDBInstanceIdentifier or SourceDbiResourceId property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified KmsKeyId property is used. However, if the source DB instance is in a different AWS Region, you must specify a KMS key ID.

If you specify the SourceDBInstanceAutomatedBackupsArn property, don't specify this property. The value is inherited from the source DB instance automated backup, and if the automated backup is encrypted, the specified KmsKeyId property is used.

If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region.

If you specify the DBSnapshotIdentifier property, don't specify this property. The StorageEncrypted property value is inherited from the snapshot. If the DB instance is encrypted, the specified KmsKeyId property is also inherited from the snapshot.

If you specify DBSecurityGroups , AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide .

Amazon Aurora

Not applicable. The KMS key identifier is managed by the DB cluster.

Returns:

See Also:



966
967
968
 
# File 'rds/cfn_db_instance_props.rb', line 966

def kms_key_id
  @kms_key_id
end

#license_model ⇒ String? (readonly)

License model information for this DB instance.

Valid Values:

  • Aurora MySQL - general-public-license
  • Aurora PostgreSQL - postgresql-license
  • RDS for Db2 - bring-your-own-license . For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide.
  • RDS for MariaDB - general-public-license
  • RDS for Microsoft SQL Server - license-included
  • RDS for MySQL - general-public-license
  • RDS for Oracle - bring-your-own-license or license-included
  • RDS for PostgreSQL - postgresql-license

If you've specified DBSecurityGroups and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.

Returns:

  • (String, nil)

See Also:



984
985
986
 
# File 'rds/cfn_db_instance_props.rb', line 984

def license_model
  @license_model
end

#manage_master_user_password ⇒ Boolean, ... (readonly)

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

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

Constraints:

  • Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.

Returns:

See Also:



995
996
997
 
# File 'rds/cfn_db_instance_props.rb', line 995

def manage_master_user_password
  @manage_master_user_password
end

#master_user_authentication_type ⇒ String? (readonly)

Specifies the authentication type for the master user.

With IAM master user authentication, you can configure the master DB user with IAM database authentication when you create a DB instance.

You can specify one of the following values:

  • password - Use standard database authentication with a password.
  • iam-db-auth - Use IAM database authentication for the master user.

This option is only valid for RDS for MySQL, RDS for MariaDB, RDS for PostgreSQL, Aurora MySQL, and Aurora PostgreSQL engines.

Returns:

  • (String, nil)

See Also:



1009
1010
1011
 
# File 'rds/cfn_db_instance_props.rb', line 1009

def master_user_authentication_type
  @master_user_authentication_type
end

#master_user_password ⇒ String? (readonly)

The password for the master user. The password can include any printable ASCII character except "/", """, or "@".

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster.

RDS for Db2

Must contain from 8 to 255 characters.

RDS for MariaDB

Constraints: Must contain from 8 to 41 characters.

RDS for Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

RDS for MySQL

Constraints: Must contain from 8 to 41 characters.

RDS for Oracle

Constraints: Must contain from 8 to 30 characters.

RDS for PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Returns:

  • (String, nil)

See Also:



1102
1103
1104
 
# File 'rds/cfn_db_instance_props.rb', line 1102

def master_user_password
  @master_user_password
end

#master_user_secret ⇒ AWSCDK::IResolvable, ... (readonly)

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

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

Returns:

See Also:



1109
1110
1111
 
# File 'rds/cfn_db_instance_props.rb', line 1109

def master_user_secret
  @master_user_secret
end

#master_username ⇒ String? (readonly)

The master user name for the DB instance.

If you specify the SourceDBInstanceIdentifier or DBSnapshotIdentifier property, don't specify this property. The value is inherited from the source DB instance or snapshot.

When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name.

Amazon Aurora

Not applicable. The name for the master user is managed by the DB cluster.

RDS for Db2

Constraints:

  • Must be 1 to 16 letters or numbers.
  • First character must be a letter.
  • Can't be a reserved word for the chosen database engine.

RDS for MariaDB

Constraints:

  • Must be 1 to 16 letters or numbers.
  • Can't be a reserved word for the chosen database engine.

RDS for Microsoft SQL Server

Constraints:

  • Must be 1 to 128 letters or numbers.
  • First character must be a letter.
  • Can't be a reserved word for the chosen database engine.

RDS for MySQL

Constraints:

  • Must be 1 to 16 letters or numbers.
  • First character must be a letter.
  • Can't be a reserved word for the chosen database engine.

RDS for Oracle

Constraints:

  • Must be 1 to 30 letters or numbers.
  • First character must be a letter.
  • Can't be a reserved word for the chosen database engine.

RDS for PostgreSQL

Constraints:

  • Must be 1 to 63 letters or numbers.
  • First character must be a letter.
  • Can't be a reserved word for the chosen database engine.

Returns:

  • (String, nil)

See Also:



1069
1070
1071
 
# File 'rds/cfn_db_instance_props.rb', line 1069

def master_username
  @master_username
end

#max_allocated_storage ⇒ Numeric? (readonly)

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide .

This setting doesn't apply to the following DB instances:

  • Amazon Aurora (Storage is managed by the DB cluster.)
  • RDS Custom

Returns:

  • (Numeric, nil)

See Also:



1121
1122
1123
 
# File 'rds/cfn_db_instance_props.rb', line 1121

def max_allocated_storage
  @max_allocated_storage
end

#monitoring_interval ⇒ Numeric? (readonly)

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

To disable collection of Enhanced Monitoring metrics, specify 0 .

If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0 .

This setting doesn't apply to RDS Custom DB instances.

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60

Default: 0

Returns:

  • (Numeric, nil)

See Also:



1136
1137
1138
 
# File 'rds/cfn_db_instance_props.rb', line 1136

def monitoring_interval
  @monitoring_interval
end

#monitoring_role_arn ⇒ String, ... (readonly)

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.

For example, arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide .

If MonitoringInterval is set to a value other than 0 , then you must supply a MonitoringRoleArn value.

This setting doesn't apply to RDS Custom DB instances.

Returns:

See Also:



1147
1148
1149
 
# File 'rds/cfn_db_instance_props.rb', line 1147

def monitoring_role_arn
  @monitoring_role_arn
end

#multi_az ⇒ Boolean, ... (readonly)

Specifies whether the DB instance is a Multi-AZ deployment.

You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

This setting doesn't apply to Amazon Aurora because the DB instance Availability Zones (AZs) are managed by the DB cluster.

Returns:

See Also:



1156
1157
1158
 
# File 'rds/cfn_db_instance_props.rb', line 1156

def multi_az
  @multi_az
end

#nchar_character_set_name ⇒ String? (readonly)

The name of the NCHAR character set for the Oracle DB instance.

This setting doesn't apply to RDS Custom DB instances.

Returns:

  • (String, nil)

See Also:



1163
1164
1165
 
# File 'rds/cfn_db_instance_props.rb', line 1163

def nchar_character_set_name
  @nchar_character_set_name
end

#network_type ⇒ String? (readonly)

The network type of the DB instance.

Valid values:

  • IPV4
  • DUAL

The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and IPv6 protocols ( DUAL ).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

Returns:

  • (String, nil)

See Also:



1177
1178
1179
 
# File 'rds/cfn_db_instance_props.rb', line 1177

def network_type
  @network_type
end

#option_group_name ⇒ String? (readonly)

Indicates that the DB instance should be associated with the specified option group.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.

Returns:

  • (String, nil)

See Also:



1184
1185
1186
 
# File 'rds/cfn_db_instance_props.rb', line 1184

def option_group_name
  @option_group_name
end

#performance_insights_kms_key_id ⇒ String, ... (readonly)

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

The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.

For information about enabling Performance Insights, see EnablePerformanceInsights .

Returns:

See Also:



1195
1196
1197
 
# File 'rds/cfn_db_instance_props.rb', line 1195

def performance_insights_kms_key_id
  @performance_insights_kms_key_id
end

#performance_insights_retention_period ⇒ Numeric? (readonly)

The number of days to retain Performance Insights data.

When creating a DB instance without enabling Performance Insights, you can't specify the parameter PerformanceInsightsRetentionPeriod .

This setting doesn't apply to RDS Custom DB instances.

Valid Values:

  • 7
  • month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
  • 731

Default: 7 days

If you specify a retention period that isn't valid, such as 94 , Amazon RDS returns an error.

Returns:

  • (Numeric, nil)

See Also:



1214
1215
1216
 
# File 'rds/cfn_db_instance_props.rb', line 1214

def performance_insights_retention_period
  @performance_insights_retention_period
end

#port ⇒ String? (readonly)

The port number on which the database accepts connections.

This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.

Valid Values: 1150-65535

Default:

  • RDS for Db2 - 50000
  • RDS for MariaDB - 3306
  • RDS for Microsoft SQL Server - 1433
  • RDS for MySQL - 3306
  • RDS for Oracle - 1521
  • RDS for PostgreSQL - 5432

Constraints:

  • For RDS for Microsoft SQL Server, the value can't be 1234 , 1434 , 3260 , 3343 , 3389 , 47001 , or 49152-49156 .

Returns:

  • (String, nil)

See Also:



1236
1237
1238
 
# File 'rds/cfn_db_instance_props.rb', line 1236

def port
  @port
end

#preferred_backup_window ⇒ String? (readonly)

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

For more information, see Backup Window in the Amazon RDS 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.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

Returns:

  • (String, nil)

See Also:



1254
1255
1256
 
# File 'rds/cfn_db_instance_props.rb', line 1254

def preferred_backup_window
  @preferred_backup_window
end

#preferred_maintenance_window ⇒ String? (readonly)

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 Maintaining a DB instance in the Amazon RDS User Guide.

This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately.

Constraints: Minimum 30-minute window.

Returns:

  • (String, nil)

See Also:



1267
1268
1269
 
# File 'rds/cfn_db_instance_props.rb', line 1267

def preferred_maintenance_window
  @preferred_maintenance_window
end

#processor_features ⇒ AWSCDK::IResolvable, ... (readonly)

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

Returns:

See Also:



1274
1275
1276
 
# File 'rds/cfn_db_instance_props.rb', line 1274

def processor_features
  @processor_features
end

#promotion_tier ⇒ Numeric? (readonly)

The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.

For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .

This setting doesn't apply to RDS Custom DB instances.

Default: 1

Valid Values: 0 - 15

Returns:

  • (Numeric, nil)

See Also:



1287
1288
1289
 
# File 'rds/cfn_db_instance_props.rb', line 1287

def promotion_tier
  @promotion_tier
end

#publicly_accessible ⇒ Boolean, ... (readonly)

Indicates whether the DB instance is an internet-facing instance.

If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address.

The default behavior value depends on your VPC setup and the database subnet group. For more information, see the PubliclyAccessible parameter in the CreateDBInstance in the Amazon RDS API Reference .

Returns:

See Also:



1296
1297
1298
 
# File 'rds/cfn_db_instance_props.rb', line 1296

def publicly_accessible
  @publicly_accessible
end

#replica_mode ⇒ String? (readonly)

The open mode of an Oracle read replica.

For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .

This setting is only supported in RDS for Oracle.

Default: open-read-only

Valid Values: open-read-only or mounted

Returns:

  • (String, nil)

See Also:



1309
1310
1311
 
# File 'rds/cfn_db_instance_props.rb', line 1309

def replica_mode
  @replica_mode
end

#restore_time ⇒ String? (readonly)

The date and time to restore from.

This parameter applies to point-in-time recovery. For more information, see Restoring a DB instance to a specified time in the in the Amazon RDS User Guide .

Constraints:

  • Must be a time in Universal Coordinated Time (UTC) format.
  • Must be before the latest restorable time for the DB instance.
  • Can't be specified if the UseLatestRestorableTime parameter is enabled.

Example: 2009-09-07T23:45:00Z

Returns:

  • (String, nil)

See Also:



1324
1325
1326
 
# File 'rds/cfn_db_instance_props.rb', line 1324

def restore_time
  @restore_time
end

#source_db_cluster_identifier ⇒ String? (readonly)

The identifier of the Multi-AZ DB cluster that will act as the source for the read replica.

Each DB cluster can have up to 15 read replicas.

Constraints:

  • Must be the identifier of an existing Multi-AZ DB cluster.
  • Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
  • The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
  • The source DB cluster must be in the same AWS Region as the read replica. Cross-Region replication isn't supported.

Returns:

  • (String, nil)

See Also:



1338
1339
1340
 
# File 'rds/cfn_db_instance_props.rb', line 1338

def source_db_cluster_identifier
  @source_db_cluster_identifier
end

#source_db_instance_automated_backups_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE .

This setting doesn't apply to RDS Custom.

Returns:

  • (String, nil)

See Also:



1345
1346
1347
 
# File 'rds/cfn_db_instance_props.rb', line 1345

def source_db_instance_automated_backups_arn
  @source_db_instance_automated_backups_arn
end

#source_db_instance_identifier ⇒ String, ... (readonly)

If you want to create a read replica DB instance, specify the ID of the source DB instance.

Each DB instance can have a limited number of read replicas. For more information, see Working with Read Replicas in the Amazon RDS User Guide .

For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide .

The SourceDBInstanceIdentifier property determines whether a DB instance is a read replica. If you remove the SourceDBInstanceIdentifier property from your template and then update your stack, AWS CloudFormation promotes the read replica to a standalone DB instance.

If you specify the UseLatestRestorableTime or RestoreTime properties in conjunction with the SourceDBInstanceIdentifier property, RDS restores the DB instance to the requested point in time, thereby creating a new DB instance.

  • If you specify a source DB instance that uses VPC security groups, we recommend that you specify the VPCSecurityGroups property. If you don't specify the property, the read replica inherits the value of the VPCSecurityGroups property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's VPCSecurityGroups property to the default value because it's not defined in the stack's template. This change might cause unexpected issues.
  • Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica.
  • If you specify SourceDBInstanceIdentifier , don't specify the DBSnapshotIdentifier property. You can't create a read replica from a snapshot.
  • Don't set the BackupRetentionPeriod , DBName , MasterUsername , MasterUserPassword , and PreferredBackupWindow properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas.
  • If the source DB instance is in a different region than the read replica, specify the source region in SourceRegion , and specify an ARN for a valid DB instance in SourceDBInstanceIdentifier . For more information, see Constructing a Amazon RDS Amazon Resource Name (ARN) in the Amazon RDS User Guide .
  • For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances.

Returns:

See Also:



1365
1366
1367
 
# File 'rds/cfn_db_instance_props.rb', line 1365

def source_db_instance_identifier
  @source_db_instance_identifier
end

#source_dbi_resource_id ⇒ String? (readonly)

The resource ID of the source DB instance from which to restore.

Returns:

  • (String, nil)

See Also:



1370
1371
1372
 
# File 'rds/cfn_db_instance_props.rb', line 1370

def source_dbi_resource_id
  @source_dbi_resource_id
end

#source_region ⇒ String? (readonly)

The ID of the region that contains the source DB instance for the read replica.

Returns:

  • (String, nil)

See Also:



1375
1376
1377
 
# File 'rds/cfn_db_instance_props.rb', line 1375

def source_region
  @source_region
end

#storage_encrypted ⇒ Boolean, ... (readonly)

A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

If you specify the KmsKeyId property, then you must enable encryption.

If you specify the SourceDBInstanceIdentifier or SourceDbiResourceId property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified KmsKeyId property is used.

If you specify the SourceDBInstanceAutomatedBackupsArn property, don't specify this property. The value is inherited from the source DB instance automated backup.

If you specify DBSnapshotIdentifier property, don't specify this property. The value is inherited from the snapshot.

Amazon Aurora

Not applicable. The encryption for DB instances is managed by the DB cluster.

Returns:

See Also:



1392
1393
1394
 
# File 'rds/cfn_db_instance_props.rb', line 1392

def storage_encrypted
  @storage_encrypted
end

#storage_throughput ⇒ Numeric? (readonly)

Specifies the storage throughput value, in mebibyte per second (MiBps), for the DB instance.

This setting applies only to the gp3 storage type.

This setting doesn't apply to RDS Custom or Amazon Aurora.

Returns:

  • (Numeric, nil)

See Also:



1401
1402
1403
 
# File 'rds/cfn_db_instance_props.rb', line 1401

def storage_throughput
  @storage_throughput
end

#storage_type ⇒ String? (readonly)

The storage type to associate with the DB instance.

If you specify io1 , io2 , or gp3 , you must also include a value for the Iops parameter.

This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.

Valid Values: gp2 | gp3 | io1 | io2 | standard

Default: io1 , if the Iops parameter is specified. Otherwise, gp3 .

Returns:

  • (String, nil)

See Also:



1414
1415
1416
 
# File 'rds/cfn_db_instance_props.rb', line 1414

def storage_type
  @storage_type
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

Tags to assign to the DB instance.

Returns:

See Also:



1419
1420
1421
 
# File 'rds/cfn_db_instance_props.rb', line 1419

def tags
  @tags
end

#tde_credential_arn ⇒ String? (readonly)

Deprecated.

this property has been deprecated

Returns:

  • (String, nil)

See Also:



1423
1424
1425
 
# File 'rds/cfn_db_instance_props.rb', line 1423

def tde_credential_arn
  @tde_credential_arn
end

#tde_credential_password ⇒ String? (readonly)

Deprecated.

this property has been deprecated

Returns:

  • (String, nil)

See Also:



1427
1428
1429
 
# File 'rds/cfn_db_instance_props.rb', line 1427

def tde_credential_password
  @tde_credential_password
end

#timezone ⇒ String? (readonly)

The time zone of the DB instance.

The time zone parameter is currently supported only by RDS for Db2 and RDS for SQL Server .

Returns:

  • (String, nil)

See Also:



1434
1435
1436
 
# File 'rds/cfn_db_instance_props.rb', line 1434

def timezone
  @timezone
end

#use_default_processor_features ⇒ Boolean, ... (readonly)

Specifies whether the DB instance class of the DB instance uses its default processor features.

This setting doesn't apply to RDS Custom DB instances.

Returns:

See Also:



1441
1442
1443
 
# File 'rds/cfn_db_instance_props.rb', line 1441

def use_default_processor_features
  @use_default_processor_features
end

#use_latest_restorable_time ⇒ Boolean, ... (readonly)

Specifies whether the DB instance is restored from the latest backup time.

By default, the DB instance isn't restored from the latest backup time. This parameter applies to point-in-time recovery. For more information, see Restoring a DB instance to a specified time in the in the Amazon RDS User Guide .

Constraints:

  • Can't be specified if the RestoreTime parameter is provided.

Returns:

See Also:



1452
1453
1454
 
# File 'rds/cfn_db_instance_props.rb', line 1452

def use_latest_restorable_time
  @use_latest_restorable_time
end

#vpc_security_groups ⇒ Array<String, AWSCDK::Interfaces::AWSEC2::ISecurityGroupRef>? (readonly)

A list of the VPC security group IDs to assign to the DB instance.

The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template.

If you plan to update the resource, don't specify VPC security groups in a shared VPC.

If you set VPCSecurityGroups , you must not set DBSecurityGroups , and vice versa.

You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:

  • You can't revert to using an RDS security group after you establish a VPC security group membership.
  • When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group.
  • To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups property.

To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.

Returns:

See Also:



1475
1476
1477
 
# File 'rds/cfn_db_instance_props.rb', line 1475

def vpc_security_groups
  @vpc_security_groups
end

Class Method Details

.jsii_properties ⇒ Object 



1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
 
# File 'rds/cfn_db_instance_props.rb', line 1477

def self.jsii_properties
  {
    :additional_storage_volumes => "additionalStorageVolumes",
    :allocated_storage => "allocatedStorage",
    :allow_major_version_upgrade => "allowMajorVersionUpgrade",
    :apply_immediately => "applyImmediately",
    :associated_roles => "associatedRoles",
    :automatic_backup_replication_kms_key_id => "automaticBackupReplicationKmsKeyId",
    :automatic_backup_replication_region => "automaticBackupReplicationRegion",
    :automatic_backup_replication_retention_period => "automaticBackupReplicationRetentionPeriod",
    :auto_minor_version_upgrade => "autoMinorVersionUpgrade",
    :availability_zone => "availabilityZone",
    :backup_retention_period => "backupRetentionPeriod",
    :backup_target => "backupTarget",
    :ca_certificate_identifier => "caCertificateIdentifier",
    :certificate_rotation_restart => "certificateRotationRestart",
    :character_set_name => "characterSetName",
    :copy_tags_to_snapshot => "copyTagsToSnapshot",
    :custom_iam_instance_profile => "customIamInstanceProfile",
    :database_insights_mode => "databaseInsightsMode",
    :db_cluster_identifier => "dbClusterIdentifier",
    :db_cluster_snapshot_identifier => "dbClusterSnapshotIdentifier",
    :db_instance_class => "dbInstanceClass",
    :db_instance_identifier => "dbInstanceIdentifier",
    :db_name => "dbName",
    :db_parameter_group_name => "dbParameterGroupName",
    :db_security_groups => "dbSecurityGroups",
    :db_snapshot_identifier => "dbSnapshotIdentifier",
    :db_subnet_group_name => "dbSubnetGroupName",
    :db_system_id => "dbSystemId",
    :dedicated_log_volume => "dedicatedLogVolume",
    :delete_automated_backups => "deleteAutomatedBackups",
    :deletion_protection => "deletionProtection",
    :domain => "domain",
    :domain_auth_secret_arn => "domainAuthSecretArn",
    :domain_dns_ips => "domainDnsIps",
    :domain_fqdn => "domainFqdn",
    :domain_iam_role_name => "domainIamRoleName",
    :domain_ou => "domainOu",
    :enable_cloudwatch_logs_exports => "enableCloudwatchLogsExports",
    :enable_iam_database_authentication => "enableIamDatabaseAuthentication",
    :enable_performance_insights => "enablePerformanceInsights",
    :engine => "engine",
    :engine_lifecycle_support => "engineLifecycleSupport",
    :engine_version => "engineVersion",
    :iops => "iops",
    :kms_key_id => "kmsKeyId",
    :license_model => "licenseModel",
    :manage_master_user_password => "manageMasterUserPassword",
    :master_user_authentication_type => "masterUserAuthenticationType",
    :master_username => "masterUsername",
    :master_user_password => "masterUserPassword",
    :master_user_secret => "masterUserSecret",
    :max_allocated_storage => "maxAllocatedStorage",
    :monitoring_interval => "monitoringInterval",
    :monitoring_role_arn => "monitoringRoleArn",
    :multi_az => "multiAz",
    :nchar_character_set_name => "ncharCharacterSetName",
    :network_type => "networkType",
    :option_group_name => "optionGroupName",
    :performance_insights_kms_key_id => "performanceInsightsKmsKeyId",
    :performance_insights_retention_period => "performanceInsightsRetentionPeriod",
    :port => "port",
    :preferred_backup_window => "preferredBackupWindow",
    :preferred_maintenance_window => "preferredMaintenanceWindow",
    :processor_features => "processorFeatures",
    :promotion_tier => "promotionTier",
    :publicly_accessible => "publiclyAccessible",
    :replica_mode => "replicaMode",
    :restore_time => "restoreTime",
    :source_db_cluster_identifier => "sourceDbClusterIdentifier",
    :source_db_instance_automated_backups_arn => "sourceDbInstanceAutomatedBackupsArn",
    :source_db_instance_identifier => "sourceDbInstanceIdentifier",
    :source_dbi_resource_id => "sourceDbiResourceId",
    :source_region => "sourceRegion",
    :storage_encrypted => "storageEncrypted",
    :storage_throughput => "storageThroughput",
    :storage_type => "storageType",
    :tags => "tags",
    :tde_credential_arn => "tdeCredentialArn",
    :tde_credential_password => "tdeCredentialPassword",
    :timezone => "timezone",
    :use_default_processor_features => "useDefaultProcessorFeatures",
    :use_latest_restorable_time => "useLatestRestorableTime",
    :vpc_security_groups => "vpcSecurityGroups",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
 
# File 'rds/cfn_db_instance_props.rb', line 1565

def to_jsii
  result = {}
  result.merge!({
    "additionalStorageVolumes" => @additional_storage_volumes,
    "allocatedStorage" => @allocated_storage,
    "allowMajorVersionUpgrade" => @allow_major_version_upgrade,
    "applyImmediately" => @apply_immediately,
    "associatedRoles" => @associated_roles,
    "automaticBackupReplicationKmsKeyId" => @automatic_backup_replication_kms_key_id,
    "automaticBackupReplicationRegion" => @automatic_backup_replication_region,
    "automaticBackupReplicationRetentionPeriod" => @automatic_backup_replication_retention_period,
    "autoMinorVersionUpgrade" => @auto_minor_version_upgrade,
    "availabilityZone" => @availability_zone,
    "backupRetentionPeriod" => @backup_retention_period,
    "backupTarget" => @backup_target,
    "caCertificateIdentifier" => @ca_certificate_identifier,
    "certificateRotationRestart" => @certificate_rotation_restart,
    "characterSetName" => @character_set_name,
    "copyTagsToSnapshot" => @copy_tags_to_snapshot,
    "customIamInstanceProfile" => @custom_iam_instance_profile,
    "databaseInsightsMode" => @database_insights_mode,
    "dbClusterIdentifier" => @db_cluster_identifier,
    "dbClusterSnapshotIdentifier" => @db_cluster_snapshot_identifier,
    "dbInstanceClass" => @db_instance_class,
    "dbInstanceIdentifier" => @db_instance_identifier,
    "dbName" => @db_name,
    "dbParameterGroupName" => @db_parameter_group_name,
    "dbSecurityGroups" => @db_security_groups,
    "dbSnapshotIdentifier" => @db_snapshot_identifier,
    "dbSubnetGroupName" => @db_subnet_group_name,
    "dbSystemId" => @db_system_id,
    "dedicatedLogVolume" => @dedicated_log_volume,
    "deleteAutomatedBackups" => @delete_automated_backups,
    "deletionProtection" => @deletion_protection,
    "domain" => @domain,
    "domainAuthSecretArn" => @domain_auth_secret_arn,
    "domainDnsIps" => @domain_dns_ips,
    "domainFqdn" => @domain_fqdn,
    "domainIamRoleName" => @domain_iam_role_name,
    "domainOu" => @domain_ou,
    "enableCloudwatchLogsExports" => @enable_cloudwatch_logs_exports,
    "enableIamDatabaseAuthentication" => @enable_iam_database_authentication,
    "enablePerformanceInsights" => @enable_performance_insights,
    "engine" => @engine,
    "engineLifecycleSupport" => @engine_lifecycle_support,
    "engineVersion" => @engine_version,
    "iops" => @iops,
    "kmsKeyId" => @kms_key_id,
    "licenseModel" => @license_model,
    "manageMasterUserPassword" => @manage_master_user_password,
    "masterUserAuthenticationType" => @master_user_authentication_type,
    "masterUsername" => @master_username,
    "masterUserPassword" => @master_user_password,
    "masterUserSecret" => @master_user_secret,
    "maxAllocatedStorage" => @max_allocated_storage,
    "monitoringInterval" => @monitoring_interval,
    "monitoringRoleArn" => @monitoring_role_arn,
    "multiAz" => @multi_az,
    "ncharCharacterSetName" => @nchar_character_set_name,
    "networkType" => @network_type,
    "optionGroupName" => @option_group_name,
    "performanceInsightsKmsKeyId" => @performance_insights_kms_key_id,
    "performanceInsightsRetentionPeriod" => @performance_insights_retention_period,
    "port" => @port,
    "preferredBackupWindow" => @preferred_backup_window,
    "preferredMaintenanceWindow" => @preferred_maintenance_window,
    "processorFeatures" => @processor_features,
    "promotionTier" => @promotion_tier,
    "publiclyAccessible" => @publicly_accessible,
    "replicaMode" => @replica_mode,
    "restoreTime" => @restore_time,
    "sourceDbClusterIdentifier" => @source_db_cluster_identifier,
    "sourceDbInstanceAutomatedBackupsArn" => @source_db_instance_automated_backups_arn,
    "sourceDbInstanceIdentifier" => @source_db_instance_identifier,
    "sourceDbiResourceId" => @source_dbi_resource_id,
    "sourceRegion" => @source_region,
    "storageEncrypted" => @storage_encrypted,
    "storageThroughput" => @storage_throughput,
    "storageType" => @storage_type,
    "tags" => @tags,
    "tdeCredentialArn" => @tde_credential_arn,
    "tdeCredentialPassword" => @tde_credential_password,
    "timezone" => @timezone,
    "useDefaultProcessorFeatures" => @use_default_processor_features,
    "useLatestRestorableTime" => @use_latest_restorable_time,
    "vpcSecurityGroups" => @vpc_security_groups,
  })
  result.compact
end