Class: AWSCDK::RDS::CfnDBInstance

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSRDS::IDBInstanceRef
Defined in:
rds/cfn_db_instance.rb

Overview

The AWS::RDS::DBInstance resource creates an Amazon DB instance.

The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster.

For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide .

For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide .

If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.

If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see Prevent Updates to Stack Resources .

Updating DB instances

When properties labeled " Update requires: Replacement " are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.

We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:

  • Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.
  • Create a snapshot of the DB instance. For more information, see Creating a DB Snapshot .
  • If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the DBSnapshotIdentifier property with the ID of the DB snapshot that you want to use.

After you restore a DB instance with a DBSnapshotIdentifier property, you can delete the DBSnapshotIdentifier property. 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.

  • Update the stack.

For more information about updating other properties of this resource, see [ModifyDBInstance](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) . For more information about updating stacks, see AWS CloudFormation Stacks Updates .

Deleting DB instances

For DB instances that are part of an Aurora DB cluster, you can set a deletion policy for your DB instance to control how AWS CloudFormation handles the DB instance when the stack is deleted. For Amazon RDS DB instances, you can choose to retain the DB instance, to delete the DB instance, or to create a snapshot of the DB instance. The default AWS CloudFormation behavior depends on the DBClusterIdentifier property:

  • For AWS::RDS::DBInstance resources that don't specify the DBClusterIdentifier property, AWS CloudFormation saves a snapshot of the DB instance.
  • For AWS::RDS::DBInstance resources that do specify the DBClusterIdentifier property, AWS CloudFormation deletes the DB instance.

For more information, see DeletionPolicy Attribute .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnDBInstance

Create a new AWS::RDS::DBInstance.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::RDS::CfnDBInstanceProps, nil) (defaults to: nil) —

    Resource properties.



53
54
55
56
57
58
59
 
# File 'rds/cfn_db_instance.rb', line 53

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::RDS::CfnDBInstanceProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLkNmbkRCSW5zdGFuY2VQcm9wcyJ9")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_db_instance(resource) ⇒ String

Parameters:

Returns:

  • (String) 


214
215
216
217
 
# File 'rds/cfn_db_instance.rb', line 214

