aws-sdk 1.8.5 → 1.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.yardopts +1 -0
- data/README.rdoc +8 -0
- data/lib/aws-sdk.rb +39 -35
- data/lib/aws/api_config/CloudFront-2012-07-01.yml +2398 -0
- data/lib/aws/api_config/DirectConnect-2012-10-25.yml +475 -0
- data/lib/aws/api_config/DynamoDB-2011-12-05.yml +8 -0
- data/lib/aws/api_config/DynamoDB-2012-08-10.yml +1516 -0
- data/lib/aws/api_config/OpsWorks-2013-02-18.yml +2 -2
- data/lib/aws/auto_scaling.rb +44 -44
- data/lib/aws/auto_scaling/activity.rb +1 -1
- data/lib/aws/auto_scaling/activity_collection.rb +14 -15
- data/lib/aws/auto_scaling/client.rb +277 -277
- data/lib/aws/auto_scaling/config.rb +1 -1
- data/lib/aws/auto_scaling/group.rb +35 -36
- data/lib/aws/auto_scaling/group_collection.rb +10 -10
- data/lib/aws/auto_scaling/group_options.rb +19 -19
- data/lib/aws/auto_scaling/instance.rb +27 -27
- data/lib/aws/auto_scaling/instance_collection.rb +10 -10
- data/lib/aws/auto_scaling/launch_configuration.rb +3 -3
- data/lib/aws/auto_scaling/launch_configuration_collection.rb +1 -1
- data/lib/aws/auto_scaling/notification_configuration.rb +2 -2
- data/lib/aws/auto_scaling/notification_configuration_collection.rb +37 -38
- data/lib/aws/auto_scaling/scaling_policy.rb +3 -3
- data/lib/aws/auto_scaling/scaling_policy_collection.rb +6 -6
- data/lib/aws/auto_scaling/scaling_policy_options.rb +8 -7
- data/lib/aws/auto_scaling/scheduled_action.rb +3 -3
- data/lib/aws/auto_scaling/scheduled_action_collection.rb +28 -28
- data/lib/aws/auto_scaling/tag_collection.rb +30 -28
- data/lib/aws/cloud_formation.rb +95 -94
- data/lib/aws/cloud_formation/client.rb +136 -133
- data/lib/aws/cloud_formation/config.rb +1 -1
- data/lib/aws/cloud_formation/stack.rb +37 -37
- data/lib/aws/cloud_formation/stack_collection.rb +28 -27
- data/lib/aws/cloud_formation/stack_event.rb +9 -11
- data/lib/aws/cloud_formation/stack_output.rb +1 -1
- data/lib/aws/cloud_formation/stack_resource.rb +6 -6
- data/lib/aws/cloud_formation/stack_resource_collection.rb +11 -12
- data/lib/aws/cloud_formation/stack_resource_summary_collection.rb +11 -11
- data/lib/aws/cloud_formation/stack_summary_collection.rb +39 -39
- data/lib/aws/cloud_front.rb +21 -21
- data/lib/aws/cloud_front/client.rb +853 -652
- data/lib/aws/cloud_front/request.rb +3 -0
- data/lib/aws/cloud_search.rb +22 -22
- data/lib/aws/cloud_search/client.rb +322 -315
- data/lib/aws/cloud_search/config.rb +1 -1
- data/lib/aws/cloud_watch.rb +39 -39
- data/lib/aws/cloud_watch/alarm.rb +55 -37
- data/lib/aws/cloud_watch/alarm_collection.rb +18 -18
- data/lib/aws/cloud_watch/alarm_history_item_collection.rb +2 -2
- data/lib/aws/cloud_watch/client.rb +360 -146
- data/lib/aws/cloud_watch/config.rb +1 -1
- data/lib/aws/cloud_watch/metric.rb +15 -15
- data/lib/aws/cloud_watch/metric_alarm_collection.rb +17 -17
- data/lib/aws/cloud_watch/metric_collection.rb +16 -16
- data/lib/aws/cloud_watch/metric_statistics.rb +11 -11
- data/lib/aws/core.rb +243 -225
- data/lib/aws/core/async_handle.rb +13 -13
- data/lib/aws/core/cacheable.rb +14 -15
- data/lib/aws/core/client.rb +40 -15
- data/lib/aws/core/collection.rb +42 -46
- data/lib/aws/core/collection/with_limit_and_next_token.rb +1 -1
- data/lib/aws/core/collection/with_next_token.rb +1 -1
- data/lib/aws/core/configuration.rb +97 -133
- data/lib/aws/core/credential_providers.rb +16 -16
- data/lib/aws/core/data.rb +23 -23
- data/lib/aws/core/http/connection_pool.rb +348 -0
- data/lib/aws/core/http/net_http_handler.rb +17 -26
- data/lib/aws/core/http/patch.rb +102 -0
- data/lib/aws/core/http/request.rb +13 -19
- data/lib/aws/core/http/response.rb +2 -2
- data/lib/aws/core/lazy_error_classes.rb +17 -17
- data/lib/aws/core/log_formatter.rb +70 -104
- data/lib/aws/core/options/json_serializer.rb +1 -1
- data/lib/aws/core/options/validator.rb +4 -4
- data/lib/aws/core/page_result.rb +8 -8
- data/lib/aws/core/policy.rb +49 -49
- data/lib/aws/core/region.rb +72 -0
- data/lib/aws/core/region_collection.rb +106 -0
- data/lib/aws/core/resource.rb +5 -5
- data/lib/aws/core/response.rb +20 -17
- data/lib/aws/core/rest_request_builder.rb +4 -4
- data/lib/aws/core/service_interface.rb +24 -2
- data/lib/aws/core/signature/version_3.rb +2 -2
- data/lib/aws/core/uri_escape.rb +1 -1
- data/lib/aws/core/xml/frame_stack.rb +1 -1
- data/lib/aws/core/xml/grammar.rb +3 -4
- data/lib/aws/core/xml/sax_handlers/libxml.rb +2 -2
- data/lib/aws/core/xml/sax_handlers/nokogiri.rb +3 -3
- data/lib/aws/core/xml/sax_handlers/rexml.rb +5 -5
- data/lib/aws/core/xml/stub.rb +9 -9
- data/lib/aws/data_pipeline.rb +21 -21
- data/lib/aws/data_pipeline/client.rb +189 -133
- data/lib/aws/data_pipeline/config.rb +1 -1
- data/lib/aws/direct_connect.rb +74 -0
- data/lib/aws/direct_connect/client.rb +253 -0
- data/lib/aws/direct_connect/config.rb +18 -0
- data/lib/aws/direct_connect/errors.rb +22 -0
- data/lib/aws/direct_connect/request.rb +27 -0
- data/lib/aws/dynamo_db.rb +71 -69
- data/lib/aws/dynamo_db/attribute_collection.rb +53 -58
- data/lib/aws/dynamo_db/batch_get.rb +23 -23
- data/lib/aws/dynamo_db/batch_write.rb +43 -43
- data/lib/aws/dynamo_db/binary.rb +9 -9
- data/lib/aws/dynamo_db/client.rb +494 -509
- data/lib/aws/dynamo_db/client_base.rb +91 -0
- data/lib/aws/dynamo_db/client_v2.rb +825 -0
- data/lib/aws/dynamo_db/config.rb +1 -1
- data/lib/aws/dynamo_db/item.rb +10 -10
- data/lib/aws/dynamo_db/item_collection.rb +75 -75
- data/lib/aws/dynamo_db/table.rb +85 -85
- data/lib/aws/dynamo_db/table_collection.rb +13 -13
- data/lib/aws/ec2.rb +132 -142
- data/lib/aws/ec2/attachment.rb +31 -36
- data/lib/aws/ec2/attachment_collection.rb +1 -1
- data/lib/aws/ec2/availability_zone.rb +4 -4
- data/lib/aws/ec2/client.rb +2272 -2125
- data/lib/aws/ec2/config.rb +1 -1
- data/lib/aws/ec2/customer_gateway.rb +6 -6
- data/lib/aws/ec2/customer_gateway_collection.rb +6 -6
- data/lib/aws/ec2/dhcp_options.rb +3 -3
- data/lib/aws/ec2/dhcp_options_collection.rb +10 -10
- data/lib/aws/ec2/elastic_ip.rb +15 -15
- data/lib/aws/ec2/elastic_ip_collection.rb +11 -15
- data/lib/aws/ec2/export_task.rb +4 -4
- data/lib/aws/ec2/export_task_collection.rb +11 -11
- data/lib/aws/ec2/filtered_collection.rb +6 -8
- data/lib/aws/ec2/image.rb +46 -40
- data/lib/aws/ec2/image_collection.rb +44 -52
- data/lib/aws/ec2/instance.rb +64 -62
- data/lib/aws/ec2/instance_collection.rb +47 -50
- data/lib/aws/ec2/internet_gateway.rb +6 -6
- data/lib/aws/ec2/internet_gateway/attachment.rb +13 -13
- data/lib/aws/ec2/internet_gateway_collection.rb +3 -3
- data/lib/aws/ec2/key_pair.rb +3 -3
- data/lib/aws/ec2/key_pair_collection.rb +12 -12
- data/lib/aws/ec2/network_acl.rb +39 -39
- data/lib/aws/ec2/network_acl/association.rb +2 -2
- data/lib/aws/ec2/network_acl/entry.rb +22 -22
- data/lib/aws/ec2/network_acl_collection.rb +2 -2
- data/lib/aws/ec2/network_interface.rb +13 -4
- data/lib/aws/ec2/network_interface/attachment.rb +3 -3
- data/lib/aws/ec2/network_interface_collection.rb +5 -5
- data/lib/aws/ec2/permission_collection.rb +1 -1
- data/lib/aws/ec2/region.rb +6 -6
- data/lib/aws/ec2/region_collection.rb +1 -1
- data/lib/aws/ec2/reserved_instances_collection.rb +2 -2
- data/lib/aws/ec2/reserved_instances_offering_collection.rb +2 -2
- data/lib/aws/ec2/resource_tag_collection.rb +5 -5
- data/lib/aws/ec2/route_table.rb +14 -14
- data/lib/aws/ec2/route_table/association.rb +22 -22
- data/lib/aws/ec2/route_table/route.rb +8 -8
- data/lib/aws/ec2/route_table_collection.rb +3 -3
- data/lib/aws/ec2/security_group.rb +39 -41
- data/lib/aws/ec2/security_group_collection.rb +19 -21
- data/lib/aws/ec2/snapshot.rb +3 -3
- data/lib/aws/ec2/snapshot_collection.rb +11 -12
- data/lib/aws/ec2/subnet.rb +2 -2
- data/lib/aws/ec2/subnet_collection.rb +17 -17
- data/lib/aws/ec2/tag_collection.rb +1 -1
- data/lib/aws/ec2/tagged_collection.rb +7 -7
- data/lib/aws/ec2/tagged_item.rb +10 -10
- data/lib/aws/ec2/volume.rb +16 -16
- data/lib/aws/ec2/volume_collection.rb +9 -12
- data/lib/aws/ec2/vpc.rb +6 -6
- data/lib/aws/ec2/vpc_collection.rb +10 -10
- data/lib/aws/ec2/vpn_connection.rb +4 -4
- data/lib/aws/ec2/vpn_connection/telemetry.rb +1 -1
- data/lib/aws/ec2/vpn_connection_collection.rb +6 -6
- data/lib/aws/ec2/vpn_gateway.rb +2 -2
- data/lib/aws/ec2/vpn_gateway_collection.rb +5 -5
- data/lib/aws/elastic_beanstalk.rb +12 -12
- data/lib/aws/elastic_beanstalk/client.rb +376 -368
- data/lib/aws/elastic_beanstalk/config.rb +1 -1
- data/lib/aws/elastic_transcoder.rb +5 -5
- data/lib/aws/elastic_transcoder/client.rb +283 -283
- data/lib/aws/elastic_transcoder/config.rb +1 -1
- data/lib/aws/elasticache.rb +12 -12
- data/lib/aws/elasticache/client.rb +484 -479
- data/lib/aws/elasticache/config.rb +1 -1
- data/lib/aws/elb.rb +23 -23
- data/lib/aws/elb/availability_zone_collection.rb +34 -34
- data/lib/aws/elb/backend_server_policy_collection.rb +24 -24
- data/lib/aws/elb/client.rb +153 -153
- data/lib/aws/elb/config.rb +1 -1
- data/lib/aws/elb/errors.rb +1 -1
- data/lib/aws/elb/instance_collection.rb +20 -25
- data/lib/aws/elb/listener.rb +3 -3
- data/lib/aws/elb/listener_collection.rb +8 -8
- data/lib/aws/elb/load_balancer.rb +15 -16
- data/lib/aws/elb/load_balancer_collection.rb +36 -24
- data/lib/aws/elb/load_balancer_policy.rb +1 -1
- data/lib/aws/elb/load_balancer_policy_collection.rb +5 -5
- data/lib/aws/emr.rb +28 -26
- data/lib/aws/emr/client.rb +165 -149
- data/lib/aws/emr/config.rb +1 -1
- data/lib/aws/emr/instance_group.rb +1 -1
- data/lib/aws/emr/instance_group_collection.rb +1 -1
- data/lib/aws/emr/job_flow.rb +27 -26
- data/lib/aws/emr/job_flow_collection.rb +34 -34
- data/lib/aws/errors.rb +7 -7
- data/lib/aws/glacier.rb +21 -21
- data/lib/aws/glacier/archive_collection.rb +2 -2
- data/lib/aws/glacier/client.rb +139 -140
- data/lib/aws/glacier/config.rb +1 -1
- data/lib/aws/glacier/vault.rb +2 -2
- data/lib/aws/glacier/vault_collection.rb +1 -1
- data/lib/aws/iam.rb +133 -144
- data/lib/aws/iam/access_key.rb +17 -17
- data/lib/aws/iam/access_key_collection.rb +22 -22
- data/lib/aws/iam/account_alias_collection.rb +2 -2
- data/lib/aws/iam/client.rb +429 -420
- data/lib/aws/iam/collection.rb +1 -1
- data/lib/aws/iam/config.rb +2 -2
- data/lib/aws/iam/group.rb +8 -8
- data/lib/aws/iam/group_collection.rb +16 -16
- data/lib/aws/iam/group_policy_collection.rb +6 -6
- data/lib/aws/iam/group_user_collection.rb +3 -3
- data/lib/aws/iam/mfa_device.rb +1 -1
- data/lib/aws/iam/mfa_device_collection.rb +9 -9
- data/lib/aws/iam/policy_collection.rb +4 -4
- data/lib/aws/iam/resource.rb +2 -2
- data/lib/aws/iam/server_certificate.rb +1 -1
- data/lib/aws/iam/server_certificate_collection.rb +15 -15
- data/lib/aws/iam/signing_certificate.rb +29 -29
- data/lib/aws/iam/signing_certificate_collection.rb +23 -23
- data/lib/aws/iam/user.rb +33 -38
- data/lib/aws/iam/user_collection.rb +27 -27
- data/lib/aws/iam/user_group_collection.rb +3 -3
- data/lib/aws/iam/user_policy_collection.rb +6 -6
- data/lib/aws/iam/virtual_mfa_device.rb +12 -12
- data/lib/aws/iam/virtual_mfa_device_collection.rb +4 -4
- data/lib/aws/import_export.rb +22 -21
- data/lib/aws/import_export/client.rb +47 -43
- data/lib/aws/ops_works.rb +5 -5
- data/lib/aws/ops_works/client.rb +484 -438
- data/lib/aws/ops_works/config.rb +1 -1
- data/lib/aws/rails.rb +34 -34
- data/lib/aws/rds.rb +18 -18
- data/lib/aws/rds/client.rb +1286 -1277
- data/lib/aws/rds/config.rb +1 -1
- data/lib/aws/rds/db_instance.rb +15 -4
- data/lib/aws/rds/db_snapshot.rb +1 -1
- data/lib/aws/record.rb +50 -24
- data/lib/aws/record/abstract_base.rb +52 -60
- data/lib/aws/record/attributes.rb +79 -79
- data/lib/aws/record/conversion.rb +1 -1
- data/lib/aws/record/dirty_tracking.rb +69 -67
- data/lib/aws/record/errors.rb +21 -21
- data/lib/aws/record/exceptions.rb +2 -2
- data/lib/aws/record/hash_model.rb +20 -21
- data/lib/aws/record/hash_model/attributes.rb +13 -15
- data/lib/aws/record/hash_model/finder_methods.rb +46 -46
- data/lib/aws/record/hash_model/scope.rb +31 -31
- data/lib/aws/record/model.rb +136 -136
- data/lib/aws/record/model/attributes.rb +57 -59
- data/lib/aws/record/model/finder_methods.rb +67 -67
- data/lib/aws/record/model/scope.rb +48 -49
- data/lib/aws/record/naming.rb +1 -1
- data/lib/aws/record/scope.rb +23 -19
- data/lib/aws/record/validations.rb +253 -271
- data/lib/aws/record/validator.rb +3 -3
- data/lib/aws/record/validators/acceptance.rb +1 -3
- data/lib/aws/record/validators/block.rb +1 -3
- data/lib/aws/record/validators/confirmation.rb +1 -3
- data/lib/aws/record/validators/count.rb +2 -4
- data/lib/aws/record/validators/exclusion.rb +2 -4
- data/lib/aws/record/validators/format.rb +2 -4
- data/lib/aws/record/validators/inclusion.rb +1 -3
- data/lib/aws/record/validators/length.rb +5 -7
- data/lib/aws/record/validators/method.rb +1 -3
- data/lib/aws/record/validators/numericality.rb +6 -8
- data/lib/aws/record/validators/presence.rb +1 -3
- data/lib/aws/redshift.rb +14 -14
- data/lib/aws/redshift/client.rb +596 -592
- data/lib/aws/redshift/config.rb +1 -1
- data/lib/aws/route_53.rb +30 -30
- data/lib/aws/route_53/change_batch.rb +7 -7
- data/lib/aws/route_53/client.rb +188 -152
- data/lib/aws/route_53/hosted_zone.rb +4 -4
- data/lib/aws/route_53/hosted_zone_collection.rb +7 -7
- data/lib/aws/route_53/resource_record_set.rb +10 -10
- data/lib/aws/route_53/resource_record_set_collection.rb +6 -6
- data/lib/aws/s3.rb +79 -79
- data/lib/aws/s3/access_control_list.rb +44 -36
- data/lib/aws/s3/acl_options.rb +51 -51
- data/lib/aws/s3/bucket.rb +146 -146
- data/lib/aws/s3/bucket_collection.rb +21 -21
- data/lib/aws/s3/bucket_lifecycle_configuration.rb +81 -82
- data/lib/aws/s3/bucket_tag_collection.rb +4 -2
- data/lib/aws/s3/cipher_io.rb +5 -4
- data/lib/aws/s3/client.rb +89 -84
- data/lib/aws/s3/client/xml.rb +1 -1
- data/lib/aws/s3/config.rb +7 -1
- data/lib/aws/s3/cors_rule.rb +2 -0
- data/lib/aws/s3/cors_rule_collection.rb +42 -40
- data/lib/aws/s3/data_options.rb +16 -11
- data/lib/aws/s3/encryption_utils.rb +2 -2
- data/lib/aws/s3/errors.rb +7 -7
- data/lib/aws/s3/multipart_upload.rb +30 -33
- data/lib/aws/s3/multipart_upload_collection.rb +8 -6
- data/lib/aws/s3/object_collection.rb +35 -35
- data/lib/aws/s3/object_metadata.rb +6 -6
- data/lib/aws/s3/object_version.rb +4 -4
- data/lib/aws/s3/object_version_collection.rb +15 -15
- data/lib/aws/s3/policy.rb +2 -2
- data/lib/aws/s3/prefixed_collection.rb +9 -5
- data/lib/aws/s3/presigned_post.rb +39 -37
- data/lib/aws/s3/request.rb +11 -11
- data/lib/aws/s3/s3_object.rb +210 -200
- data/lib/aws/s3/tree.rb +25 -27
- data/lib/aws/s3/tree/child_collection.rb +3 -3
- data/lib/aws/s3/tree/leaf_node.rb +2 -2
- data/lib/aws/s3/tree/parent.rb +1 -1
- data/lib/aws/s3/website_configuration.rb +13 -13
- data/lib/aws/simple_db.rb +83 -83
- data/lib/aws/simple_db/attribute.rb +9 -7
- data/lib/aws/simple_db/attribute_collection.rb +22 -13
- data/lib/aws/simple_db/client.rb +107 -107
- data/lib/aws/simple_db/config.rb +7 -1
- data/lib/aws/simple_db/consistent_read_option.rb +5 -5
- data/lib/aws/simple_db/domain.rb +4 -2
- data/lib/aws/simple_db/domain_collection.rb +4 -4
- data/lib/aws/simple_db/domain_metadata.rb +5 -5
- data/lib/aws/simple_db/errors.rb +9 -9
- data/lib/aws/simple_db/item.rb +5 -5
- data/lib/aws/simple_db/item_collection.rb +83 -81
- data/lib/aws/simple_db/item_data.rb +4 -4
- data/lib/aws/simple_db/put_attributes.rb +3 -3
- data/lib/aws/simple_email_service.rb +140 -140
- data/lib/aws/simple_email_service/client.rb +82 -76
- data/lib/aws/simple_email_service/config.rb +1 -2
- data/lib/aws/simple_email_service/email_address_collection.rb +3 -3
- data/lib/aws/simple_email_service/identity.rb +8 -8
- data/lib/aws/simple_email_service/quotas.rb +8 -6
- data/lib/aws/simple_workflow.rb +106 -106
- data/lib/aws/simple_workflow/activity_task.rb +15 -22
- data/lib/aws/simple_workflow/activity_task_collection.rb +15 -15
- data/lib/aws/simple_workflow/activity_type.rb +23 -23
- data/lib/aws/simple_workflow/activity_type_collection.rb +23 -23
- data/lib/aws/simple_workflow/client.rb +1004 -956
- data/lib/aws/simple_workflow/config.rb +1 -1
- data/lib/aws/simple_workflow/count.rb +5 -5
- data/lib/aws/simple_workflow/decision_task.rb +129 -129
- data/lib/aws/simple_workflow/decision_task_collection.rb +59 -59
- data/lib/aws/simple_workflow/domain.rb +11 -11
- data/lib/aws/simple_workflow/domain_collection.rb +26 -26
- data/lib/aws/simple_workflow/history_event.rb +32 -32
- data/lib/aws/simple_workflow/history_event_collection.rb +3 -3
- data/lib/aws/simple_workflow/option_formatters.rb +5 -5
- data/lib/aws/simple_workflow/request.rb +1 -1
- data/lib/aws/simple_workflow/resource.rb +1 -1
- data/lib/aws/simple_workflow/type.rb +8 -8
- data/lib/aws/simple_workflow/type_collection.rb +15 -15
- data/lib/aws/simple_workflow/workflow_execution.rb +70 -72
- data/lib/aws/simple_workflow/workflow_execution_collection.rb +130 -130
- data/lib/aws/simple_workflow/workflow_type.rb +27 -25
- data/lib/aws/simple_workflow/workflow_type_collection.rb +20 -20
- data/lib/aws/sns.rb +25 -25
- data/lib/aws/sns/client.rb +55 -55
- data/lib/aws/sns/config.rb +1 -1
- data/lib/aws/sns/policy.rb +1 -1
- data/lib/aws/sns/subscription.rb +7 -7
- data/lib/aws/sns/subscription_collection.rb +5 -5
- data/lib/aws/sns/topic.rb +49 -49
- data/lib/aws/sns/topic_collection.rb +2 -2
- data/lib/aws/sns/topic_subscription_collection.rb +5 -5
- data/lib/aws/sqs.rb +20 -20
- data/lib/aws/sqs/client.rb +78 -78
- data/lib/aws/sqs/config.rb +1 -1
- data/lib/aws/sqs/errors.rb +12 -12
- data/lib/aws/sqs/queue.rb +66 -67
- data/lib/aws/sqs/queue_collection.rb +16 -8
- data/lib/aws/sqs/received_message.rb +7 -6
- data/lib/aws/storage_gateway.rb +21 -21
- data/lib/aws/storage_gateway/client.rb +269 -202
- data/lib/aws/storage_gateway/config.rb +1 -1
- data/lib/aws/sts.rb +10 -8
- data/lib/aws/sts/client.rb +35 -35
- data/lib/aws/sts/session.rb +3 -3
- data/lib/aws/version.rb +1 -2
- metadata +23 -21
- data/lib/aws/core/autoloader.rb +0 -64
- data/lib/net/http/connection_pool.rb +0 -226
- data/lib/net/http/connection_pool/connection.rb +0 -189
- data/lib/net/http/connection_pool/session.rb +0 -126
data/lib/aws/ops_works/config.rb
CHANGED
data/lib/aws/rails.rb
CHANGED
|
@@ -43,11 +43,11 @@ module AWS
|
|
|
43
43
|
#
|
|
44
44
|
# Rails 3+ (RAILS_ROOT/Gemfile)
|
|
45
45
|
#
|
|
46
|
-
#
|
|
46
|
+
# gem 'aws-sdk'
|
|
47
47
|
#
|
|
48
48
|
# Rails 2.1 - 2.3 (RAILS_ROOT/config/environment.rb)
|
|
49
49
|
#
|
|
50
|
-
#
|
|
50
|
+
# config.gem 'aws-sdk'
|
|
51
51
|
#
|
|
52
52
|
# @return [nil]
|
|
53
53
|
def self.setup
|
|
@@ -57,48 +57,48 @@ module AWS
|
|
|
57
57
|
nil
|
|
58
58
|
end
|
|
59
59
|
|
|
60
|
-
# Loads AWS configuration options from
|
|
60
|
+
# Loads AWS configuration options from `RAILS_ROOT/config/aws.yml`.
|
|
61
61
|
#
|
|
62
62
|
# This configuration file is optional. You can omit this file and instead
|
|
63
63
|
# use ruby to configure AWS inside a configuration initialization script
|
|
64
64
|
# (e.g. RAILS_ROOT/config/intializers/aws.rb).
|
|
65
65
|
#
|
|
66
66
|
# If you have a yaml configuration file it should be formatted like the
|
|
67
|
-
# standard
|
|
67
|
+
# standard `database.yml` file in a Rails application. This means there
|
|
68
68
|
# should be one section for Rails environment:
|
|
69
69
|
#
|
|
70
|
-
#
|
|
71
|
-
#
|
|
72
|
-
#
|
|
73
|
-
#
|
|
70
|
+
# development:
|
|
71
|
+
# access_key_id: YOUR_ACCESS_KEY_ID
|
|
72
|
+
# secret_access_key: YOUR_SECRET_ACCESS_KEY
|
|
73
|
+
# simple_db_consistent_reads: false
|
|
74
74
|
#
|
|
75
|
-
#
|
|
76
|
-
#
|
|
77
|
-
#
|
|
78
|
-
#
|
|
75
|
+
# production:
|
|
76
|
+
# access_key_id: YOUR_ACCESS_KEY_ID
|
|
77
|
+
# secret_access_key: YOUR_SECRET_ACCESS_KEY
|
|
78
|
+
# simple_db_consistent_reads: true
|
|
79
79
|
#
|
|
80
80
|
# You should also consider DRYing up your configuration file using
|
|
81
81
|
# YAML references:
|
|
82
82
|
#
|
|
83
|
-
#
|
|
84
|
-
#
|
|
85
|
-
#
|
|
86
|
-
#
|
|
83
|
+
# development:
|
|
84
|
+
# access_key_id: YOUR_ACCESS_KEY_ID
|
|
85
|
+
# secret_access_key: YOUR_SECRET_ACCESS_KEY
|
|
86
|
+
# simple_db_consistent_reads: false
|
|
87
87
|
#
|
|
88
|
-
#
|
|
89
|
-
#
|
|
90
|
-
#
|
|
88
|
+
# production:
|
|
89
|
+
# <<: *development
|
|
90
|
+
# simple_db_consistent_reads: true
|
|
91
91
|
#
|
|
92
92
|
# The yaml file will also be ERB parsed so you can use ruby inside of it:
|
|
93
93
|
#
|
|
94
|
-
#
|
|
95
|
-
#
|
|
96
|
-
#
|
|
97
|
-
#
|
|
94
|
+
# development:
|
|
95
|
+
# access_key_id: YOUR_ACCESS_KEY_ID
|
|
96
|
+
# secret_access_key: <%= read_secret_from_a_secure_location %>
|
|
97
|
+
# simple_db_consistent_reads: false
|
|
98
98
|
#
|
|
99
|
-
#
|
|
100
|
-
#
|
|
101
|
-
#
|
|
99
|
+
# production:
|
|
100
|
+
# <<: *development
|
|
101
|
+
# simple_db_consistent_reads: true
|
|
102
102
|
#
|
|
103
103
|
def self.load_yaml_config
|
|
104
104
|
|
|
@@ -121,28 +121,28 @@ module AWS
|
|
|
121
121
|
# use this for ActionMailer in your environment configuration
|
|
122
122
|
# (e.g. RAILS_ROOT/config/environments/production.rb)
|
|
123
123
|
#
|
|
124
|
-
#
|
|
124
|
+
# config.action_mailer.delivery_method = :amazon_ses
|
|
125
125
|
#
|
|
126
|
-
#
|
|
126
|
+
# ### Defaults
|
|
127
127
|
#
|
|
128
128
|
# Normally you don't need to call this method. By default a delivery method
|
|
129
|
-
# named
|
|
129
|
+
# named `:amazon_ses` is added to ActionMailer::Base. This delivery method
|
|
130
130
|
# uses your default configuration (#{AWS.config}).
|
|
131
131
|
#
|
|
132
|
-
#
|
|
132
|
+
# ### Custom SES Options
|
|
133
133
|
#
|
|
134
134
|
# If you need to supply configuration values for SES that are different than
|
|
135
135
|
# those in {AWS.config} then you can pass those options:
|
|
136
136
|
#
|
|
137
|
-
#
|
|
137
|
+
# AWS.add_action_mailer_delivery_method(:ses, custom_options)
|
|
138
138
|
#
|
|
139
139
|
# @param [Symbol] name (:amazon_ses) The name of the delivery
|
|
140
140
|
# method. The name used here should be the same as you set in
|
|
141
141
|
# your environment config. If you name the delivery method
|
|
142
|
-
#
|
|
142
|
+
# `:amazon_ses` then you could do something like this in your
|
|
143
143
|
# config/environments/ENV.rb file:
|
|
144
144
|
#
|
|
145
|
-
#
|
|
145
|
+
# config.action_mailer.delivery_method = :amazon_ses
|
|
146
146
|
#
|
|
147
147
|
# @param [Hash] options A hash of options that are passes to
|
|
148
148
|
# {AWS::SimpleEmailService#new} before delivering email.
|
|
@@ -151,7 +151,7 @@ module AWS
|
|
|
151
151
|
#
|
|
152
152
|
def self.add_action_mailer_delivery_method name = :amazon_ses, options = {}
|
|
153
153
|
|
|
154
|
-
if ::Rails.version.
|
|
154
|
+
if ::Rails.version.to_s >= '3.0'
|
|
155
155
|
ActiveSupport.on_load(:action_mailer) do
|
|
156
156
|
self.add_delivery_method(name, AWS::SimpleEmailService, options)
|
|
157
157
|
end
|
data/lib/aws/rds.rb
CHANGED
|
@@ -21,40 +21,40 @@ module AWS
|
|
|
21
21
|
#
|
|
22
22
|
# For more information about RDS:
|
|
23
23
|
#
|
|
24
|
-
# *
|
|
25
|
-
# *
|
|
24
|
+
# * [Amazon RDS](http://aws.amazon.com/rds/)
|
|
25
|
+
# * [Amazon RDS Documentation](http://aws.amazon.com/documentation/rds/)
|
|
26
26
|
#
|
|
27
|
-
#
|
|
27
|
+
# # Credentials
|
|
28
28
|
#
|
|
29
29
|
# You can setup default credentials for all AWS services via
|
|
30
30
|
# AWS.config:
|
|
31
31
|
#
|
|
32
|
-
#
|
|
33
|
-
#
|
|
34
|
-
#
|
|
32
|
+
# AWS.config(
|
|
33
|
+
# :access_key_id => 'YOUR_ACCESS_KEY_ID',
|
|
34
|
+
# :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
|
|
35
35
|
#
|
|
36
36
|
# Or you can set them directly on the AWS::RDS interface:
|
|
37
37
|
#
|
|
38
|
-
#
|
|
39
|
-
#
|
|
40
|
-
#
|
|
38
|
+
# rds = AWS::RDS.new(
|
|
39
|
+
# :access_key_id => 'YOUR_ACCESS_KEY_ID',
|
|
40
|
+
# :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
|
|
41
41
|
#
|
|
42
42
|
# @!attribute [r] client
|
|
43
43
|
# @return [Client] the low-level RDS client object
|
|
44
44
|
class RDS
|
|
45
45
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
autoload :Request, 'request'
|
|
54
|
-
end
|
|
46
|
+
autoload :Client, 'aws/rds/client'
|
|
47
|
+
autoload :Errors, 'aws/rds/errors'
|
|
48
|
+
autoload :DBInstance, 'aws/rds/db_instance'
|
|
49
|
+
autoload :DBInstanceCollection, 'aws/rds/db_instance_collection'
|
|
50
|
+
autoload :DBSnapshot, 'aws/rds/db_snapshot'
|
|
51
|
+
autoload :DBSnapshotCollection, 'aws/rds/db_snapshot_collection'
|
|
52
|
+
autoload :Request, 'aws/rds/request'
|
|
55
53
|
|
|
56
54
|
include Core::ServiceInterface
|
|
57
55
|
|
|
56
|
+
endpoint_prefix 'rds'
|
|
57
|
+
|
|
58
58
|
# @return [DBInstanceCollection]
|
|
59
59
|
def db_instances
|
|
60
60
|
DBInstanceCollection.new(:config => config)
|
data/lib/aws/rds/client.rb
CHANGED
|
@@ -25,10 +25,10 @@ module AWS
|
|
|
25
25
|
# @!method add_source_identifier_to_subscription(options = {})
|
|
26
26
|
# Calls the AddSourceIdentifierToSubscription API operation.
|
|
27
27
|
# @param [Hash] options
|
|
28
|
-
# *
|
|
28
|
+
# * `:subscription_name` - *required* - (String) The name of the RDS
|
|
29
29
|
# event notification subscription you want to add a source identifier
|
|
30
30
|
# to.
|
|
31
|
-
# *
|
|
31
|
+
# * `:source_identifier` - *required* - (String) The identifier of the
|
|
32
32
|
# event source to be added. An identifier must begin with a letter
|
|
33
33
|
# and must contain only ASCII letters, digits, and hyphens; it cannot
|
|
34
34
|
# end with a hyphen or contain two consecutive hyphens. Constraints:
|
|
@@ -41,30 +41,30 @@ module AWS
|
|
|
41
41
|
# @return [Core::Response]
|
|
42
42
|
# The #data method of the response object returns
|
|
43
43
|
# a hash with the following structure:
|
|
44
|
-
# *
|
|
45
|
-
# *
|
|
46
|
-
# *
|
|
47
|
-
# *
|
|
48
|
-
# *
|
|
49
|
-
# *
|
|
50
|
-
# *
|
|
51
|
-
# *
|
|
52
|
-
# *
|
|
44
|
+
# * `:customer_aws_id` - (String)
|
|
45
|
+
# * `:cust_subscription_id` - (String)
|
|
46
|
+
# * `:sns_topic_arn` - (String)
|
|
47
|
+
# * `:status` - (String)
|
|
48
|
+
# * `:subscription_creation_time` - (String)
|
|
49
|
+
# * `:source_type` - (String)
|
|
50
|
+
# * `:source_ids_list` - (Array<String>)
|
|
51
|
+
# * `:event_categories_list` - (Array<String>)
|
|
52
|
+
# * `:enabled` - (Boolean)
|
|
53
53
|
|
|
54
54
|
# @!method add_tags_to_resource(options = {})
|
|
55
55
|
# Calls the AddTagsToResource API operation.
|
|
56
56
|
# @param [Hash] options
|
|
57
|
-
# *
|
|
57
|
+
# * `:resource_name` - *required* - (String) The DB Instance the tags
|
|
58
58
|
# will be added to.
|
|
59
|
-
# *
|
|
59
|
+
# * `:tags` - *required* - (Array<Hash>) The tags to be assigned to the
|
|
60
60
|
# DB Instance.
|
|
61
|
-
# *
|
|
61
|
+
# * `:key` - (String) A key is the required name of the tag. The
|
|
62
62
|
# string value can be from 1 to 128 Unicode characters in length
|
|
63
63
|
# and cannot be prefixed with "aws:". The string may only contain
|
|
64
64
|
# only the set of Unicode letters, digits, white-space, '_', '.',
|
|
65
65
|
# '/', '=', '+', '-' (Java regex:
|
|
66
66
|
# "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
|
|
67
|
-
# *
|
|
67
|
+
# * `:value` - (String) A value is the optional value of the tag. The
|
|
68
68
|
# string value can be from 1 to 256 Unicode characters in length
|
|
69
69
|
# and cannot be prefixed with "aws:". The string may only contain
|
|
70
70
|
# only the set of Unicode letters, digits, white-space, '_', '.',
|
|
@@ -75,42 +75,42 @@ module AWS
|
|
|
75
75
|
# @!method authorize_db_security_group_ingress(options = {})
|
|
76
76
|
# Calls the AuthorizeDBSecurityGroupIngress API operation.
|
|
77
77
|
# @param [Hash] options
|
|
78
|
-
# *
|
|
78
|
+
# * `:db_security_group_name` - *required* - (String) The name of the
|
|
79
79
|
# DB Security Group to authorize.
|
|
80
|
-
# *
|
|
81
|
-
# *
|
|
80
|
+
# * `:cidrip` - (String) The IP range to authorize.
|
|
81
|
+
# * `:ec2_security_group_name` - (String) Name of the EC2 Security
|
|
82
82
|
# Group to authorize.
|
|
83
|
-
# *
|
|
83
|
+
# * `:ec2_security_group_id` - (String) Id of the EC2 Security Group to
|
|
84
84
|
# authorize. For VPC DB Security Groups, EC2SecurityGroupId must be
|
|
85
85
|
# provided. Otherwise, EC2SecurityGroupOwnerId and either
|
|
86
86
|
# EC2SecurityGroupName or EC2SecurityGroupId must be provided.
|
|
87
|
-
# *
|
|
87
|
+
# * `:ec2_security_group_owner_id` - (String) AWS Account Number of the
|
|
88
88
|
# owner of the security group specified in the EC2SecurityGroupName
|
|
89
89
|
# parameter. The AWS Access Key ID is not an acceptable value.
|
|
90
90
|
# @return [Core::Response]
|
|
91
91
|
# The #data method of the response object returns
|
|
92
92
|
# a hash with the following structure:
|
|
93
|
-
# *
|
|
94
|
-
# *
|
|
95
|
-
# *
|
|
96
|
-
# *
|
|
97
|
-
# *
|
|
98
|
-
# *
|
|
99
|
-
# *
|
|
100
|
-
# *
|
|
101
|
-
# *
|
|
102
|
-
# *
|
|
103
|
-
# *
|
|
104
|
-
# *
|
|
93
|
+
# * `:owner_id` - (String)
|
|
94
|
+
# * `:db_security_group_name` - (String)
|
|
95
|
+
# * `:db_security_group_description` - (String)
|
|
96
|
+
# * `:vpc_id` - (String)
|
|
97
|
+
# * `:ec_2_security_groups` - (Array<Hash>)
|
|
98
|
+
# * `:status` - (String)
|
|
99
|
+
# * `:ec2_security_group_name` - (String)
|
|
100
|
+
# * `:ec2_security_group_id` - (String)
|
|
101
|
+
# * `:ec2_security_group_owner_id` - (String)
|
|
102
|
+
# * `:ip_ranges` - (Array<Hash>)
|
|
103
|
+
# * `:status` - (String)
|
|
104
|
+
# * `:cidrip` - (String)
|
|
105
105
|
|
|
106
106
|
# @!method copy_db_snapshot(options = {})
|
|
107
107
|
# Calls the CopyDBSnapshot API operation.
|
|
108
108
|
# @param [Hash] options
|
|
109
|
-
# *
|
|
109
|
+
# * `:source_db_snapshot_identifier` - *required* - (String) The
|
|
110
110
|
# identifier for the source DB snapshot. Constraints: Must be the
|
|
111
111
|
# identifier for a valid automated snapshot in the "available" state.
|
|
112
112
|
# Example: rds:mydb-2012-01-15-00-01
|
|
113
|
-
# *
|
|
113
|
+
# * `:target_db_snapshot_identifier` - *required* - (String) The
|
|
114
114
|
# identifier for the copied snapshot. Constraints: Cannot be null,
|
|
115
115
|
# empty, or blank Must contain from 1 to 255 alphanumeric characters
|
|
116
116
|
# or hyphens First character must be a letter Cannot end with a
|
|
@@ -118,93 +118,93 @@ module AWS
|
|
|
118
118
|
# @return [Core::Response]
|
|
119
119
|
# The #data method of the response object returns
|
|
120
120
|
# a hash with the following structure:
|
|
121
|
-
# *
|
|
122
|
-
# *
|
|
123
|
-
# *
|
|
124
|
-
# *
|
|
125
|
-
# *
|
|
126
|
-
# *
|
|
127
|
-
# *
|
|
128
|
-
# *
|
|
129
|
-
# *
|
|
130
|
-
# *
|
|
131
|
-
# *
|
|
132
|
-
# *
|
|
133
|
-
# *
|
|
134
|
-
# *
|
|
135
|
-
# *
|
|
136
|
-
# *
|
|
121
|
+
# * `:db_snapshot_identifier` - (String)
|
|
122
|
+
# * `:db_instance_identifier` - (String)
|
|
123
|
+
# * `:snapshot_create_time` - (Time)
|
|
124
|
+
# * `:engine` - (String)
|
|
125
|
+
# * `:allocated_storage` - (Integer)
|
|
126
|
+
# * `:status` - (String)
|
|
127
|
+
# * `:port` - (Integer)
|
|
128
|
+
# * `:availability_zone` - (String)
|
|
129
|
+
# * `:vpc_id` - (String)
|
|
130
|
+
# * `:instance_create_time` - (Time)
|
|
131
|
+
# * `:master_username` - (String)
|
|
132
|
+
# * `:engine_version` - (String)
|
|
133
|
+
# * `:license_model` - (String)
|
|
134
|
+
# * `:snapshot_type` - (String)
|
|
135
|
+
# * `:iops` - (Integer)
|
|
136
|
+
# * `:option_group_name` - (String)
|
|
137
137
|
|
|
138
138
|
# @!method create_db_instance(options = {})
|
|
139
139
|
# Calls the CreateDBInstance API operation.
|
|
140
140
|
# @param [Hash] options
|
|
141
|
-
# *
|
|
141
|
+
# * `:db_name` - (String) The name of the database to create when the
|
|
142
142
|
# DB Instance is created. If this parameter is not specified, no
|
|
143
143
|
# database is created in the DB Instance.
|
|
144
|
-
# *
|
|
144
|
+
# * `:db_instance_identifier` - *required* - (String) The DB Instance
|
|
145
145
|
# identifier. This parameter is stored as a lowercase string.
|
|
146
|
-
# *
|
|
146
|
+
# * `:allocated_storage` - *required* - (Integer) The amount of storage
|
|
147
147
|
# (in gigabytes) to be initially allocated for the database instance.
|
|
148
|
-
# *
|
|
148
|
+
# * `:db_instance_class` - *required* - (String) The compute and memory
|
|
149
149
|
# capacity of the DB Instance.
|
|
150
|
-
# *
|
|
150
|
+
# * `:engine` - *required* - (String) The name of the database engine
|
|
151
151
|
# to be used for this instance.
|
|
152
|
-
# *
|
|
152
|
+
# * `:master_username` - *required* - (String) The name of master user
|
|
153
153
|
# for the client DB Instance.
|
|
154
|
-
# *
|
|
154
|
+
# * `:master_user_password` - *required* - (String) The password for
|
|
155
155
|
# the master DB Instance user.
|
|
156
|
-
# *
|
|
156
|
+
# * `:db_security_groups` - (Array<String>) A list of DB Security
|
|
157
157
|
# Groups to associate with this DB Instance.
|
|
158
|
-
# *
|
|
158
|
+
# * `:vpc_security_group_ids` - (Array<String>) A list of Ec2 Vpc
|
|
159
159
|
# Security Groups to associate with this DB Instance. Default: The
|
|
160
160
|
# default Ec2 Vpc Security Group for the DB Subnet group's Vpc.
|
|
161
|
-
# *
|
|
161
|
+
# * `:availability_zone` - (String) The EC2 Availability Zone that the
|
|
162
162
|
# database instance will be created in.
|
|
163
|
-
# *
|
|
163
|
+
# * `:db_subnet_group_name` - (String) A DB Subnet Group to associate
|
|
164
164
|
# with this DB Instance. If there is no DB Subnet Group, then it is a
|
|
165
165
|
# non-VPC DB instance.
|
|
166
|
-
# *
|
|
166
|
+
# * `:preferred_maintenance_window` - (String) The weekly time range
|
|
167
167
|
# (in UTC) during which system maintenance can occur.
|
|
168
|
-
# *
|
|
168
|
+
# * `:db_parameter_group_name` - (String) The name of the database
|
|
169
169
|
# parameter group to associate with this DB instance. If this
|
|
170
170
|
# argument is omitted, the default DBParameterGroup for the specified
|
|
171
171
|
# engine will be used.
|
|
172
|
-
# *
|
|
172
|
+
# * `:backup_retention_period` - (Integer) The number of days for which
|
|
173
173
|
# automated backups are retained. Setting this parameter to a
|
|
174
174
|
# positive number enables backups. Setting this parameter to 0
|
|
175
175
|
# disables automated backups.
|
|
176
|
-
# *
|
|
176
|
+
# * `:preferred_backup_window` - (String) The daily time range during
|
|
177
177
|
# which automated backups are created if automated backups are
|
|
178
178
|
# enabled, as determined by the BackupRetentionPeriod.
|
|
179
|
-
# *
|
|
179
|
+
# * `:port` - (Integer) The port number on which the database accepts
|
|
180
180
|
# connections.
|
|
181
|
-
# *
|
|
181
|
+
# * `:multi_az` - (Boolean) Specifies if the DB Instance is a Multi-AZ
|
|
182
182
|
# deployment. You cannot set the AvailabilityZone parameter if the
|
|
183
|
-
# MultiAZ parameter is set to
|
|
184
|
-
# *
|
|
183
|
+
# MultiAZ parameter is set to `true` .
|
|
184
|
+
# * `:engine_version` - (String) The version number of the database
|
|
185
185
|
# engine to use. Example: 5.1.42
|
|
186
|
-
# *
|
|
186
|
+
# * `:auto_minor_version_upgrade` - (Boolean) Indicates that minor
|
|
187
187
|
# engine upgrades will be applied automatically to the DB Instance
|
|
188
|
-
# during the maintenance window. Default:
|
|
189
|
-
# *
|
|
188
|
+
# during the maintenance window. Default: `true`
|
|
189
|
+
# * `:license_model` - (String) License model information for this DB
|
|
190
190
|
# Instance. Valid values: license-included | bring-your-own-license |
|
|
191
191
|
# general-public-license
|
|
192
|
-
# *
|
|
192
|
+
# * `:iops` - (Integer) The amount of provisioned input/output
|
|
193
193
|
# operations per second to be initially allocated for the database
|
|
194
194
|
# instance. Constraints: Must be an integer Type: Integer
|
|
195
|
-
# *
|
|
195
|
+
# * `:option_group_name` - (String) Indicates that the DB Instance
|
|
196
196
|
# should be associated with the specified option group.
|
|
197
|
-
# *
|
|
197
|
+
# * `:character_set_name` - (String) For supported engines, indicates
|
|
198
198
|
# that the DB Instance should be associated with the specified
|
|
199
199
|
# CharacterSet.
|
|
200
|
-
# *
|
|
201
|
-
# options for the DB Instance. A value of
|
|
200
|
+
# * `:publicly_accessible` - (Boolean) Specifies the accessibility
|
|
201
|
+
# options for the DB Instance. A value of `true` specifies an
|
|
202
202
|
# Internet-facing instance with a publicly resolvable DNS name, which
|
|
203
|
-
# resolves to a public IP address. A value of
|
|
203
|
+
# resolves to a public IP address. A value of `false` specifies an
|
|
204
204
|
# internal instance with a DNS name that resolves to a private IP
|
|
205
205
|
# address. Default: The default behavior varies depending on whether
|
|
206
206
|
# a VPC has been requested or not. The following list shows the
|
|
207
|
-
# default behavior in each case. Default VPC:
|
|
207
|
+
# default behavior in each case. Default VPC: `true` VPC: `false` If
|
|
208
208
|
# no DB subnet group has been specified as part of the request and
|
|
209
209
|
# the PubliclyAccessible value has not been set, the DB instance will
|
|
210
210
|
# be publicly accessible. If a specific DB subnet group has been
|
|
@@ -213,107 +213,107 @@ module AWS
|
|
|
213
213
|
# @return [Core::Response]
|
|
214
214
|
# The #data method of the response object returns
|
|
215
215
|
# a hash with the following structure:
|
|
216
|
-
# *
|
|
217
|
-
# *
|
|
218
|
-
# *
|
|
219
|
-
# *
|
|
220
|
-
# *
|
|
221
|
-
# *
|
|
222
|
-
# *
|
|
223
|
-
# *
|
|
224
|
-
# *
|
|
225
|
-
# *
|
|
226
|
-
# *
|
|
227
|
-
# *
|
|
228
|
-
# *
|
|
229
|
-
# *
|
|
230
|
-
# *
|
|
231
|
-
# *
|
|
232
|
-
# *
|
|
233
|
-
# *
|
|
234
|
-
# *
|
|
235
|
-
# *
|
|
236
|
-
# *
|
|
237
|
-
# *
|
|
238
|
-
# *
|
|
239
|
-
# *
|
|
240
|
-
# *
|
|
241
|
-
# *
|
|
242
|
-
# *
|
|
243
|
-
# *
|
|
244
|
-
# *
|
|
245
|
-
# *
|
|
246
|
-
# *
|
|
247
|
-
# *
|
|
248
|
-
# *
|
|
249
|
-
# *
|
|
250
|
-
# *
|
|
251
|
-
# *
|
|
252
|
-
# *
|
|
253
|
-
# *
|
|
254
|
-
# *
|
|
255
|
-
# *
|
|
256
|
-
# *
|
|
257
|
-
# *
|
|
258
|
-
# *
|
|
259
|
-
# *
|
|
260
|
-
# *
|
|
261
|
-
# *
|
|
262
|
-
# *
|
|
263
|
-
# *
|
|
264
|
-
# *
|
|
265
|
-
# *
|
|
266
|
-
# *
|
|
267
|
-
# *
|
|
268
|
-
# *
|
|
269
|
-
# *
|
|
270
|
-
# *
|
|
271
|
-
# *
|
|
272
|
-
# *
|
|
273
|
-
# *
|
|
274
|
-
# *
|
|
216
|
+
# * `:db_instance_identifier` - (String)
|
|
217
|
+
# * `:db_instance_class` - (String)
|
|
218
|
+
# * `:engine` - (String)
|
|
219
|
+
# * `:db_instance_status` - (String)
|
|
220
|
+
# * `:master_username` - (String)
|
|
221
|
+
# * `:db_name` - (String)
|
|
222
|
+
# * `:endpoint` - (Hash)
|
|
223
|
+
# * `:address` - (String)
|
|
224
|
+
# * `:port` - (Integer)
|
|
225
|
+
# * `:allocated_storage` - (Integer)
|
|
226
|
+
# * `:instance_create_time` - (Time)
|
|
227
|
+
# * `:preferred_backup_window` - (String)
|
|
228
|
+
# * `:backup_retention_period` - (Integer)
|
|
229
|
+
# * `:db_security_groups` - (Array<Hash>)
|
|
230
|
+
# * `:db_security_group_name` - (String)
|
|
231
|
+
# * `:status` - (String)
|
|
232
|
+
# * `:vpc_security_groups` - (Array<Hash>)
|
|
233
|
+
# * `:vpc_security_group_id` - (String)
|
|
234
|
+
# * `:status` - (String)
|
|
235
|
+
# * `:db_parameter_groups` - (Array<Hash>)
|
|
236
|
+
# * `:db_parameter_group_name` - (String)
|
|
237
|
+
# * `:parameter_apply_status` - (String)
|
|
238
|
+
# * `:availability_zone` - (String)
|
|
239
|
+
# * `:db_subnet_group` - (Hash)
|
|
240
|
+
# * `:db_subnet_group_name` - (String)
|
|
241
|
+
# * `:db_subnet_group_description` - (String)
|
|
242
|
+
# * `:vpc_id` - (String)
|
|
243
|
+
# * `:subnet_group_status` - (String)
|
|
244
|
+
# * `:subnets` - (Array<Hash>)
|
|
245
|
+
# * `:subnet_identifier` - (String)
|
|
246
|
+
# * `:subnet_availability_zone` - (Hash)
|
|
247
|
+
# * `:name` - (String)
|
|
248
|
+
# * `:provisioned_iops_capable` - (Boolean)
|
|
249
|
+
# * `:subnet_status` - (String)
|
|
250
|
+
# * `:preferred_maintenance_window` - (String)
|
|
251
|
+
# * `:pending_modified_values` - (Hash)
|
|
252
|
+
# * `:db_instance_class` - (String)
|
|
253
|
+
# * `:allocated_storage` - (Integer)
|
|
254
|
+
# * `:master_user_password` - (String)
|
|
255
|
+
# * `:port` - (Integer)
|
|
256
|
+
# * `:backup_retention_period` - (Integer)
|
|
257
|
+
# * `:multi_az` - (Boolean)
|
|
258
|
+
# * `:engine_version` - (String)
|
|
259
|
+
# * `:iops` - (Integer)
|
|
260
|
+
# * `:db_instance_identifier` - (String)
|
|
261
|
+
# * `:latest_restorable_time` - (Time)
|
|
262
|
+
# * `:multi_az` - (Boolean)
|
|
263
|
+
# * `:engine_version` - (String)
|
|
264
|
+
# * `:auto_minor_version_upgrade` - (Boolean)
|
|
265
|
+
# * `:read_replica_source_db_instance_identifier` - (String)
|
|
266
|
+
# * `:read_replica_db_instance_identifiers` - (Array<String>)
|
|
267
|
+
# * `:license_model` - (String)
|
|
268
|
+
# * `:iops` - (Integer)
|
|
269
|
+
# * `:option_group_memberships` - (Array<Hash>)
|
|
270
|
+
# * `:option_group_name` - (String)
|
|
271
|
+
# * `:status` - (String)
|
|
272
|
+
# * `:character_set_name` - (String)
|
|
273
|
+
# * `:secondary_availability_zone` - (String)
|
|
274
|
+
# * `:publicly_accessible` - (Boolean)
|
|
275
275
|
|
|
276
276
|
# @!method create_db_instance_read_replica(options = {})
|
|
277
277
|
# Calls the CreateDBInstanceReadReplica API operation.
|
|
278
278
|
# @param [Hash] options
|
|
279
|
-
# *
|
|
279
|
+
# * `:db_instance_identifier` - *required* - (String) The DB Instance
|
|
280
280
|
# identifier of the Read Replica. This is the unique key that
|
|
281
281
|
# identifies a DB Instance. This parameter is stored as a lowercase
|
|
282
282
|
# string.
|
|
283
|
-
# *
|
|
283
|
+
# * `:source_db_instance_identifier` - *required* - (String) The
|
|
284
284
|
# identifier of the DB Instance that will act as the source for the
|
|
285
285
|
# Read Replica. Each DB Instance can have up to five Read Replicas.
|
|
286
286
|
# Constraints: Must be the identifier of an existing DB Instance that
|
|
287
287
|
# is not already a Read Replica DB Instance.
|
|
288
|
-
# *
|
|
288
|
+
# * `:db_instance_class` - (String) The compute and memory capacity of
|
|
289
289
|
# the Read Replica. Valid Values: db.m1.small | db.m1.large |
|
|
290
290
|
# db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge Default:
|
|
291
291
|
# Inherits from the source DB Instance.
|
|
292
|
-
# *
|
|
292
|
+
# * `:availability_zone` - (String) The Amazon EC2 Availability Zone
|
|
293
293
|
# that the Read Replica will be created in. Default: A random,
|
|
294
294
|
# system-chosen Availability Zone in the endpoint's region. Example:
|
|
295
295
|
# us-east-1d
|
|
296
|
-
# *
|
|
296
|
+
# * `:port` - (Integer) The port number that the DB Instance uses for
|
|
297
297
|
# connections. Default: Inherits from the source DB Instance Valid
|
|
298
298
|
# Values: 1150-65535
|
|
299
|
-
# *
|
|
299
|
+
# * `:auto_minor_version_upgrade` - (Boolean) Indicates that minor
|
|
300
300
|
# engine upgrades will be applied automatically to the Read Replica
|
|
301
301
|
# during the maintenance window. Default: Inherits from the source DB
|
|
302
302
|
# Instance
|
|
303
|
-
# *
|
|
303
|
+
# * `:iops` - (Integer) The amount of Provisioned IOPS (input/output
|
|
304
304
|
# operations per second) to be initially allocated for the DB
|
|
305
305
|
# Instance.
|
|
306
|
-
# *
|
|
306
|
+
# * `:option_group_name` - (String) The option group the DB instance
|
|
307
307
|
# will be associated with. If omitted, the default Option Group for
|
|
308
308
|
# the engine specified will be used.
|
|
309
|
-
# *
|
|
310
|
-
# options for the DB Instance. A value of
|
|
309
|
+
# * `:publicly_accessible` - (Boolean) Specifies the accessibility
|
|
310
|
+
# options for the DB Instance. A value of `true` specifies an
|
|
311
311
|
# Internet-facing instance with a publicly resolvable DNS name, which
|
|
312
|
-
# resolves to a public IP address. A value of
|
|
312
|
+
# resolves to a public IP address. A value of `false` specifies an
|
|
313
313
|
# internal instance with a DNS name that resolves to a private IP
|
|
314
314
|
# address. Default: The default behavior varies depending on whether
|
|
315
315
|
# a VPC has been requested or not. The following list shows the
|
|
316
|
-
# default behavior in each case. Default VPC:
|
|
316
|
+
# default behavior in each case. Default VPC: `true` VPC: `false` If
|
|
317
317
|
# no DB subnet group has been specified as part of the request and
|
|
318
318
|
# the PubliclyAccessible value has not been set, the DB instance will
|
|
319
319
|
# be publicly accessible. If a specific DB subnet group has been
|
|
@@ -322,180 +322,180 @@ module AWS
|
|
|
322
322
|
# @return [Core::Response]
|
|
323
323
|
# The #data method of the response object returns
|
|
324
324
|
# a hash with the following structure:
|
|
325
|
-
# *
|
|
326
|
-
# *
|
|
327
|
-
# *
|
|
328
|
-
# *
|
|
329
|
-
# *
|
|
330
|
-
# *
|
|
331
|
-
# *
|
|
332
|
-
# *
|
|
333
|
-
# *
|
|
334
|
-
# *
|
|
335
|
-
# *
|
|
336
|
-
# *
|
|
337
|
-
# *
|
|
338
|
-
# *
|
|
339
|
-
# *
|
|
340
|
-
# *
|
|
341
|
-
# *
|
|
342
|
-
# *
|
|
343
|
-
# *
|
|
344
|
-
# *
|
|
345
|
-
# *
|
|
346
|
-
# *
|
|
347
|
-
# *
|
|
348
|
-
# *
|
|
349
|
-
# *
|
|
350
|
-
# *
|
|
351
|
-
# *
|
|
352
|
-
# *
|
|
353
|
-
# *
|
|
354
|
-
# *
|
|
355
|
-
# *
|
|
356
|
-
# *
|
|
357
|
-
# *
|
|
358
|
-
# *
|
|
359
|
-
# *
|
|
360
|
-
# *
|
|
361
|
-
# *
|
|
362
|
-
# *
|
|
363
|
-
# *
|
|
364
|
-
# *
|
|
365
|
-
# *
|
|
366
|
-
# *
|
|
367
|
-
# *
|
|
368
|
-
# *
|
|
369
|
-
# *
|
|
370
|
-
# *
|
|
371
|
-
# *
|
|
372
|
-
# *
|
|
373
|
-
# *
|
|
374
|
-
# *
|
|
375
|
-
# *
|
|
376
|
-
# *
|
|
377
|
-
# *
|
|
378
|
-
# *
|
|
379
|
-
# *
|
|
380
|
-
# *
|
|
381
|
-
# *
|
|
382
|
-
# *
|
|
383
|
-
# *
|
|
325
|
+
# * `:db_instance_identifier` - (String)
|
|
326
|
+
# * `:db_instance_class` - (String)
|
|
327
|
+
# * `:engine` - (String)
|
|
328
|
+
# * `:db_instance_status` - (String)
|
|
329
|
+
# * `:master_username` - (String)
|
|
330
|
+
# * `:db_name` - (String)
|
|
331
|
+
# * `:endpoint` - (Hash)
|
|
332
|
+
# * `:address` - (String)
|
|
333
|
+
# * `:port` - (Integer)
|
|
334
|
+
# * `:allocated_storage` - (Integer)
|
|
335
|
+
# * `:instance_create_time` - (Time)
|
|
336
|
+
# * `:preferred_backup_window` - (String)
|
|
337
|
+
# * `:backup_retention_period` - (Integer)
|
|
338
|
+
# * `:db_security_groups` - (Array<Hash>)
|
|
339
|
+
# * `:db_security_group_name` - (String)
|
|
340
|
+
# * `:status` - (String)
|
|
341
|
+
# * `:vpc_security_groups` - (Array<Hash>)
|
|
342
|
+
# * `:vpc_security_group_id` - (String)
|
|
343
|
+
# * `:status` - (String)
|
|
344
|
+
# * `:db_parameter_groups` - (Array<Hash>)
|
|
345
|
+
# * `:db_parameter_group_name` - (String)
|
|
346
|
+
# * `:parameter_apply_status` - (String)
|
|
347
|
+
# * `:availability_zone` - (String)
|
|
348
|
+
# * `:db_subnet_group` - (Hash)
|
|
349
|
+
# * `:db_subnet_group_name` - (String)
|
|
350
|
+
# * `:db_subnet_group_description` - (String)
|
|
351
|
+
# * `:vpc_id` - (String)
|
|
352
|
+
# * `:subnet_group_status` - (String)
|
|
353
|
+
# * `:subnets` - (Array<Hash>)
|
|
354
|
+
# * `:subnet_identifier` - (String)
|
|
355
|
+
# * `:subnet_availability_zone` - (Hash)
|
|
356
|
+
# * `:name` - (String)
|
|
357
|
+
# * `:provisioned_iops_capable` - (Boolean)
|
|
358
|
+
# * `:subnet_status` - (String)
|
|
359
|
+
# * `:preferred_maintenance_window` - (String)
|
|
360
|
+
# * `:pending_modified_values` - (Hash)
|
|
361
|
+
# * `:db_instance_class` - (String)
|
|
362
|
+
# * `:allocated_storage` - (Integer)
|
|
363
|
+
# * `:master_user_password` - (String)
|
|
364
|
+
# * `:port` - (Integer)
|
|
365
|
+
# * `:backup_retention_period` - (Integer)
|
|
366
|
+
# * `:multi_az` - (Boolean)
|
|
367
|
+
# * `:engine_version` - (String)
|
|
368
|
+
# * `:iops` - (Integer)
|
|
369
|
+
# * `:db_instance_identifier` - (String)
|
|
370
|
+
# * `:latest_restorable_time` - (Time)
|
|
371
|
+
# * `:multi_az` - (Boolean)
|
|
372
|
+
# * `:engine_version` - (String)
|
|
373
|
+
# * `:auto_minor_version_upgrade` - (Boolean)
|
|
374
|
+
# * `:read_replica_source_db_instance_identifier` - (String)
|
|
375
|
+
# * `:read_replica_db_instance_identifiers` - (Array<String>)
|
|
376
|
+
# * `:license_model` - (String)
|
|
377
|
+
# * `:iops` - (Integer)
|
|
378
|
+
# * `:option_group_memberships` - (Array<Hash>)
|
|
379
|
+
# * `:option_group_name` - (String)
|
|
380
|
+
# * `:status` - (String)
|
|
381
|
+
# * `:character_set_name` - (String)
|
|
382
|
+
# * `:secondary_availability_zone` - (String)
|
|
383
|
+
# * `:publicly_accessible` - (Boolean)
|
|
384
384
|
|
|
385
385
|
# @!method create_db_parameter_group(options = {})
|
|
386
386
|
# Calls the CreateDBParameterGroup API operation.
|
|
387
387
|
# @param [Hash] options
|
|
388
|
-
# *
|
|
388
|
+
# * `:db_parameter_group_name` - *required* - (String) The name of the
|
|
389
389
|
# DB Parameter Group.
|
|
390
|
-
# *
|
|
390
|
+
# * `:db_parameter_group_family` - *required* - (String) The name of
|
|
391
391
|
# the DB Parameter Group Family the DB Parameter Group can be used
|
|
392
392
|
# with.
|
|
393
|
-
# *
|
|
393
|
+
# * `:description` - *required* - (String) The description for the DB
|
|
394
394
|
# Parameter Group.
|
|
395
395
|
# @return [Core::Response]
|
|
396
396
|
# The #data method of the response object returns
|
|
397
397
|
# a hash with the following structure:
|
|
398
|
-
# *
|
|
399
|
-
# *
|
|
400
|
-
# *
|
|
398
|
+
# * `:db_parameter_group_name` - (String)
|
|
399
|
+
# * `:db_parameter_group_family` - (String)
|
|
400
|
+
# * `:description` - (String)
|
|
401
401
|
|
|
402
402
|
# @!method create_db_security_group(options = {})
|
|
403
403
|
# Calls the CreateDBSecurityGroup API operation.
|
|
404
404
|
# @param [Hash] options
|
|
405
|
-
# *
|
|
405
|
+
# * `:db_security_group_name` - *required* - (String) The name for the
|
|
406
406
|
# DB Security Group. This value is stored as a lowercase string.
|
|
407
|
-
# *
|
|
407
|
+
# * `:db_security_group_description` - *required* - (String) The
|
|
408
408
|
# description for the DB Security Group.
|
|
409
409
|
# @return [Core::Response]
|
|
410
410
|
# The #data method of the response object returns
|
|
411
411
|
# a hash with the following structure:
|
|
412
|
-
# *
|
|
413
|
-
# *
|
|
414
|
-
# *
|
|
415
|
-
# *
|
|
416
|
-
# *
|
|
417
|
-
# *
|
|
418
|
-
# *
|
|
419
|
-
# *
|
|
420
|
-
# *
|
|
421
|
-
# *
|
|
422
|
-
# *
|
|
423
|
-
# *
|
|
412
|
+
# * `:owner_id` - (String)
|
|
413
|
+
# * `:db_security_group_name` - (String)
|
|
414
|
+
# * `:db_security_group_description` - (String)
|
|
415
|
+
# * `:vpc_id` - (String)
|
|
416
|
+
# * `:ec_2_security_groups` - (Array<Hash>)
|
|
417
|
+
# * `:status` - (String)
|
|
418
|
+
# * `:ec2_security_group_name` - (String)
|
|
419
|
+
# * `:ec2_security_group_id` - (String)
|
|
420
|
+
# * `:ec2_security_group_owner_id` - (String)
|
|
421
|
+
# * `:ip_ranges` - (Array<Hash>)
|
|
422
|
+
# * `:status` - (String)
|
|
423
|
+
# * `:cidrip` - (String)
|
|
424
424
|
|
|
425
425
|
# @!method create_db_snapshot(options = {})
|
|
426
426
|
# Calls the CreateDBSnapshot API operation.
|
|
427
427
|
# @param [Hash] options
|
|
428
|
-
# *
|
|
428
|
+
# * `:db_snapshot_identifier` - *required* - (String) The identifier
|
|
429
429
|
# for the DB Snapshot.
|
|
430
|
-
# *
|
|
430
|
+
# * `:db_instance_identifier` - *required* - (String) The DB Instance
|
|
431
431
|
# identifier. This is the unique key that identifies a DB Instance.
|
|
432
432
|
# This parameter isn't case sensitive.
|
|
433
433
|
# @return [Core::Response]
|
|
434
434
|
# The #data method of the response object returns
|
|
435
435
|
# a hash with the following structure:
|
|
436
|
-
# *
|
|
437
|
-
# *
|
|
438
|
-
# *
|
|
439
|
-
# *
|
|
440
|
-
# *
|
|
441
|
-
# *
|
|
442
|
-
# *
|
|
443
|
-
# *
|
|
444
|
-
# *
|
|
445
|
-
# *
|
|
446
|
-
# *
|
|
447
|
-
# *
|
|
448
|
-
# *
|
|
449
|
-
# *
|
|
450
|
-
# *
|
|
451
|
-
# *
|
|
436
|
+
# * `:db_snapshot_identifier` - (String)
|
|
437
|
+
# * `:db_instance_identifier` - (String)
|
|
438
|
+
# * `:snapshot_create_time` - (Time)
|
|
439
|
+
# * `:engine` - (String)
|
|
440
|
+
# * `:allocated_storage` - (Integer)
|
|
441
|
+
# * `:status` - (String)
|
|
442
|
+
# * `:port` - (Integer)
|
|
443
|
+
# * `:availability_zone` - (String)
|
|
444
|
+
# * `:vpc_id` - (String)
|
|
445
|
+
# * `:instance_create_time` - (Time)
|
|
446
|
+
# * `:master_username` - (String)
|
|
447
|
+
# * `:engine_version` - (String)
|
|
448
|
+
# * `:license_model` - (String)
|
|
449
|
+
# * `:snapshot_type` - (String)
|
|
450
|
+
# * `:iops` - (Integer)
|
|
451
|
+
# * `:option_group_name` - (String)
|
|
452
452
|
|
|
453
453
|
# @!method create_db_subnet_group(options = {})
|
|
454
454
|
# Calls the CreateDBSubnetGroup API operation.
|
|
455
455
|
# @param [Hash] options
|
|
456
|
-
# *
|
|
456
|
+
# * `:db_subnet_group_name` - *required* - (String) The name for the DB
|
|
457
457
|
# Subnet Group. This value is stored as a lowercase string.
|
|
458
458
|
# Constraints: Must contain no more than 255 alphanumeric characters
|
|
459
459
|
# or hyphens. Must not be "Default". Example: mySubnetgroup
|
|
460
|
-
# *
|
|
460
|
+
# * `:db_subnet_group_description` - *required* - (String) The
|
|
461
461
|
# description for the DB Subnet Group.
|
|
462
|
-
# *
|
|
462
|
+
# * `:subnet_ids` - *required* - (Array<String>) The EC2 Subnet IDs for
|
|
463
463
|
# the DB Subnet Group.
|
|
464
464
|
# @return [Core::Response]
|
|
465
465
|
# The #data method of the response object returns
|
|
466
466
|
# a hash with the following structure:
|
|
467
|
-
# *
|
|
468
|
-
# *
|
|
469
|
-
# *
|
|
470
|
-
# *
|
|
471
|
-
# *
|
|
472
|
-
# *
|
|
473
|
-
# *
|
|
474
|
-
# *
|
|
475
|
-
# *
|
|
476
|
-
# *
|
|
467
|
+
# * `:db_subnet_group_name` - (String)
|
|
468
|
+
# * `:db_subnet_group_description` - (String)
|
|
469
|
+
# * `:vpc_id` - (String)
|
|
470
|
+
# * `:subnet_group_status` - (String)
|
|
471
|
+
# * `:subnets` - (Array<Hash>)
|
|
472
|
+
# * `:subnet_identifier` - (String)
|
|
473
|
+
# * `:subnet_availability_zone` - (Hash)
|
|
474
|
+
# * `:name` - (String)
|
|
475
|
+
# * `:provisioned_iops_capable` - (Boolean)
|
|
476
|
+
# * `:subnet_status` - (String)
|
|
477
477
|
|
|
478
478
|
# @!method create_event_subscription(options = {})
|
|
479
479
|
# Calls the CreateEventSubscription API operation.
|
|
480
480
|
# @param [Hash] options
|
|
481
|
-
# *
|
|
481
|
+
# * `:subscription_name` - *required* - (String) The name of the
|
|
482
482
|
# subscription. Constraints: The name must be less than 255
|
|
483
483
|
# characters.
|
|
484
|
-
# *
|
|
484
|
+
# * `:sns_topic_arn` - *required* - (String) The Amazon Resource Name
|
|
485
485
|
# (ARN) of the SNS topic created for event notification. The ARN is
|
|
486
486
|
# created by Amazon SNS when you create a topic and subscribe to it.
|
|
487
|
-
# *
|
|
487
|
+
# * `:source_type` - (String) The type of source that will be
|
|
488
488
|
# generating the events. For example, if you want to be notified of
|
|
489
489
|
# events generated by a DB instance, you would set this parameter to
|
|
490
490
|
# db-instance. if this value is not specified, all events are
|
|
491
491
|
# returned. Valid values: db-instance | db-parameter-group |
|
|
492
492
|
# db-security-group | db-snapshot
|
|
493
|
-
# *
|
|
493
|
+
# * `:event_categories` - (Array<String>) A list of event categories
|
|
494
494
|
# for a SourceType that you want to subscribe to. You can see a list
|
|
495
495
|
# of the categories for a given SourceType in the Events topic in the
|
|
496
496
|
# Amazon RDS User Guide or by using the DescribeEventCategories
|
|
497
497
|
# action.
|
|
498
|
-
# *
|
|
498
|
+
# * `:source_ids` - (Array<String>) The list of identifiers of the
|
|
499
499
|
# event sources for which events will be returned. If not specified,
|
|
500
500
|
# then all sources are included in the response. An identifier must
|
|
501
501
|
# begin with a letter and must contain only ASCII letters, digits,
|
|
@@ -507,146 +507,146 @@ module AWS
|
|
|
507
507
|
# source type is a DB parameter group, a DBParameterGroupName must be
|
|
508
508
|
# supplied. If the source type is a DB Snapshot, a
|
|
509
509
|
# DBSnapshotIdentifier must be supplied.
|
|
510
|
-
# *
|
|
511
|
-
# the subscription, set to
|
|
510
|
+
# * `:enabled` - (Boolean) A Boolean value; set to `true` to activate
|
|
511
|
+
# the subscription, set to `false` to create the subscription but not
|
|
512
512
|
# active it.
|
|
513
513
|
# @return [Core::Response]
|
|
514
514
|
# The #data method of the response object returns
|
|
515
515
|
# a hash with the following structure:
|
|
516
|
-
# *
|
|
517
|
-
# *
|
|
518
|
-
# *
|
|
519
|
-
# *
|
|
520
|
-
# *
|
|
521
|
-
# *
|
|
522
|
-
# *
|
|
523
|
-
# *
|
|
524
|
-
# *
|
|
516
|
+
# * `:customer_aws_id` - (String)
|
|
517
|
+
# * `:cust_subscription_id` - (String)
|
|
518
|
+
# * `:sns_topic_arn` - (String)
|
|
519
|
+
# * `:status` - (String)
|
|
520
|
+
# * `:subscription_creation_time` - (String)
|
|
521
|
+
# * `:source_type` - (String)
|
|
522
|
+
# * `:source_ids_list` - (Array<String>)
|
|
523
|
+
# * `:event_categories_list` - (Array<String>)
|
|
524
|
+
# * `:enabled` - (Boolean)
|
|
525
525
|
|
|
526
526
|
# @!method create_option_group(options = {})
|
|
527
527
|
# Calls the CreateOptionGroup API operation.
|
|
528
528
|
# @param [Hash] options
|
|
529
|
-
# *
|
|
529
|
+
# * `:option_group_name` - *required* - (String) Specifies the name of
|
|
530
530
|
# the option group to be created. Constraints: Must be 1 to 255
|
|
531
531
|
# alphanumeric characters or hyphens First character must be a letter
|
|
532
532
|
# Cannot end with a hyphen or contain two consecutive hyphens
|
|
533
533
|
# Example: myOptiongroup
|
|
534
|
-
# *
|
|
534
|
+
# * `:engine_name` - *required* - (String) Specifies the name of the
|
|
535
535
|
# engine that this option group should be associated with.
|
|
536
|
-
# *
|
|
536
|
+
# * `:major_engine_version` - *required* - (String) Specifies the major
|
|
537
537
|
# version of the engine that this option group should be associated
|
|
538
538
|
# with.
|
|
539
|
-
# *
|
|
539
|
+
# * `:option_group_description` - *required* - (String) The description
|
|
540
540
|
# of the option group.
|
|
541
541
|
# @return [Core::Response]
|
|
542
542
|
# The #data method of the response object returns
|
|
543
543
|
# a hash with the following structure:
|
|
544
|
-
# *
|
|
545
|
-
# *
|
|
546
|
-
# *
|
|
547
|
-
# *
|
|
548
|
-
# *
|
|
549
|
-
# *
|
|
550
|
-
# *
|
|
551
|
-
# *
|
|
552
|
-
# *
|
|
553
|
-
# *
|
|
554
|
-
# *
|
|
555
|
-
# *
|
|
556
|
-
# *
|
|
557
|
-
# *
|
|
558
|
-
# *
|
|
559
|
-
# *
|
|
560
|
-
# *
|
|
561
|
-
# *
|
|
562
|
-
# *
|
|
563
|
-
# *
|
|
564
|
-
# *
|
|
565
|
-
# *
|
|
566
|
-
# *
|
|
567
|
-
# *
|
|
568
|
-
# *
|
|
569
|
-
# *
|
|
570
|
-
# *
|
|
544
|
+
# * `:option_group_name` - (String)
|
|
545
|
+
# * `:option_group_description` - (String)
|
|
546
|
+
# * `:engine_name` - (String)
|
|
547
|
+
# * `:major_engine_version` - (String)
|
|
548
|
+
# * `:options` - (Array<Hash>)
|
|
549
|
+
# * `:option_name` - (String)
|
|
550
|
+
# * `:option_description` - (String)
|
|
551
|
+
# * `:persistent` - (Boolean)
|
|
552
|
+
# * `:port` - (Integer)
|
|
553
|
+
# * `:option_settings` - (Array<Hash>)
|
|
554
|
+
# * `:name` - (String)
|
|
555
|
+
# * `:value` - (String)
|
|
556
|
+
# * `:default_value` - (String)
|
|
557
|
+
# * `:description` - (String)
|
|
558
|
+
# * `:apply_type` - (String)
|
|
559
|
+
# * `:data_type` - (String)
|
|
560
|
+
# * `:allowed_values` - (String)
|
|
561
|
+
# * `:is_modifiable` - (Boolean)
|
|
562
|
+
# * `:is_collection` - (Boolean)
|
|
563
|
+
# * `:db_security_group_memberships` - (Array<Hash>)
|
|
564
|
+
# * `:db_security_group_name` - (String)
|
|
565
|
+
# * `:status` - (String)
|
|
566
|
+
# * `:vpc_security_group_memberships` - (Array<Hash>)
|
|
567
|
+
# * `:vpc_security_group_id` - (String)
|
|
568
|
+
# * `:status` - (String)
|
|
569
|
+
# * `:allows_vpc_and_non_vpc_instance_memberships` - (Boolean)
|
|
570
|
+
# * `:vpc_id` - (String)
|
|
571
571
|
|
|
572
572
|
# @!method delete_db_instance(options = {})
|
|
573
573
|
# Calls the DeleteDBInstance API operation.
|
|
574
574
|
# @param [Hash] options
|
|
575
|
-
# *
|
|
575
|
+
# * `:db_instance_identifier` - *required* - (String) The DB Instance
|
|
576
576
|
# identifier for the DB Instance to be deleted. This parameter isn't
|
|
577
577
|
# case sensitive.
|
|
578
|
-
# *
|
|
579
|
-
# *
|
|
578
|
+
# * `:skip_final_snapshot` - (Boolean)
|
|
579
|
+
# * `:final_db_snapshot_identifier` - (String) Determines whether a
|
|
580
580
|
# final DB Snapshot is created before the DB Instance is deleted. If
|
|
581
|
-
#
|
|
581
|
+
# `true` , no DBSnapshot is created. If `false` , a DB Snapshot is
|
|
582
582
|
# created before the DB Instance is deleted.
|
|
583
583
|
# @return [Core::Response]
|
|
584
584
|
# The #data method of the response object returns
|
|
585
585
|
# a hash with the following structure:
|
|
586
|
-
# *
|
|
587
|
-
# *
|
|
588
|
-
# *
|
|
589
|
-
# *
|
|
590
|
-
# *
|
|
591
|
-
# *
|
|
592
|
-
# *
|
|
593
|
-
# *
|
|
594
|
-
# *
|
|
595
|
-
# *
|
|
596
|
-
# *
|
|
597
|
-
# *
|
|
598
|
-
# *
|
|
599
|
-
# *
|
|
600
|
-
# *
|
|
601
|
-
# *
|
|
602
|
-
# *
|
|
603
|
-
# *
|
|
604
|
-
# *
|
|
605
|
-
# *
|
|
606
|
-
# *
|
|
607
|
-
# *
|
|
608
|
-
# *
|
|
609
|
-
# *
|
|
610
|
-
# *
|
|
611
|
-
# *
|
|
612
|
-
# *
|
|
613
|
-
# *
|
|
614
|
-
# *
|
|
615
|
-
# *
|
|
616
|
-
# *
|
|
617
|
-
# *
|
|
618
|
-
# *
|
|
619
|
-
# *
|
|
620
|
-
# *
|
|
621
|
-
# *
|
|
622
|
-
# *
|
|
623
|
-
# *
|
|
624
|
-
# *
|
|
625
|
-
# *
|
|
626
|
-
# *
|
|
627
|
-
# *
|
|
628
|
-
# *
|
|
629
|
-
# *
|
|
630
|
-
# *
|
|
631
|
-
# *
|
|
632
|
-
# *
|
|
633
|
-
# *
|
|
634
|
-
# *
|
|
635
|
-
# *
|
|
636
|
-
# *
|
|
637
|
-
# *
|
|
638
|
-
# *
|
|
639
|
-
# *
|
|
640
|
-
# *
|
|
641
|
-
# *
|
|
642
|
-
# *
|
|
643
|
-
# *
|
|
644
|
-
# *
|
|
586
|
+
# * `:db_instance_identifier` - (String)
|
|
587
|
+
# * `:db_instance_class` - (String)
|
|
588
|
+
# * `:engine` - (String)
|
|
589
|
+
# * `:db_instance_status` - (String)
|
|
590
|
+
# * `:master_username` - (String)
|
|
591
|
+
# * `:db_name` - (String)
|
|
592
|
+
# * `:endpoint` - (Hash)
|
|
593
|
+
# * `:address` - (String)
|
|
594
|
+
# * `:port` - (Integer)
|
|
595
|
+
# * `:allocated_storage` - (Integer)
|
|
596
|
+
# * `:instance_create_time` - (Time)
|
|
597
|
+
# * `:preferred_backup_window` - (String)
|
|
598
|
+
# * `:backup_retention_period` - (Integer)
|
|
599
|
+
# * `:db_security_groups` - (Array<Hash>)
|
|
600
|
+
# * `:db_security_group_name` - (String)
|
|
601
|
+
# * `:status` - (String)
|
|
602
|
+
# * `:vpc_security_groups` - (Array<Hash>)
|
|
603
|
+
# * `:vpc_security_group_id` - (String)
|
|
604
|
+
# * `:status` - (String)
|
|
605
|
+
# * `:db_parameter_groups` - (Array<Hash>)
|
|
606
|
+
# * `:db_parameter_group_name` - (String)
|
|
607
|
+
# * `:parameter_apply_status` - (String)
|
|
608
|
+
# * `:availability_zone` - (String)
|
|
609
|
+
# * `:db_subnet_group` - (Hash)
|
|
610
|
+
# * `:db_subnet_group_name` - (String)
|
|
611
|
+
# * `:db_subnet_group_description` - (String)
|
|
612
|
+
# * `:vpc_id` - (String)
|
|
613
|
+
# * `:subnet_group_status` - (String)
|
|
614
|
+
# * `:subnets` - (Array<Hash>)
|
|
615
|
+
# * `:subnet_identifier` - (String)
|
|
616
|
+
# * `:subnet_availability_zone` - (Hash)
|
|
617
|
+
# * `:name` - (String)
|
|
618
|
+
# * `:provisioned_iops_capable` - (Boolean)
|
|
619
|
+
# * `:subnet_status` - (String)
|
|
620
|
+
# * `:preferred_maintenance_window` - (String)
|
|
621
|
+
# * `:pending_modified_values` - (Hash)
|
|
622
|
+
# * `:db_instance_class` - (String)
|
|
623
|
+
# * `:allocated_storage` - (Integer)
|
|
624
|
+
# * `:master_user_password` - (String)
|
|
625
|
+
# * `:port` - (Integer)
|
|
626
|
+
# * `:backup_retention_period` - (Integer)
|
|
627
|
+
# * `:multi_az` - (Boolean)
|
|
628
|
+
# * `:engine_version` - (String)
|
|
629
|
+
# * `:iops` - (Integer)
|
|
630
|
+
# * `:db_instance_identifier` - (String)
|
|
631
|
+
# * `:latest_restorable_time` - (Time)
|
|
632
|
+
# * `:multi_az` - (Boolean)
|
|
633
|
+
# * `:engine_version` - (String)
|
|
634
|
+
# * `:auto_minor_version_upgrade` - (Boolean)
|
|
635
|
+
# * `:read_replica_source_db_instance_identifier` - (String)
|
|
636
|
+
# * `:read_replica_db_instance_identifiers` - (Array<String>)
|
|
637
|
+
# * `:license_model` - (String)
|
|
638
|
+
# * `:iops` - (Integer)
|
|
639
|
+
# * `:option_group_memberships` - (Array<Hash>)
|
|
640
|
+
# * `:option_group_name` - (String)
|
|
641
|
+
# * `:status` - (String)
|
|
642
|
+
# * `:character_set_name` - (String)
|
|
643
|
+
# * `:secondary_availability_zone` - (String)
|
|
644
|
+
# * `:publicly_accessible` - (Boolean)
|
|
645
645
|
|
|
646
646
|
# @!method delete_db_parameter_group(options = {})
|
|
647
647
|
# Calls the DeleteDBParameterGroup API operation.
|
|
648
648
|
# @param [Hash] options
|
|
649
|
-
# *
|
|
649
|
+
# * `:db_parameter_group_name` - *required* - (String) The name of the
|
|
650
650
|
# DB Parameter Group. The specified database security group must not
|
|
651
651
|
# be associated with any DB instances.
|
|
652
652
|
# @return [Core::Response]
|
|
@@ -654,39 +654,39 @@ module AWS
|
|
|
654
654
|
# @!method delete_db_security_group(options = {})
|
|
655
655
|
# Calls the DeleteDBSecurityGroup API operation.
|
|
656
656
|
# @param [Hash] options
|
|
657
|
-
# *
|
|
657
|
+
# * `:db_security_group_name` - *required* - (String) The name of the
|
|
658
658
|
# database security group to delete.
|
|
659
659
|
# @return [Core::Response]
|
|
660
660
|
|
|
661
661
|
# @!method delete_db_snapshot(options = {})
|
|
662
662
|
# Calls the DeleteDBSnapshot API operation.
|
|
663
663
|
# @param [Hash] options
|
|
664
|
-
# *
|
|
664
|
+
# * `:db_snapshot_identifier` - *required* - (String) The DBSnapshot
|
|
665
665
|
# identifier.
|
|
666
666
|
# @return [Core::Response]
|
|
667
667
|
# The #data method of the response object returns
|
|
668
668
|
# a hash with the following structure:
|
|
669
|
-
# *
|
|
670
|
-
# *
|
|
671
|
-
# *
|
|
672
|
-
# *
|
|
673
|
-
# *
|
|
674
|
-
# *
|
|
675
|
-
# *
|
|
676
|
-
# *
|
|
677
|
-
# *
|
|
678
|
-
# *
|
|
679
|
-
# *
|
|
680
|
-
# *
|
|
681
|
-
# *
|
|
682
|
-
# *
|
|
683
|
-
# *
|
|
684
|
-
# *
|
|
669
|
+
# * `:db_snapshot_identifier` - (String)
|
|
670
|
+
# * `:db_instance_identifier` - (String)
|
|
671
|
+
# * `:snapshot_create_time` - (Time)
|
|
672
|
+
# * `:engine` - (String)
|
|
673
|
+
# * `:allocated_storage` - (Integer)
|
|
674
|
+
# * `:status` - (String)
|
|
675
|
+
# * `:port` - (Integer)
|
|
676
|
+
# * `:availability_zone` - (String)
|
|
677
|
+
# * `:vpc_id` - (String)
|
|
678
|
+
# * `:instance_create_time` - (Time)
|
|
679
|
+
# * `:master_username` - (String)
|
|
680
|
+
# * `:engine_version` - (String)
|
|
681
|
+
# * `:license_model` - (String)
|
|
682
|
+
# * `:snapshot_type` - (String)
|
|
683
|
+
# * `:iops` - (Integer)
|
|
684
|
+
# * `:option_group_name` - (String)
|
|
685
685
|
|
|
686
686
|
# @!method delete_db_subnet_group(options = {})
|
|
687
687
|
# Calls the DeleteDBSubnetGroup API operation.
|
|
688
688
|
# @param [Hash] options
|
|
689
|
-
# *
|
|
689
|
+
# * `:db_subnet_group_name` - *required* - (String) The name of the
|
|
690
690
|
# database subnet group to delete. You cannot delete the default
|
|
691
691
|
# subnet group. Constraints: Must be 1 to 255 alphanumeric characters
|
|
692
692
|
# First character must be a letter Cannot end with a hyphen or
|
|
@@ -696,48 +696,48 @@ module AWS
|
|
|
696
696
|
# @!method delete_event_subscription(options = {})
|
|
697
697
|
# Calls the DeleteEventSubscription API operation.
|
|
698
698
|
# @param [Hash] options
|
|
699
|
-
# *
|
|
699
|
+
# * `:subscription_name` - *required* - (String) The name of the RDS
|
|
700
700
|
# event notification subscription you want to delete.
|
|
701
701
|
# @return [Core::Response]
|
|
702
702
|
# The #data method of the response object returns
|
|
703
703
|
# a hash with the following structure:
|
|
704
|
-
# *
|
|
705
|
-
# *
|
|
706
|
-
# *
|
|
707
|
-
# *
|
|
708
|
-
# *
|
|
709
|
-
# *
|
|
710
|
-
# *
|
|
711
|
-
# *
|
|
712
|
-
# *
|
|
704
|
+
# * `:customer_aws_id` - (String)
|
|
705
|
+
# * `:cust_subscription_id` - (String)
|
|
706
|
+
# * `:sns_topic_arn` - (String)
|
|
707
|
+
# * `:status` - (String)
|
|
708
|
+
# * `:subscription_creation_time` - (String)
|
|
709
|
+
# * `:source_type` - (String)
|
|
710
|
+
# * `:source_ids_list` - (Array<String>)
|
|
711
|
+
# * `:event_categories_list` - (Array<String>)
|
|
712
|
+
# * `:enabled` - (Boolean)
|
|
713
713
|
|
|
714
714
|
# @!method delete_option_group(options = {})
|
|
715
715
|
# Calls the DeleteOptionGroup API operation.
|
|
716
716
|
# @param [Hash] options
|
|
717
|
-
# *
|
|
717
|
+
# * `:option_group_name` - *required* - (String) The name of the option
|
|
718
718
|
# group to be deleted. You cannot delete default Option Groups.
|
|
719
719
|
# @return [Core::Response]
|
|
720
720
|
|
|
721
721
|
# @!method describe_db_engine_versions(options = {})
|
|
722
722
|
# Calls the DescribeDBEngineVersions API operation.
|
|
723
723
|
# @param [Hash] options
|
|
724
|
-
# *
|
|
725
|
-
# *
|
|
726
|
-
# *
|
|
724
|
+
# * `:engine` - (String) The database engine to return.
|
|
725
|
+
# * `:engine_version` - (String) The database engine version to return.
|
|
726
|
+
# * `:db_parameter_group_family` - (String) The name of a specific
|
|
727
727
|
# database parameter group family to return details for. Constraints:
|
|
728
728
|
# Must be 1 to 255 alphanumeric characters First character must be a
|
|
729
729
|
# letter Cannot end with a hyphen or contain two consecutive hyphens
|
|
730
|
-
# *
|
|
730
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
|
731
731
|
# in the response. If more than the MaxRecords value is available, a
|
|
732
732
|
# marker is included in the response so that the following results
|
|
733
733
|
# can be retrieved. Default: 100 Constraints: minimum 20, maximum 100
|
|
734
|
-
# *
|
|
734
|
+
# * `:marker` - (String) The marker provided in the previous request.
|
|
735
735
|
# If this parameter is specified, the response includes records
|
|
736
736
|
# beyond the marker only, up to MaxRecords.
|
|
737
|
-
# *
|
|
737
|
+
# * `:default_only` - (Boolean) Indicates that only the default version
|
|
738
738
|
# of the specified engine or engine and major version combination is
|
|
739
739
|
# returned.
|
|
740
|
-
# *
|
|
740
|
+
# * `:list_supported_character_sets` - (Boolean) If this parameter is
|
|
741
741
|
# specified, and if the requested engine supports the
|
|
742
742
|
# CharacterSetName parameter for CreateDBInstance, the response
|
|
743
743
|
# includes a list of supported character sets for each engine
|
|
@@ -745,735 +745,740 @@ module AWS
|
|
|
745
745
|
# @return [Core::Response]
|
|
746
746
|
# The #data method of the response object returns
|
|
747
747
|
# a hash with the following structure:
|
|
748
|
-
# *
|
|
749
|
-
# *
|
|
750
|
-
# *
|
|
751
|
-
# *
|
|
752
|
-
# *
|
|
753
|
-
# *
|
|
754
|
-
# *
|
|
755
|
-
# *
|
|
756
|
-
# *
|
|
757
|
-
# *
|
|
758
|
-
# *
|
|
759
|
-
# *
|
|
760
|
-
# *
|
|
748
|
+
# * `:marker` - (String)
|
|
749
|
+
# * `:db_engine_versions` - (Array<Hash>)
|
|
750
|
+
# * `:engine` - (String)
|
|
751
|
+
# * `:engine_version` - (String)
|
|
752
|
+
# * `:db_parameter_group_family` - (String)
|
|
753
|
+
# * `:db_engine_description` - (String)
|
|
754
|
+
# * `:db_engine_version_description` - (String)
|
|
755
|
+
# * `:default_character_set` - (Hash)
|
|
756
|
+
# * `:character_set_name` - (String)
|
|
757
|
+
# * `:character_set_description` - (String)
|
|
758
|
+
# * `:supported_character_sets` - (Array<Hash>)
|
|
759
|
+
# * `:character_set_name` - (String)
|
|
760
|
+
# * `:character_set_description` - (String)
|
|
761
761
|
|
|
762
762
|
# @!method describe_db_instances(options = {})
|
|
763
763
|
# Calls the DescribeDBInstances API operation.
|
|
764
764
|
# @param [Hash] options
|
|
765
|
-
# *
|
|
765
|
+
# * `:db_instance_identifier` - (String) The user-supplied instance
|
|
766
766
|
# identifier. If this parameter is specified, information from only
|
|
767
767
|
# the specific DB Instance is returned. This parameter isn't case
|
|
768
768
|
# sensitive.
|
|
769
|
-
# *
|
|
769
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
|
770
770
|
# in the response. If more records exist than the specified
|
|
771
771
|
# MaxRecords value, a marker is included in the response so that the
|
|
772
772
|
# remaining results may be retrieved.
|
|
773
|
-
# *
|
|
773
|
+
# * `:marker` - (String) An optional marker provided in the previous
|
|
774
774
|
# DescribeDBInstances request. If this parameter is specified, the
|
|
775
775
|
# response includes only records beyond the marker, up to the value
|
|
776
776
|
# specified by MaxRecords.
|
|
777
777
|
# @return [Core::Response]
|
|
778
778
|
# The #data method of the response object returns
|
|
779
779
|
# a hash with the following structure:
|
|
780
|
-
# *
|
|
781
|
-
# *
|
|
782
|
-
# *
|
|
783
|
-
# *
|
|
784
|
-
# *
|
|
785
|
-
# *
|
|
786
|
-
# *
|
|
787
|
-
# *
|
|
788
|
-
# *
|
|
789
|
-
# *
|
|
790
|
-
# *
|
|
791
|
-
# *
|
|
792
|
-
# *
|
|
793
|
-
# *
|
|
794
|
-
# *
|
|
795
|
-
# *
|
|
796
|
-
# *
|
|
797
|
-
# *
|
|
798
|
-
# *
|
|
799
|
-
# *
|
|
800
|
-
# *
|
|
801
|
-
# *
|
|
802
|
-
# *
|
|
803
|
-
# *
|
|
804
|
-
# *
|
|
805
|
-
# *
|
|
806
|
-
# *
|
|
807
|
-
# *
|
|
808
|
-
# *
|
|
809
|
-
# *
|
|
810
|
-
# *
|
|
811
|
-
# *
|
|
812
|
-
# *
|
|
813
|
-
# *
|
|
814
|
-
# *
|
|
815
|
-
# *
|
|
816
|
-
# *
|
|
817
|
-
# *
|
|
818
|
-
# *
|
|
819
|
-
# *
|
|
820
|
-
# *
|
|
821
|
-
# *
|
|
822
|
-
# *
|
|
823
|
-
# *
|
|
824
|
-
# *
|
|
825
|
-
# *
|
|
826
|
-
# *
|
|
827
|
-
# *
|
|
828
|
-
# *
|
|
829
|
-
# *
|
|
830
|
-
# *
|
|
831
|
-
# *
|
|
832
|
-
# *
|
|
833
|
-
# *
|
|
834
|
-
# *
|
|
835
|
-
# *
|
|
836
|
-
# *
|
|
837
|
-
# *
|
|
838
|
-
# *
|
|
839
|
-
# *
|
|
840
|
-
# *
|
|
780
|
+
# * `:marker` - (String)
|
|
781
|
+
# * `:db_instances` - (Array<Hash>)
|
|
782
|
+
# * `:db_instance_identifier` - (String)
|
|
783
|
+
# * `:db_instance_class` - (String)
|
|
784
|
+
# * `:engine` - (String)
|
|
785
|
+
# * `:db_instance_status` - (String)
|
|
786
|
+
# * `:master_username` - (String)
|
|
787
|
+
# * `:db_name` - (String)
|
|
788
|
+
# * `:endpoint` - (Hash)
|
|
789
|
+
# * `:address` - (String)
|
|
790
|
+
# * `:port` - (Integer)
|
|
791
|
+
# * `:allocated_storage` - (Integer)
|
|
792
|
+
# * `:instance_create_time` - (Time)
|
|
793
|
+
# * `:preferred_backup_window` - (String)
|
|
794
|
+
# * `:backup_retention_period` - (Integer)
|
|
795
|
+
# * `:db_security_groups` - (Array<Hash>)
|
|
796
|
+
# * `:db_security_group_name` - (String)
|
|
797
|
+
# * `:status` - (String)
|
|
798
|
+
# * `:vpc_security_groups` - (Array<Hash>)
|
|
799
|
+
# * `:vpc_security_group_id` - (String)
|
|
800
|
+
# * `:status` - (String)
|
|
801
|
+
# * `:db_parameter_groups` - (Array<Hash>)
|
|
802
|
+
# * `:db_parameter_group_name` - (String)
|
|
803
|
+
# * `:parameter_apply_status` - (String)
|
|
804
|
+
# * `:availability_zone` - (String)
|
|
805
|
+
# * `:db_subnet_group` - (Hash)
|
|
806
|
+
# * `:db_subnet_group_name` - (String)
|
|
807
|
+
# * `:db_subnet_group_description` - (String)
|
|
808
|
+
# * `:vpc_id` - (String)
|
|
809
|
+
# * `:subnet_group_status` - (String)
|
|
810
|
+
# * `:subnets` - (Array<Hash>)
|
|
811
|
+
# * `:subnet_identifier` - (String)
|
|
812
|
+
# * `:subnet_availability_zone` - (Hash)
|
|
813
|
+
# * `:name` - (String)
|
|
814
|
+
# * `:provisioned_iops_capable` - (Boolean)
|
|
815
|
+
# * `:subnet_status` - (String)
|
|
816
|
+
# * `:preferred_maintenance_window` - (String)
|
|
817
|
+
# * `:pending_modified_values` - (Hash)
|
|
818
|
+
# * `:db_instance_class` - (String)
|
|
819
|
+
# * `:allocated_storage` - (Integer)
|
|
820
|
+
# * `:master_user_password` - (String)
|
|
821
|
+
# * `:port` - (Integer)
|
|
822
|
+
# * `:backup_retention_period` - (Integer)
|
|
823
|
+
# * `:multi_az` - (Boolean)
|
|
824
|
+
# * `:engine_version` - (String)
|
|
825
|
+
# * `:iops` - (Integer)
|
|
826
|
+
# * `:db_instance_identifier` - (String)
|
|
827
|
+
# * `:latest_restorable_time` - (Time)
|
|
828
|
+
# * `:multi_az` - (Boolean)
|
|
829
|
+
# * `:engine_version` - (String)
|
|
830
|
+
# * `:auto_minor_version_upgrade` - (Boolean)
|
|
831
|
+
# * `:read_replica_source_db_instance_identifier` - (String)
|
|
832
|
+
# * `:read_replica_db_instance_identifiers` - (Array<String>)
|
|
833
|
+
# * `:license_model` - (String)
|
|
834
|
+
# * `:iops` - (Integer)
|
|
835
|
+
# * `:option_group_memberships` - (Array<Hash>)
|
|
836
|
+
# * `:option_group_name` - (String)
|
|
837
|
+
# * `:status` - (String)
|
|
838
|
+
# * `:character_set_name` - (String)
|
|
839
|
+
# * `:secondary_availability_zone` - (String)
|
|
840
|
+
# * `:publicly_accessible` - (Boolean)
|
|
841
841
|
|
|
842
842
|
# @!method describe_db_log_files(options = {})
|
|
843
843
|
# Calls the DescribeDBLogFiles API operation.
|
|
844
844
|
# @param [Hash] options
|
|
845
|
-
# *
|
|
845
|
+
# * `:db_instance_identifier` - (String) The customer-assigned name of
|
|
846
846
|
# the DB Instance that contains the log files you want to list.
|
|
847
847
|
# Constraints: Must contain from 1 to 63 alphanumeric characters or
|
|
848
848
|
# hyphens First character must be a letter Cannot end with a hyphen
|
|
849
849
|
# or contain two consecutive hyphens
|
|
850
|
-
# *
|
|
850
|
+
# * `:filename_contains` - (String) Filters the available log files for
|
|
851
851
|
# log file names that contain the specified string.
|
|
852
|
-
# *
|
|
852
|
+
# * `:file_last_written` - (Integer) Filters the available log files
|
|
853
853
|
# for files written since the specified date.
|
|
854
|
-
# *
|
|
854
|
+
# * `:file_size` - (Integer) Filters the available log files for files
|
|
855
855
|
# larger than the specified size.
|
|
856
|
-
# *
|
|
856
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
|
857
857
|
# in the response. If more records exist than the specified
|
|
858
858
|
# MaxRecords value, a pagination token called a marker is included in
|
|
859
859
|
# the response so that the remaining results can be retrieved.
|
|
860
|
-
# *
|
|
860
|
+
# * `:marker` - (String) The pagination token provided in the previous
|
|
861
861
|
# request. If this parameter is specified the response includes only
|
|
862
862
|
# records beyond the marker, up to MaxRecords.
|
|
863
863
|
# @return [Core::Response]
|
|
864
864
|
# The #data method of the response object returns
|
|
865
865
|
# a hash with the following structure:
|
|
866
|
-
# *
|
|
867
|
-
# *
|
|
868
|
-
# *
|
|
869
|
-
# *
|
|
870
|
-
# *
|
|
866
|
+
# * `:describe_db_log_files` - (Array<Hash>)
|
|
867
|
+
# * `:log_file_name` - (String)
|
|
868
|
+
# * `:last_written` - (Integer)
|
|
869
|
+
# * `:size` - (Integer)
|
|
870
|
+
# * `:marker` - (String)
|
|
871
871
|
|
|
872
872
|
# @!method describe_db_parameter_groups(options = {})
|
|
873
873
|
# Calls the DescribeDBParameterGroups API operation.
|
|
874
874
|
# @param [Hash] options
|
|
875
|
-
# *
|
|
875
|
+
# * `:db_parameter_group_name` - (String) The name of a specific
|
|
876
876
|
# database parameter group to return details for.
|
|
877
|
-
# *
|
|
877
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
|
878
878
|
# in the response. If more records exist than the specified
|
|
879
879
|
# MaxRecords value, a marker is included in the response so that the
|
|
880
880
|
# remaining results may be retrieved.
|
|
881
|
-
# *
|
|
881
|
+
# * `:marker` - (String) An optional marker provided in the previous
|
|
882
882
|
# DescribeDBInstances request. If this parameter is specified, the
|
|
883
883
|
# response includes only records beyond the marker, up to the value
|
|
884
884
|
# specified by MaxRecords.
|
|
885
885
|
# @return [Core::Response]
|
|
886
886
|
# The #data method of the response object returns
|
|
887
887
|
# a hash with the following structure:
|
|
888
|
-
# *
|
|
889
|
-
# *
|
|
890
|
-
# *
|
|
891
|
-
# *
|
|
892
|
-
# *
|
|
888
|
+
# * `:marker` - (String)
|
|
889
|
+
# * `:db_parameter_groups` - (Array<Hash>)
|
|
890
|
+
# * `:db_parameter_group_name` - (String)
|
|
891
|
+
# * `:db_parameter_group_family` - (String)
|
|
892
|
+
# * `:description` - (String)
|
|
893
893
|
|
|
894
894
|
# @!method describe_db_parameters(options = {})
|
|
895
895
|
# Calls the DescribeDBParameters API operation.
|
|
896
896
|
# @param [Hash] options
|
|
897
|
-
# *
|
|
897
|
+
# * `:db_parameter_group_name` - *required* - (String) The name of a
|
|
898
898
|
# specific database parameter group to return details for.
|
|
899
|
-
# *
|
|
900
|
-
# *
|
|
899
|
+
# * `:source` - (String) The parameter types to return.
|
|
900
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
|
901
901
|
# in the response. If more records exist than the specified
|
|
902
902
|
# MaxRecords value, a marker is included in the response so that the
|
|
903
903
|
# remaining results may be retrieved.
|
|
904
|
-
# *
|
|
904
|
+
# * `:marker` - (String) An optional marker provided in the previous
|
|
905
905
|
# DescribeDBInstances request. If this parameter is specified, the
|
|
906
906
|
# response includes only records beyond the marker, up to the value
|
|
907
907
|
# specified by MaxRecords.
|
|
908
908
|
# @return [Core::Response]
|
|
909
909
|
# The #data method of the response object returns
|
|
910
910
|
# a hash with the following structure:
|
|
911
|
-
# *
|
|
912
|
-
# *
|
|
913
|
-
# *
|
|
914
|
-
# *
|
|
915
|
-
# *
|
|
916
|
-
# *
|
|
917
|
-
# *
|
|
918
|
-
# *
|
|
919
|
-
# *
|
|
920
|
-
# *
|
|
921
|
-
# *
|
|
922
|
-
# *
|
|
911
|
+
# * `:parameters` - (Array<Hash>)
|
|
912
|
+
# * `:parameter_name` - (String)
|
|
913
|
+
# * `:parameter_value` - (String)
|
|
914
|
+
# * `:description` - (String)
|
|
915
|
+
# * `:source` - (String)
|
|
916
|
+
# * `:apply_type` - (String)
|
|
917
|
+
# * `:data_type` - (String)
|
|
918
|
+
# * `:allowed_values` - (String)
|
|
919
|
+
# * `:is_modifiable` - (Boolean)
|
|
920
|
+
# * `:minimum_engine_version` - (String)
|
|
921
|
+
# * `:apply_method` - (String)
|
|
922
|
+
# * `:marker` - (String)
|
|
923
923
|
|
|
924
924
|
# @!method describe_db_security_groups(options = {})
|
|
925
925
|
# Calls the DescribeDBSecurityGroups API operation.
|
|
926
926
|
# @param [Hash] options
|
|
927
|
-
# *
|
|
927
|
+
# * `:db_security_group_name` - (String) The name of the DB Security
|
|
928
928
|
# Group to return details for.
|
|
929
|
-
# *
|
|
929
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
|
930
930
|
# in the response. If more records exist than the specified
|
|
931
931
|
# MaxRecords value, a marker is included in the response so that the
|
|
932
932
|
# remaining results may be retrieved.
|
|
933
|
-
# *
|
|
933
|
+
# * `:marker` - (String) An optional marker provided in the previous
|
|
934
934
|
# DescribeDBInstances request. If this parameter is specified, the
|
|
935
935
|
# response includes only records beyond the marker, up to the value
|
|
936
936
|
# specified by MaxRecords.
|
|
937
937
|
# @return [Core::Response]
|
|
938
938
|
# The #data method of the response object returns
|
|
939
939
|
# a hash with the following structure:
|
|
940
|
-
# *
|
|
941
|
-
# *
|
|
942
|
-
# *
|
|
943
|
-
# *
|
|
944
|
-
# *
|
|
945
|
-
# *
|
|
946
|
-
# *
|
|
947
|
-
# *
|
|
948
|
-
# *
|
|
949
|
-
# *
|
|
950
|
-
# *
|
|
951
|
-
# *
|
|
952
|
-
# *
|
|
953
|
-
# *
|
|
940
|
+
# * `:marker` - (String)
|
|
941
|
+
# * `:db_security_groups` - (Array<Hash>)
|
|
942
|
+
# * `:owner_id` - (String)
|
|
943
|
+
# * `:db_security_group_name` - (String)
|
|
944
|
+
# * `:db_security_group_description` - (String)
|
|
945
|
+
# * `:vpc_id` - (String)
|
|
946
|
+
# * `:ec_2_security_groups` - (Array<Hash>)
|
|
947
|
+
# * `:status` - (String)
|
|
948
|
+
# * `:ec2_security_group_name` - (String)
|
|
949
|
+
# * `:ec2_security_group_id` - (String)
|
|
950
|
+
# * `:ec2_security_group_owner_id` - (String)
|
|
951
|
+
# * `:ip_ranges` - (Array<Hash>)
|
|
952
|
+
# * `:status` - (String)
|
|
953
|
+
# * `:cidrip` - (String)
|
|
954
954
|
|
|
955
955
|
# @!method describe_db_snapshots(options = {})
|
|
956
956
|
# Calls the DescribeDBSnapshots API operation.
|
|
957
957
|
# @param [Hash] options
|
|
958
|
-
# *
|
|
958
|
+
# * `:db_instance_identifier` - (String) The unique identifier for the
|
|
959
959
|
# Amazon RDS DB snapshot. This value is stored as a lowercase string.
|
|
960
|
-
# *
|
|
960
|
+
# * `:db_snapshot_identifier` - (String) The DB Instance identifier.
|
|
961
961
|
# This parameter isn't case sensitive.
|
|
962
|
-
# *
|
|
962
|
+
# * `:snapshot_type` - (String) An optional snapshot type for which
|
|
963
963
|
# snapshots will be returned. If not specified, the returned results
|
|
964
964
|
# will include snapshots of all types.
|
|
965
|
-
# *
|
|
965
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
|
966
966
|
# in the response. If more records exist than the specified
|
|
967
967
|
# MaxRecords value, a marker is included in the response so that the
|
|
968
968
|
# remaining results may be retrieved.
|
|
969
|
-
# *
|
|
969
|
+
# * `:marker` - (String) An optional marker provided in the previous
|
|
970
970
|
# DescribeDBInstances request. If this parameter is specified, the
|
|
971
971
|
# response includes only records beyond the marker, up to the value
|
|
972
972
|
# specified by MaxRecords.
|
|
973
973
|
# @return [Core::Response]
|
|
974
974
|
# The #data method of the response object returns
|
|
975
975
|
# a hash with the following structure:
|
|
976
|
-
# *
|
|
977
|
-
# *
|
|
978
|
-
# *
|
|
979
|
-
# *
|
|
980
|
-
# *
|
|
981
|
-
# *
|
|
982
|
-
# *
|
|
983
|
-
# *
|
|
984
|
-
# *
|
|
985
|
-
# *
|
|
986
|
-
# *
|
|
987
|
-
# *
|
|
988
|
-
# *
|
|
989
|
-
# *
|
|
990
|
-
# *
|
|
991
|
-
# *
|
|
992
|
-
# *
|
|
993
|
-
# *
|
|
976
|
+
# * `:marker` - (String)
|
|
977
|
+
# * `:db_snapshots` - (Array<Hash>)
|
|
978
|
+
# * `:db_snapshot_identifier` - (String)
|
|
979
|
+
# * `:db_instance_identifier` - (String)
|
|
980
|
+
# * `:snapshot_create_time` - (Time)
|
|
981
|
+
# * `:engine` - (String)
|
|
982
|
+
# * `:allocated_storage` - (Integer)
|
|
983
|
+
# * `:status` - (String)
|
|
984
|
+
# * `:port` - (Integer)
|
|
985
|
+
# * `:availability_zone` - (String)
|
|
986
|
+
# * `:vpc_id` - (String)
|
|
987
|
+
# * `:instance_create_time` - (Time)
|
|
988
|
+
# * `:master_username` - (String)
|
|
989
|
+
# * `:engine_version` - (String)
|
|
990
|
+
# * `:license_model` - (String)
|
|
991
|
+
# * `:snapshot_type` - (String)
|
|
992
|
+
# * `:iops` - (Integer)
|
|
993
|
+
# * `:option_group_name` - (String)
|
|
994
994
|
|
|
995
995
|
# @!method describe_db_subnet_groups(options = {})
|
|
996
996
|
# Calls the DescribeDBSubnetGroups API operation.
|
|
997
997
|
# @param [Hash] options
|
|
998
|
-
# *
|
|
998
|
+
# * `:db_subnet_group_name` - (String) The name of the DB Subnet Group
|
|
999
999
|
# to return details for.
|
|
1000
|
-
# *
|
|
1000
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
|
1001
1001
|
# in the response. If more records exist than the specified
|
|
1002
1002
|
# MaxRecords value, a marker is included in the response so that the
|
|
1003
1003
|
# remaining results may be retrieved. Default: 100 Constraints:
|
|
1004
1004
|
# minimum 20, maximum 100
|
|
1005
|
-
# *
|
|
1005
|
+
# * `:marker` - (String) An optional marker provided in the previous
|
|
1006
1006
|
# DescribeDBSubnetGroups request. If this parameter is specified, the
|
|
1007
1007
|
# response includes only records beyond the marker, up to the value
|
|
1008
1008
|
# specified by MaxRecords.
|
|
1009
1009
|
# @return [Core::Response]
|
|
1010
1010
|
# The #data method of the response object returns
|
|
1011
1011
|
# a hash with the following structure:
|
|
1012
|
-
# *
|
|
1013
|
-
# *
|
|
1014
|
-
# *
|
|
1015
|
-
# *
|
|
1016
|
-
# *
|
|
1017
|
-
# *
|
|
1018
|
-
# *
|
|
1019
|
-
# *
|
|
1020
|
-
# *
|
|
1021
|
-
# *
|
|
1022
|
-
# *
|
|
1023
|
-
# *
|
|
1012
|
+
# * `:marker` - (String)
|
|
1013
|
+
# * `:db_subnet_groups` - (Array<Hash>)
|
|
1014
|
+
# * `:db_subnet_group_name` - (String)
|
|
1015
|
+
# * `:db_subnet_group_description` - (String)
|
|
1016
|
+
# * `:vpc_id` - (String)
|
|
1017
|
+
# * `:subnet_group_status` - (String)
|
|
1018
|
+
# * `:subnets` - (Array<Hash>)
|
|
1019
|
+
# * `:subnet_identifier` - (String)
|
|
1020
|
+
# * `:subnet_availability_zone` - (Hash)
|
|
1021
|
+
# * `:name` - (String)
|
|
1022
|
+
# * `:provisioned_iops_capable` - (Boolean)
|
|
1023
|
+
# * `:subnet_status` - (String)
|
|
1024
1024
|
|
|
1025
1025
|
# @!method describe_engine_default_parameters(options = {})
|
|
1026
1026
|
# Calls the DescribeEngineDefaultParameters API operation.
|
|
1027
1027
|
# @param [Hash] options
|
|
1028
|
-
# *
|
|
1028
|
+
# * `:db_parameter_group_family` - *required* - (String) The name of
|
|
1029
1029
|
# the DB Parameter Group Family.
|
|
1030
|
-
# *
|
|
1030
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
|
1031
1031
|
# in the response. If more records exist than the specified
|
|
1032
1032
|
# MaxRecords value, a marker is included in the response so that the
|
|
1033
1033
|
# remaining results may be retrieved.
|
|
1034
|
-
# *
|
|
1034
|
+
# * `:marker` - (String) An optional marker provided in the previous
|
|
1035
1035
|
# DescribeDBInstances request. If this parameter is specified, the
|
|
1036
1036
|
# response includes only records beyond the marker, up to the value
|
|
1037
1037
|
# specified by MaxRecords.
|
|
1038
1038
|
# @return [Core::Response]
|
|
1039
1039
|
# The #data method of the response object returns
|
|
1040
1040
|
# a hash with the following structure:
|
|
1041
|
-
# *
|
|
1042
|
-
# *
|
|
1043
|
-
# *
|
|
1044
|
-
# *
|
|
1045
|
-
# *
|
|
1046
|
-
# *
|
|
1047
|
-
# *
|
|
1048
|
-
# *
|
|
1049
|
-
# *
|
|
1050
|
-
# *
|
|
1051
|
-
# *
|
|
1052
|
-
# *
|
|
1053
|
-
# *
|
|
1041
|
+
# * `:db_parameter_group_family` - (String)
|
|
1042
|
+
# * `:marker` - (String)
|
|
1043
|
+
# * `:parameters` - (Array<Hash>)
|
|
1044
|
+
# * `:parameter_name` - (String)
|
|
1045
|
+
# * `:parameter_value` - (String)
|
|
1046
|
+
# * `:description` - (String)
|
|
1047
|
+
# * `:source` - (String)
|
|
1048
|
+
# * `:apply_type` - (String)
|
|
1049
|
+
# * `:data_type` - (String)
|
|
1050
|
+
# * `:allowed_values` - (String)
|
|
1051
|
+
# * `:is_modifiable` - (Boolean)
|
|
1052
|
+
# * `:minimum_engine_version` - (String)
|
|
1053
|
+
# * `:apply_method` - (String)
|
|
1054
1054
|
|
|
1055
1055
|
# @!method describe_event_categories(options = {})
|
|
1056
1056
|
# Calls the DescribeEventCategories API operation.
|
|
1057
1057
|
# @param [Hash] options
|
|
1058
|
-
# *
|
|
1058
|
+
# * `:source_type` - (String) The type of source that will be
|
|
1059
1059
|
# generating the events. Valid values: db-instance |
|
|
1060
1060
|
# db-parameter-group | db-security-group | db-snapshot
|
|
1061
1061
|
# @return [Core::Response]
|
|
1062
1062
|
# The #data method of the response object returns
|
|
1063
1063
|
# a hash with the following structure:
|
|
1064
|
-
# *
|
|
1065
|
-
# *
|
|
1066
|
-
# *
|
|
1064
|
+
# * `:event_categories_map_list` - (Array<Hash>)
|
|
1065
|
+
# * `:source_type` - (String)
|
|
1066
|
+
# * `:event_categories` - (Array<String>)
|
|
1067
1067
|
|
|
1068
1068
|
# @!method describe_event_subscriptions(options = {})
|
|
1069
1069
|
# Calls the DescribeEventSubscriptions API operation.
|
|
1070
1070
|
# @param [Hash] options
|
|
1071
|
-
# *
|
|
1071
|
+
# * `:subscription_name` - (String) The name of the RDS event
|
|
1072
1072
|
# notification subscription you want to describe.
|
|
1073
|
-
# *
|
|
1073
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
|
1074
1074
|
# in the response. If more records exist than the specified
|
|
1075
1075
|
# MaxRecords value, a pagination token called a marker is included in
|
|
1076
1076
|
# the response so that the remaining results can be retrieved.
|
|
1077
1077
|
# Default: 100 Constraints: minimum 20, maximum 100
|
|
1078
|
-
# *
|
|
1078
|
+
# * `:marker` - (String) An optional pagination token provided by a
|
|
1079
1079
|
# previous DescribeOrderableDBInstanceOptions request. If this
|
|
1080
1080
|
# parameter is specified, the response includes only records beyond
|
|
1081
1081
|
# the marker, up to the value specified by MaxRecords .
|
|
1082
1082
|
# @return [Core::Response]
|
|
1083
1083
|
# The #data method of the response object returns
|
|
1084
1084
|
# a hash with the following structure:
|
|
1085
|
-
# *
|
|
1086
|
-
# *
|
|
1087
|
-
# *
|
|
1088
|
-
# *
|
|
1089
|
-
# *
|
|
1090
|
-
# *
|
|
1091
|
-
# *
|
|
1092
|
-
# *
|
|
1093
|
-
# *
|
|
1094
|
-
# *
|
|
1095
|
-
# *
|
|
1085
|
+
# * `:marker` - (String)
|
|
1086
|
+
# * `:event_subscriptions_list` - (Array<Hash>)
|
|
1087
|
+
# * `:customer_aws_id` - (String)
|
|
1088
|
+
# * `:cust_subscription_id` - (String)
|
|
1089
|
+
# * `:sns_topic_arn` - (String)
|
|
1090
|
+
# * `:status` - (String)
|
|
1091
|
+
# * `:subscription_creation_time` - (String)
|
|
1092
|
+
# * `:source_type` - (String)
|
|
1093
|
+
# * `:source_ids_list` - (Array<String>)
|
|
1094
|
+
# * `:event_categories_list` - (Array<String>)
|
|
1095
|
+
# * `:enabled` - (Boolean)
|
|
1096
1096
|
|
|
1097
1097
|
# @!method describe_events(options = {})
|
|
1098
1098
|
# Calls the DescribeEvents API operation.
|
|
1099
1099
|
# @param [Hash] options
|
|
1100
|
-
# *
|
|
1100
|
+
# * `:source_identifier` - (String) The identifier of the event source
|
|
1101
1101
|
# for which events will be returned. If not specified, then all
|
|
1102
1102
|
# sources are included in the response.
|
|
1103
|
-
# *
|
|
1104
|
-
# If no value is specified, all events are returned.
|
|
1105
|
-
#
|
|
1103
|
+
# * `:source_type` - (String) The event source to retrieve events for.
|
|
1104
|
+
# If no value is specified, all events are returned. Valid values
|
|
1105
|
+
# include:
|
|
1106
|
+
# * `db-instance`
|
|
1107
|
+
# * `db-parameter-group`
|
|
1108
|
+
# * `db-security-group`
|
|
1109
|
+
# * `db-snapshot`
|
|
1110
|
+
# * `:start_time` - (String<ISO8601 datetime>) The beginning of the
|
|
1106
1111
|
# time interval to retrieve events for, specified in ISO 8601 format.
|
|
1107
|
-
# *
|
|
1112
|
+
# * `:end_time` - (String<ISO8601 datetime>) The end of the time
|
|
1108
1113
|
# interval for which to retrieve events, specified in ISO 8601
|
|
1109
1114
|
# format.
|
|
1110
|
-
# *
|
|
1115
|
+
# * `:duration` - (Integer) The number of minutes to retrieve events
|
|
1111
1116
|
# for.
|
|
1112
|
-
# *
|
|
1117
|
+
# * `:event_categories` - (Array<String>) A list of event categories
|
|
1113
1118
|
# that trigger notifications for a event notification subscription.
|
|
1114
|
-
# *
|
|
1119
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
|
1115
1120
|
# in the response. If more records exist than the specified
|
|
1116
1121
|
# MaxRecords value, a marker is included in the response so that the
|
|
1117
1122
|
# remaining results may be retrieved.
|
|
1118
|
-
# *
|
|
1123
|
+
# * `:marker` - (String) An optional marker provided in the previous
|
|
1119
1124
|
# DescribeDBInstances request. If this parameter is specified, the
|
|
1120
1125
|
# response includes only records beyond the marker, up to the value
|
|
1121
1126
|
# specified by MaxRecords.
|
|
1122
1127
|
# @return [Core::Response]
|
|
1123
1128
|
# The #data method of the response object returns
|
|
1124
1129
|
# a hash with the following structure:
|
|
1125
|
-
# *
|
|
1126
|
-
# *
|
|
1127
|
-
# *
|
|
1128
|
-
# *
|
|
1129
|
-
# *
|
|
1130
|
-
# *
|
|
1131
|
-
# *
|
|
1130
|
+
# * `:marker` - (String)
|
|
1131
|
+
# * `:events` - (Array<Hash>)
|
|
1132
|
+
# * `:source_identifier` - (String)
|
|
1133
|
+
# * `:source_type` - (String)
|
|
1134
|
+
# * `:message` - (String)
|
|
1135
|
+
# * `:event_categories` - (Array<String>)
|
|
1136
|
+
# * `:date` - (Time)
|
|
1132
1137
|
|
|
1133
1138
|
# @!method describe_option_group_options(options = {})
|
|
1134
1139
|
# Calls the DescribeOptionGroupOptions API operation.
|
|
1135
1140
|
# @param [Hash] options
|
|
1136
|
-
# *
|
|
1141
|
+
# * `:engine_name` - *required* - (String) A required parameter.
|
|
1137
1142
|
# Options available for the given Engine name will be described.
|
|
1138
|
-
# *
|
|
1143
|
+
# * `:major_engine_version` - (String) If specified, filters the
|
|
1139
1144
|
# results to include only options for the specified major engine
|
|
1140
1145
|
# version.
|
|
1141
|
-
# *
|
|
1146
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
|
1142
1147
|
# in the response. If more records exist than the specified
|
|
1143
1148
|
# MaxRecords value, a pagination token called a marker is included in
|
|
1144
1149
|
# the response so that the remaining results can be retrieved.
|
|
1145
1150
|
# Default: 100 Constraints: minimum 20, maximum 100
|
|
1146
|
-
# *
|
|
1151
|
+
# * `:marker` - (String) An optional pagination token provided by a
|
|
1147
1152
|
# previous request. If this parameter is specified, the response
|
|
1148
1153
|
# includes only records beyond the marker, up to the value specified
|
|
1149
1154
|
# by MaxRecords.
|
|
1150
1155
|
# @return [Core::Response]
|
|
1151
1156
|
# The #data method of the response object returns
|
|
1152
1157
|
# a hash with the following structure:
|
|
1153
|
-
# *
|
|
1154
|
-
# *
|
|
1155
|
-
# *
|
|
1156
|
-
# *
|
|
1157
|
-
# *
|
|
1158
|
-
# *
|
|
1159
|
-
# *
|
|
1160
|
-
# *
|
|
1161
|
-
# *
|
|
1162
|
-
# *
|
|
1163
|
-
# *
|
|
1164
|
-
# *
|
|
1165
|
-
# *
|
|
1166
|
-
# *
|
|
1167
|
-
# *
|
|
1168
|
-
# *
|
|
1169
|
-
# *
|
|
1170
|
-
# *
|
|
1158
|
+
# * `:option_group_options` - (Array<Hash>)
|
|
1159
|
+
# * `:name` - (String)
|
|
1160
|
+
# * `:description` - (String)
|
|
1161
|
+
# * `:engine_name` - (String)
|
|
1162
|
+
# * `:major_engine_version` - (String)
|
|
1163
|
+
# * `:minimum_required_minor_engine_version` - (String)
|
|
1164
|
+
# * `:port_required` - (Boolean)
|
|
1165
|
+
# * `:default_port` - (Integer)
|
|
1166
|
+
# * `:options_depended_on` - (Array<String>)
|
|
1167
|
+
# * `:persistent` - (Boolean)
|
|
1168
|
+
# * `:option_group_option_settings` - (Array<Hash>)
|
|
1169
|
+
# * `:setting_name` - (String)
|
|
1170
|
+
# * `:setting_description` - (String)
|
|
1171
|
+
# * `:default_value` - (String)
|
|
1172
|
+
# * `:apply_type` - (String)
|
|
1173
|
+
# * `:allowed_values` - (String)
|
|
1174
|
+
# * `:is_modifiable` - (Boolean)
|
|
1175
|
+
# * `:marker` - (String)
|
|
1171
1176
|
|
|
1172
1177
|
# @!method describe_option_groups(options = {})
|
|
1173
1178
|
# Calls the DescribeOptionGroups API operation.
|
|
1174
1179
|
# @param [Hash] options
|
|
1175
|
-
# *
|
|
1180
|
+
# * `:option_group_name` - (String) The name of the option group to
|
|
1176
1181
|
# describe. Cannot be supplied together with EngineName or
|
|
1177
1182
|
# MajorEngineVersion.
|
|
1178
|
-
# *
|
|
1183
|
+
# * `:marker` - (String) An optional pagination token provided by a
|
|
1179
1184
|
# previous DescribeOptionGroups request. If this parameter is
|
|
1180
1185
|
# specified, the response includes only records beyond the marker, up
|
|
1181
1186
|
# to the value specified by MaxRecords.
|
|
1182
|
-
# *
|
|
1187
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
|
1183
1188
|
# in the response. If more records exist than the specified
|
|
1184
1189
|
# MaxRecords value, a pagination token called a marker is included in
|
|
1185
1190
|
# the response so that the remaining results can be retrieved.
|
|
1186
1191
|
# Default: 100 Constraints: minimum 20, maximum 100
|
|
1187
|
-
# *
|
|
1192
|
+
# * `:engine_name` - (String) Filters the list of option groups to only
|
|
1188
1193
|
# include groups associated with a specific database engine.
|
|
1189
|
-
# *
|
|
1194
|
+
# * `:major_engine_version` - (String) Filters the list of option
|
|
1190
1195
|
# groups to only include groups associated with a specific database
|
|
1191
1196
|
# engine version. If specified, then EngineName must also be
|
|
1192
1197
|
# specified.
|
|
1193
1198
|
# @return [Core::Response]
|
|
1194
1199
|
# The #data method of the response object returns
|
|
1195
1200
|
# a hash with the following structure:
|
|
1196
|
-
# *
|
|
1197
|
-
# *
|
|
1198
|
-
# *
|
|
1199
|
-
# *
|
|
1200
|
-
# *
|
|
1201
|
-
# *
|
|
1202
|
-
# *
|
|
1203
|
-
# *
|
|
1204
|
-
# *
|
|
1205
|
-
# *
|
|
1206
|
-
# *
|
|
1207
|
-
# *
|
|
1208
|
-
# *
|
|
1209
|
-
# *
|
|
1210
|
-
# *
|
|
1211
|
-
# *
|
|
1212
|
-
# *
|
|
1213
|
-
# *
|
|
1214
|
-
# *
|
|
1215
|
-
# *
|
|
1216
|
-
# *
|
|
1217
|
-
# *
|
|
1218
|
-
# *
|
|
1219
|
-
# *
|
|
1220
|
-
# *
|
|
1221
|
-
# *
|
|
1222
|
-
# *
|
|
1223
|
-
# *
|
|
1224
|
-
# *
|
|
1201
|
+
# * `:option_groups_list` - (Array<Hash>)
|
|
1202
|
+
# * `:option_group_name` - (String)
|
|
1203
|
+
# * `:option_group_description` - (String)
|
|
1204
|
+
# * `:engine_name` - (String)
|
|
1205
|
+
# * `:major_engine_version` - (String)
|
|
1206
|
+
# * `:options` - (Array<Hash>)
|
|
1207
|
+
# * `:option_name` - (String)
|
|
1208
|
+
# * `:option_description` - (String)
|
|
1209
|
+
# * `:persistent` - (Boolean)
|
|
1210
|
+
# * `:port` - (Integer)
|
|
1211
|
+
# * `:option_settings` - (Array<Hash>)
|
|
1212
|
+
# * `:name` - (String)
|
|
1213
|
+
# * `:value` - (String)
|
|
1214
|
+
# * `:default_value` - (String)
|
|
1215
|
+
# * `:description` - (String)
|
|
1216
|
+
# * `:apply_type` - (String)
|
|
1217
|
+
# * `:data_type` - (String)
|
|
1218
|
+
# * `:allowed_values` - (String)
|
|
1219
|
+
# * `:is_modifiable` - (Boolean)
|
|
1220
|
+
# * `:is_collection` - (Boolean)
|
|
1221
|
+
# * `:db_security_group_memberships` - (Array<Hash>)
|
|
1222
|
+
# * `:db_security_group_name` - (String)
|
|
1223
|
+
# * `:status` - (String)
|
|
1224
|
+
# * `:vpc_security_group_memberships` - (Array<Hash>)
|
|
1225
|
+
# * `:vpc_security_group_id` - (String)
|
|
1226
|
+
# * `:status` - (String)
|
|
1227
|
+
# * `:allows_vpc_and_non_vpc_instance_memberships` - (Boolean)
|
|
1228
|
+
# * `:vpc_id` - (String)
|
|
1229
|
+
# * `:marker` - (String)
|
|
1225
1230
|
|
|
1226
1231
|
# @!method describe_orderable_db_instance_options(options = {})
|
|
1227
1232
|
# Calls the DescribeOrderableDBInstanceOptions API operation.
|
|
1228
1233
|
# @param [Hash] options
|
|
1229
|
-
# *
|
|
1234
|
+
# * `:engine` - *required* - (String) The name of the engine to
|
|
1230
1235
|
# retrieve DB Instance options for.
|
|
1231
|
-
# *
|
|
1236
|
+
# * `:engine_version` - (String) The engine version filter value.
|
|
1232
1237
|
# Specify this parameter to show only the available offerings
|
|
1233
1238
|
# matching the specified engine version.
|
|
1234
|
-
# *
|
|
1239
|
+
# * `:db_instance_class` - (String) The DB Instance class filter value.
|
|
1235
1240
|
# Specify this parameter to show only the available offerings
|
|
1236
1241
|
# matching the specified DB Instance class.
|
|
1237
|
-
# *
|
|
1242
|
+
# * `:license_model` - (String) The license model filter value. Specify
|
|
1238
1243
|
# this parameter to show only the available offerings matching the
|
|
1239
1244
|
# specified license model.
|
|
1240
|
-
# *
|
|
1245
|
+
# * `:vpc` - (Boolean) The VPC filter value. Specify this parameter to
|
|
1241
1246
|
# show only the available VPC or non-VPC offerings.
|
|
1242
|
-
# *
|
|
1247
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
|
1243
1248
|
# in the response. If more records exist than the specified
|
|
1244
1249
|
# MaxRecords value, a marker is included in the response so that the
|
|
1245
1250
|
# remaining results may be retrieved. Default: 100 Constraints:
|
|
1246
1251
|
# minimum 20, maximum 100
|
|
1247
|
-
# *
|
|
1252
|
+
# * `:marker` - (String) An optional marker provided in the previous
|
|
1248
1253
|
# DescribeOrderableDBInstanceOptions request. If this parameter is
|
|
1249
1254
|
# specified, the response includes only records beyond the marker, up
|
|
1250
1255
|
# to the value specified by MaxRecords .
|
|
1251
1256
|
# @return [Core::Response]
|
|
1252
1257
|
# The #data method of the response object returns
|
|
1253
1258
|
# a hash with the following structure:
|
|
1254
|
-
# *
|
|
1255
|
-
# *
|
|
1256
|
-
# *
|
|
1257
|
-
# *
|
|
1258
|
-
# *
|
|
1259
|
-
# *
|
|
1260
|
-
# *
|
|
1261
|
-
# *
|
|
1262
|
-
# *
|
|
1263
|
-
# *
|
|
1264
|
-
# *
|
|
1265
|
-
# *
|
|
1259
|
+
# * `:orderable_db_instance_options` - (Array<Hash>)
|
|
1260
|
+
# * `:engine` - (String)
|
|
1261
|
+
# * `:engine_version` - (String)
|
|
1262
|
+
# * `:db_instance_class` - (String)
|
|
1263
|
+
# * `:license_model` - (String)
|
|
1264
|
+
# * `:availability_zones` - (Array<Hash>)
|
|
1265
|
+
# * `:name` - (String)
|
|
1266
|
+
# * `:provisioned_iops_capable` - (Boolean)
|
|
1267
|
+
# * `:multi_az_capable` - (Boolean)
|
|
1268
|
+
# * `:read_replica_capable` - (Boolean)
|
|
1269
|
+
# * `:vpc` - (Boolean)
|
|
1270
|
+
# * `:marker` - (String)
|
|
1266
1271
|
|
|
1267
1272
|
# @!method describe_reserved_db_instances(options = {})
|
|
1268
1273
|
# Calls the DescribeReservedDBInstances API operation.
|
|
1269
1274
|
# @param [Hash] options
|
|
1270
|
-
# *
|
|
1275
|
+
# * `:reserved_db_instance_id` - (String) The reserved DB Instance
|
|
1271
1276
|
# identifier filter value. Specify this parameter to show only the
|
|
1272
1277
|
# reservation that matches the specified reservation ID.
|
|
1273
|
-
# *
|
|
1278
|
+
# * `:reserved_db_instances_offering_id` - (String) The offering
|
|
1274
1279
|
# identifier filter value. Specify this parameter to show only
|
|
1275
1280
|
# purchased reservations matching the specified offering identifier.
|
|
1276
|
-
# *
|
|
1281
|
+
# * `:db_instance_class` - (String) The DB Instance class filter value.
|
|
1277
1282
|
# Specify this parameter to show only those reservations matching the
|
|
1278
1283
|
# specified DB Instances class.
|
|
1279
|
-
# *
|
|
1284
|
+
# * `:duration` - (String) The duration filter value, specified in
|
|
1280
1285
|
# years or seconds. Specify this parameter to show only reservations
|
|
1281
1286
|
# for this duration. Valid Values: 1 | 3 | 31536000 | 94608000
|
|
1282
|
-
# *
|
|
1287
|
+
# * `:product_description` - (String) The product description filter
|
|
1283
1288
|
# value. Specify this parameter to show only those reservations
|
|
1284
1289
|
# matching the specified product description.
|
|
1285
|
-
# *
|
|
1290
|
+
# * `:offering_type` - (String) The offering type filter value. Specify
|
|
1286
1291
|
# this parameter to show only the available offerings matching the
|
|
1287
1292
|
# specified offering type. Valid Values: "Light Utilization" |
|
|
1288
1293
|
# "Medium Utilization" | "Heavy Utilization"
|
|
1289
|
-
# *
|
|
1294
|
+
# * `:multi_az` - (Boolean) The Multi-AZ filter value. Specify this
|
|
1290
1295
|
# parameter to show only those reservations matching the specified
|
|
1291
1296
|
# Multi-AZ parameter.
|
|
1292
|
-
# *
|
|
1297
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
|
1293
1298
|
# in the response. If more than the MaxRecords value is available, a
|
|
1294
1299
|
# marker is included in the response so that the following results
|
|
1295
1300
|
# can be retrieved. Default: 100 Constraints: minimum 20, maximum 100
|
|
1296
|
-
# *
|
|
1301
|
+
# * `:marker` - (String) The marker provided in the previous request.
|
|
1297
1302
|
# If this parameter is specified, the response includes records
|
|
1298
1303
|
# beyond the marker only, up to MaxRecords.
|
|
1299
1304
|
# @return [Core::Response]
|
|
1300
1305
|
# The #data method of the response object returns
|
|
1301
1306
|
# a hash with the following structure:
|
|
1302
|
-
# *
|
|
1303
|
-
# *
|
|
1304
|
-
# *
|
|
1305
|
-
# *
|
|
1306
|
-
# *
|
|
1307
|
-
# *
|
|
1308
|
-
# *
|
|
1309
|
-
# *
|
|
1310
|
-
# *
|
|
1311
|
-
# *
|
|
1312
|
-
# *
|
|
1313
|
-
# *
|
|
1314
|
-
# *
|
|
1315
|
-
# *
|
|
1316
|
-
# *
|
|
1317
|
-
# *
|
|
1318
|
-
# *
|
|
1319
|
-
# *
|
|
1307
|
+
# * `:marker` - (String)
|
|
1308
|
+
# * `:reserved_db_instances` - (Array<Hash>)
|
|
1309
|
+
# * `:reserved_db_instance_id` - (String)
|
|
1310
|
+
# * `:reserved_db_instances_offering_id` - (String)
|
|
1311
|
+
# * `:db_instance_class` - (String)
|
|
1312
|
+
# * `:start_time` - (Time)
|
|
1313
|
+
# * `:duration` - (Integer)
|
|
1314
|
+
# * `:fixed_price` - (Numeric)
|
|
1315
|
+
# * `:usage_price` - (Numeric)
|
|
1316
|
+
# * `:currency_code` - (String)
|
|
1317
|
+
# * `:db_instance_count` - (Integer)
|
|
1318
|
+
# * `:product_description` - (String)
|
|
1319
|
+
# * `:offering_type` - (String)
|
|
1320
|
+
# * `:multi_az` - (Boolean)
|
|
1321
|
+
# * `:state` - (String)
|
|
1322
|
+
# * `:recurring_charges` - (Array<Hash>)
|
|
1323
|
+
# * `:recurring_charge_amount` - (Numeric)
|
|
1324
|
+
# * `:recurring_charge_frequency` - (String)
|
|
1320
1325
|
|
|
1321
1326
|
# @!method describe_reserved_db_instances_offerings(options = {})
|
|
1322
1327
|
# Calls the DescribeReservedDBInstancesOfferings API operation.
|
|
1323
1328
|
# @param [Hash] options
|
|
1324
|
-
# *
|
|
1329
|
+
# * `:reserved_db_instances_offering_id` - (String) The offering
|
|
1325
1330
|
# identifier filter value. Specify this parameter to show only the
|
|
1326
1331
|
# available offering that matches the specified reservation
|
|
1327
1332
|
# identifier. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
|
|
1328
|
-
# *
|
|
1333
|
+
# * `:db_instance_class` - (String) The DB Instance class filter value.
|
|
1329
1334
|
# Specify this parameter to show only the available offerings
|
|
1330
1335
|
# matching the specified DB Instance class.
|
|
1331
|
-
# *
|
|
1336
|
+
# * `:duration` - (String) Duration filter value, specified in years or
|
|
1332
1337
|
# seconds. Specify this parameter to show only reservations for this
|
|
1333
1338
|
# duration. Valid Values: 1 | 3 | 31536000 | 94608000
|
|
1334
|
-
# *
|
|
1339
|
+
# * `:product_description` - (String) Product description filter value.
|
|
1335
1340
|
# Specify this parameter to show only the available offerings
|
|
1336
1341
|
# matching the specified product description.
|
|
1337
|
-
# *
|
|
1342
|
+
# * `:offering_type` - (String) The offering type filter value. Specify
|
|
1338
1343
|
# this parameter to show only the available offerings matching the
|
|
1339
1344
|
# specified offering type. Valid Values: "Light Utilization" |
|
|
1340
1345
|
# "Medium Utilization" | "Heavy Utilization"
|
|
1341
|
-
# *
|
|
1346
|
+
# * `:multi_az` - (Boolean) The Multi-AZ filter value. Specify this
|
|
1342
1347
|
# parameter to show only the available offerings matching the
|
|
1343
1348
|
# specified Multi-AZ parameter.
|
|
1344
|
-
# *
|
|
1349
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
|
1345
1350
|
# in the response. If more than the MaxRecords value is available, a
|
|
1346
1351
|
# marker is included in the response so that the following results
|
|
1347
1352
|
# can be retrieved. Default: 100 Constraints: minimum 20, maximum 100
|
|
1348
|
-
# *
|
|
1353
|
+
# * `:marker` - (String) The marker provided in the previous request.
|
|
1349
1354
|
# If this parameter is specified, the response includes records
|
|
1350
1355
|
# beyond the marker only, up to MaxRecords.
|
|
1351
1356
|
# @return [Core::Response]
|
|
1352
1357
|
# The #data method of the response object returns
|
|
1353
1358
|
# a hash with the following structure:
|
|
1354
|
-
# *
|
|
1355
|
-
# *
|
|
1356
|
-
# *
|
|
1357
|
-
# *
|
|
1358
|
-
# *
|
|
1359
|
-
# *
|
|
1360
|
-
# *
|
|
1361
|
-
# *
|
|
1362
|
-
# *
|
|
1363
|
-
# *
|
|
1364
|
-
# *
|
|
1365
|
-
# *
|
|
1366
|
-
# *
|
|
1367
|
-
# *
|
|
1359
|
+
# * `:marker` - (String)
|
|
1360
|
+
# * `:reserved_db_instances_offerings` - (Array<Hash>)
|
|
1361
|
+
# * `:reserved_db_instances_offering_id` - (String)
|
|
1362
|
+
# * `:db_instance_class` - (String)
|
|
1363
|
+
# * `:duration` - (Integer)
|
|
1364
|
+
# * `:fixed_price` - (Numeric)
|
|
1365
|
+
# * `:usage_price` - (Numeric)
|
|
1366
|
+
# * `:currency_code` - (String)
|
|
1367
|
+
# * `:product_description` - (String)
|
|
1368
|
+
# * `:offering_type` - (String)
|
|
1369
|
+
# * `:multi_az` - (Boolean)
|
|
1370
|
+
# * `:recurring_charges` - (Array<Hash>)
|
|
1371
|
+
# * `:recurring_charge_amount` - (Numeric)
|
|
1372
|
+
# * `:recurring_charge_frequency` - (String)
|
|
1368
1373
|
|
|
1369
1374
|
# @!method download_db_log_file_portion(options = {})
|
|
1370
1375
|
# Calls the DownloadDBLogFilePortion API operation.
|
|
1371
1376
|
# @param [Hash] options
|
|
1372
|
-
# *
|
|
1373
|
-
# *
|
|
1374
|
-
# *
|
|
1377
|
+
# * `:db_instance_identifier` - (String)
|
|
1378
|
+
# * `:log_file_name` - (String)
|
|
1379
|
+
# * `:marker` - (String) The pagination token provided in the previous
|
|
1375
1380
|
# request. If this parameter is specified the response includes only
|
|
1376
1381
|
# records beyond the marker, up to MaxRecords.
|
|
1377
|
-
# *
|
|
1382
|
+
# * `:number_of_lines` - (Integer) The number of lines remaining to be
|
|
1378
1383
|
# downloaded.
|
|
1379
1384
|
# @return [Core::Response]
|
|
1380
1385
|
# The #data method of the response object returns
|
|
1381
1386
|
# a hash with the following structure:
|
|
1382
|
-
# *
|
|
1383
|
-
# *
|
|
1384
|
-
# *
|
|
1387
|
+
# * `:log_file_data` - (String)
|
|
1388
|
+
# * `:marker` - (String)
|
|
1389
|
+
# * `:additional_data_pending` - (Boolean)
|
|
1385
1390
|
|
|
1386
1391
|
# @!method list_tags_for_resource(options = {})
|
|
1387
1392
|
# Calls the ListTagsForResource API operation.
|
|
1388
1393
|
# @param [Hash] options
|
|
1389
|
-
# *
|
|
1394
|
+
# * `:resource_name` - *required* - (String) The DB Instance with tags
|
|
1390
1395
|
# to be listed.
|
|
1391
1396
|
# @return [Core::Response]
|
|
1392
1397
|
# The #data method of the response object returns
|
|
1393
1398
|
# a hash with the following structure:
|
|
1394
|
-
# *
|
|
1395
|
-
# *
|
|
1396
|
-
# *
|
|
1399
|
+
# * `:tag_list` - (Array<Hash>)
|
|
1400
|
+
# * `:key` - (String)
|
|
1401
|
+
# * `:value` - (String)
|
|
1397
1402
|
|
|
1398
1403
|
# @!method modify_db_instance(options = {})
|
|
1399
1404
|
# Calls the ModifyDBInstance API operation.
|
|
1400
1405
|
# @param [Hash] options
|
|
1401
|
-
# *
|
|
1406
|
+
# * `:db_instance_identifier` - *required* - (String) The DB Instance
|
|
1402
1407
|
# identifier. This value is stored as a lowercase string.
|
|
1403
|
-
# *
|
|
1408
|
+
# * `:allocated_storage` - (Integer) The new storage capacity of the
|
|
1404
1409
|
# RDS instance. This change does not result in an outage and is
|
|
1405
1410
|
# applied during the next maintenance window unless the
|
|
1406
|
-
# ApplyImmediately parameter is specified as
|
|
1407
|
-
# *
|
|
1411
|
+
# ApplyImmediately parameter is specified as `true` for this request.
|
|
1412
|
+
# * `:db_instance_class` - (String) The new compute and memory capacity
|
|
1408
1413
|
# of the DB Instance. Passing a value for this parameter causes an
|
|
1409
1414
|
# outage during the change and is applied during the next maintenance
|
|
1410
1415
|
# window, unless the ApplyImmediately parameter is specified as
|
|
1411
|
-
#
|
|
1412
|
-
# *
|
|
1416
|
+
# `true` for this request.
|
|
1417
|
+
# * `:db_security_groups` - (Array<String>) A list of DB Security
|
|
1413
1418
|
# Groups to authorize on this DB Instance. This change is
|
|
1414
1419
|
# asynchronously applied as soon as possible.
|
|
1415
|
-
# *
|
|
1420
|
+
# * `:vpc_security_group_ids` - (Array<String>) A list of Ec2 Vpc
|
|
1416
1421
|
# Security Groups to authorize on this DB Instance. This change is
|
|
1417
1422
|
# asynchronously applied as soon as possible. Constraints: Must be 1
|
|
1418
1423
|
# to 255 alphanumeric characters First character must be a letter
|
|
1419
1424
|
# Cannot end with a hyphen or contain two consecutive hyphens
|
|
1420
|
-
# *
|
|
1425
|
+
# * `:apply_immediately` - (Boolean) Specifies whether or not the
|
|
1421
1426
|
# modifications in this request and any pending modifications are
|
|
1422
1427
|
# asynchronously applied as soon as possible, regardless of the
|
|
1423
1428
|
# PreferredMaintenanceWindow setting for the DB Instance. If this
|
|
1424
|
-
# parameter is passed as
|
|
1429
|
+
# parameter is passed as `false` , changes to the DB Instance are
|
|
1425
1430
|
# applied on the next call to RebootDBInstance, the next maintenance
|
|
1426
1431
|
# reboot, or the next failure reboot, whichever occurs first.
|
|
1427
|
-
# *
|
|
1432
|
+
# * `:master_user_password` - (String) The new password for the DB
|
|
1428
1433
|
# Instance master user. This change is asynchronously applied as soon
|
|
1429
1434
|
# as possible. Between the time of the request and the completion of
|
|
1430
1435
|
# the request, the MasterUserPassword element exists in the
|
|
1431
1436
|
# PendingModifiedValues element of the operation response.
|
|
1432
|
-
# *
|
|
1437
|
+
# * `:db_parameter_group_name` - (String) The name of the DB Parameter
|
|
1433
1438
|
# Group to apply to this DB Instance. This change is asynchronously
|
|
1434
1439
|
# applied as soon as possible for parameters when the
|
|
1435
|
-
# ApplyImmediately parameter is specified as
|
|
1436
|
-
# *
|
|
1440
|
+
# ApplyImmediately parameter is specified as `true` for this request.
|
|
1441
|
+
# * `:backup_retention_period` - (Integer) The number of days to retain
|
|
1437
1442
|
# automated backups. Setting this parameter to a positive number
|
|
1438
1443
|
# enables backups. Setting this parameter to 0 disables automated
|
|
1439
1444
|
# backups.
|
|
1440
|
-
# *
|
|
1445
|
+
# * `:preferred_backup_window` - (String) The daily time range during
|
|
1441
1446
|
# which automated backups are created if automated backups are
|
|
1442
1447
|
# enabled, as determined by the BackupRetentionPeriod.
|
|
1443
|
-
# *
|
|
1448
|
+
# * `:preferred_maintenance_window` - (String) The weekly time range
|
|
1444
1449
|
# (in UTC) during which system maintenance can occur, which may
|
|
1445
1450
|
# result in an outage. This change is made immediately. If moving
|
|
1446
1451
|
# this window to the current time, there must be at least 120 minutes
|
|
1447
1452
|
# between the current time and end of the window to ensure pending
|
|
1448
1453
|
# changes are applied.
|
|
1449
|
-
# *
|
|
1454
|
+
# * `:multi_az` - (Boolean) Specifies if the DB Instance is a Multi-AZ
|
|
1450
1455
|
# deployment. Constraints: Cannot be specified if the DB Instance is
|
|
1451
1456
|
# a read replica.
|
|
1452
|
-
# *
|
|
1457
|
+
# * `:engine_version` - (String) The version number of the database
|
|
1453
1458
|
# engine to upgrade to. For major version upgrades, if a nondefault
|
|
1454
1459
|
# DB Parameter Group is currently in use, a new DB Parameter Group in
|
|
1455
1460
|
# the DB Parameter Group Family for the new engine version must be
|
|
1456
1461
|
# specified. The new DB Parameter Group can be the default for that
|
|
1457
1462
|
# DB Parameter Group Family. Example: 5.1.42
|
|
1458
|
-
# *
|
|
1463
|
+
# * `:allow_major_version_upgrade` - (Boolean) Indicates that major
|
|
1459
1464
|
# version upgrades are allowed. Constraints: This parameter must be
|
|
1460
|
-
# set to
|
|
1465
|
+
# set to `true` when specifying a value for the EngineVersion
|
|
1461
1466
|
# parameter that is a different major version than the DB Instance's
|
|
1462
1467
|
# current version.
|
|
1463
|
-
# *
|
|
1468
|
+
# * `:auto_minor_version_upgrade` - (Boolean) Indicates that minor
|
|
1464
1469
|
# version upgrades will be applied automatically to the DB Instance
|
|
1465
1470
|
# during the maintenance window.
|
|
1466
|
-
# *
|
|
1471
|
+
# * `:iops` - (Integer) The new provisioned I/O operations per second
|
|
1467
1472
|
# of the RDS instance. This change does not result in an outage and
|
|
1468
1473
|
# is applied during the next maintenance window unless the
|
|
1469
|
-
# ApplyImmediately parameter is specified as
|
|
1474
|
+
# ApplyImmediately parameter is specified as `true` for this request.
|
|
1470
1475
|
# Default: Uses existing setting Constraints: Value supplied must be
|
|
1471
1476
|
# at least 10% greater than the current value. Values that are not at
|
|
1472
1477
|
# least 10% greater than the existing value are rounded up so that
|
|
1473
1478
|
# they are 10% greater than the current value. Type: Integer
|
|
1474
|
-
# *
|
|
1479
|
+
# * `:option_group_name` - (String) Indicates that the DB Instance
|
|
1475
1480
|
# should be associated with the specified option group.
|
|
1476
|
-
# *
|
|
1481
|
+
# * `:new_db_instance_identifier` - (String) The new DB Instance
|
|
1477
1482
|
# identifier for the DB Instance when renaming a DB Instance. This
|
|
1478
1483
|
# value is stored as a lowercase string. Constraints: Must contain
|
|
1479
1484
|
# from 1 to 63 alphanumeric characters or hyphens First character
|
|
@@ -1482,241 +1487,243 @@ module AWS
|
|
|
1482
1487
|
# @return [Core::Response]
|
|
1483
1488
|
# The #data method of the response object returns
|
|
1484
1489
|
# a hash with the following structure:
|
|
1485
|
-
# *
|
|
1486
|
-
# *
|
|
1487
|
-
# *
|
|
1488
|
-
# *
|
|
1489
|
-
# *
|
|
1490
|
-
# *
|
|
1491
|
-
# *
|
|
1492
|
-
# *
|
|
1493
|
-
# *
|
|
1494
|
-
# *
|
|
1495
|
-
# *
|
|
1496
|
-
# *
|
|
1497
|
-
# *
|
|
1498
|
-
# *
|
|
1499
|
-
# *
|
|
1500
|
-
# *
|
|
1501
|
-
# *
|
|
1502
|
-
# *
|
|
1503
|
-
# *
|
|
1504
|
-
# *
|
|
1505
|
-
# *
|
|
1506
|
-
# *
|
|
1507
|
-
# *
|
|
1508
|
-
# *
|
|
1509
|
-
# *
|
|
1510
|
-
# *
|
|
1511
|
-
# *
|
|
1512
|
-
# *
|
|
1513
|
-
# *
|
|
1514
|
-
# *
|
|
1515
|
-
# *
|
|
1516
|
-
# *
|
|
1517
|
-
# *
|
|
1518
|
-
# *
|
|
1519
|
-
# *
|
|
1520
|
-
# *
|
|
1521
|
-
# *
|
|
1522
|
-
# *
|
|
1523
|
-
# *
|
|
1524
|
-
# *
|
|
1525
|
-
# *
|
|
1526
|
-
# *
|
|
1527
|
-
# *
|
|
1528
|
-
# *
|
|
1529
|
-
# *
|
|
1530
|
-
# *
|
|
1531
|
-
# *
|
|
1532
|
-
# *
|
|
1533
|
-
# *
|
|
1534
|
-
# *
|
|
1535
|
-
# *
|
|
1536
|
-
# *
|
|
1537
|
-
# *
|
|
1538
|
-
# *
|
|
1539
|
-
# *
|
|
1540
|
-
# *
|
|
1541
|
-
# *
|
|
1542
|
-
# *
|
|
1543
|
-
# *
|
|
1490
|
+
# * `:db_instance_identifier` - (String)
|
|
1491
|
+
# * `:db_instance_class` - (String)
|
|
1492
|
+
# * `:engine` - (String)
|
|
1493
|
+
# * `:db_instance_status` - (String)
|
|
1494
|
+
# * `:master_username` - (String)
|
|
1495
|
+
# * `:db_name` - (String)
|
|
1496
|
+
# * `:endpoint` - (Hash)
|
|
1497
|
+
# * `:address` - (String)
|
|
1498
|
+
# * `:port` - (Integer)
|
|
1499
|
+
# * `:allocated_storage` - (Integer)
|
|
1500
|
+
# * `:instance_create_time` - (Time)
|
|
1501
|
+
# * `:preferred_backup_window` - (String)
|
|
1502
|
+
# * `:backup_retention_period` - (Integer)
|
|
1503
|
+
# * `:db_security_groups` - (Array<Hash>)
|
|
1504
|
+
# * `:db_security_group_name` - (String)
|
|
1505
|
+
# * `:status` - (String)
|
|
1506
|
+
# * `:vpc_security_groups` - (Array<Hash>)
|
|
1507
|
+
# * `:vpc_security_group_id` - (String)
|
|
1508
|
+
# * `:status` - (String)
|
|
1509
|
+
# * `:db_parameter_groups` - (Array<Hash>)
|
|
1510
|
+
# * `:db_parameter_group_name` - (String)
|
|
1511
|
+
# * `:parameter_apply_status` - (String)
|
|
1512
|
+
# * `:availability_zone` - (String)
|
|
1513
|
+
# * `:db_subnet_group` - (Hash)
|
|
1514
|
+
# * `:db_subnet_group_name` - (String)
|
|
1515
|
+
# * `:db_subnet_group_description` - (String)
|
|
1516
|
+
# * `:vpc_id` - (String)
|
|
1517
|
+
# * `:subnet_group_status` - (String)
|
|
1518
|
+
# * `:subnets` - (Array<Hash>)
|
|
1519
|
+
# * `:subnet_identifier` - (String)
|
|
1520
|
+
# * `:subnet_availability_zone` - (Hash)
|
|
1521
|
+
# * `:name` - (String)
|
|
1522
|
+
# * `:provisioned_iops_capable` - (Boolean)
|
|
1523
|
+
# * `:subnet_status` - (String)
|
|
1524
|
+
# * `:preferred_maintenance_window` - (String)
|
|
1525
|
+
# * `:pending_modified_values` - (Hash)
|
|
1526
|
+
# * `:db_instance_class` - (String)
|
|
1527
|
+
# * `:allocated_storage` - (Integer)
|
|
1528
|
+
# * `:master_user_password` - (String)
|
|
1529
|
+
# * `:port` - (Integer)
|
|
1530
|
+
# * `:backup_retention_period` - (Integer)
|
|
1531
|
+
# * `:multi_az` - (Boolean)
|
|
1532
|
+
# * `:engine_version` - (String)
|
|
1533
|
+
# * `:iops` - (Integer)
|
|
1534
|
+
# * `:db_instance_identifier` - (String)
|
|
1535
|
+
# * `:latest_restorable_time` - (Time)
|
|
1536
|
+
# * `:multi_az` - (Boolean)
|
|
1537
|
+
# * `:engine_version` - (String)
|
|
1538
|
+
# * `:auto_minor_version_upgrade` - (Boolean)
|
|
1539
|
+
# * `:read_replica_source_db_instance_identifier` - (String)
|
|
1540
|
+
# * `:read_replica_db_instance_identifiers` - (Array<String>)
|
|
1541
|
+
# * `:license_model` - (String)
|
|
1542
|
+
# * `:iops` - (Integer)
|
|
1543
|
+
# * `:option_group_memberships` - (Array<Hash>)
|
|
1544
|
+
# * `:option_group_name` - (String)
|
|
1545
|
+
# * `:status` - (String)
|
|
1546
|
+
# * `:character_set_name` - (String)
|
|
1547
|
+
# * `:secondary_availability_zone` - (String)
|
|
1548
|
+
# * `:publicly_accessible` - (Boolean)
|
|
1544
1549
|
|
|
1545
1550
|
# @!method modify_db_parameter_group(options = {})
|
|
1546
1551
|
# Calls the ModifyDBParameterGroup API operation.
|
|
1547
1552
|
# @param [Hash] options
|
|
1548
|
-
# *
|
|
1553
|
+
# * `:db_parameter_group_name` - *required* - (String) The name of the
|
|
1549
1554
|
# database parameter group.
|
|
1550
|
-
# *
|
|
1555
|
+
# * `:parameters` - *required* - (Array<Hash>) An array of parameter
|
|
1551
1556
|
# names, values, and the apply method for the parameter update. At
|
|
1552
1557
|
# least one parameter name, value, and apply method must be supplied;
|
|
1553
1558
|
# subsequent arguments are optional. A maximum of 20 parameters may
|
|
1554
1559
|
# be modified in a single request.
|
|
1555
|
-
# *
|
|
1556
|
-
# *
|
|
1560
|
+
# * `:parameter_name` - (String) Specifies the name of the parameter.
|
|
1561
|
+
# * `:parameter_value` - (String) Specifies the value of the
|
|
1557
1562
|
# parameter.
|
|
1558
|
-
# *
|
|
1563
|
+
# * `:description` - (String) Provides a description of the
|
|
1559
1564
|
# parameter.
|
|
1560
|
-
# *
|
|
1561
|
-
# *
|
|
1565
|
+
# * `:source` - (String) Indicates the source of the parameter value.
|
|
1566
|
+
# * `:apply_type` - (String) Specifies the engine specific parameters
|
|
1562
1567
|
# type.
|
|
1563
|
-
# *
|
|
1568
|
+
# * `:data_type` - (String) Specifies the valid data type for the
|
|
1564
1569
|
# parameter.
|
|
1565
|
-
# *
|
|
1570
|
+
# * `:allowed_values` - (String) Specifies the valid range of values
|
|
1566
1571
|
# for the parameter.
|
|
1567
|
-
# *
|
|
1568
|
-
# (
|
|
1572
|
+
# * `:is_modifiable` - (Boolean) Indicates whether ( `true` ) or not
|
|
1573
|
+
# ( `false` ) the parameter can be modified. Some parameters have
|
|
1569
1574
|
# security or operational implications that prevent them from being
|
|
1570
1575
|
# changed.
|
|
1571
|
-
# *
|
|
1576
|
+
# * `:minimum_engine_version` - (String) The earliest engine version
|
|
1572
1577
|
# to which the parameter can apply.
|
|
1573
|
-
# *
|
|
1574
|
-
# updates.
|
|
1578
|
+
# * `:apply_method` - (String) Indicates when to apply parameter
|
|
1579
|
+
# updates. Valid values include:
|
|
1580
|
+
# * `immediate`
|
|
1581
|
+
# * `pending-reboot`
|
|
1575
1582
|
# @return [Core::Response]
|
|
1576
1583
|
# The #data method of the response object returns
|
|
1577
1584
|
# a hash with the following structure:
|
|
1578
|
-
# *
|
|
1585
|
+
# * `:db_parameter_group_name` - (String)
|
|
1579
1586
|
|
|
1580
1587
|
# @!method modify_db_subnet_group(options = {})
|
|
1581
1588
|
# Calls the ModifyDBSubnetGroup API operation.
|
|
1582
1589
|
# @param [Hash] options
|
|
1583
|
-
# *
|
|
1590
|
+
# * `:db_subnet_group_name` - *required* - (String) The name for the DB
|
|
1584
1591
|
# Subnet Group. This value is stored as a lowercase string.
|
|
1585
1592
|
# Constraints: Must contain no more than 255 alphanumeric characters
|
|
1586
1593
|
# or hyphens. Must not be "Default". Example: mySubnetgroup
|
|
1587
|
-
# *
|
|
1594
|
+
# * `:db_subnet_group_description` - (String) The description for the
|
|
1588
1595
|
# DB Subnet Group.
|
|
1589
|
-
# *
|
|
1596
|
+
# * `:subnet_ids` - *required* - (Array<String>) The EC2 Subnet IDs for
|
|
1590
1597
|
# the DB Subnet Group.
|
|
1591
1598
|
# @return [Core::Response]
|
|
1592
1599
|
# The #data method of the response object returns
|
|
1593
1600
|
# a hash with the following structure:
|
|
1594
|
-
# *
|
|
1595
|
-
# *
|
|
1596
|
-
# *
|
|
1597
|
-
# *
|
|
1598
|
-
# *
|
|
1599
|
-
# *
|
|
1600
|
-
# *
|
|
1601
|
-
# *
|
|
1602
|
-
# *
|
|
1603
|
-
# *
|
|
1601
|
+
# * `:db_subnet_group_name` - (String)
|
|
1602
|
+
# * `:db_subnet_group_description` - (String)
|
|
1603
|
+
# * `:vpc_id` - (String)
|
|
1604
|
+
# * `:subnet_group_status` - (String)
|
|
1605
|
+
# * `:subnets` - (Array<Hash>)
|
|
1606
|
+
# * `:subnet_identifier` - (String)
|
|
1607
|
+
# * `:subnet_availability_zone` - (Hash)
|
|
1608
|
+
# * `:name` - (String)
|
|
1609
|
+
# * `:provisioned_iops_capable` - (Boolean)
|
|
1610
|
+
# * `:subnet_status` - (String)
|
|
1604
1611
|
|
|
1605
1612
|
# @!method modify_event_subscription(options = {})
|
|
1606
1613
|
# Calls the ModifyEventSubscription API operation.
|
|
1607
1614
|
# @param [Hash] options
|
|
1608
|
-
# *
|
|
1615
|
+
# * `:subscription_name` - *required* - (String) The name of the RDS
|
|
1609
1616
|
# event notification subscription.
|
|
1610
|
-
# *
|
|
1617
|
+
# * `:sns_topic_arn` - (String) The Amazon Resource Name (ARN) of the
|
|
1611
1618
|
# SNS topic created for event notification. The ARN is created by
|
|
1612
1619
|
# Amazon SNS when you create a topic and subscribe to it.
|
|
1613
|
-
# *
|
|
1620
|
+
# * `:source_type` - (String) The type of source that will be
|
|
1614
1621
|
# generating the events. For example, if you want to be notified of
|
|
1615
1622
|
# events generated by a DB instance, you would set this parameter to
|
|
1616
1623
|
# db-instance. if this value is not specified, all events are
|
|
1617
1624
|
# returned. Valid values: db-instance | db-parameter-group |
|
|
1618
1625
|
# db-security-group | db-snapshot
|
|
1619
|
-
# *
|
|
1626
|
+
# * `:event_categories` - (Array<String>) A list of event categories
|
|
1620
1627
|
# for a SourceType that you want to subscribe to. You can see a list
|
|
1621
1628
|
# of the categories for a given SourceType in the Events topic in the
|
|
1622
1629
|
# Amazon RDS User Guide or by using the DescribeEventCategories
|
|
1623
1630
|
# action.
|
|
1624
|
-
# *
|
|
1631
|
+
# * `:enabled` - (Boolean) A Boolean value; set to `true` to activate
|
|
1625
1632
|
# the subscription.
|
|
1626
1633
|
# @return [Core::Response]
|
|
1627
1634
|
# The #data method of the response object returns
|
|
1628
1635
|
# a hash with the following structure:
|
|
1629
|
-
# *
|
|
1630
|
-
# *
|
|
1631
|
-
# *
|
|
1632
|
-
# *
|
|
1633
|
-
# *
|
|
1634
|
-
# *
|
|
1635
|
-
# *
|
|
1636
|
-
# *
|
|
1637
|
-
# *
|
|
1636
|
+
# * `:customer_aws_id` - (String)
|
|
1637
|
+
# * `:cust_subscription_id` - (String)
|
|
1638
|
+
# * `:sns_topic_arn` - (String)
|
|
1639
|
+
# * `:status` - (String)
|
|
1640
|
+
# * `:subscription_creation_time` - (String)
|
|
1641
|
+
# * `:source_type` - (String)
|
|
1642
|
+
# * `:source_ids_list` - (Array<String>)
|
|
1643
|
+
# * `:event_categories_list` - (Array<String>)
|
|
1644
|
+
# * `:enabled` - (Boolean)
|
|
1638
1645
|
|
|
1639
1646
|
# @!method modify_option_group(options = {})
|
|
1640
1647
|
# Calls the ModifyOptionGroup API operation.
|
|
1641
1648
|
# @param [Hash] options
|
|
1642
|
-
# *
|
|
1649
|
+
# * `:option_group_name` - *required* - (String) The name of the option
|
|
1643
1650
|
# group to be modified.
|
|
1644
|
-
# *
|
|
1651
|
+
# * `:options_to_include` - (Array<Hash>) Options in this list are
|
|
1645
1652
|
# added to the Option Group or, if already present, the specified
|
|
1646
1653
|
# configuration is used to update the existing configuration.
|
|
1647
|
-
# *
|
|
1654
|
+
# * `:option_name` - *required* - (String) The configuration of
|
|
1648
1655
|
# options to include in a group.
|
|
1649
|
-
# *
|
|
1650
|
-
# *
|
|
1656
|
+
# * `:port` - (Integer) The optional port for the option.
|
|
1657
|
+
# * `:db_security_group_memberships` - (Array<String>) A list of
|
|
1651
1658
|
# DBSecurityGroupMemebrship name strings used for this option.
|
|
1652
|
-
# *
|
|
1659
|
+
# * `:vpc_security_group_memberships` - (Array<String>) A list of
|
|
1653
1660
|
# VpcSecurityGroupMemebrship name strings used for this option.
|
|
1654
|
-
# *
|
|
1661
|
+
# * `:option_settings` - (Array<Hash>) A list of option settings
|
|
1655
1662
|
# applied for this option.
|
|
1656
|
-
# *
|
|
1657
|
-
# *
|
|
1658
|
-
# *
|
|
1659
|
-
# *
|
|
1660
|
-
# *
|
|
1663
|
+
# * `:name` - (String) The name of the setting.
|
|
1664
|
+
# * `:value` - (String) The value of this setting.
|
|
1665
|
+
# * `:default_value` - (String) Default value for this setting.
|
|
1666
|
+
# * `:description` - (String) The description of the setting.
|
|
1667
|
+
# * `:apply_type` - (String) Specifies the apply type for this
|
|
1661
1668
|
# setting.
|
|
1662
|
-
# *
|
|
1669
|
+
# * `:data_type` - (String) Specifies the valid data type of this
|
|
1663
1670
|
# setting
|
|
1664
|
-
# *
|
|
1671
|
+
# * `:allowed_values` - (String) Specifies a valid list/range of
|
|
1665
1672
|
# values allowed for this setting.
|
|
1666
|
-
# *
|
|
1673
|
+
# * `:is_modifiable` - (Boolean) Indicates if the setting is
|
|
1667
1674
|
# modifiable or not.
|
|
1668
|
-
# *
|
|
1675
|
+
# * `:is_collection` - (Boolean) Indicates if the value for the
|
|
1669
1676
|
# setting can be a list of values or a single value.
|
|
1670
|
-
# *
|
|
1677
|
+
# * `:options_to_remove` - (Array<String>) Options in this list are
|
|
1671
1678
|
# removed from the Option Group.
|
|
1672
|
-
# *
|
|
1679
|
+
# * `:apply_immediately` - (Boolean) Indicates whether the changes
|
|
1673
1680
|
# should be applied immediately, or during the next maintenance
|
|
1674
1681
|
# window for each instance associated with the Option Group.
|
|
1675
1682
|
# @return [Core::Response]
|
|
1676
1683
|
# The #data method of the response object returns
|
|
1677
1684
|
# a hash with the following structure:
|
|
1678
|
-
# *
|
|
1679
|
-
# *
|
|
1680
|
-
# *
|
|
1681
|
-
# *
|
|
1682
|
-
# *
|
|
1683
|
-
# *
|
|
1684
|
-
# *
|
|
1685
|
-
# *
|
|
1686
|
-
# *
|
|
1687
|
-
# *
|
|
1688
|
-
# *
|
|
1689
|
-
# *
|
|
1690
|
-
# *
|
|
1691
|
-
# *
|
|
1692
|
-
# *
|
|
1693
|
-
# *
|
|
1694
|
-
# *
|
|
1695
|
-
# *
|
|
1696
|
-
# *
|
|
1697
|
-
# *
|
|
1698
|
-
# *
|
|
1699
|
-
# *
|
|
1700
|
-
# *
|
|
1701
|
-
# *
|
|
1702
|
-
# *
|
|
1703
|
-
# *
|
|
1704
|
-
# *
|
|
1685
|
+
# * `:option_group_name` - (String)
|
|
1686
|
+
# * `:option_group_description` - (String)
|
|
1687
|
+
# * `:engine_name` - (String)
|
|
1688
|
+
# * `:major_engine_version` - (String)
|
|
1689
|
+
# * `:options` - (Array<Hash>)
|
|
1690
|
+
# * `:option_name` - (String)
|
|
1691
|
+
# * `:option_description` - (String)
|
|
1692
|
+
# * `:persistent` - (Boolean)
|
|
1693
|
+
# * `:port` - (Integer)
|
|
1694
|
+
# * `:option_settings` - (Array<Hash>)
|
|
1695
|
+
# * `:name` - (String)
|
|
1696
|
+
# * `:value` - (String)
|
|
1697
|
+
# * `:default_value` - (String)
|
|
1698
|
+
# * `:description` - (String)
|
|
1699
|
+
# * `:apply_type` - (String)
|
|
1700
|
+
# * `:data_type` - (String)
|
|
1701
|
+
# * `:allowed_values` - (String)
|
|
1702
|
+
# * `:is_modifiable` - (Boolean)
|
|
1703
|
+
# * `:is_collection` - (Boolean)
|
|
1704
|
+
# * `:db_security_group_memberships` - (Array<Hash>)
|
|
1705
|
+
# * `:db_security_group_name` - (String)
|
|
1706
|
+
# * `:status` - (String)
|
|
1707
|
+
# * `:vpc_security_group_memberships` - (Array<Hash>)
|
|
1708
|
+
# * `:vpc_security_group_id` - (String)
|
|
1709
|
+
# * `:status` - (String)
|
|
1710
|
+
# * `:allows_vpc_and_non_vpc_instance_memberships` - (Boolean)
|
|
1711
|
+
# * `:vpc_id` - (String)
|
|
1705
1712
|
|
|
1706
1713
|
# @!method promote_read_replica(options = {})
|
|
1707
1714
|
# Calls the PromoteReadReplica API operation.
|
|
1708
1715
|
# @param [Hash] options
|
|
1709
|
-
# *
|
|
1716
|
+
# * `:db_instance_identifier` - *required* - (String) The DB Instance
|
|
1710
1717
|
# identifier. This value is stored as a lowercase string.
|
|
1711
1718
|
# Constraints: Must be the identifier for an existing Read Replica DB
|
|
1712
1719
|
# Instance Must contain from 1 to 63 alphanumeric characters or
|
|
1713
1720
|
# hyphens First character must be a letter Cannot end with a hyphen
|
|
1714
1721
|
# or contain two consecutive hyphens Example: mydbinstance
|
|
1715
|
-
# *
|
|
1722
|
+
# * `:backup_retention_period` - (Integer) The number of days to retain
|
|
1716
1723
|
# automated backups. Setting this parameter to a positive number
|
|
1717
1724
|
# enables backups. Setting this parameter to 0 disables automated
|
|
1718
1725
|
# backups. Default: 1 Constraints: Must be a value from 0 to 8
|
|
1719
|
-
# *
|
|
1726
|
+
# * `:preferred_backup_window` - (String) The daily time range during
|
|
1720
1727
|
# which automated backups are created if automated backups are
|
|
1721
1728
|
# enabled, using the BackupRetentionPeriod parameter. Default: A
|
|
1722
1729
|
# 30-minute window selected at random from an 8-hour block of time
|
|
@@ -1732,492 +1739,494 @@ module AWS
|
|
|
1732
1739
|
# @return [Core::Response]
|
|
1733
1740
|
# The #data method of the response object returns
|
|
1734
1741
|
# a hash with the following structure:
|
|
1735
|
-
# *
|
|
1736
|
-
# *
|
|
1737
|
-
# *
|
|
1738
|
-
# *
|
|
1739
|
-
# *
|
|
1740
|
-
# *
|
|
1741
|
-
# *
|
|
1742
|
-
# *
|
|
1743
|
-
# *
|
|
1744
|
-
# *
|
|
1745
|
-
# *
|
|
1746
|
-
# *
|
|
1747
|
-
# *
|
|
1748
|
-
# *
|
|
1749
|
-
# *
|
|
1750
|
-
# *
|
|
1751
|
-
# *
|
|
1752
|
-
# *
|
|
1753
|
-
# *
|
|
1754
|
-
# *
|
|
1755
|
-
# *
|
|
1756
|
-
# *
|
|
1757
|
-
# *
|
|
1758
|
-
# *
|
|
1759
|
-
# *
|
|
1760
|
-
# *
|
|
1761
|
-
# *
|
|
1762
|
-
# *
|
|
1763
|
-
# *
|
|
1764
|
-
# *
|
|
1765
|
-
# *
|
|
1766
|
-
# *
|
|
1767
|
-
# *
|
|
1768
|
-
# *
|
|
1769
|
-
# *
|
|
1770
|
-
# *
|
|
1771
|
-
# *
|
|
1772
|
-
# *
|
|
1773
|
-
# *
|
|
1774
|
-
# *
|
|
1775
|
-
# *
|
|
1776
|
-
# *
|
|
1777
|
-
# *
|
|
1778
|
-
# *
|
|
1779
|
-
# *
|
|
1780
|
-
# *
|
|
1781
|
-
# *
|
|
1782
|
-
# *
|
|
1783
|
-
# *
|
|
1784
|
-
# *
|
|
1785
|
-
# *
|
|
1786
|
-
# *
|
|
1787
|
-
# *
|
|
1788
|
-
# *
|
|
1789
|
-
# *
|
|
1790
|
-
# *
|
|
1791
|
-
# *
|
|
1792
|
-
# *
|
|
1793
|
-
# *
|
|
1742
|
+
# * `:db_instance_identifier` - (String)
|
|
1743
|
+
# * `:db_instance_class` - (String)
|
|
1744
|
+
# * `:engine` - (String)
|
|
1745
|
+
# * `:db_instance_status` - (String)
|
|
1746
|
+
# * `:master_username` - (String)
|
|
1747
|
+
# * `:db_name` - (String)
|
|
1748
|
+
# * `:endpoint` - (Hash)
|
|
1749
|
+
# * `:address` - (String)
|
|
1750
|
+
# * `:port` - (Integer)
|
|
1751
|
+
# * `:allocated_storage` - (Integer)
|
|
1752
|
+
# * `:instance_create_time` - (Time)
|
|
1753
|
+
# * `:preferred_backup_window` - (String)
|
|
1754
|
+
# * `:backup_retention_period` - (Integer)
|
|
1755
|
+
# * `:db_security_groups` - (Array<Hash>)
|
|
1756
|
+
# * `:db_security_group_name` - (String)
|
|
1757
|
+
# * `:status` - (String)
|
|
1758
|
+
# * `:vpc_security_groups` - (Array<Hash>)
|
|
1759
|
+
# * `:vpc_security_group_id` - (String)
|
|
1760
|
+
# * `:status` - (String)
|
|
1761
|
+
# * `:db_parameter_groups` - (Array<Hash>)
|
|
1762
|
+
# * `:db_parameter_group_name` - (String)
|
|
1763
|
+
# * `:parameter_apply_status` - (String)
|
|
1764
|
+
# * `:availability_zone` - (String)
|
|
1765
|
+
# * `:db_subnet_group` - (Hash)
|
|
1766
|
+
# * `:db_subnet_group_name` - (String)
|
|
1767
|
+
# * `:db_subnet_group_description` - (String)
|
|
1768
|
+
# * `:vpc_id` - (String)
|
|
1769
|
+
# * `:subnet_group_status` - (String)
|
|
1770
|
+
# * `:subnets` - (Array<Hash>)
|
|
1771
|
+
# * `:subnet_identifier` - (String)
|
|
1772
|
+
# * `:subnet_availability_zone` - (Hash)
|
|
1773
|
+
# * `:name` - (String)
|
|
1774
|
+
# * `:provisioned_iops_capable` - (Boolean)
|
|
1775
|
+
# * `:subnet_status` - (String)
|
|
1776
|
+
# * `:preferred_maintenance_window` - (String)
|
|
1777
|
+
# * `:pending_modified_values` - (Hash)
|
|
1778
|
+
# * `:db_instance_class` - (String)
|
|
1779
|
+
# * `:allocated_storage` - (Integer)
|
|
1780
|
+
# * `:master_user_password` - (String)
|
|
1781
|
+
# * `:port` - (Integer)
|
|
1782
|
+
# * `:backup_retention_period` - (Integer)
|
|
1783
|
+
# * `:multi_az` - (Boolean)
|
|
1784
|
+
# * `:engine_version` - (String)
|
|
1785
|
+
# * `:iops` - (Integer)
|
|
1786
|
+
# * `:db_instance_identifier` - (String)
|
|
1787
|
+
# * `:latest_restorable_time` - (Time)
|
|
1788
|
+
# * `:multi_az` - (Boolean)
|
|
1789
|
+
# * `:engine_version` - (String)
|
|
1790
|
+
# * `:auto_minor_version_upgrade` - (Boolean)
|
|
1791
|
+
# * `:read_replica_source_db_instance_identifier` - (String)
|
|
1792
|
+
# * `:read_replica_db_instance_identifiers` - (Array<String>)
|
|
1793
|
+
# * `:license_model` - (String)
|
|
1794
|
+
# * `:iops` - (Integer)
|
|
1795
|
+
# * `:option_group_memberships` - (Array<Hash>)
|
|
1796
|
+
# * `:option_group_name` - (String)
|
|
1797
|
+
# * `:status` - (String)
|
|
1798
|
+
# * `:character_set_name` - (String)
|
|
1799
|
+
# * `:secondary_availability_zone` - (String)
|
|
1800
|
+
# * `:publicly_accessible` - (Boolean)
|
|
1794
1801
|
|
|
1795
1802
|
# @!method purchase_reserved_db_instances_offering(options = {})
|
|
1796
1803
|
# Calls the PurchaseReservedDBInstancesOffering API operation.
|
|
1797
1804
|
# @param [Hash] options
|
|
1798
|
-
# *
|
|
1805
|
+
# * `:reserved_db_instances_offering_id` - *required* - (String) The ID
|
|
1799
1806
|
# of the Reserved DB Instance offering to purchase. Example:
|
|
1800
1807
|
# 438012d3-4052-4cc7-b2e3-8d3372e0e706
|
|
1801
|
-
# *
|
|
1808
|
+
# * `:reserved_db_instance_id` - (String) Customer-specified identifier
|
|
1802
1809
|
# to track this reservation. Example: myreservationID
|
|
1803
|
-
# *
|
|
1810
|
+
# * `:db_instance_count` - (Integer) The number of instances to
|
|
1804
1811
|
# reserve. Default: 1
|
|
1805
1812
|
# @return [Core::Response]
|
|
1806
1813
|
# The #data method of the response object returns
|
|
1807
1814
|
# a hash with the following structure:
|
|
1808
|
-
# *
|
|
1809
|
-
# *
|
|
1810
|
-
# *
|
|
1811
|
-
# *
|
|
1812
|
-
# *
|
|
1813
|
-
# *
|
|
1814
|
-
# *
|
|
1815
|
-
# *
|
|
1816
|
-
# *
|
|
1817
|
-
# *
|
|
1818
|
-
# *
|
|
1819
|
-
# *
|
|
1820
|
-
# *
|
|
1821
|
-
# *
|
|
1822
|
-
# *
|
|
1823
|
-
# *
|
|
1815
|
+
# * `:reserved_db_instance_id` - (String)
|
|
1816
|
+
# * `:reserved_db_instances_offering_id` - (String)
|
|
1817
|
+
# * `:db_instance_class` - (String)
|
|
1818
|
+
# * `:start_time` - (Time)
|
|
1819
|
+
# * `:duration` - (Integer)
|
|
1820
|
+
# * `:fixed_price` - (Numeric)
|
|
1821
|
+
# * `:usage_price` - (Numeric)
|
|
1822
|
+
# * `:currency_code` - (String)
|
|
1823
|
+
# * `:db_instance_count` - (Integer)
|
|
1824
|
+
# * `:product_description` - (String)
|
|
1825
|
+
# * `:offering_type` - (String)
|
|
1826
|
+
# * `:multi_az` - (Boolean)
|
|
1827
|
+
# * `:state` - (String)
|
|
1828
|
+
# * `:recurring_charges` - (Array<Hash>)
|
|
1829
|
+
# * `:recurring_charge_amount` - (Numeric)
|
|
1830
|
+
# * `:recurring_charge_frequency` - (String)
|
|
1824
1831
|
|
|
1825
1832
|
# @!method reboot_db_instance(options = {})
|
|
1826
1833
|
# Calls the RebootDBInstance API operation.
|
|
1827
1834
|
# @param [Hash] options
|
|
1828
|
-
# *
|
|
1835
|
+
# * `:db_instance_identifier` - *required* - (String) The DB Instance
|
|
1829
1836
|
# identifier. This parameter is stored as a lowercase string.
|
|
1830
|
-
# *
|
|
1837
|
+
# * `:force_failover` - (Boolean) When `true` , the reboot will be
|
|
1831
1838
|
# conducted through a MultiAZ failover. Constraint: You cannot
|
|
1832
|
-
# specify
|
|
1839
|
+
# specify `true` if the instance is not configured for MultiAZ.
|
|
1833
1840
|
# @return [Core::Response]
|
|
1834
1841
|
# The #data method of the response object returns
|
|
1835
1842
|
# a hash with the following structure:
|
|
1836
|
-
# *
|
|
1837
|
-
# *
|
|
1838
|
-
# *
|
|
1839
|
-
# *
|
|
1840
|
-
# *
|
|
1841
|
-
# *
|
|
1842
|
-
# *
|
|
1843
|
-
# *
|
|
1844
|
-
# *
|
|
1845
|
-
# *
|
|
1846
|
-
# *
|
|
1847
|
-
# *
|
|
1848
|
-
# *
|
|
1849
|
-
# *
|
|
1850
|
-
# *
|
|
1851
|
-
# *
|
|
1852
|
-
# *
|
|
1853
|
-
# *
|
|
1854
|
-
# *
|
|
1855
|
-
# *
|
|
1856
|
-
# *
|
|
1857
|
-
# *
|
|
1858
|
-
# *
|
|
1859
|
-
# *
|
|
1860
|
-
# *
|
|
1861
|
-
# *
|
|
1862
|
-
# *
|
|
1863
|
-
# *
|
|
1864
|
-
# *
|
|
1865
|
-
# *
|
|
1866
|
-
# *
|
|
1867
|
-
# *
|
|
1868
|
-
# *
|
|
1869
|
-
# *
|
|
1870
|
-
# *
|
|
1871
|
-
# *
|
|
1872
|
-
# *
|
|
1873
|
-
# *
|
|
1874
|
-
# *
|
|
1875
|
-
# *
|
|
1876
|
-
# *
|
|
1877
|
-
# *
|
|
1878
|
-
# *
|
|
1879
|
-
# *
|
|
1880
|
-
# *
|
|
1881
|
-
# *
|
|
1882
|
-
# *
|
|
1883
|
-
# *
|
|
1884
|
-
# *
|
|
1885
|
-
# *
|
|
1886
|
-
# *
|
|
1887
|
-
# *
|
|
1888
|
-
# *
|
|
1889
|
-
# *
|
|
1890
|
-
# *
|
|
1891
|
-
# *
|
|
1892
|
-
# *
|
|
1893
|
-
# *
|
|
1894
|
-
# *
|
|
1843
|
+
# * `:db_instance_identifier` - (String)
|
|
1844
|
+
# * `:db_instance_class` - (String)
|
|
1845
|
+
# * `:engine` - (String)
|
|
1846
|
+
# * `:db_instance_status` - (String)
|
|
1847
|
+
# * `:master_username` - (String)
|
|
1848
|
+
# * `:db_name` - (String)
|
|
1849
|
+
# * `:endpoint` - (Hash)
|
|
1850
|
+
# * `:address` - (String)
|
|
1851
|
+
# * `:port` - (Integer)
|
|
1852
|
+
# * `:allocated_storage` - (Integer)
|
|
1853
|
+
# * `:instance_create_time` - (Time)
|
|
1854
|
+
# * `:preferred_backup_window` - (String)
|
|
1855
|
+
# * `:backup_retention_period` - (Integer)
|
|
1856
|
+
# * `:db_security_groups` - (Array<Hash>)
|
|
1857
|
+
# * `:db_security_group_name` - (String)
|
|
1858
|
+
# * `:status` - (String)
|
|
1859
|
+
# * `:vpc_security_groups` - (Array<Hash>)
|
|
1860
|
+
# * `:vpc_security_group_id` - (String)
|
|
1861
|
+
# * `:status` - (String)
|
|
1862
|
+
# * `:db_parameter_groups` - (Array<Hash>)
|
|
1863
|
+
# * `:db_parameter_group_name` - (String)
|
|
1864
|
+
# * `:parameter_apply_status` - (String)
|
|
1865
|
+
# * `:availability_zone` - (String)
|
|
1866
|
+
# * `:db_subnet_group` - (Hash)
|
|
1867
|
+
# * `:db_subnet_group_name` - (String)
|
|
1868
|
+
# * `:db_subnet_group_description` - (String)
|
|
1869
|
+
# * `:vpc_id` - (String)
|
|
1870
|
+
# * `:subnet_group_status` - (String)
|
|
1871
|
+
# * `:subnets` - (Array<Hash>)
|
|
1872
|
+
# * `:subnet_identifier` - (String)
|
|
1873
|
+
# * `:subnet_availability_zone` - (Hash)
|
|
1874
|
+
# * `:name` - (String)
|
|
1875
|
+
# * `:provisioned_iops_capable` - (Boolean)
|
|
1876
|
+
# * `:subnet_status` - (String)
|
|
1877
|
+
# * `:preferred_maintenance_window` - (String)
|
|
1878
|
+
# * `:pending_modified_values` - (Hash)
|
|
1879
|
+
# * `:db_instance_class` - (String)
|
|
1880
|
+
# * `:allocated_storage` - (Integer)
|
|
1881
|
+
# * `:master_user_password` - (String)
|
|
1882
|
+
# * `:port` - (Integer)
|
|
1883
|
+
# * `:backup_retention_period` - (Integer)
|
|
1884
|
+
# * `:multi_az` - (Boolean)
|
|
1885
|
+
# * `:engine_version` - (String)
|
|
1886
|
+
# * `:iops` - (Integer)
|
|
1887
|
+
# * `:db_instance_identifier` - (String)
|
|
1888
|
+
# * `:latest_restorable_time` - (Time)
|
|
1889
|
+
# * `:multi_az` - (Boolean)
|
|
1890
|
+
# * `:engine_version` - (String)
|
|
1891
|
+
# * `:auto_minor_version_upgrade` - (Boolean)
|
|
1892
|
+
# * `:read_replica_source_db_instance_identifier` - (String)
|
|
1893
|
+
# * `:read_replica_db_instance_identifiers` - (Array<String>)
|
|
1894
|
+
# * `:license_model` - (String)
|
|
1895
|
+
# * `:iops` - (Integer)
|
|
1896
|
+
# * `:option_group_memberships` - (Array<Hash>)
|
|
1897
|
+
# * `:option_group_name` - (String)
|
|
1898
|
+
# * `:status` - (String)
|
|
1899
|
+
# * `:character_set_name` - (String)
|
|
1900
|
+
# * `:secondary_availability_zone` - (String)
|
|
1901
|
+
# * `:publicly_accessible` - (Boolean)
|
|
1895
1902
|
|
|
1896
1903
|
# @!method remove_source_identifier_from_subscription(options = {})
|
|
1897
1904
|
# Calls the RemoveSourceIdentifierFromSubscription API operation.
|
|
1898
1905
|
# @param [Hash] options
|
|
1899
|
-
# *
|
|
1906
|
+
# * `:subscription_name` - *required* - (String) The name of the RDS
|
|
1900
1907
|
# event notification subscription you want to remove a source
|
|
1901
1908
|
# identifier from.
|
|
1902
|
-
# *
|
|
1909
|
+
# * `:source_identifier` - *required* - (String) The source identifier
|
|
1903
1910
|
# to be removed from the subscription, such as the DB instance
|
|
1904
1911
|
# identifier for a DB instance or the name of a security group.
|
|
1905
1912
|
# @return [Core::Response]
|
|
1906
1913
|
# The #data method of the response object returns
|
|
1907
1914
|
# a hash with the following structure:
|
|
1908
|
-
# *
|
|
1909
|
-
# *
|
|
1910
|
-
# *
|
|
1911
|
-
# *
|
|
1912
|
-
# *
|
|
1913
|
-
# *
|
|
1914
|
-
# *
|
|
1915
|
-
# *
|
|
1916
|
-
# *
|
|
1915
|
+
# * `:customer_aws_id` - (String)
|
|
1916
|
+
# * `:cust_subscription_id` - (String)
|
|
1917
|
+
# * `:sns_topic_arn` - (String)
|
|
1918
|
+
# * `:status` - (String)
|
|
1919
|
+
# * `:subscription_creation_time` - (String)
|
|
1920
|
+
# * `:source_type` - (String)
|
|
1921
|
+
# * `:source_ids_list` - (Array<String>)
|
|
1922
|
+
# * `:event_categories_list` - (Array<String>)
|
|
1923
|
+
# * `:enabled` - (Boolean)
|
|
1917
1924
|
|
|
1918
1925
|
# @!method remove_tags_from_resource(options = {})
|
|
1919
1926
|
# Calls the RemoveTagsFromResource API operation.
|
|
1920
1927
|
# @param [Hash] options
|
|
1921
|
-
# *
|
|
1928
|
+
# * `:resource_name` - *required* - (String) The DB Instance the tags
|
|
1922
1929
|
# will be removed from.
|
|
1923
|
-
# *
|
|
1930
|
+
# * `:tag_keys` - *required* - (Array<String>) The tag key (name) of
|
|
1924
1931
|
# the tag to be removed.
|
|
1925
1932
|
# @return [Core::Response]
|
|
1926
1933
|
|
|
1927
1934
|
# @!method reset_db_parameter_group(options = {})
|
|
1928
1935
|
# Calls the ResetDBParameterGroup API operation.
|
|
1929
1936
|
# @param [Hash] options
|
|
1930
|
-
# *
|
|
1937
|
+
# * `:db_parameter_group_name` - *required* - (String) The name of the
|
|
1931
1938
|
# DB Parameter Group.
|
|
1932
|
-
# *
|
|
1933
|
-
# not (
|
|
1939
|
+
# * `:reset_all_parameters` - (Boolean) Specifies whether ( `true` ) or
|
|
1940
|
+
# not ( `false` ) to reset all parameters in the DB Parameter Group
|
|
1934
1941
|
# to default values.
|
|
1935
|
-
# *
|
|
1942
|
+
# * `:parameters` - (Array<Hash>) An array of parameter names, values,
|
|
1936
1943
|
# and the apply method for the parameter update. At least one
|
|
1937
1944
|
# parameter name, value, and apply method must be supplied;
|
|
1938
1945
|
# subsequent arguments are optional. A maximum of 20 parameters may
|
|
1939
1946
|
# be modified in a single request.
|
|
1940
|
-
# *
|
|
1941
|
-
# *
|
|
1947
|
+
# * `:parameter_name` - (String) Specifies the name of the parameter.
|
|
1948
|
+
# * `:parameter_value` - (String) Specifies the value of the
|
|
1942
1949
|
# parameter.
|
|
1943
|
-
# *
|
|
1950
|
+
# * `:description` - (String) Provides a description of the
|
|
1944
1951
|
# parameter.
|
|
1945
|
-
# *
|
|
1946
|
-
# *
|
|
1952
|
+
# * `:source` - (String) Indicates the source of the parameter value.
|
|
1953
|
+
# * `:apply_type` - (String) Specifies the engine specific parameters
|
|
1947
1954
|
# type.
|
|
1948
|
-
# *
|
|
1955
|
+
# * `:data_type` - (String) Specifies the valid data type for the
|
|
1949
1956
|
# parameter.
|
|
1950
|
-
# *
|
|
1957
|
+
# * `:allowed_values` - (String) Specifies the valid range of values
|
|
1951
1958
|
# for the parameter.
|
|
1952
|
-
# *
|
|
1953
|
-
# (
|
|
1959
|
+
# * `:is_modifiable` - (Boolean) Indicates whether ( `true` ) or not
|
|
1960
|
+
# ( `false` ) the parameter can be modified. Some parameters have
|
|
1954
1961
|
# security or operational implications that prevent them from being
|
|
1955
1962
|
# changed.
|
|
1956
|
-
# *
|
|
1963
|
+
# * `:minimum_engine_version` - (String) The earliest engine version
|
|
1957
1964
|
# to which the parameter can apply.
|
|
1958
|
-
# *
|
|
1959
|
-
# updates.
|
|
1965
|
+
# * `:apply_method` - (String) Indicates when to apply parameter
|
|
1966
|
+
# updates. Valid values include:
|
|
1967
|
+
# * `immediate`
|
|
1968
|
+
# * `pending-reboot`
|
|
1960
1969
|
# @return [Core::Response]
|
|
1961
1970
|
# The #data method of the response object returns
|
|
1962
1971
|
# a hash with the following structure:
|
|
1963
|
-
# *
|
|
1972
|
+
# * `:db_parameter_group_name` - (String)
|
|
1964
1973
|
|
|
1965
1974
|
# @!method restore_db_instance_from_db_snapshot(options = {})
|
|
1966
1975
|
# Calls the RestoreDBInstanceFromDBSnapshot API operation.
|
|
1967
1976
|
# @param [Hash] options
|
|
1968
|
-
# *
|
|
1977
|
+
# * `:db_instance_identifier` - *required* - (String) The identifier
|
|
1969
1978
|
# for the DB Snapshot to restore from.
|
|
1970
|
-
# *
|
|
1979
|
+
# * `:db_snapshot_identifier` - *required* - (String) Name of the DB
|
|
1971
1980
|
# Instance to create from the DB Snapshot. This parameter isn't case
|
|
1972
1981
|
# sensitive.
|
|
1973
|
-
# *
|
|
1982
|
+
# * `:db_instance_class` - (String) The compute and memory capacity of
|
|
1974
1983
|
# the Amazon RDS DB instance.
|
|
1975
|
-
# *
|
|
1984
|
+
# * `:port` - (Integer) The port number on which the database accepts
|
|
1976
1985
|
# connections.
|
|
1977
|
-
# *
|
|
1986
|
+
# * `:availability_zone` - (String) The EC2 Availability Zone that the
|
|
1978
1987
|
# database instance will be created in.
|
|
1979
|
-
# *
|
|
1988
|
+
# * `:db_subnet_group_name` - (String) The DB Subnet Group name to use
|
|
1980
1989
|
# for the new instance.
|
|
1981
|
-
# *
|
|
1990
|
+
# * `:multi_az` - (Boolean) Specifies if the DB Instance is a Multi-AZ
|
|
1982
1991
|
# deployment. Constraint: You cannot specify the AvailabilityZone
|
|
1983
|
-
# parameter if the MultiAZ parameter is set to
|
|
1984
|
-
# *
|
|
1985
|
-
# options for the DB Instance. A value of
|
|
1992
|
+
# parameter if the MultiAZ parameter is set to `true` .
|
|
1993
|
+
# * `:publicly_accessible` - (Boolean) Specifies the accessibility
|
|
1994
|
+
# options for the DB Instance. A value of `true` specifies an
|
|
1986
1995
|
# Internet-facing instance with a publicly resolvable DNS name, which
|
|
1987
|
-
# resolves to a public IP address. A value of
|
|
1996
|
+
# resolves to a public IP address. A value of `false` specifies an
|
|
1988
1997
|
# internal instance with a DNS name that resolves to a private IP
|
|
1989
1998
|
# address. Default: The default behavior varies depending on whether
|
|
1990
1999
|
# a VPC has been requested or not. The following list shows the
|
|
1991
|
-
# default behavior in each case. Default VPC:
|
|
2000
|
+
# default behavior in each case. Default VPC: `true` VPC: `false` If
|
|
1992
2001
|
# no DB subnet group has been specified as part of the request and
|
|
1993
2002
|
# the PubliclyAccessible value has not been set, the DB instance will
|
|
1994
2003
|
# be publicly accessible. If a specific DB subnet group has been
|
|
1995
2004
|
# specified as part of the request and the PubliclyAccessible value
|
|
1996
2005
|
# has not been set, the DB instance will be private.
|
|
1997
|
-
# *
|
|
2006
|
+
# * `:auto_minor_version_upgrade` - (Boolean) Indicates that minor
|
|
1998
2007
|
# version upgrades will be applied automatically to the DB Instance
|
|
1999
2008
|
# during the maintenance window.
|
|
2000
|
-
# *
|
|
2009
|
+
# * `:license_model` - (String) License model information for the
|
|
2001
2010
|
# restored DB Instance. Default: Same as source. Valid values:
|
|
2002
2011
|
# license-included | bring-your-own-license | general-public-license
|
|
2003
|
-
# *
|
|
2012
|
+
# * `:db_name` - (String) The database name for the restored DB
|
|
2004
2013
|
# Instance. This parameter doesn't apply to the MySQL engine.
|
|
2005
|
-
# *
|
|
2014
|
+
# * `:engine` - (String) The database engine to use for the new
|
|
2006
2015
|
# instance. Default: The same as source Constraint: Must be
|
|
2007
2016
|
# compatible with the engine of the source Example: oracle-ee
|
|
2008
|
-
# *
|
|
2017
|
+
# * `:iops` - (Integer) The amount of Provisioned IOPS (input/output
|
|
2009
2018
|
# operations per second) to be initially allocated for the DB
|
|
2010
2019
|
# Instance. Constraints: Must be an integer greater than 1000.
|
|
2011
|
-
# *
|
|
2020
|
+
# * `:option_group_name` - (String)
|
|
2012
2021
|
# @return [Core::Response]
|
|
2013
2022
|
# The #data method of the response object returns
|
|
2014
2023
|
# a hash with the following structure:
|
|
2015
|
-
# *
|
|
2016
|
-
# *
|
|
2017
|
-
# *
|
|
2018
|
-
# *
|
|
2019
|
-
# *
|
|
2020
|
-
# *
|
|
2021
|
-
# *
|
|
2022
|
-
# *
|
|
2023
|
-
# *
|
|
2024
|
-
# *
|
|
2025
|
-
# *
|
|
2026
|
-
# *
|
|
2027
|
-
# *
|
|
2028
|
-
# *
|
|
2029
|
-
# *
|
|
2030
|
-
# *
|
|
2031
|
-
# *
|
|
2032
|
-
# *
|
|
2033
|
-
# *
|
|
2034
|
-
# *
|
|
2035
|
-
# *
|
|
2036
|
-
# *
|
|
2037
|
-
# *
|
|
2038
|
-
# *
|
|
2039
|
-
# *
|
|
2040
|
-
# *
|
|
2041
|
-
# *
|
|
2042
|
-
# *
|
|
2043
|
-
# *
|
|
2044
|
-
# *
|
|
2045
|
-
# *
|
|
2046
|
-
# *
|
|
2047
|
-
# *
|
|
2048
|
-
# *
|
|
2049
|
-
# *
|
|
2050
|
-
# *
|
|
2051
|
-
# *
|
|
2052
|
-
# *
|
|
2053
|
-
# *
|
|
2054
|
-
# *
|
|
2055
|
-
# *
|
|
2056
|
-
# *
|
|
2057
|
-
# *
|
|
2058
|
-
# *
|
|
2059
|
-
# *
|
|
2060
|
-
# *
|
|
2061
|
-
# *
|
|
2062
|
-
# *
|
|
2063
|
-
# *
|
|
2064
|
-
# *
|
|
2065
|
-
# *
|
|
2066
|
-
# *
|
|
2067
|
-
# *
|
|
2068
|
-
# *
|
|
2069
|
-
# *
|
|
2070
|
-
# *
|
|
2071
|
-
# *
|
|
2072
|
-
# *
|
|
2073
|
-
# *
|
|
2024
|
+
# * `:db_instance_identifier` - (String)
|
|
2025
|
+
# * `:db_instance_class` - (String)
|
|
2026
|
+
# * `:engine` - (String)
|
|
2027
|
+
# * `:db_instance_status` - (String)
|
|
2028
|
+
# * `:master_username` - (String)
|
|
2029
|
+
# * `:db_name` - (String)
|
|
2030
|
+
# * `:endpoint` - (Hash)
|
|
2031
|
+
# * `:address` - (String)
|
|
2032
|
+
# * `:port` - (Integer)
|
|
2033
|
+
# * `:allocated_storage` - (Integer)
|
|
2034
|
+
# * `:instance_create_time` - (Time)
|
|
2035
|
+
# * `:preferred_backup_window` - (String)
|
|
2036
|
+
# * `:backup_retention_period` - (Integer)
|
|
2037
|
+
# * `:db_security_groups` - (Array<Hash>)
|
|
2038
|
+
# * `:db_security_group_name` - (String)
|
|
2039
|
+
# * `:status` - (String)
|
|
2040
|
+
# * `:vpc_security_groups` - (Array<Hash>)
|
|
2041
|
+
# * `:vpc_security_group_id` - (String)
|
|
2042
|
+
# * `:status` - (String)
|
|
2043
|
+
# * `:db_parameter_groups` - (Array<Hash>)
|
|
2044
|
+
# * `:db_parameter_group_name` - (String)
|
|
2045
|
+
# * `:parameter_apply_status` - (String)
|
|
2046
|
+
# * `:availability_zone` - (String)
|
|
2047
|
+
# * `:db_subnet_group` - (Hash)
|
|
2048
|
+
# * `:db_subnet_group_name` - (String)
|
|
2049
|
+
# * `:db_subnet_group_description` - (String)
|
|
2050
|
+
# * `:vpc_id` - (String)
|
|
2051
|
+
# * `:subnet_group_status` - (String)
|
|
2052
|
+
# * `:subnets` - (Array<Hash>)
|
|
2053
|
+
# * `:subnet_identifier` - (String)
|
|
2054
|
+
# * `:subnet_availability_zone` - (Hash)
|
|
2055
|
+
# * `:name` - (String)
|
|
2056
|
+
# * `:provisioned_iops_capable` - (Boolean)
|
|
2057
|
+
# * `:subnet_status` - (String)
|
|
2058
|
+
# * `:preferred_maintenance_window` - (String)
|
|
2059
|
+
# * `:pending_modified_values` - (Hash)
|
|
2060
|
+
# * `:db_instance_class` - (String)
|
|
2061
|
+
# * `:allocated_storage` - (Integer)
|
|
2062
|
+
# * `:master_user_password` - (String)
|
|
2063
|
+
# * `:port` - (Integer)
|
|
2064
|
+
# * `:backup_retention_period` - (Integer)
|
|
2065
|
+
# * `:multi_az` - (Boolean)
|
|
2066
|
+
# * `:engine_version` - (String)
|
|
2067
|
+
# * `:iops` - (Integer)
|
|
2068
|
+
# * `:db_instance_identifier` - (String)
|
|
2069
|
+
# * `:latest_restorable_time` - (Time)
|
|
2070
|
+
# * `:multi_az` - (Boolean)
|
|
2071
|
+
# * `:engine_version` - (String)
|
|
2072
|
+
# * `:auto_minor_version_upgrade` - (Boolean)
|
|
2073
|
+
# * `:read_replica_source_db_instance_identifier` - (String)
|
|
2074
|
+
# * `:read_replica_db_instance_identifiers` - (Array<String>)
|
|
2075
|
+
# * `:license_model` - (String)
|
|
2076
|
+
# * `:iops` - (Integer)
|
|
2077
|
+
# * `:option_group_memberships` - (Array<Hash>)
|
|
2078
|
+
# * `:option_group_name` - (String)
|
|
2079
|
+
# * `:status` - (String)
|
|
2080
|
+
# * `:character_set_name` - (String)
|
|
2081
|
+
# * `:secondary_availability_zone` - (String)
|
|
2082
|
+
# * `:publicly_accessible` - (Boolean)
|
|
2074
2083
|
|
|
2075
2084
|
# @!method restore_db_instance_to_point_in_time(options = {})
|
|
2076
2085
|
# Calls the RestoreDBInstanceToPointInTime API operation.
|
|
2077
2086
|
# @param [Hash] options
|
|
2078
|
-
# *
|
|
2087
|
+
# * `:source_db_instance_identifier` - *required* - (String) The
|
|
2079
2088
|
# identifier of the source DB Instance from which to restore.
|
|
2080
|
-
# *
|
|
2089
|
+
# * `:target_db_instance_identifier` - *required* - (String) The name
|
|
2081
2090
|
# of the new database instance to be created.
|
|
2082
|
-
# *
|
|
2091
|
+
# * `:restore_time` - (String<ISO8601 datetime>) The date and time from
|
|
2083
2092
|
# to restore from.
|
|
2084
|
-
# *
|
|
2085
|
-
#
|
|
2093
|
+
# * `:use_latest_restorable_time` - (Boolean) Specifies whether (
|
|
2094
|
+
# `true` ) or not ( `false` ) the DB Instance is restored from the
|
|
2086
2095
|
# latest backup time.
|
|
2087
|
-
# *
|
|
2096
|
+
# * `:db_instance_class` - (String) The compute and memory capacity of
|
|
2088
2097
|
# the Amazon RDS DB instance.
|
|
2089
|
-
# *
|
|
2098
|
+
# * `:port` - (Integer) The port number on which the database accepts
|
|
2090
2099
|
# connections.
|
|
2091
|
-
# *
|
|
2100
|
+
# * `:availability_zone` - (String) The EC2 Availability Zone that the
|
|
2092
2101
|
# database instance will be created in.
|
|
2093
|
-
# *
|
|
2102
|
+
# * `:db_subnet_group_name` - (String) The DB subnet group name to use
|
|
2094
2103
|
# for the new instance.
|
|
2095
|
-
# *
|
|
2104
|
+
# * `:multi_az` - (Boolean) Specifies if the DB Instance is a Multi-AZ
|
|
2096
2105
|
# deployment. Constraint: You cannot specify the AvailabilityZone
|
|
2097
|
-
# parameter if the MultiAZ parameter is set to
|
|
2098
|
-
# *
|
|
2099
|
-
# options for the DB Instance. A value of
|
|
2106
|
+
# parameter if the MultiAZ parameter is set to `true` .
|
|
2107
|
+
# * `:publicly_accessible` - (Boolean) Specifies the accessibility
|
|
2108
|
+
# options for the DB Instance. A value of `true` specifies an
|
|
2100
2109
|
# Internet-facing instance with a publicly resolvable DNS name, which
|
|
2101
|
-
# resolves to a public IP address. A value of
|
|
2110
|
+
# resolves to a public IP address. A value of `false` specifies an
|
|
2102
2111
|
# internal instance with a DNS name that resolves to a private IP
|
|
2103
2112
|
# address. Default: The default behavior varies depending on whether
|
|
2104
2113
|
# a VPC has been requested or not. The following list shows the
|
|
2105
|
-
# default behavior in each case. Default VPC:
|
|
2114
|
+
# default behavior in each case. Default VPC: `true` VPC: `false` If
|
|
2106
2115
|
# no DB subnet group has been specified as part of the request and
|
|
2107
2116
|
# the PubliclyAccessible value has not been set, the DB instance will
|
|
2108
2117
|
# be publicly accessible. If a specific DB subnet group has been
|
|
2109
2118
|
# specified as part of the request and the PubliclyAccessible value
|
|
2110
2119
|
# has not been set, the DB instance will be private.
|
|
2111
|
-
# *
|
|
2120
|
+
# * `:auto_minor_version_upgrade` - (Boolean) Indicates that minor
|
|
2112
2121
|
# version upgrades will be applied automatically to the DB Instance
|
|
2113
2122
|
# during the maintenance window.
|
|
2114
|
-
# *
|
|
2123
|
+
# * `:license_model` - (String) License model information for the
|
|
2115
2124
|
# restored DB Instance. Default: Same as source. Valid values:
|
|
2116
2125
|
# license-included | bring-your-own-license | general-public-license
|
|
2117
|
-
# *
|
|
2126
|
+
# * `:db_name` - (String) The database name for the restored DB
|
|
2118
2127
|
# Instance. This parameter is not used for the MySQL engine.
|
|
2119
|
-
# *
|
|
2128
|
+
# * `:engine` - (String) The database engine to use for the new
|
|
2120
2129
|
# instance. Default: The same as source Constraint: Must be
|
|
2121
2130
|
# compatible with the engine of the source Example: oracle-ee
|
|
2122
|
-
# *
|
|
2131
|
+
# * `:iops` - (Integer) The amount of Provisioned IOPS (input/output
|
|
2123
2132
|
# operations per second) to be initially allocated for the DB
|
|
2124
2133
|
# Instance. Constraints: Must be an integer greater than 1000.
|
|
2125
|
-
# *
|
|
2134
|
+
# * `:option_group_name` - (String)
|
|
2126
2135
|
# @return [Core::Response]
|
|
2127
2136
|
# The #data method of the response object returns
|
|
2128
2137
|
# a hash with the following structure:
|
|
2129
|
-
# *
|
|
2130
|
-
# *
|
|
2131
|
-
# *
|
|
2132
|
-
# *
|
|
2133
|
-
# *
|
|
2134
|
-
# *
|
|
2135
|
-
# *
|
|
2136
|
-
# *
|
|
2137
|
-
# *
|
|
2138
|
-
# *
|
|
2139
|
-
# *
|
|
2140
|
-
# *
|
|
2141
|
-
# *
|
|
2142
|
-
# *
|
|
2143
|
-
# *
|
|
2144
|
-
# *
|
|
2145
|
-
# *
|
|
2146
|
-
# *
|
|
2147
|
-
# *
|
|
2148
|
-
# *
|
|
2149
|
-
# *
|
|
2150
|
-
# *
|
|
2151
|
-
# *
|
|
2152
|
-
# *
|
|
2153
|
-
# *
|
|
2154
|
-
# *
|
|
2155
|
-
# *
|
|
2156
|
-
# *
|
|
2157
|
-
# *
|
|
2158
|
-
# *
|
|
2159
|
-
# *
|
|
2160
|
-
# *
|
|
2161
|
-
# *
|
|
2162
|
-
# *
|
|
2163
|
-
# *
|
|
2164
|
-
# *
|
|
2165
|
-
# *
|
|
2166
|
-
# *
|
|
2167
|
-
# *
|
|
2168
|
-
# *
|
|
2169
|
-
# *
|
|
2170
|
-
# *
|
|
2171
|
-
# *
|
|
2172
|
-
# *
|
|
2173
|
-
# *
|
|
2174
|
-
# *
|
|
2175
|
-
# *
|
|
2176
|
-
# *
|
|
2177
|
-
# *
|
|
2178
|
-
# *
|
|
2179
|
-
# *
|
|
2180
|
-
# *
|
|
2181
|
-
# *
|
|
2182
|
-
# *
|
|
2183
|
-
# *
|
|
2184
|
-
# *
|
|
2185
|
-
# *
|
|
2186
|
-
# *
|
|
2187
|
-
# *
|
|
2138
|
+
# * `:db_instance_identifier` - (String)
|
|
2139
|
+
# * `:db_instance_class` - (String)
|
|
2140
|
+
# * `:engine` - (String)
|
|
2141
|
+
# * `:db_instance_status` - (String)
|
|
2142
|
+
# * `:master_username` - (String)
|
|
2143
|
+
# * `:db_name` - (String)
|
|
2144
|
+
# * `:endpoint` - (Hash)
|
|
2145
|
+
# * `:address` - (String)
|
|
2146
|
+
# * `:port` - (Integer)
|
|
2147
|
+
# * `:allocated_storage` - (Integer)
|
|
2148
|
+
# * `:instance_create_time` - (Time)
|
|
2149
|
+
# * `:preferred_backup_window` - (String)
|
|
2150
|
+
# * `:backup_retention_period` - (Integer)
|
|
2151
|
+
# * `:db_security_groups` - (Array<Hash>)
|
|
2152
|
+
# * `:db_security_group_name` - (String)
|
|
2153
|
+
# * `:status` - (String)
|
|
2154
|
+
# * `:vpc_security_groups` - (Array<Hash>)
|
|
2155
|
+
# * `:vpc_security_group_id` - (String)
|
|
2156
|
+
# * `:status` - (String)
|
|
2157
|
+
# * `:db_parameter_groups` - (Array<Hash>)
|
|
2158
|
+
# * `:db_parameter_group_name` - (String)
|
|
2159
|
+
# * `:parameter_apply_status` - (String)
|
|
2160
|
+
# * `:availability_zone` - (String)
|
|
2161
|
+
# * `:db_subnet_group` - (Hash)
|
|
2162
|
+
# * `:db_subnet_group_name` - (String)
|
|
2163
|
+
# * `:db_subnet_group_description` - (String)
|
|
2164
|
+
# * `:vpc_id` - (String)
|
|
2165
|
+
# * `:subnet_group_status` - (String)
|
|
2166
|
+
# * `:subnets` - (Array<Hash>)
|
|
2167
|
+
# * `:subnet_identifier` - (String)
|
|
2168
|
+
# * `:subnet_availability_zone` - (Hash)
|
|
2169
|
+
# * `:name` - (String)
|
|
2170
|
+
# * `:provisioned_iops_capable` - (Boolean)
|
|
2171
|
+
# * `:subnet_status` - (String)
|
|
2172
|
+
# * `:preferred_maintenance_window` - (String)
|
|
2173
|
+
# * `:pending_modified_values` - (Hash)
|
|
2174
|
+
# * `:db_instance_class` - (String)
|
|
2175
|
+
# * `:allocated_storage` - (Integer)
|
|
2176
|
+
# * `:master_user_password` - (String)
|
|
2177
|
+
# * `:port` - (Integer)
|
|
2178
|
+
# * `:backup_retention_period` - (Integer)
|
|
2179
|
+
# * `:multi_az` - (Boolean)
|
|
2180
|
+
# * `:engine_version` - (String)
|
|
2181
|
+
# * `:iops` - (Integer)
|
|
2182
|
+
# * `:db_instance_identifier` - (String)
|
|
2183
|
+
# * `:latest_restorable_time` - (Time)
|
|
2184
|
+
# * `:multi_az` - (Boolean)
|
|
2185
|
+
# * `:engine_version` - (String)
|
|
2186
|
+
# * `:auto_minor_version_upgrade` - (Boolean)
|
|
2187
|
+
# * `:read_replica_source_db_instance_identifier` - (String)
|
|
2188
|
+
# * `:read_replica_db_instance_identifiers` - (Array<String>)
|
|
2189
|
+
# * `:license_model` - (String)
|
|
2190
|
+
# * `:iops` - (Integer)
|
|
2191
|
+
# * `:option_group_memberships` - (Array<Hash>)
|
|
2192
|
+
# * `:option_group_name` - (String)
|
|
2193
|
+
# * `:status` - (String)
|
|
2194
|
+
# * `:character_set_name` - (String)
|
|
2195
|
+
# * `:secondary_availability_zone` - (String)
|
|
2196
|
+
# * `:publicly_accessible` - (Boolean)
|
|
2188
2197
|
|
|
2189
2198
|
# @!method revoke_db_security_group_ingress(options = {})
|
|
2190
2199
|
# Calls the RevokeDBSecurityGroupIngress API operation.
|
|
2191
2200
|
# @param [Hash] options
|
|
2192
|
-
# *
|
|
2201
|
+
# * `:db_security_group_name` - *required* - (String) The name of the
|
|
2193
2202
|
# DB Security Group to revoke ingress from.
|
|
2194
|
-
# *
|
|
2195
|
-
# *
|
|
2203
|
+
# * `:cidrip` - (String) The IP range to revoke access from.
|
|
2204
|
+
# * `:ec2_security_group_name` - (String) The name of the EC2 Security
|
|
2196
2205
|
# Group to revoke access from.
|
|
2197
|
-
# *
|
|
2206
|
+
# * `:ec2_security_group_id` - (String) The id of the EC2 Security
|
|
2198
2207
|
# Group to revoke access from. For VPC DB Security Groups,
|
|
2199
2208
|
# EC2SecurityGroupId must be provided. Otherwise,
|
|
2200
2209
|
# EC2SecurityGroupOwnerId and either EC2SecurityGroupName or
|
|
2201
2210
|
# EC2SecurityGroupId must be provided.
|
|
2202
|
-
# *
|
|
2211
|
+
# * `:ec2_security_group_owner_id` - (String) The AWS Account Number of
|
|
2203
2212
|
# the owner of the security group specified in the
|
|
2204
2213
|
# EC2SecurityGroupName parameter. The AWS Access Key ID is not an
|
|
2205
2214
|
# acceptable value.
|
|
2206
2215
|
# @return [Core::Response]
|
|
2207
2216
|
# The #data method of the response object returns
|
|
2208
2217
|
# a hash with the following structure:
|
|
2209
|
-
# *
|
|
2210
|
-
# *
|
|
2211
|
-
# *
|
|
2212
|
-
# *
|
|
2213
|
-
# *
|
|
2214
|
-
# *
|
|
2215
|
-
# *
|
|
2216
|
-
# *
|
|
2217
|
-
# *
|
|
2218
|
-
# *
|
|
2219
|
-
# *
|
|
2220
|
-
# *
|
|
2218
|
+
# * `:owner_id` - (String)
|
|
2219
|
+
# * `:db_security_group_name` - (String)
|
|
2220
|
+
# * `:db_security_group_description` - (String)
|
|
2221
|
+
# * `:vpc_id` - (String)
|
|
2222
|
+
# * `:ec_2_security_groups` - (Array<Hash>)
|
|
2223
|
+
# * `:status` - (String)
|
|
2224
|
+
# * `:ec2_security_group_name` - (String)
|
|
2225
|
+
# * `:ec2_security_group_id` - (String)
|
|
2226
|
+
# * `:ec2_security_group_owner_id` - (String)
|
|
2227
|
+
# * `:ip_ranges` - (Array<Hash>)
|
|
2228
|
+
# * `:status` - (String)
|
|
2229
|
+
# * `:cidrip` - (String)
|
|
2221
2230
|
|
|
2222
2231
|
# end client methods #
|
|
2223
2232
|
|