aws-sdk-rds 1.213.0 → 1.215.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +1 -1
- data/lib/aws-sdk-rds/client_api.rb +2 -0
- data/lib/aws-sdk-rds/plugins/endpoints.rb +1 -0
- data/lib/aws-sdk-rds.rb +1 -1
- data/sig/account_quota.rbs +41 -0
- data/sig/certificate.rbs +59 -0
- data/sig/client.rbs +3515 -0
- data/sig/db_cluster.rbs +524 -0
- data/sig/db_cluster_parameter_group.rbs +106 -0
- data/sig/db_cluster_snapshot.rbs +213 -0
- data/sig/db_engine.rbs +79 -0
- data/sig/db_engine_version.rbs +163 -0
- data/sig/db_instance.rbs +681 -0
- data/sig/db_log_file.rbs +51 -0
- data/sig/db_parameter_group.rbs +158 -0
- data/sig/db_parameter_group_family.rbs +58 -0
- data/sig/db_security_group.rbs +118 -0
- data/sig/db_snapshot.rbs +271 -0
- data/sig/db_snapshot_attribute.rbs +48 -0
- data/sig/db_subnet_group.rbs +81 -0
- data/sig/errors.rbs +306 -0
- data/sig/event.rbs +50 -0
- data/sig/event_category_map.rbs +40 -0
- data/sig/event_subscription.rbs +107 -0
- data/sig/option_group.rbs +129 -0
- data/sig/option_group_option.rbs +82 -0
- data/sig/parameter.rbs +65 -0
- data/sig/pending_maintenance_action.rbs +68 -0
- data/sig/reserved_db_instance.rbs +86 -0
- data/sig/reserved_db_instances_offering.rbs +78 -0
- data/sig/resource.rbs +599 -0
- data/sig/resource_pending_maintenance_action_list.rbs +41 -0
- data/sig/types.rbs +4275 -0
- data/sig/waiters.rbs +217 -0
- metadata +34 -4
data/sig/db_instance.rbs
ADDED
@@ -0,0 +1,681 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module RDS
|
10
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html
|
11
|
+
class DBInstance
|
12
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#initialize-instance_method
|
13
|
+
def initialize: (String id, Hash[Symbol, untyped] options) -> void
|
14
|
+
| (id: String, ?client: Client) -> void
|
15
|
+
| (Hash[Symbol, untyped] args) -> void
|
16
|
+
|
17
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#id-instance_method
|
18
|
+
def id: () -> String
|
19
|
+
alias db_instance_identifier id
|
20
|
+
|
21
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#db_instance_class-instance_method
|
22
|
+
def db_instance_class: () -> ::String
|
23
|
+
|
24
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#engine-instance_method
|
25
|
+
def engine: () -> ::String
|
26
|
+
|
27
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#db_instance_status-instance_method
|
28
|
+
def db_instance_status: () -> ::String
|
29
|
+
|
30
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#automatic_restart_time-instance_method
|
31
|
+
def automatic_restart_time: () -> ::Time
|
32
|
+
|
33
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#master_username-instance_method
|
34
|
+
def master_username: () -> ::String
|
35
|
+
|
36
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#db_name-instance_method
|
37
|
+
def db_name: () -> ::String
|
38
|
+
|
39
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#endpoint-instance_method
|
40
|
+
def endpoint: () -> Types::Endpoint
|
41
|
+
|
42
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#allocated_storage-instance_method
|
43
|
+
def allocated_storage: () -> ::Integer
|
44
|
+
|
45
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#instance_create_time-instance_method
|
46
|
+
def instance_create_time: () -> ::Time
|
47
|
+
|
48
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#preferred_backup_window-instance_method
|
49
|
+
def preferred_backup_window: () -> ::String
|
50
|
+
|
51
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#backup_retention_period-instance_method
|
52
|
+
def backup_retention_period: () -> ::Integer
|
53
|
+
|
54
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#db_security_groups-instance_method
|
55
|
+
def db_security_groups: () -> ::Array[Types::DBSecurityGroupMembership]
|
56
|
+
|
57
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#vpc_security_groups-instance_method
|
58
|
+
def vpc_security_groups: () -> ::Array[Types::VpcSecurityGroupMembership]
|
59
|
+
|
60
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#db_parameter_groups-instance_method
|
61
|
+
def db_parameter_groups: () -> ::Array[Types::DBParameterGroupStatus]
|
62
|
+
|
63
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#availability_zone-instance_method
|
64
|
+
def availability_zone: () -> ::String
|
65
|
+
|
66
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#db_subnet_group-instance_method
|
67
|
+
def db_subnet_group: () -> Types::DBSubnetGroup
|
68
|
+
|
69
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#preferred_maintenance_window-instance_method
|
70
|
+
def preferred_maintenance_window: () -> ::String
|
71
|
+
|
72
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#pending_modified_values-instance_method
|
73
|
+
def pending_modified_values: () -> Types::PendingModifiedValues
|
74
|
+
|
75
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#latest_restorable_time-instance_method
|
76
|
+
def latest_restorable_time: () -> ::Time
|
77
|
+
|
78
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#multi_az-instance_method
|
79
|
+
def multi_az: () -> bool
|
80
|
+
|
81
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#engine_version-instance_method
|
82
|
+
def engine_version: () -> ::String
|
83
|
+
|
84
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#auto_minor_version_upgrade-instance_method
|
85
|
+
def auto_minor_version_upgrade: () -> bool
|
86
|
+
|
87
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#read_replica_source_db_instance_identifier-instance_method
|
88
|
+
def read_replica_source_db_instance_identifier: () -> ::String
|
89
|
+
|
90
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#read_replica_db_instance_identifiers-instance_method
|
91
|
+
def read_replica_db_instance_identifiers: () -> ::Array[::String]
|
92
|
+
|
93
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#read_replica_db_cluster_identifiers-instance_method
|
94
|
+
def read_replica_db_cluster_identifiers: () -> ::Array[::String]
|
95
|
+
|
96
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#replica_mode-instance_method
|
97
|
+
def replica_mode: () -> ("open-read-only" | "mounted")
|
98
|
+
|
99
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#license_model-instance_method
|
100
|
+
def license_model: () -> ::String
|
101
|
+
|
102
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#iops-instance_method
|
103
|
+
def iops: () -> ::Integer
|
104
|
+
|
105
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#option_group_memberships-instance_method
|
106
|
+
def option_group_memberships: () -> ::Array[Types::OptionGroupMembership]
|
107
|
+
|
108
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#character_set_name-instance_method
|
109
|
+
def character_set_name: () -> ::String
|
110
|
+
|
111
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#nchar_character_set_name-instance_method
|
112
|
+
def nchar_character_set_name: () -> ::String
|
113
|
+
|
114
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#secondary_availability_zone-instance_method
|
115
|
+
def secondary_availability_zone: () -> ::String
|
116
|
+
|
117
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#publicly_accessible-instance_method
|
118
|
+
def publicly_accessible: () -> bool
|
119
|
+
|
120
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#status_infos-instance_method
|
121
|
+
def status_infos: () -> ::Array[Types::DBInstanceStatusInfo]
|
122
|
+
|
123
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#storage_type-instance_method
|
124
|
+
def storage_type: () -> ::String
|
125
|
+
|
126
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#tde_credential_arn-instance_method
|
127
|
+
def tde_credential_arn: () -> ::String
|
128
|
+
|
129
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#db_instance_port-instance_method
|
130
|
+
def db_instance_port: () -> ::Integer
|
131
|
+
|
132
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#db_cluster_identifier-instance_method
|
133
|
+
def db_cluster_identifier: () -> ::String
|
134
|
+
|
135
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#storage_encrypted-instance_method
|
136
|
+
def storage_encrypted: () -> bool
|
137
|
+
|
138
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#kms_key_id-instance_method
|
139
|
+
def kms_key_id: () -> ::String
|
140
|
+
|
141
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#dbi_resource_id-instance_method
|
142
|
+
def dbi_resource_id: () -> ::String
|
143
|
+
|
144
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#ca_certificate_identifier-instance_method
|
145
|
+
def ca_certificate_identifier: () -> ::String
|
146
|
+
|
147
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#domain_memberships-instance_method
|
148
|
+
def domain_memberships: () -> ::Array[Types::DomainMembership]
|
149
|
+
|
150
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#copy_tags_to_snapshot-instance_method
|
151
|
+
def copy_tags_to_snapshot: () -> bool
|
152
|
+
|
153
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#monitoring_interval-instance_method
|
154
|
+
def monitoring_interval: () -> ::Integer
|
155
|
+
|
156
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#enhanced_monitoring_resource_arn-instance_method
|
157
|
+
def enhanced_monitoring_resource_arn: () -> ::String
|
158
|
+
|
159
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#monitoring_role_arn-instance_method
|
160
|
+
def monitoring_role_arn: () -> ::String
|
161
|
+
|
162
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#promotion_tier-instance_method
|
163
|
+
def promotion_tier: () -> ::Integer
|
164
|
+
|
165
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#db_instance_arn-instance_method
|
166
|
+
def db_instance_arn: () -> ::String
|
167
|
+
|
168
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#timezone-instance_method
|
169
|
+
def timezone: () -> ::String
|
170
|
+
|
171
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#iam_database_authentication_enabled-instance_method
|
172
|
+
def iam_database_authentication_enabled: () -> bool
|
173
|
+
|
174
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#performance_insights_enabled-instance_method
|
175
|
+
def performance_insights_enabled: () -> bool
|
176
|
+
|
177
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#performance_insights_kms_key_id-instance_method
|
178
|
+
def performance_insights_kms_key_id: () -> ::String
|
179
|
+
|
180
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#performance_insights_retention_period-instance_method
|
181
|
+
def performance_insights_retention_period: () -> ::Integer
|
182
|
+
|
183
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#enabled_cloudwatch_logs_exports-instance_method
|
184
|
+
def enabled_cloudwatch_logs_exports: () -> ::Array[::String]
|
185
|
+
|
186
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#processor_features-instance_method
|
187
|
+
def processor_features: () -> ::Array[Types::ProcessorFeature]
|
188
|
+
|
189
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#deletion_protection-instance_method
|
190
|
+
def deletion_protection: () -> bool
|
191
|
+
|
192
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#associated_roles-instance_method
|
193
|
+
def associated_roles: () -> ::Array[Types::DBInstanceRole]
|
194
|
+
|
195
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#listener_endpoint-instance_method
|
196
|
+
def listener_endpoint: () -> Types::Endpoint
|
197
|
+
|
198
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#max_allocated_storage-instance_method
|
199
|
+
def max_allocated_storage: () -> ::Integer
|
200
|
+
|
201
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#tag_list-instance_method
|
202
|
+
def tag_list: () -> ::Array[Types::Tag]
|
203
|
+
|
204
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#db_instance_automated_backups_replications-instance_method
|
205
|
+
def db_instance_automated_backups_replications: () -> ::Array[Types::DBInstanceAutomatedBackupsReplication]
|
206
|
+
|
207
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#customer_owned_ip_enabled-instance_method
|
208
|
+
def customer_owned_ip_enabled: () -> bool
|
209
|
+
|
210
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#aws_backup_recovery_point_arn-instance_method
|
211
|
+
def aws_backup_recovery_point_arn: () -> ::String
|
212
|
+
|
213
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#activity_stream_status-instance_method
|
214
|
+
def activity_stream_status: () -> ("stopped" | "starting" | "started" | "stopping")
|
215
|
+
|
216
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#activity_stream_kms_key_id-instance_method
|
217
|
+
def activity_stream_kms_key_id: () -> ::String
|
218
|
+
|
219
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#activity_stream_kinesis_stream_name-instance_method
|
220
|
+
def activity_stream_kinesis_stream_name: () -> ::String
|
221
|
+
|
222
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#activity_stream_mode-instance_method
|
223
|
+
def activity_stream_mode: () -> ("sync" | "async")
|
224
|
+
|
225
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#activity_stream_engine_native_audit_fields_included-instance_method
|
226
|
+
def activity_stream_engine_native_audit_fields_included: () -> bool
|
227
|
+
|
228
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#automation_mode-instance_method
|
229
|
+
def automation_mode: () -> ("full" | "all-paused")
|
230
|
+
|
231
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#resume_full_automation_mode_time-instance_method
|
232
|
+
def resume_full_automation_mode_time: () -> ::Time
|
233
|
+
|
234
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#custom_iam_instance_profile-instance_method
|
235
|
+
def custom_iam_instance_profile: () -> ::String
|
236
|
+
|
237
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#backup_target-instance_method
|
238
|
+
def backup_target: () -> ::String
|
239
|
+
|
240
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#network_type-instance_method
|
241
|
+
def network_type: () -> ::String
|
242
|
+
|
243
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#activity_stream_policy_status-instance_method
|
244
|
+
def activity_stream_policy_status: () -> ("locked" | "unlocked" | "locking-policy" | "unlocking-policy")
|
245
|
+
|
246
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#storage_throughput-instance_method
|
247
|
+
def storage_throughput: () -> ::Integer
|
248
|
+
|
249
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#db_system_id-instance_method
|
250
|
+
def db_system_id: () -> ::String
|
251
|
+
|
252
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#master_user_secret-instance_method
|
253
|
+
def master_user_secret: () -> Types::MasterUserSecret
|
254
|
+
|
255
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#certificate_details-instance_method
|
256
|
+
def certificate_details: () -> Types::CertificateDetails
|
257
|
+
|
258
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#read_replica_source_db_cluster_identifier-instance_method
|
259
|
+
def read_replica_source_db_cluster_identifier: () -> ::String
|
260
|
+
|
261
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#percent_progress-instance_method
|
262
|
+
def percent_progress: () -> ::String
|
263
|
+
|
264
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#dedicated_log_volume-instance_method
|
265
|
+
def dedicated_log_volume: () -> bool
|
266
|
+
|
267
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#is_storage_config_upgrade_available-instance_method
|
268
|
+
def is_storage_config_upgrade_available: () -> bool
|
269
|
+
|
270
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#multi_tenant-instance_method
|
271
|
+
def multi_tenant: () -> bool
|
272
|
+
|
273
|
+
def client: () -> Client
|
274
|
+
|
275
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#load-instance_method
|
276
|
+
def load: () -> self
|
277
|
+
alias reload load
|
278
|
+
|
279
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#data-instance_method
|
280
|
+
def data: () -> Types::DBInstance
|
281
|
+
|
282
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#data_loaded?-instance_method
|
283
|
+
def data_loaded?: () -> bool
|
284
|
+
|
285
|
+
|
286
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#create-instance_method
|
287
|
+
def create: (
|
288
|
+
?db_name: ::String,
|
289
|
+
?allocated_storage: ::Integer,
|
290
|
+
db_instance_class: ::String,
|
291
|
+
engine: ::String,
|
292
|
+
?master_username: ::String,
|
293
|
+
?master_user_password: ::String,
|
294
|
+
?db_security_groups: Array[::String],
|
295
|
+
?vpc_security_group_ids: Array[::String],
|
296
|
+
?availability_zone: ::String,
|
297
|
+
?db_subnet_group_name: ::String,
|
298
|
+
?preferred_maintenance_window: ::String,
|
299
|
+
?db_parameter_group_name: ::String,
|
300
|
+
?backup_retention_period: ::Integer,
|
301
|
+
?preferred_backup_window: ::String,
|
302
|
+
?port: ::Integer,
|
303
|
+
?multi_az: bool,
|
304
|
+
?engine_version: ::String,
|
305
|
+
?auto_minor_version_upgrade: bool,
|
306
|
+
?license_model: ::String,
|
307
|
+
?iops: ::Integer,
|
308
|
+
?option_group_name: ::String,
|
309
|
+
?character_set_name: ::String,
|
310
|
+
?nchar_character_set_name: ::String,
|
311
|
+
?publicly_accessible: bool,
|
312
|
+
?tags: Array[
|
313
|
+
{
|
314
|
+
key: ::String?,
|
315
|
+
value: ::String?
|
316
|
+
},
|
317
|
+
],
|
318
|
+
?db_cluster_identifier: ::String,
|
319
|
+
?storage_type: ::String,
|
320
|
+
?tde_credential_arn: ::String,
|
321
|
+
?tde_credential_password: ::String,
|
322
|
+
?storage_encrypted: bool,
|
323
|
+
?kms_key_id: ::String,
|
324
|
+
?domain: ::String,
|
325
|
+
?domain_fqdn: ::String,
|
326
|
+
?domain_ou: ::String,
|
327
|
+
?domain_auth_secret_arn: ::String,
|
328
|
+
?domain_dns_ips: Array[::String],
|
329
|
+
?copy_tags_to_snapshot: bool,
|
330
|
+
?monitoring_interval: ::Integer,
|
331
|
+
?monitoring_role_arn: ::String,
|
332
|
+
?domain_iam_role_name: ::String,
|
333
|
+
?promotion_tier: ::Integer,
|
334
|
+
?timezone: ::String,
|
335
|
+
?enable_iam_database_authentication: bool,
|
336
|
+
?enable_performance_insights: bool,
|
337
|
+
?performance_insights_kms_key_id: ::String,
|
338
|
+
?performance_insights_retention_period: ::Integer,
|
339
|
+
?enable_cloudwatch_logs_exports: Array[::String],
|
340
|
+
?processor_features: Array[
|
341
|
+
{
|
342
|
+
name: ::String?,
|
343
|
+
value: ::String?
|
344
|
+
},
|
345
|
+
],
|
346
|
+
?deletion_protection: bool,
|
347
|
+
?max_allocated_storage: ::Integer,
|
348
|
+
?enable_customer_owned_ip: bool,
|
349
|
+
?custom_iam_instance_profile: ::String,
|
350
|
+
?backup_target: ::String,
|
351
|
+
?network_type: ::String,
|
352
|
+
?storage_throughput: ::Integer,
|
353
|
+
?manage_master_user_password: bool,
|
354
|
+
?master_user_secret_kms_key_id: ::String,
|
355
|
+
?ca_certificate_identifier: ::String,
|
356
|
+
?db_system_id: ::String,
|
357
|
+
?dedicated_log_volume: bool,
|
358
|
+
?multi_tenant: bool
|
359
|
+
) -> DBInstance
|
360
|
+
| (?Hash[Symbol, untyped]) -> DBInstance
|
361
|
+
|
362
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#create_read_replica-instance_method
|
363
|
+
def create_read_replica: (
|
364
|
+
db_instance_identifier: ::String,
|
365
|
+
?db_instance_class: ::String,
|
366
|
+
?availability_zone: ::String,
|
367
|
+
?port: ::Integer,
|
368
|
+
?multi_az: bool,
|
369
|
+
?auto_minor_version_upgrade: bool,
|
370
|
+
?iops: ::Integer,
|
371
|
+
?option_group_name: ::String,
|
372
|
+
?db_parameter_group_name: ::String,
|
373
|
+
?publicly_accessible: bool,
|
374
|
+
?tags: Array[
|
375
|
+
{
|
376
|
+
key: ::String?,
|
377
|
+
value: ::String?
|
378
|
+
},
|
379
|
+
],
|
380
|
+
?db_subnet_group_name: ::String,
|
381
|
+
?vpc_security_group_ids: Array[::String],
|
382
|
+
?storage_type: ::String,
|
383
|
+
?copy_tags_to_snapshot: bool,
|
384
|
+
?monitoring_interval: ::Integer,
|
385
|
+
?monitoring_role_arn: ::String,
|
386
|
+
?kms_key_id: ::String,
|
387
|
+
?pre_signed_url: ::String,
|
388
|
+
?enable_iam_database_authentication: bool,
|
389
|
+
?enable_performance_insights: bool,
|
390
|
+
?performance_insights_kms_key_id: ::String,
|
391
|
+
?performance_insights_retention_period: ::Integer,
|
392
|
+
?enable_cloudwatch_logs_exports: Array[::String],
|
393
|
+
?processor_features: Array[
|
394
|
+
{
|
395
|
+
name: ::String?,
|
396
|
+
value: ::String?
|
397
|
+
},
|
398
|
+
],
|
399
|
+
?use_default_processor_features: bool,
|
400
|
+
?deletion_protection: bool,
|
401
|
+
?domain: ::String,
|
402
|
+
?domain_iam_role_name: ::String,
|
403
|
+
?domain_fqdn: ::String,
|
404
|
+
?domain_ou: ::String,
|
405
|
+
?domain_auth_secret_arn: ::String,
|
406
|
+
?domain_dns_ips: Array[::String],
|
407
|
+
?replica_mode: ("open-read-only" | "mounted"),
|
408
|
+
?max_allocated_storage: ::Integer,
|
409
|
+
?custom_iam_instance_profile: ::String,
|
410
|
+
?network_type: ::String,
|
411
|
+
?storage_throughput: ::Integer,
|
412
|
+
?enable_customer_owned_ip: bool,
|
413
|
+
?allocated_storage: ::Integer,
|
414
|
+
?source_db_cluster_identifier: ::String,
|
415
|
+
?dedicated_log_volume: bool,
|
416
|
+
?upgrade_storage_config: bool,
|
417
|
+
?source_region: ::String
|
418
|
+
) -> DBInstance
|
419
|
+
| (?Hash[Symbol, untyped]) -> DBInstance
|
420
|
+
|
421
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#create_snapshot-instance_method
|
422
|
+
def create_snapshot: (
|
423
|
+
db_snapshot_identifier: ::String,
|
424
|
+
?tags: Array[
|
425
|
+
{
|
426
|
+
key: ::String?,
|
427
|
+
value: ::String?
|
428
|
+
},
|
429
|
+
]
|
430
|
+
) -> DBSnapshot
|
431
|
+
| (?Hash[Symbol, untyped]) -> DBSnapshot
|
432
|
+
|
433
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#delete-instance_method
|
434
|
+
def delete: (
|
435
|
+
?skip_final_snapshot: bool,
|
436
|
+
?final_db_snapshot_identifier: ::String,
|
437
|
+
?delete_automated_backups: bool
|
438
|
+
) -> DBInstance
|
439
|
+
| (?Hash[Symbol, untyped]) -> DBInstance
|
440
|
+
|
441
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#modify-instance_method
|
442
|
+
def modify: (
|
443
|
+
?allocated_storage: ::Integer,
|
444
|
+
?db_instance_class: ::String,
|
445
|
+
?db_subnet_group_name: ::String,
|
446
|
+
?db_security_groups: Array[::String],
|
447
|
+
?vpc_security_group_ids: Array[::String],
|
448
|
+
?apply_immediately: bool,
|
449
|
+
?master_user_password: ::String,
|
450
|
+
?db_parameter_group_name: ::String,
|
451
|
+
?backup_retention_period: ::Integer,
|
452
|
+
?preferred_backup_window: ::String,
|
453
|
+
?preferred_maintenance_window: ::String,
|
454
|
+
?multi_az: bool,
|
455
|
+
?engine_version: ::String,
|
456
|
+
?allow_major_version_upgrade: bool,
|
457
|
+
?auto_minor_version_upgrade: bool,
|
458
|
+
?license_model: ::String,
|
459
|
+
?iops: ::Integer,
|
460
|
+
?option_group_name: ::String,
|
461
|
+
?new_db_instance_identifier: ::String,
|
462
|
+
?storage_type: ::String,
|
463
|
+
?tde_credential_arn: ::String,
|
464
|
+
?tde_credential_password: ::String,
|
465
|
+
?ca_certificate_identifier: ::String,
|
466
|
+
?domain: ::String,
|
467
|
+
?domain_fqdn: ::String,
|
468
|
+
?domain_ou: ::String,
|
469
|
+
?domain_auth_secret_arn: ::String,
|
470
|
+
?domain_dns_ips: Array[::String],
|
471
|
+
?copy_tags_to_snapshot: bool,
|
472
|
+
?monitoring_interval: ::Integer,
|
473
|
+
?db_port_number: ::Integer,
|
474
|
+
?publicly_accessible: bool,
|
475
|
+
?monitoring_role_arn: ::String,
|
476
|
+
?domain_iam_role_name: ::String,
|
477
|
+
?disable_domain: bool,
|
478
|
+
?promotion_tier: ::Integer,
|
479
|
+
?enable_iam_database_authentication: bool,
|
480
|
+
?enable_performance_insights: bool,
|
481
|
+
?performance_insights_kms_key_id: ::String,
|
482
|
+
?performance_insights_retention_period: ::Integer,
|
483
|
+
?cloudwatch_logs_export_configuration: {
|
484
|
+
enable_log_types: Array[::String]?,
|
485
|
+
disable_log_types: Array[::String]?
|
486
|
+
},
|
487
|
+
?processor_features: Array[
|
488
|
+
{
|
489
|
+
name: ::String?,
|
490
|
+
value: ::String?
|
491
|
+
},
|
492
|
+
],
|
493
|
+
?use_default_processor_features: bool,
|
494
|
+
?deletion_protection: bool,
|
495
|
+
?max_allocated_storage: ::Integer,
|
496
|
+
?certificate_rotation_restart: bool,
|
497
|
+
?replica_mode: ("open-read-only" | "mounted"),
|
498
|
+
?enable_customer_owned_ip: bool,
|
499
|
+
?aws_backup_recovery_point_arn: ::String,
|
500
|
+
?automation_mode: ("full" | "all-paused"),
|
501
|
+
?resume_full_automation_mode_minutes: ::Integer,
|
502
|
+
?network_type: ::String,
|
503
|
+
?storage_throughput: ::Integer,
|
504
|
+
?manage_master_user_password: bool,
|
505
|
+
?rotate_master_user_password: bool,
|
506
|
+
?master_user_secret_kms_key_id: ::String,
|
507
|
+
?engine: ::String,
|
508
|
+
?dedicated_log_volume: bool,
|
509
|
+
?multi_tenant: bool
|
510
|
+
) -> DBInstance
|
511
|
+
| (?Hash[Symbol, untyped]) -> DBInstance
|
512
|
+
|
513
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#promote-instance_method
|
514
|
+
def promote: (
|
515
|
+
?backup_retention_period: ::Integer,
|
516
|
+
?preferred_backup_window: ::String
|
517
|
+
) -> DBInstance
|
518
|
+
| (?Hash[Symbol, untyped]) -> DBInstance
|
519
|
+
|
520
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#reboot-instance_method
|
521
|
+
def reboot: (
|
522
|
+
?force_failover: bool
|
523
|
+
) -> DBInstance
|
524
|
+
| (?Hash[Symbol, untyped]) -> DBInstance
|
525
|
+
|
526
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#restore-instance_method
|
527
|
+
def restore: (
|
528
|
+
target_db_instance_identifier: ::String,
|
529
|
+
?restore_time: ::Time,
|
530
|
+
?use_latest_restorable_time: bool,
|
531
|
+
?db_instance_class: ::String,
|
532
|
+
?port: ::Integer,
|
533
|
+
?availability_zone: ::String,
|
534
|
+
?db_subnet_group_name: ::String,
|
535
|
+
?multi_az: bool,
|
536
|
+
?publicly_accessible: bool,
|
537
|
+
?auto_minor_version_upgrade: bool,
|
538
|
+
?license_model: ::String,
|
539
|
+
?db_name: ::String,
|
540
|
+
?engine: ::String,
|
541
|
+
?iops: ::Integer,
|
542
|
+
?option_group_name: ::String,
|
543
|
+
?copy_tags_to_snapshot: bool,
|
544
|
+
?tags: Array[
|
545
|
+
{
|
546
|
+
key: ::String?,
|
547
|
+
value: ::String?
|
548
|
+
},
|
549
|
+
],
|
550
|
+
?storage_type: ::String,
|
551
|
+
?tde_credential_arn: ::String,
|
552
|
+
?tde_credential_password: ::String,
|
553
|
+
?vpc_security_group_ids: Array[::String],
|
554
|
+
?domain: ::String,
|
555
|
+
?domain_iam_role_name: ::String,
|
556
|
+
?domain_fqdn: ::String,
|
557
|
+
?domain_ou: ::String,
|
558
|
+
?domain_auth_secret_arn: ::String,
|
559
|
+
?domain_dns_ips: Array[::String],
|
560
|
+
?enable_iam_database_authentication: bool,
|
561
|
+
?enable_cloudwatch_logs_exports: Array[::String],
|
562
|
+
?processor_features: Array[
|
563
|
+
{
|
564
|
+
name: ::String?,
|
565
|
+
value: ::String?
|
566
|
+
},
|
567
|
+
],
|
568
|
+
?use_default_processor_features: bool,
|
569
|
+
?db_parameter_group_name: ::String,
|
570
|
+
?deletion_protection: bool,
|
571
|
+
?source_dbi_resource_id: ::String,
|
572
|
+
?max_allocated_storage: ::Integer,
|
573
|
+
?source_db_instance_automated_backups_arn: ::String,
|
574
|
+
?enable_customer_owned_ip: bool,
|
575
|
+
?custom_iam_instance_profile: ::String,
|
576
|
+
?backup_target: ::String,
|
577
|
+
?network_type: ::String,
|
578
|
+
?storage_throughput: ::Integer,
|
579
|
+
?allocated_storage: ::Integer,
|
580
|
+
?dedicated_log_volume: bool
|
581
|
+
) -> DBInstance
|
582
|
+
| (?Hash[Symbol, untyped]) -> DBInstance
|
583
|
+
|
584
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#subscribe_to-instance_method
|
585
|
+
def subscribe_to: (
|
586
|
+
subscription_name: ::String
|
587
|
+
) -> EventSubscription
|
588
|
+
| (?Hash[Symbol, untyped]) -> EventSubscription
|
589
|
+
|
590
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#unsubscribe_from-instance_method
|
591
|
+
def unsubscribe_from: (
|
592
|
+
subscription_name: ::String
|
593
|
+
) -> EventSubscription
|
594
|
+
| (?Hash[Symbol, untyped]) -> EventSubscription
|
595
|
+
|
596
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#certificate-instance_method
|
597
|
+
def certificate: () -> Certificate?
|
598
|
+
|
599
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#cluster-instance_method
|
600
|
+
def cluster: () -> DBCluster?
|
601
|
+
|
602
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#events-instance_method
|
603
|
+
def events: (
|
604
|
+
?start_time: ::Time,
|
605
|
+
?end_time: ::Time,
|
606
|
+
?duration: ::Integer,
|
607
|
+
?event_categories: Array[::String],
|
608
|
+
?filters: Array[
|
609
|
+
{
|
610
|
+
name: ::String,
|
611
|
+
values: Array[::String]
|
612
|
+
},
|
613
|
+
]
|
614
|
+
) -> Event::Collection
|
615
|
+
| (?Hash[Symbol, untyped]) -> Event::Collection
|
616
|
+
|
617
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#log_files-instance_method
|
618
|
+
def log_files: (
|
619
|
+
?filename_contains: ::String,
|
620
|
+
?file_last_written: ::Integer,
|
621
|
+
?file_size: ::Integer,
|
622
|
+
?filters: Array[
|
623
|
+
{
|
624
|
+
name: ::String,
|
625
|
+
values: Array[::String]
|
626
|
+
},
|
627
|
+
]
|
628
|
+
) -> DBLogFile::Collection
|
629
|
+
| (?Hash[Symbol, untyped]) -> DBLogFile::Collection
|
630
|
+
|
631
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#option_groups-instance_method
|
632
|
+
def option_groups: () -> OptionGroup::Collection
|
633
|
+
|
634
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#parameter_groups-instance_method
|
635
|
+
def parameter_groups: () -> DBParameterGroup::Collection
|
636
|
+
|
637
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#pending_maintenance_actions-instance_method
|
638
|
+
def pending_maintenance_actions: (
|
639
|
+
?resource_identifier: ::String,
|
640
|
+
?filters: Array[
|
641
|
+
{
|
642
|
+
name: ::String,
|
643
|
+
values: Array[::String]
|
644
|
+
},
|
645
|
+
]
|
646
|
+
) -> PendingMaintenanceAction::Collection
|
647
|
+
| (?Hash[Symbol, untyped]) -> PendingMaintenanceAction::Collection
|
648
|
+
|
649
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#read_replicas-instance_method
|
650
|
+
def read_replicas: () -> DBInstance::Collection
|
651
|
+
|
652
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#security_groups-instance_method
|
653
|
+
def security_groups: () -> DBSecurityGroup::Collection
|
654
|
+
|
655
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#snapshots-instance_method
|
656
|
+
def snapshots: (
|
657
|
+
?db_snapshot_identifier: ::String,
|
658
|
+
?snapshot_type: ::String,
|
659
|
+
?filters: Array[
|
660
|
+
{
|
661
|
+
name: ::String,
|
662
|
+
values: Array[::String]
|
663
|
+
},
|
664
|
+
],
|
665
|
+
?include_shared: bool,
|
666
|
+
?include_public: bool,
|
667
|
+
?dbi_resource_id: ::String
|
668
|
+
) -> DBSnapshot::Collection
|
669
|
+
| (?Hash[Symbol, untyped]) -> DBSnapshot::Collection
|
670
|
+
|
671
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#source-instance_method
|
672
|
+
def source: () -> DBInstance?
|
673
|
+
|
674
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBInstance.html#subnet_group-instance_method
|
675
|
+
def subnet_group: () -> DBSubnetGroup?
|
676
|
+
|
677
|
+
class Collection < ::Aws::Resources::Collection[DBInstance]
|
678
|
+
end
|
679
|
+
end
|
680
|
+
end
|
681
|
+
end
|