def self.arn_for_db_instance(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19yZHMuSURCSW5zdGFuY2VSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_rds.CfnDBInstance", "arnForDBInstance", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


321
322
323
 
# File 'rds/cfn_db_instance.rb', line 321

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_rds.CfnDBInstance", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_db_instance(x) ⇒ Boolean

Checks whether the given object is a CfnDBInstance.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


223
224
225
226
 
# File 'rds/cfn_db_instance.rb', line 223

def self.is_cfn_db_instance(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_rds.CfnDBInstance", "isCfnDBInstance", [x])
end

.jsii_overridable_methods ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
 
# File 'rds/cfn_db_instance.rb', line 61

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_automatic_restart_time => { kind: :property, name: "attrAutomaticRestartTime", is_optional: false },
    :attr_certificate_details => { kind: :property, name: "attrCertificateDetails", is_optional: false },
    :attr_certificate_details_ca_identifier => { kind: :property, name: "attrCertificateDetailsCaIdentifier", is_optional: false },
    :attr_certificate_details_valid_till => { kind: :property, name: "attrCertificateDetailsValidTill", is_optional: false },
    :attr_db_instance_arn => { kind: :property, name: "attrDbInstanceArn", is_optional: false },
    :attr_db_instance_status => { kind: :property, name: "attrDbInstanceStatus", is_optional: false },
    :attr_dbi_resource_id => { kind: :property, name: "attrDbiResourceId", is_optional: false },
    :attr_db_system_id => { kind: :property, name: "attrDbSystemId", is_optional: false },
    :attr_endpoint => { kind: :property, name: "attrEndpoint", is_optional: false },
    :attr_endpoint_address => { kind: :property, name: "attrEndpointAddress", is_optional: false },
    :attr_endpoint_hosted_zone_id => { kind: :property, name: "attrEndpointHostedZoneId", is_optional: false },
    :attr_endpoint_port => { kind: :property, name: "attrEndpointPort", is_optional: false },
    :attr_instance_create_time => { kind: :property, name: "attrInstanceCreateTime", is_optional: false },
    :attr_is_storage_config_upgrade_available => { kind: :property, name: "attrIsStorageConfigUpgradeAvailable", is_optional: false },
    :attr_latest_restorable_time => { kind: :property, name: "attrLatestRestorableTime", is_optional: false },
    :attr_listener_endpoint => { kind: :property, name: "attrListenerEndpoint", is_optional: false },
    :attr_listener_endpoint_address => { kind: :property, name: "attrListenerEndpointAddress", is_optional: false },
    :attr_listener_endpoint_hosted_zone_id => { kind: :property, name: "attrListenerEndpointHostedZoneId", is_optional: false },
    :attr_listener_endpoint_port => { kind: :property, name: "attrListenerEndpointPort", is_optional: false },
    :attr_master_user_secret_secret_arn => { kind: :property, name: "attrMasterUserSecretSecretArn", is_optional: false },
    :attr_percent_progress => { kind: :property, name: "attrPercentProgress", is_optional: false },
    :attr_read_replica_db_cluster_identifiers => { kind: :property, name: "attrReadReplicaDbClusterIdentifiers", is_optional: false },
    :attr_read_replica_db_instance_identifiers => { kind: :property, name: "attrReadReplicaDbInstanceIdentifiers", is_optional: false },
    :attr_resume_full_automation_mode_time => { kind: :property, name: "attrResumeFullAutomationModeTime", is_optional: false },
    :attr_secondary_availability_zone => { kind: :property, name: "attrSecondaryAvailabilityZone", is_optional: false },
    :attr_status_infos => { kind: :property, name: "attrStatusInfos", is_optional: false },
    :db_instance_ref => { kind: :property, name: "dbInstanceRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :additional_storage_volumes => { kind: :property, name: "additionalStorageVolumes", is_optional: true },
    :allocated_storage => { kind: :property, name: "allocatedStorage", is_optional: true },
    :allow_major_version_upgrade => { kind: :property, name: "allowMajorVersionUpgrade", is_optional: true },
    :apply_immediately => { kind: :property, name: "applyImmediately", is_optional: true },
    :associated_roles => { kind: :property, name: "associatedRoles", is_optional: true },
    :automatic_backup_replication_kms_key_id => { kind: :property, name: "automaticBackupReplicationKmsKeyId", is_optional: true },
    :automatic_backup_replication_region => { kind: :property, name: "automaticBackupReplicationRegion", is_optional: true },
    :automatic_backup_replication_retention_period => { kind: :property, name: "automaticBackupReplicationRetentionPeriod", is_optional: true },
    :auto_minor_version_upgrade => { kind: :property, name: "autoMinorVersionUpgrade", is_optional: true },
    :availability_zone => { kind: :property, name: "availabilityZone", is_optional: true },
    :backup_retention_period => { kind: :property, name: "backupRetentionPeriod", is_optional: true },
    :backup_target => { kind: :property, name: "backupTarget", is_optional: true },
    :ca_certificate_identifier => { kind: :property, name: "caCertificateIdentifier", is_optional: true },
    :certificate_rotation_restart => { kind: :property, name: "certificateRotationRestart", is_optional: true },
    :character_set_name => { kind: :property, name: "characterSetName", is_optional: true },
    :copy_tags_to_snapshot => { kind: :property, name: "copyTagsToSnapshot", is_optional: true },
    :custom_iam_instance_profile => { kind: :property, name: "customIamInstanceProfile", is_optional: true },
    :database_insights_mode => { kind: :property, name: "databaseInsightsMode", is_optional: true },
    :db_cluster_identifier => { kind: :property, name: "dbClusterIdentifier", is_optional: true },
    :db_cluster_snapshot_identifier => { kind: :property, name: "dbClusterSnapshotIdentifier", is_optional: true },
    :db_instance_class => { kind: :property, name: "dbInstanceClass", is_optional: true },
    :db_instance_identifier => { kind: :property, name: "dbInstanceIdentifier", is_optional: true },
    :db_name => { kind: :property, name: "dbName", is_optional: true },
    :db_parameter_group_name => { kind: :property, name: "dbParameterGroupName", is_optional: true },
    :db_security_groups => { kind: :property, name: "dbSecurityGroups", is_optional: true },
    :db_snapshot_identifier => { kind: :property, name: "dbSnapshotIdentifier", is_optional: true },
    :db_subnet_group_name => { kind: :property, name: "dbSubnetGroupName", is_optional: true },
    :db_system_id => { kind: :property, name: "dbSystemId", is_optional: true },
    :dedicated_log_volume => { kind: :property, name: "dedicatedLogVolume", is_optional: true },
    :delete_automated_backups => { kind: :property, name: "deleteAutomatedBackups", is_optional: true },
    :deletion_protection => { kind: :property, name: "deletionProtection", is_optional: true },
    :domain => { kind: :property, name: "domain", is_optional: true },
    :domain_auth_secret_arn => { kind: :property, name: "domainAuthSecretArn", is_optional: true },
    :domain_dns_ips => { kind: :property, name: "domainDnsIps", is_optional: true },
    :domain_fqdn => { kind: :property, name: "domainFqdn", is_optional: true },
    :domain_iam_role_name => { kind: :property, name: "domainIamRoleName", is_optional: true },
    :domain_ou => { kind: :property, name: "domainOu", is_optional: true },
    :enable_cloudwatch_logs_exports => { kind: :property, name: "enableCloudwatchLogsExports", is_optional: true },
    :enable_iam_database_authentication => { kind: :property, name: "enableIamDatabaseAuthentication", is_optional: true },
    :enable_performance_insights => { kind: :property, name: "enablePerformanceInsights", is_optional: true },
    :engine => { kind: :property, name: "engine", is_optional: true },
    :engine_lifecycle_support => { kind: :property, name: "engineLifecycleSupport", is_optional: true },
    :engine_version => { kind: :property, name: "engineVersion", is_optional: true },
    :iops => { kind: :property, name: "iops", is_optional: true },
    :kms_key_id => { kind: :property, name: "kmsKeyId", is_optional: true },
    :license_model => { kind: :property, name: "licenseModel", is_optional: true },
    :manage_master_user_password => { kind: :property, name: "manageMasterUserPassword", is_optional: true },
    :master_user_authentication_type => { kind: :property, name: "masterUserAuthenticationType", is_optional: true },
    :master_username => { kind: :property, name: "masterUsername", is_optional: true },
    :master_user_password => { kind: :property, name: "masterUserPassword", is_optional: true },
    :master_user_secret => { kind: :property, name: "masterUserSecret", is_optional: true },
    :max_allocated_storage => { kind: :property, name: "maxAllocatedStorage", is_optional: true },
    :monitoring_interval => { kind: :property, name: "monitoringInterval", is_optional: true },
    :monitoring_role_arn => { kind: :property, name: "monitoringRoleArn", is_optional: true },
    :multi_az => { kind: :property, name: "multiAz", is_optional: true },
    :nchar_character_set_name => { kind: :property, name: "ncharCharacterSetName", is_optional: true },
    :network_type => { kind: :property, name: "networkType", is_optional: true },
    :option_group_name => { kind: :property, name: "optionGroupName", is_optional: true },
    :performance_insights_kms_key_id => { kind: :property, name: "performanceInsightsKmsKeyId", is_optional: true },
    :performance_insights_retention_period => { kind: :property, name: "performanceInsightsRetentionPeriod", is_optional: true },
    :port => { kind: :property, name: "port", is_optional: true },
    :preferred_backup_window => { kind: :property, name: "preferredBackupWindow", is_optional: true },
    :preferred_maintenance_window => { kind: :property, name: "preferredMaintenanceWindow", is_optional: true },
    :processor_features => { kind: :property, name: "processorFeatures", is_optional: true },
    :promotion_tier => { kind: :property, name: "promotionTier", is_optional: true },
    :publicly_accessible => { kind: :property, name: "publiclyAccessible", is_optional: true },
    :replica_mode => { kind: :property, name: "replicaMode", is_optional: true },
    :restore_time => { kind: :property, name: "restoreTime", is_optional: true },
    :source_db_cluster_identifier => { kind: :property, name: "sourceDbClusterIdentifier", is_optional: true },
    :source_db_instance_automated_backups_arn => { kind: :property, name: "sourceDbInstanceAutomatedBackupsArn", is_optional: true },
    :source_db_instance_identifier => { kind: :property, name: "sourceDbInstanceIdentifier", is_optional: true },
    :source_dbi_resource_id => { kind: :property, name: "sourceDbiResourceId", is_optional: true },
    :source_region => { kind: :property, name: "sourceRegion", is_optional: true },
    :storage_encrypted => { kind: :property, name: "storageEncrypted", is_optional: true },
    :storage_throughput => { kind: :property, name: "storageThroughput", is_optional: true },
    :storage_type => { kind: :property, name: "storageType", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :tde_credential_arn => { kind: :property, name: "tdeCredentialArn", is_optional: true },
    :tde_credential_password => { kind: :property, name: "tdeCredentialPassword", is_optional: true },
    :timezone => { kind: :property, name: "timezone", is_optional: true },
    :use_default_processor_features => { kind: :property, name: "useDefaultProcessorFeatures", is_optional: true },
    :use_latest_restorable_time => { kind: :property, name: "useLatestRestorableTime", is_optional: true },
    :vpc_security_groups => { kind: :property, name: "vpcSecurityGroups", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



1591
1592
1593
1594
 
# File 'rds/cfn_db_instance.rb', line 1591

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



1603
1604
1605
1606
 
# File 'rds/cfn_db_instance.rb', line 1603

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



1613
1614
1615
1616
 
# File 'rds/cfn_db_instance.rb', line 1613

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



1624
1625
1626
1627
1628
 
# File 'rds/cfn_db_instance.rb', line 1624

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


1681
1682
1683
1684
1685
 
# File 'rds/cfn_db_instance.rb', line 1681

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



1691
1692
1693
1694
 
# File 'rds/cfn_db_instance.rb', line 1691

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



1703
1704
1705
1706
1707
 
# File 'rds/cfn_db_instance.rb', line 1703

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#additional_storage_volumes ⇒ AWSCDK::IResolvable, ...

The additional storage volumes associated with the DB instance.

Returns:



558
559
560
 
# File 'rds/cfn_db_instance.rb', line 558

def additional_storage_volumes()
  jsii_get_property("additionalStorageVolumes")
end

#additional_storage_volumes=(value) ⇒ Object 



562
563
564
565
 
# File 'rds/cfn_db_instance.rb', line 562

def additional_storage_volumes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLkNmbkRCSW5zdGFuY2UuQWRkaXRpb25hbFN0b3JhZ2VWb2x1bWVQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "additionalStorageVolumes") unless value.nil?
  jsii_set_property("additionalStorageVolumes", value)
end

#allocated_storage ⇒ String?

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

Returns:

  • (String, nil) 


570
571
572
 
# File 'rds/cfn_db_instance.rb', line 570

def allocated_storage()
  jsii_get_property("allocatedStorage")
end

#allocated_storage=(value) ⇒ Object 



574
575
576
577
 
# File 'rds/cfn_db_instance.rb', line 574

def allocated_storage=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "allocatedStorage") unless value.nil?
  jsii_set_property("allocatedStorage", value)
end

#allow_major_version_upgrade ⇒ Boolean, ...

A value that indicates whether major version upgrades are allowed.

Returns:



582
583
584
 
# File 'rds/cfn_db_instance.rb', line 582

def allow_major_version_upgrade()
  jsii_get_property("allowMajorVersionUpgrade")
end

#allow_major_version_upgrade=(value) ⇒ Object 



586
587
588
589
 
# File 'rds/cfn_db_instance.rb', line 586

def allow_major_version_upgrade=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "allowMajorVersionUpgrade") unless value.nil?
  jsii_set_property("allowMajorVersionUpgrade", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



1716
1717
1718
1719
 
# File 'rds/cfn_db_instance.rb', line 1716

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_immediately ⇒ Boolean, ...

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

Returns:



594
595
596
 
# File 'rds/cfn_db_instance.rb', line 594

def apply_immediately()
  jsii_get_property("applyImmediately")
end

#apply_immediately=(value) ⇒ Object 



598
599
600
601
 
# File 'rds/cfn_db_instance.rb', line 598

def apply_immediately=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "applyImmediately") unless value.nil?
  jsii_set_property("applyImmediately", value)
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



1738
1739
1740
1741
1742
1743
 
# File 'rds/cfn_db_instance.rb', line 1738

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#associated_roles ⇒ AWSCDK::IResolvable, ...

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

Returns:



606
607
608
 
# File 'rds/cfn_db_instance.rb', line 606

def associated_roles()
  jsii_get_property("associatedRoles")
end

#associated_roles=(value) ⇒ Object 



610
611
612
613
 
# File 'rds/cfn_db_instance.rb', line 610

def associated_roles=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLkNmbkRCSW5zdGFuY2UuREJJbnN0YW5jZVJvbGVQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "associatedRoles") unless value.nil?
  jsii_set_property("associatedRoles", value)
end

#attr_automatic_restart_time ⇒ String

The time when a stopped DB instance is restarted automatically.

Returns:

  • (String) 


328
329
330
 
# File 'rds/cfn_db_instance.rb', line 328

def attr_automatic_restart_time()
  jsii_get_property("attrAutomaticRestartTime")
end

#attr_certificate_details ⇒ AWSCDK::IResolvable

The details of the DB instance’s server certificate.

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:



337
338
339
 
# File 'rds/cfn_db_instance.rb', line 337

def attr_certificate_details()
  jsii_get_property("attrCertificateDetails")
end

#attr_certificate_details_ca_identifier ⇒ String

The CA identifier of the CA certificate used for the DB instance's server certificate.

Returns:

  • (String) 


344
345
346
 
# File 'rds/cfn_db_instance.rb', line 344

def attr_certificate_details_ca_identifier()
  jsii_get_property("attrCertificateDetailsCaIdentifier")
end

#attr_certificate_details_valid_till ⇒ String

The expiration date of the DB instance’s server certificate.

Returns:

  • (String) 


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

def attr_certificate_details_valid_till()
  jsii_get_property("attrCertificateDetailsValidTill")
end

#attr_db_instance_arn ⇒ String

The Amazon Resource Name (ARN) for the DB instance.

Returns:

  • (String) 


358
359
360
 
# File 'rds/cfn_db_instance.rb', line 358

def attr_db_instance_arn()
  jsii_get_property("attrDbInstanceArn")
end

#attr_db_instance_status ⇒ String

The current state of this DB instance.

Returns:

  • (String) 


365
366
367
 
# File 'rds/cfn_db_instance.rb', line 365

def attr_db_instance_status()
  jsii_get_property("attrDbInstanceStatus")
end

#attr_db_system_id ⇒ String

The Oracle system ID (Oracle SID) for a container database (CDB).

The Oracle SID is also the name of the CDB.

This setting is valid for RDS Custom only.

Returns:

  • (String) 


385
386
387
 
# File 'rds/cfn_db_instance.rb', line 385

def attr_db_system_id()
  jsii_get_property("attrDbSystemId")
end

#attr_dbi_resource_id ⇒ String

The AWS Region-unique, immutable identifier for the DB instance.

This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

Returns:

  • (String) 


374
375
376
 
# File 'rds/cfn_db_instance.rb', line 374

def attr_dbi_resource_id()
  jsii_get_property("attrDbiResourceId")
end

#attr_endpoint ⇒ AWSCDK::IResolvable

This data type represents the information you need to connect to an Amazon RDS DB instance.

This data type is used as a response element in the following actions:

  • CreateDBInstance
  • DescribeDBInstances
  • DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

Returns:



400
401
402
 
# File 'rds/cfn_db_instance.rb', line 400

def attr_endpoint()
  jsii_get_property("attrEndpoint")
end

#attr_endpoint_address ⇒ String

The connection endpoint for the database. For example: mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com.

For Aurora Serverless DB clusters, the connection endpoint only applies to the DB cluster.

Returns:

  • (String) 


409
410
411
 
# File 'rds/cfn_db_instance.rb', line 409

def attr_endpoint_address()
  jsii_get_property("attrEndpointAddress")
end

#attr_endpoint_hosted_zone_id ⇒ String

The ID that Amazon Route 53 assigns when you create a hosted zone.

Returns:

  • (String) 


416
417
418
 
# File 'rds/cfn_db_instance.rb', line 416

def attr_endpoint_hosted_zone_id()
  jsii_get_property("attrEndpointHostedZoneId")
end

#attr_endpoint_port ⇒ String

The port number on which the database accepts connections.

For example: 3306

Returns:

  • (String) 


425
426
427
 
# File 'rds/cfn_db_instance.rb', line 425

def attr_endpoint_port()
  jsii_get_property("attrEndpointPort")
end

#attr_instance_create_time ⇒ String

The date and time when the DB instance was created.

Returns:

  • (String) 


432
433
434
 
# File 'rds/cfn_db_instance.rb', line 432

def attr_instance_create_time()
  jsii_get_property("attrInstanceCreateTime")
end

#attr_is_storage_config_upgrade_available ⇒ AWSCDK::IResolvable

Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance.

Returns:



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

def attr_is_storage_config_upgrade_available()
  jsii_get_property("attrIsStorageConfigUpgradeAvailable")
end

#attr_latest_restorable_time ⇒ String

The latest time to which a database in this DB instance can be restored with point-in-time restore.

Returns:

  • (String) 


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

def attr_latest_restorable_time()
  jsii_get_property("attrLatestRestorableTime")
end

#attr_listener_endpoint ⇒ AWSCDK::IResolvable

This data type represents the information you need to connect to an Amazon RDS DB instance.

This data type is used as a response element in the following actions:

  • CreateDBInstance
  • DescribeDBInstances
  • DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

Returns:



461
462
463
 
# File 'rds/cfn_db_instance.rb', line 461

def attr_listener_endpoint()
  jsii_get_property("attrListenerEndpoint")
end

#attr_listener_endpoint_address ⇒ String

Specifies the DNS address of the DB instance.

Returns:

  • (String) 


468
469
470
 
# File 'rds/cfn_db_instance.rb', line 468

def attr_listener_endpoint_address()
  jsii_get_property("attrListenerEndpointAddress")
end

#attr_listener_endpoint_hosted_zone_id ⇒ String

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Returns:

  • (String) 


475
476
477
 
# File 'rds/cfn_db_instance.rb', line 475

def attr_listener_endpoint_hosted_zone_id()
  jsii_get_property("attrListenerEndpointHostedZoneId")
end

#attr_listener_endpoint_port ⇒ String

Specifies the port that the database engine is listening on.

Returns:

  • (String) 


482
483
484
 
# File 'rds/cfn_db_instance.rb', line 482

def attr_listener_endpoint_port()
  jsii_get_property("attrListenerEndpointPort")
end

#attr_master_user_secret_secret_arn ⇒ String

The Amazon Resource Name (ARN) of the secret.

This parameter is a return value that you can retrieve using the Fn::GetAtt intrinsic function. For more information, see Return values .

Returns:

  • (String) 


491
492
493
 
# File 'rds/cfn_db_instance.rb', line 491

def attr_master_user_secret_secret_arn()
  jsii_get_property("attrMasterUserSecretSecretArn")
end

#attr_percent_progress ⇒ String

The progress of the storage optimization operation as a percentage.

Returns:

  • (String) 


498
499
500
 
# File 'rds/cfn_db_instance.rb', line 498

def attr_percent_progress()
  jsii_get_property("attrPercentProgress")
end

#attr_read_replica_db_cluster_identifiers ⇒ Array<String>

The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.

Returns:

  • (Array<String>) 


505
506
507
 
# File 'rds/cfn_db_instance.rb', line 505

def attr_read_replica_db_cluster_identifiers()
  jsii_get_property("attrReadReplicaDbClusterIdentifiers")
end

#attr_read_replica_db_instance_identifiers ⇒ Array<String>

The identifiers of the read replicas associated with this DB instance.

Returns:

  • (Array<String>) 


512
513
514
 
# File 'rds/cfn_db_instance.rb', line 512

def attr_read_replica_db_instance_identifiers()
  jsii_get_property("attrReadReplicaDbInstanceIdentifiers")
end

#attr_resume_full_automation_mode_time ⇒ String

The number of minutes to pause the automation.

When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

Returns:

  • (String) 


521
522
523
 
# File 'rds/cfn_db_instance.rb', line 521

def attr_resume_full_automation_mode_time()
  jsii_get_property("attrResumeFullAutomationModeTime")
end

#attr_secondary_availability_zone ⇒ String

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

Returns:

  • (String) 


528
529
530
 
# File 'rds/cfn_db_instance.rb', line 528

def attr_secondary_availability_zone()
  jsii_get_property("attrSecondaryAvailabilityZone")
end

#attr_status_infos ⇒ AWSCDK::IResolvable

The status of a read replica.

If the DB instance isn't a read replica, the value is blank.

Returns:



537
538
539
 
# File 'rds/cfn_db_instance.rb', line 537

def attr_status_infos()
  jsii_get_property("attrStatusInfos")
end

#auto_minor_version_upgrade ⇒ Boolean, ...

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

Returns:



654
655
656
 
# File 'rds/cfn_db_instance.rb', line 654

def auto_minor_version_upgrade()
  jsii_get_property("autoMinorVersionUpgrade")
end

#auto_minor_version_upgrade=(value) ⇒ Object 



658
659
660
661
 
# File 'rds/cfn_db_instance.rb', line 658

def auto_minor_version_upgrade=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "autoMinorVersionUpgrade") unless value.nil?
  jsii_set_property("autoMinorVersionUpgrade", value)
end

#automatic_backup_replication_kms_key_id ⇒ String?

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

Returns:

  • (String, nil) 


618
619
620
 
# File 'rds/cfn_db_instance.rb', line 618

def automatic_backup_replication_kms_key_id()
  jsii_get_property("automaticBackupReplicationKmsKeyId")
end

#automatic_backup_replication_kms_key_id=(value) ⇒ Object 



622
623
624
625
 
# File 'rds/cfn_db_instance.rb', line 622

def automatic_backup_replication_kms_key_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "automaticBackupReplicationKmsKeyId") unless value.nil?
  jsii_set_property("automaticBackupReplicationKmsKeyId", value)
end

#automatic_backup_replication_region ⇒ String?

The AWS Region associated with the automated backup.

Returns:

  • (String, nil) 


630
631
632
 
# File 'rds/cfn_db_instance.rb', line 630

def automatic_backup_replication_region()
  jsii_get_property("automaticBackupReplicationRegion")
end

#automatic_backup_replication_region=(value) ⇒ Object 



634
635
636
637
 
# File 'rds/cfn_db_instance.rb', line 634

def automatic_backup_replication_region=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "automaticBackupReplicationRegion") unless value.nil?
  jsii_set_property("automaticBackupReplicationRegion", value)
end

#automatic_backup_replication_retention_period ⇒ Numeric?

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

Returns:

  • (Numeric, nil) 


642
643
644
 
# File 'rds/cfn_db_instance.rb', line 642

def automatic_backup_replication_retention_period()
  jsii_get_property("automaticBackupReplicationRetentionPeriod")
end

#automatic_backup_replication_retention_period=(value) ⇒ Object 



646
647
648
649
 
# File 'rds/cfn_db_instance.rb', line 646

def automatic_backup_replication_retention_period=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "automaticBackupReplicationRetentionPeriod") unless value.nil?
  jsii_set_property("automaticBackupReplicationRetentionPeriod", value)
end

#availability_zone ⇒ String?

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

Returns:

  • (String, nil) 


666
667
668
 
# File 'rds/cfn_db_instance.rb', line 666

def availability_zone()
  jsii_get_property("availabilityZone")
end

#availability_zone=(value) ⇒ Object 



670
671
672
673
 
# File 'rds/cfn_db_instance.rb', line 670

def availability_zone=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "availabilityZone") unless value.nil?
  jsii_set_property("availabilityZone", value)
end

#backup_retention_period ⇒ Numeric?

The number of days for which automated backups are retained.

Returns:

  • (Numeric, nil) 


678
679
680
 
# File 'rds/cfn_db_instance.rb', line 678

def backup_retention_period()
  jsii_get_property("backupRetentionPeriod")
end

#backup_retention_period=(value) ⇒ Object 



682
683
684
685
 
# File 'rds/cfn_db_instance.rb', line 682

def backup_retention_period=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "backupRetentionPeriod") unless value.nil?
  jsii_set_property("backupRetentionPeriod", value)
end

#backup_target ⇒ String?

The location for storing automated backups and manual snapshots.

Returns:

  • (String, nil) 


690
691
692
 
# File 'rds/cfn_db_instance.rb', line 690

def backup_target()
  jsii_get_property("backupTarget")
end

#backup_target=(value) ⇒ Object 



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

def backup_target=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "backupTarget") unless value.nil?
  jsii_set_property("backupTarget", value)
end

#ca_certificate_identifier ⇒ String?

The identifier of the CA certificate for this DB instance.

Returns:

  • (String, nil) 


702
703
704
 
# File 'rds/cfn_db_instance.rb', line 702

def ca_certificate_identifier()
  jsii_get_property("caCertificateIdentifier")
end

#ca_certificate_identifier=(value) ⇒ Object 



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

def ca_certificate_identifier=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "caCertificateIdentifier") unless value.nil?
  jsii_set_property("caCertificateIdentifier", value)
end

#certificate_rotation_restart ⇒ Boolean, ...

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

Returns:



714
715
716
 
# File 'rds/cfn_db_instance.rb', line 714

def certificate_rotation_restart()
  jsii_get_property("certificateRotationRestart")
end

#certificate_rotation_restart=(value) ⇒ Object 



718
719
720
721
 
# File 'rds/cfn_db_instance.rb', line 718

def certificate_rotation_restart=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "certificateRotationRestart") unless value.nil?
  jsii_set_property("certificateRotationRestart", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



274
275
276
 
# File 'rds/cfn_db_instance.rb', line 274

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


279
280
281
 
# File 'rds/cfn_db_instance.rb', line 279

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


1747
1748
1749
1750
 
# File 'rds/cfn_db_instance.rb', line 1747

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


284
285
286
 
# File 'rds/cfn_db_instance.rb', line 284

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


291
292
293
 
# File 'rds/cfn_db_instance.rb', line 291

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#character_set_name ⇒ String?

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

Returns:

  • (String, nil) 


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

def character_set_name()
  jsii_get_property("characterSetName")
end

#character_set_name=(value) ⇒ Object 



730
731
732
733
 
# File 'rds/cfn_db_instance.rb', line 730

def character_set_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "characterSetName") unless value.nil?
  jsii_set_property("characterSetName", value)
end

#copy_tags_to_snapshot ⇒ Boolean, ...

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

Returns:



738
739
740
 
# File 'rds/cfn_db_instance.rb', line 738

def copy_tags_to_snapshot()
  jsii_get_property("copyTagsToSnapshot")
end

#copy_tags_to_snapshot=(value) ⇒ Object 



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

def copy_tags_to_snapshot=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "copyTagsToSnapshot") unless value.nil?
  jsii_set_property("copyTagsToSnapshot", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


236
237
238
 
# File 'rds/cfn_db_instance.rb', line 236

def creation_stack()
  jsii_get_property("creationStack")
end

#custom_iam_instance_profile ⇒ String?

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

Returns:

  • (String, nil) 


750
751
752
 
# File 'rds/cfn_db_instance.rb', line 750

def custom_iam_instance_profile()
  jsii_get_property("customIamInstanceProfile")
end

#custom_iam_instance_profile=(value) ⇒ Object 



754
755
756
757
 
# File 'rds/cfn_db_instance.rb', line 754

def custom_iam_instance_profile=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customIamInstanceProfile") unless value.nil?
  jsii_set_property("customIamInstanceProfile", value)
end

#database_insights_mode ⇒ String?

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

Returns:

  • (String, nil) 


762
763
764
 
# File 'rds/cfn_db_instance.rb', line 762

def database_insights_mode()
  jsii_get_property("databaseInsightsMode")
end

#database_insights_mode=(value) ⇒ Object 



766
767
768
769
 
# File 'rds/cfn_db_instance.rb', line 766

def database_insights_mode=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "databaseInsightsMode") unless value.nil?
  jsii_set_property("databaseInsightsMode", value)
end

#db_cluster_identifier ⇒ String?

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

Returns:

  • (String, nil) 


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

def db_cluster_identifier()
  jsii_get_property("dbClusterIdentifier")
end

#db_cluster_identifier=(value) ⇒ Object 



778
779
780
781
 
# File 'rds/cfn_db_instance.rb', line 778

def db_cluster_identifier=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbClusterIdentifier") unless value.nil?
  jsii_set_property("dbClusterIdentifier", value)
end

#db_cluster_snapshot_identifier ⇒ String?

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

Returns:

  • (String, nil) 


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

def db_cluster_snapshot_identifier()
  jsii_get_property("dbClusterSnapshotIdentifier")
end

#db_cluster_snapshot_identifier=(value) ⇒ Object 



790
791
792
793
 
# File 'rds/cfn_db_instance.rb', line 790

def db_cluster_snapshot_identifier=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbClusterSnapshotIdentifier") unless value.nil?
  jsii_set_property("dbClusterSnapshotIdentifier", value)
end

#db_instance_class ⇒ String?

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) 


798
799
800
 
# File 'rds/cfn_db_instance.rb', line 798

def db_instance_class()
  jsii_get_property("dbInstanceClass")
end

#db_instance_class=(value) ⇒ Object 



802
803
804
805
 
# File 'rds/cfn_db_instance.rb', line 802

def db_instance_class=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbInstanceClass") unless value.nil?
  jsii_set_property("dbInstanceClass", value)
end

#db_instance_identifier ⇒ String?

A name for the DB instance.

Returns:

  • (String, nil) 


810
811
812
 
# File 'rds/cfn_db_instance.rb', line 810

def db_instance_identifier()
  jsii_get_property("dbInstanceIdentifier")
end

#db_instance_identifier=(value) ⇒ Object 



814
815
816
817
 
# File 'rds/cfn_db_instance.rb', line 814

def db_instance_identifier=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbInstanceIdentifier") unless value.nil?
  jsii_set_property("dbInstanceIdentifier", value)
end

#db_instance_ref ⇒ AWSCDK::Interfaces::AWSRDS::DBInstanceReference

A reference to a DBInstance resource.

Returns:



544
545
546
 
# File 'rds/cfn_db_instance.rb', line 544

def db_instance_ref()
  jsii_get_property("dbInstanceRef")
end

#db_name ⇒ String?

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

Returns:

  • (String, nil) 


822
823
824
 
# File 'rds/cfn_db_instance.rb', line 822

def db_name()
  jsii_get_property("dbName")
end

#db_name=(value) ⇒ Object 



826
827
828
829
 
# File 'rds/cfn_db_instance.rb', line 826

def db_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbName") unless value.nil?
  jsii_set_property("dbName", value)
end

#db_parameter_group_name ⇒ String?

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

Returns:

  • (String, nil) 


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

def db_parameter_group_name()
  jsii_get_property("dbParameterGroupName")
end

#db_parameter_group_name=(value) ⇒ Object 



838
839
840
841
 
# File 'rds/cfn_db_instance.rb', line 838

def db_parameter_group_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbParameterGroupName") unless value.nil?
  jsii_set_property("dbParameterGroupName", value)
end

#db_security_groups ⇒ Array<String>?

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

Returns:

  • (Array<String>, nil) 


846
847
848
 
# File 'rds/cfn_db_instance.rb', line 846

def db_security_groups()
  jsii_get_property("dbSecurityGroups")
end

#db_security_groups=(value) ⇒ Object 



850
851
852
853
 
# File 'rds/cfn_db_instance.rb', line 850

def db_security_groups=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "dbSecurityGroups") unless value.nil?
  jsii_set_property("dbSecurityGroups", value)
end

#db_snapshot_identifier ⇒ String?

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

Returns:

  • (String, nil) 


858
859
860
 
# File 'rds/cfn_db_instance.rb', line 858

def db_snapshot_identifier()
  jsii_get_property("dbSnapshotIdentifier")
end

#db_snapshot_identifier=(value) ⇒ Object 



862
863
864
865
 
# File 'rds/cfn_db_instance.rb', line 862

def db_snapshot_identifier=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbSnapshotIdentifier") unless value.nil?
  jsii_set_property("dbSnapshotIdentifier", value)
end

#db_subnet_group_name ⇒ String?

A DB subnet group to associate with the DB instance.

Returns:

  • (String, nil) 


870
871
872
 
# File 'rds/cfn_db_instance.rb', line 870

def db_subnet_group_name()
  jsii_get_property("dbSubnetGroupName")
end

#db_subnet_group_name=(value) ⇒ Object 



874
875
876
877
 
# File 'rds/cfn_db_instance.rb', line 874

def db_subnet_group_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbSubnetGroupName") unless value.nil?
  jsii_set_property("dbSubnetGroupName", value)
end

#db_system_id ⇒ String?

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

Returns:

  • (String, nil) 


882
883
884
 
# File 'rds/cfn_db_instance.rb', line 882

def db_system_id()
  jsii_get_property("dbSystemId")
end

#db_system_id=(value) ⇒ Object 



886
887
888
889
 
# File 'rds/cfn_db_instance.rb', line 886

def db_system_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbSystemId") unless value.nil?
  jsii_set_property("dbSystemId", value)
end

#dedicated_log_volume ⇒ Boolean, ...

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

Returns:



894
895
896
 
# File 'rds/cfn_db_instance.rb', line 894

def dedicated_log_volume()
  jsii_get_property("dedicatedLogVolume")
end

#dedicated_log_volume=(value) ⇒ Object 



898
899
900
901
 
# File 'rds/cfn_db_instance.rb', line 898

def dedicated_log_volume=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "dedicatedLogVolume") unless value.nil?
  jsii_set_property("dedicatedLogVolume", value)
end

#delete_automated_backups ⇒ Boolean, ...

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

Returns:



906
907
908
 
# File 'rds/cfn_db_instance.rb', line 906

def delete_automated_backups()
  jsii_get_property("deleteAutomatedBackups")
end

#delete_automated_backups=(value) ⇒ Object 



910
911
912
913
 
# File 'rds/cfn_db_instance.rb', line 910

def delete_automated_backups=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "deleteAutomatedBackups") unless value.nil?
  jsii_set_property("deleteAutomatedBackups", value)
end

#deletion_protection ⇒ Boolean, ...

Specifies whether the DB instance has deletion protection enabled.

Returns:



918
919
920
 
# File 'rds/cfn_db_instance.rb', line 918

def deletion_protection()
  jsii_get_property("deletionProtection")
end

#deletion_protection=(value) ⇒ Object 



922
923
924
925
 
# File 'rds/cfn_db_instance.rb', line 922

def deletion_protection=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "deletionProtection") unless value.nil?
  jsii_set_property("deletionProtection", value)
end

#domain ⇒ String?

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

Returns:

  • (String, nil) 


930
931
932
 
# File 'rds/cfn_db_instance.rb', line 930

def domain()
  jsii_get_property("domain")
end

#domain=(value) ⇒ Object 



934
935
936
937
 
# File 'rds/cfn_db_instance.rb', line 934

def domain=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domain") unless value.nil?
  jsii_set_property("domain", value)
end

#domain_auth_secret_arn ⇒ String?

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

Returns:

  • (String, nil) 


942
943
944
 
# File 'rds/cfn_db_instance.rb', line 942

def domain_auth_secret_arn()
  jsii_get_property("domainAuthSecretArn")
end

#domain_auth_secret_arn=(value) ⇒ Object 



946
947
948
949
 
# File 'rds/cfn_db_instance.rb', line 946

def domain_auth_secret_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainAuthSecretArn") unless value.nil?
  jsii_set_property("domainAuthSecretArn", value)
end

#domain_dns_ips ⇒ Array<String>?

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

Returns:

  • (Array<String>, nil) 


954
955
956
 
# File 'rds/cfn_db_instance.rb', line 954

def domain_dns_ips()
  jsii_get_property("domainDnsIps")
end

#domain_dns_ips=(value) ⇒ Object 



958
959
960
961
 
# File 'rds/cfn_db_instance.rb', line 958

def domain_dns_ips=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "domainDnsIps") unless value.nil?
  jsii_set_property("domainDnsIps", value)
end

#domain_fqdn ⇒ String?

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

Returns:

  • (String, nil) 


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

def domain_fqdn()
  jsii_get_property("domainFqdn")
end

#domain_fqdn=(value) ⇒ Object 



970
971
972
973
 
# File 'rds/cfn_db_instance.rb', line 970

def domain_fqdn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainFqdn") unless value.nil?
  jsii_set_property("domainFqdn", value)
end

#domain_iam_role_name ⇒ String?

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

Returns:

  • (String, nil) 


978
979
980
 
# File 'rds/cfn_db_instance.rb', line 978

def domain_iam_role_name()
  jsii_get_property("domainIamRoleName")
end

#domain_iam_role_name=(value) ⇒ Object 



982
983
984
985
 
# File 'rds/cfn_db_instance.rb', line 982

def domain_iam_role_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainIamRoleName") unless value.nil?
  jsii_set_property("domainIamRoleName", value)
end

#domain_ou ⇒ String?

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

Returns:

  • (String, nil) 


990
991
992
 
# File 'rds/cfn_db_instance.rb', line 990

def domain_ou()
  jsii_get_property("domainOu")
end

#domain_ou=(value) ⇒ Object 



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

def domain_ou=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainOu") unless value.nil?
  jsii_set_property("domainOu", value)
end

#enable_cloudwatch_logs_exports ⇒ Array<String>?

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

Returns:

  • (Array<String>, nil) 


1002
1003
1004
 
# File 'rds/cfn_db_instance.rb', line 1002

def enable_cloudwatch_logs_exports()
  jsii_get_property("enableCloudwatchLogsExports")
end

#enable_cloudwatch_logs_exports=(value) ⇒ Object 



1006
1007
1008
1009
 
# File 'rds/cfn_db_instance.rb', line 1006

def enable_cloudwatch_logs_exports=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "enableCloudwatchLogsExports") unless value.nil?
  jsii_set_property("enableCloudwatchLogsExports", value)
end

#enable_iam_database_authentication ⇒ Boolean, ...

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

Returns:



1014
1015
1016
 
# File 'rds/cfn_db_instance.rb', line 1014

def enable_iam_database_authentication()
  jsii_get_property("enableIamDatabaseAuthentication")
end

#enable_iam_database_authentication=(value) ⇒ Object 



1018
1019
1020
1021
 
# File 'rds/cfn_db_instance.rb', line 1018

def enable_iam_database_authentication=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableIamDatabaseAuthentication") unless value.nil?
  jsii_set_property("enableIamDatabaseAuthentication", value)
end

#enable_performance_insights ⇒ Boolean, ...

Specifies whether to enable Performance Insights for the DB instance.

Returns:



1026
1027
1028
 
# File 'rds/cfn_db_instance.rb', line 1026

def enable_performance_insights()
  jsii_get_property("enablePerformanceInsights")
end

#enable_performance_insights=(value) ⇒ Object 



1030
1031
1032
1033
 
# File 'rds/cfn_db_instance.rb', line 1030

def enable_performance_insights=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enablePerformanceInsights") unless value.nil?
  jsii_set_property("enablePerformanceInsights", value)
end

#engine ⇒ String?

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

Returns:

  • (String, nil) 


1038
1039
1040
 
# File 'rds/cfn_db_instance.rb', line 1038

def engine()
  jsii_get_property("engine")
end

#engine=(value) ⇒ Object 



1042
1043
1044
1045
 
# File 'rds/cfn_db_instance.rb', line 1042

def engine=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engine") unless value.nil?
  jsii_set_property("engine", value)
end

#engine_lifecycle_support ⇒ String?

The life cycle type for this DB instance.

Returns:

  • (String, nil) 


1050
1051
1052
 
# File 'rds/cfn_db_instance.rb', line 1050

def engine_lifecycle_support()
  jsii_get_property("engineLifecycleSupport")
end

#engine_lifecycle_support=(value) ⇒ Object 



1054
1055
1056
1057
 
# File 'rds/cfn_db_instance.rb', line 1054

def engine_lifecycle_support=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engineLifecycleSupport") unless value.nil?
  jsii_set_property("engineLifecycleSupport", value)
end

#engine_version ⇒ String?

The version number of the database engine to use.

Returns:

  • (String, nil) 


1062
1063
1064
 
# File 'rds/cfn_db_instance.rb', line 1062

def engine_version()
  jsii_get_property("engineVersion")
end

#engine_version=(value) ⇒ Object 



1066
1067
1068
1069
 
# File 'rds/cfn_db_instance.rb', line 1066

def engine_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engineVersion") unless value.nil?
  jsii_set_property("engineVersion", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



296
297
298
 
# File 'rds/cfn_db_instance.rb', line 296

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



1760
1761
1762
1763
1764
 
# File 'rds/cfn_db_instance.rb', line 1760

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



1771
1772
1773
1774
 
# File 'rds/cfn_db_instance.rb', line 1771

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



1841
1842
1843
1844
 
# File 'rds/cfn_db_instance.rb', line 1841

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#iops ⇒ Numeric?

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

Returns:

  • (Numeric, nil) 


1074
1075
1076
 
# File 'rds/cfn_db_instance.rb', line 1074

def iops()
  jsii_get_property("iops")
end

#iops=(value) ⇒ Object 



1078
1079
1080
1081
 
# File 'rds/cfn_db_instance.rb', line 1078

def iops=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "iops") unless value.nil?
  jsii_set_property("iops", value)
end

#kms_key_id ⇒ String?

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 .

Returns:

  • (String, nil) 


1086
1087
1088
 
# File 'rds/cfn_db_instance.rb', line 1086

def kms_key_id()
  jsii_get_property("kmsKeyId")
end

#kms_key_id=(value) ⇒ Object 



1090
1091
1092
1093
 
# File 'rds/cfn_db_instance.rb', line 1090

def kms_key_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless value.nil?
  jsii_set_property("kmsKeyId", value)
end

#license_model ⇒ String?

License model information for this DB instance.

Returns:

  • (String, nil) 


1098
1099
1100
 
# File 'rds/cfn_db_instance.rb', line 1098

def license_model()
  jsii_get_property("licenseModel")
end

#license_model=(value) ⇒ Object 



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

def license_model=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "licenseModel") unless value.nil?
  jsii_set_property("licenseModel", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


248
249
250
 
# File 'rds/cfn_db_instance.rb', line 248

def logical_id()
  jsii_get_property("logicalId")
end

#manage_master_user_password ⇒ Boolean, ...

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

Returns:



1110
1111
1112
 
# File 'rds/cfn_db_instance.rb', line 1110

def manage_master_user_password()
  jsii_get_property("manageMasterUserPassword")
end

#manage_master_user_password=(value) ⇒ Object 



1114
1115
1116
1117
 
# File 'rds/cfn_db_instance.rb', line 1114

def manage_master_user_password=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "manageMasterUserPassword") unless value.nil?
  jsii_set_property("manageMasterUserPassword", value)
end

#master_user_authentication_type ⇒ String?

Specifies the authentication type for the master user.

Returns:

  • (String, nil) 


1122
1123
1124
 
# File 'rds/cfn_db_instance.rb', line 1122

def master_user_authentication_type()
  jsii_get_property("masterUserAuthenticationType")
end

#master_user_authentication_type=(value) ⇒ Object 



1126
1127
1128
1129
 
# File 'rds/cfn_db_instance.rb', line 1126

def master_user_authentication_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "masterUserAuthenticationType") unless value.nil?
  jsii_set_property("masterUserAuthenticationType", value)
end

#master_user_password ⇒ String?

The password for the master user.

The password can include any printable ASCII character except "/", """, or "@".

Returns:

  • (String, nil) 


1148
1149
1150
 
# File 'rds/cfn_db_instance.rb', line 1148

def master_user_password()
  jsii_get_property("masterUserPassword")
end

#master_user_password=(value) ⇒ Object 



1152
1153
1154
1155
 
# File 'rds/cfn_db_instance.rb', line 1152

def master_user_password=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "masterUserPassword") unless value.nil?
  jsii_set_property("masterUserPassword", value)
end

#master_user_secret ⇒ AWSCDK::IResolvable, ...

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

Returns:



1160
1161
1162
 
# File 'rds/cfn_db_instance.rb', line 1160

def master_user_secret()
  jsii_get_property("masterUserSecret")
end

#master_user_secret=(value) ⇒ Object 



1164
1165
1166
1167
1168
 
# File 'rds/cfn_db_instance.rb', line 1164

def master_user_secret=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::RDS::CfnDBInstance::MasterUserSecretProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yZHMuQ2ZuREJJbnN0YW5jZS5NYXN0ZXJVc2VyU2VjcmV0UHJvcGVydHkifV19fQ==")), "masterUserSecret") unless value.nil?
  jsii_set_property("masterUserSecret", value)
end

#master_username ⇒ String?

The master user name for the DB instance.

Returns:

  • (String, nil) 


1134
1135
1136
 
# File 'rds/cfn_db_instance.rb', line 1134

def master_username()
  jsii_get_property("masterUsername")
end

#master_username=(value) ⇒ Object 



1138
1139
1140
1141
 
# File 'rds/cfn_db_instance.rb', line 1138

def master_username=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "masterUsername") unless value.nil?
  jsii_set_property("masterUsername", value)
end

#max_allocated_storage ⇒ Numeric?

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

Returns:

  • (Numeric, nil) 


1173
1174
1175
 
# File 'rds/cfn_db_instance.rb', line 1173

def max_allocated_storage()
  jsii_get_property("maxAllocatedStorage")
end

#max_allocated_storage=(value) ⇒ Object 



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

def max_allocated_storage=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxAllocatedStorage") unless value.nil?
  jsii_set_property("maxAllocatedStorage", value)
end

#monitoring_interval ⇒ Numeric?

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

Returns:

  • (Numeric, nil) 


1185
1186
1187
 
# File 'rds/cfn_db_instance.rb', line 1185

def monitoring_interval()
  jsii_get_property("monitoringInterval")
end

#monitoring_interval=(value) ⇒ Object 



1189
1190
1191
1192
 
# File 'rds/cfn_db_instance.rb', line 1189

def monitoring_interval=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "monitoringInterval") unless value.nil?
  jsii_set_property("monitoringInterval", value)
end

#monitoring_role_arn ⇒ String?

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

Returns:

  • (String, nil) 


1197
1198
1199
 
# File 'rds/cfn_db_instance.rb', line 1197

def monitoring_role_arn()
  jsii_get_property("monitoringRoleArn")
end

#monitoring_role_arn=(value) ⇒ Object 



1201
1202
1203
1204
 
# File 'rds/cfn_db_instance.rb', line 1201

def monitoring_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "monitoringRoleArn") unless value.nil?
  jsii_set_property("monitoringRoleArn", value)
end

#multi_az ⇒ Boolean, ...

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

Returns:



1209
1210
1211
 
# File 'rds/cfn_db_instance.rb', line 1209

def multi_az()
  jsii_get_property("multiAz")
end

#multi_az=(value) ⇒ Object 



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

def multi_az=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "multiAz") unless value.nil?
  jsii_set_property("multiAz", value)
end

#nchar_character_set_name ⇒ String?

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

Returns:

  • (String, nil) 


1221
1222
1223
 
# File 'rds/cfn_db_instance.rb', line 1221

def nchar_character_set_name()
  jsii_get_property("ncharCharacterSetName")
end

#nchar_character_set_name=(value) ⇒ Object 



1225
1226
1227
1228
 
# File 'rds/cfn_db_instance.rb', line 1225

def nchar_character_set_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ncharCharacterSetName") unless value.nil?
  jsii_set_property("ncharCharacterSetName", value)
end

#network_type ⇒ String?

The network type of the DB instance.

Returns:

  • (String, nil) 


1233
1234
1235
 
# File 'rds/cfn_db_instance.rb', line 1233

def network_type()
  jsii_get_property("networkType")
end

#network_type=(value) ⇒ Object 



1237
1238
1239
1240
 
# File 'rds/cfn_db_instance.rb', line 1237

def network_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "networkType") unless value.nil?
  jsii_set_property("networkType", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


231
232
233
 
# File 'rds/cfn_db_instance.rb', line 231

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



1782
1783
1784
 
# File 'rds/cfn_db_instance.rb', line 1782

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



1789
1790
1791
 
# File 'rds/cfn_db_instance.rb', line 1789

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#option_group_name ⇒ String?

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

Returns:

  • (String, nil) 


1245
1246
1247
 
# File 'rds/cfn_db_instance.rb', line 1245

def option_group_name()
  jsii_get_property("optionGroupName")
end

#option_group_name=(value) ⇒ Object 



1249
1250
1251
1252
 
# File 'rds/cfn_db_instance.rb', line 1249

def option_group_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "optionGroupName") unless value.nil?
  jsii_set_property("optionGroupName", value)
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



1582
1583
1584
1585
 
# File 'rds/cfn_db_instance.rb', line 1582

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#performance_insights_kms_key_id ⇒ String?

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

Returns:

  • (String, nil) 


1257
1258
1259
 
# File 'rds/cfn_db_instance.rb', line 1257

def performance_insights_kms_key_id()
  jsii_get_property("performanceInsightsKmsKeyId")
end

#performance_insights_kms_key_id=(value) ⇒ Object 



1261
1262
1263
1264
 
# File 'rds/cfn_db_instance.rb', line 1261

def performance_insights_kms_key_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "performanceInsightsKmsKeyId") unless value.nil?
  jsii_set_property("performanceInsightsKmsKeyId", value)
end

#performance_insights_retention_period ⇒ Numeric?

The number of days to retain Performance Insights data.

Returns:

  • (Numeric, nil) 


1269
1270
1271
 
# File 'rds/cfn_db_instance.rb', line 1269

def performance_insights_retention_period()
  jsii_get_property("performanceInsightsRetentionPeriod")
end

#performance_insights_retention_period=(value) ⇒ Object 



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

def performance_insights_retention_period=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "performanceInsightsRetentionPeriod") unless value.nil?
  jsii_set_property("performanceInsightsRetentionPeriod", value)
end

#port ⇒ String?

The port number on which the database accepts connections.

Returns:

  • (String, nil) 


1281
1282
1283
 
# File 'rds/cfn_db_instance.rb', line 1281

def port()
  jsii_get_property("port")
end

#port=(value) ⇒ Object 



1285
1286
1287
1288
 
# File 'rds/cfn_db_instance.rb', line 1285

def port=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "port") unless value.nil?
  jsii_set_property("port", value)
end

#preferred_backup_window ⇒ String?

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

Returns:

  • (String, nil) 


1293
1294
1295
 
# File 'rds/cfn_db_instance.rb', line 1293

def preferred_backup_window()
  jsii_get_property("preferredBackupWindow")
end

#preferred_backup_window=(value) ⇒ Object 



1297
1298
1299
1300
 
# File 'rds/cfn_db_instance.rb', line 1297

def preferred_backup_window=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "preferredBackupWindow") unless value.nil?
  jsii_set_property("preferredBackupWindow", value)
end

#preferred_maintenance_window ⇒ String?

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

Returns:

  • (String, nil) 


1305
1306
1307
 
# File 'rds/cfn_db_instance.rb', line 1305

def preferred_maintenance_window()
  jsii_get_property("preferredMaintenanceWindow")
end

#preferred_maintenance_window=(value) ⇒ Object 



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

def preferred_maintenance_window=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "preferredMaintenanceWindow") unless value.nil?
  jsii_set_property("preferredMaintenanceWindow", value)
end

#processor_features ⇒ AWSCDK::IResolvable, ...

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

Returns:



1317
1318
1319
 
# File 'rds/cfn_db_instance.rb', line 1317

def processor_features()
  jsii_get_property("processorFeatures")
end

#processor_features=(value) ⇒ Object 



1321
1322
1323
1324
 
# File 'rds/cfn_db_instance.rb', line 1321

def processor_features=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLkNmbkRCSW5zdGFuY2UuUHJvY2Vzc29yRmVhdHVyZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "processorFeatures") unless value.nil?
  jsii_set_property("processorFeatures", value)
end

#promotion_tier ⇒ Numeric?

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

Returns:

  • (Numeric, nil) 


1329
1330
1331
 
# File 'rds/cfn_db_instance.rb', line 1329

def promotion_tier()
  jsii_get_property("promotionTier")
end

#promotion_tier=(value) ⇒ Object 



1333
1334
1335
1336
 
# File 'rds/cfn_db_instance.rb', line 1333

def promotion_tier=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "promotionTier") unless value.nil?
  jsii_set_property("promotionTier", value)
end

#publicly_accessible ⇒ Boolean, ...

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

Returns:



1341
1342
1343
 
# File 'rds/cfn_db_instance.rb', line 1341

def publicly_accessible()
  jsii_get_property("publiclyAccessible")
end

#publicly_accessible=(value) ⇒ Object 



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

def publicly_accessible=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "publiclyAccessible") unless value.nil?
  jsii_set_property("publiclyAccessible", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


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

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



1800
1801
1802
1803
 
# File 'rds/cfn_db_instance.rb', line 1800

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


1807
1808
1809
1810
 
# File 'rds/cfn_db_instance.rb', line 1807

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



1817
1818
1819
1820
1821
 
# File 'rds/cfn_db_instance.rb', line 1817

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#replica_mode ⇒ String?

The open mode of an Oracle read replica.

Returns:

  • (String, nil) 


1353
1354
1355
 
# File 'rds/cfn_db_instance.rb', line 1353

def replica_mode()
  jsii_get_property("replicaMode")
end

#replica_mode=(value) ⇒ Object 



1357
1358
1359
1360
 
# File 'rds/cfn_db_instance.rb', line 1357

def replica_mode=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "replicaMode") unless value.nil?
  jsii_set_property("replicaMode", value)
end

#restore_time ⇒ String?

The date and time to restore from.

Returns:

  • (String, nil) 


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

def restore_time()
  jsii_get_property("restoreTime")
end

#restore_time=(value) ⇒ Object 



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

def restore_time=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "restoreTime") unless value.nil?
  jsii_set_property("restoreTime", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



1826
1827
1828
 
# File 'rds/cfn_db_instance.rb', line 1826

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#source_db_cluster_identifier ⇒ String?

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

Returns:

  • (String, nil) 


1377
1378
1379
 
# File 'rds/cfn_db_instance.rb', line 1377

def source_db_cluster_identifier()
  jsii_get_property("sourceDbClusterIdentifier")
end

#source_db_cluster_identifier=(value) ⇒ Object 



1381
1382
1383
1384
 
# File 'rds/cfn_db_instance.rb', line 1381

def source_db_cluster_identifier=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceDbClusterIdentifier") unless value.nil?
  jsii_set_property("sourceDbClusterIdentifier", value)
end

#source_db_instance_automated_backups_arn ⇒ String?

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 .

Returns:

  • (String, nil) 


1389
1390
1391
 
# File 'rds/cfn_db_instance.rb', line 1389

def source_db_instance_automated_backups_arn()
  jsii_get_property("sourceDbInstanceAutomatedBackupsArn")
end

#source_db_instance_automated_backups_arn=(value) ⇒ Object 



1393
1394
1395
1396
 
# File 'rds/cfn_db_instance.rb', line 1393

def source_db_instance_automated_backups_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceDbInstanceAutomatedBackupsArn") unless value.nil?
  jsii_set_property("sourceDbInstanceAutomatedBackupsArn", value)
end

#source_db_instance_identifier ⇒ String?

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

Returns:

  • (String, nil) 


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

def source_db_instance_identifier()
  jsii_get_property("sourceDbInstanceIdentifier")
end

#source_db_instance_identifier=(value) ⇒ Object 



1405
1406
1407
1408
 
# File 'rds/cfn_db_instance.rb', line 1405

def source_db_instance_identifier=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceDbInstanceIdentifier") unless value.nil?
  jsii_set_property("sourceDbInstanceIdentifier", value)
end

#source_dbi_resource_id ⇒ String?

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

Returns:

  • (String, nil) 


1413
1414
1415
 
# File 'rds/cfn_db_instance.rb', line 1413

def source_dbi_resource_id()
  jsii_get_property("sourceDbiResourceId")
end

#source_dbi_resource_id=(value) ⇒ Object 



1417
1418
1419
1420
 
# File 'rds/cfn_db_instance.rb', line 1417

def source_dbi_resource_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceDbiResourceId") unless value.nil?
  jsii_set_property("sourceDbiResourceId", value)
end

#source_region ⇒ String?

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

Returns:

  • (String, nil) 


1425
1426
1427
 
# File 'rds/cfn_db_instance.rb', line 1425

def source_region()
  jsii_get_property("sourceRegion")
end

#source_region=(value) ⇒ Object 



1429
1430
1431
1432
 
# File 'rds/cfn_db_instance.rb', line 1429

def source_region=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceRegion") unless value.nil?
  jsii_set_property("sourceRegion", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



257
258
259
 
# File 'rds/cfn_db_instance.rb', line 257

def stack()
  jsii_get_property("stack")
end

#storage_encrypted ⇒ Boolean, ...

A value that indicates whether the DB instance is encrypted.

By default, it isn't encrypted.

Returns:



1439
1440
1441
 
# File 'rds/cfn_db_instance.rb', line 1439

def storage_encrypted()
  jsii_get_property("storageEncrypted")
end

#storage_encrypted=(value) ⇒ Object 



1443
1444
1445
1446
 
# File 'rds/cfn_db_instance.rb', line 1443

def storage_encrypted=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "storageEncrypted") unless value.nil?
  jsii_set_property("storageEncrypted", value)
end

#storage_throughput ⇒ Numeric?

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

Returns:

  • (Numeric, nil) 


1451
1452
1453
 
# File 'rds/cfn_db_instance.rb', line 1451

def storage_throughput()
  jsii_get_property("storageThroughput")
end

#storage_throughput=(value) ⇒ Object 



1455
1456
1457
1458
 
# File 'rds/cfn_db_instance.rb', line 1455

def storage_throughput=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "storageThroughput") unless value.nil?
  jsii_set_property("storageThroughput", value)
end

#storage_type ⇒ String?

The storage type to associate with the DB instance.

Returns:

  • (String, nil) 


1463
1464
1465
 
# File 'rds/cfn_db_instance.rb', line 1463

def storage_type()
  jsii_get_property("storageType")
end

#storage_type=(value) ⇒ Object 



1467
1468
1469
1470
 
# File 'rds/cfn_db_instance.rb', line 1467

def storage_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "storageType") unless value.nil?
  jsii_set_property("storageType", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



551
552
553
 
# File 'rds/cfn_db_instance.rb', line 551

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Tags to assign to the DB instance.

Returns:



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

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



1479
1480
1481
1482
1483
 
# File 'rds/cfn_db_instance.rb', line 1479

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#tde_credential_arn ⇒ String?

Deprecated.

this property has been deprecated

Returns:

  • (String, nil) 


1487
1488
1489
 
# File 'rds/cfn_db_instance.rb', line 1487

def tde_credential_arn()
  jsii_get_property("tdeCredentialArn")
end

#tde_credential_arn=(value) ⇒ Object 



1491
1492
1493
1494
 
# File 'rds/cfn_db_instance.rb', line 1491

def tde_credential_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tdeCredentialArn") unless value.nil?
  jsii_set_property("tdeCredentialArn", value)
end

#tde_credential_password ⇒ String?

Deprecated.

this property has been deprecated

Returns:

  • (String, nil) 


1498
1499
1500
 
# File 'rds/cfn_db_instance.rb', line 1498

def tde_credential_password()
  jsii_get_property("tdeCredentialPassword")
end

#tde_credential_password=(value) ⇒ Object 



1502
1503
1504
1505
 
# File 'rds/cfn_db_instance.rb', line 1502

def tde_credential_password=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tdeCredentialPassword") unless value.nil?
  jsii_set_property("tdeCredentialPassword", value)
end

#timezone ⇒ String?

The time zone of the DB instance.

Returns:

  • (String, nil) 


1510
1511
1512
 
# File 'rds/cfn_db_instance.rb', line 1510

def timezone()
  jsii_get_property("timezone")
end

#timezone=(value) ⇒ Object 



1514
1515
1516
1517
 
# File 'rds/cfn_db_instance.rb', line 1514

def timezone=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timezone") unless value.nil?
  jsii_set_property("timezone", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



1558
1559
1560
 
# File 'rds/cfn_db_instance.rb', line 1558

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


304
305
306
 
# File 'rds/cfn_db_instance.rb', line 304

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


314
315
316
 
# File 'rds/cfn_db_instance.rb', line 314

def updated_properties()
  jsii_get_property("updatedProperties")
end

#use_default_processor_features ⇒ Boolean, ...

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

Returns:



1522
1523
1524
 
# File 'rds/cfn_db_instance.rb', line 1522

def use_default_processor_features()
  jsii_get_property("useDefaultProcessorFeatures")
end

#use_default_processor_features=(value) ⇒ Object 



1526
1527
1528
1529
 
# File 'rds/cfn_db_instance.rb', line 1526

def use_default_processor_features=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "useDefaultProcessorFeatures") unless value.nil?
  jsii_set_property("useDefaultProcessorFeatures", value)
end

#use_latest_restorable_time ⇒ Boolean, ...

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

Returns:



1534
1535
1536
 
# File 'rds/cfn_db_instance.rb', line 1534

def use_latest_restorable_time()
  jsii_get_property("useLatestRestorableTime")
end

#use_latest_restorable_time=(value) ⇒ Object 



1538
1539
1540
1541
 
# File 'rds/cfn_db_instance.rb', line 1538

def use_latest_restorable_time=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "useLatestRestorableTime") unless value.nil?
  jsii_set_property("useLatestRestorableTime", value)
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


1832
1833
1834
1835
 
# File 'rds/cfn_db_instance.rb', line 1832

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#vpc_security_groups ⇒ Array<String>?

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

Returns:

  • (Array<String>, nil) 


1546
1547
1548
 
# File 'rds/cfn_db_instance.rb', line 1546

def vpc_security_groups()
  jsii_get_property("vpcSecurityGroups")
end

#vpc_security_groups=(value) ⇒ Object 



1550
1551
1552
1553
 
# File 'rds/cfn_db_instance.rb', line 1550

def vpc_security_groups=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "vpcSecurityGroups") unless value.nil?
  jsii_set_property("vpcSecurityGroups", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


1571
1572
1573
1574
1575
1576
 
# File 'rds/cfn_db_instance.rb', line 1571

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end