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/elasticache.rb
CHANGED
@@ -18,33 +18,33 @@ module AWS
|
|
18
18
|
|
19
19
|
# Provides an expressive, object-oriented interface to Amazon ElastiCache.
|
20
20
|
#
|
21
|
-
#
|
21
|
+
# ## Credentials
|
22
22
|
#
|
23
23
|
# You can setup default credentials for all AWS services via
|
24
24
|
# AWS.config:
|
25
25
|
#
|
26
|
-
#
|
27
|
-
#
|
28
|
-
#
|
26
|
+
# AWS.config(
|
27
|
+
# :access_key_id => 'YOUR_ACCESS_KEY_ID',
|
28
|
+
# :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
|
29
29
|
#
|
30
30
|
# Or you can set them directly on the ElastiCache interface:
|
31
31
|
#
|
32
|
-
#
|
33
|
-
#
|
34
|
-
#
|
32
|
+
# ec = AWS::ElastiCache.new(
|
33
|
+
# :access_key_id => 'YOUR_ACCESS_KEY_ID',
|
34
|
+
# :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
|
35
35
|
#
|
36
36
|
# @!attribute [r] client
|
37
37
|
# @return [Client] the low-level ElastiCache client object
|
38
38
|
class ElastiCache
|
39
39
|
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
autoload :Request, 'request'
|
44
|
-
end
|
40
|
+
autoload :Client, 'aws/elasticache/client'
|
41
|
+
autoload :Errors, 'aws/elasticache/errors'
|
42
|
+
autoload :Request, 'aws/elasticache/request'
|
45
43
|
|
46
44
|
include Core::ServiceInterface
|
47
45
|
|
46
|
+
endpoint_prefix 'elasticache'
|
47
|
+
|
48
48
|
end
|
49
49
|
|
50
50
|
end
|
@@ -25,234 +25,234 @@ module AWS
|
|
25
25
|
# @!method authorize_cache_security_group_ingress(options = {})
|
26
26
|
# Calls the AuthorizeCacheSecurityGroupIngress API operation.
|
27
27
|
# @param [Hash] options
|
28
|
-
# *
|
28
|
+
# * `:cache_security_group_name` - *required* - (String) The name of
|
29
29
|
# the Cache Security Group to authorize.
|
30
|
-
# *
|
30
|
+
# * `:ec2_security_group_name` - *required* - (String) Name of the EC2
|
31
31
|
# Security Group to include in the authorization.
|
32
|
-
# *
|
32
|
+
# * `:ec2_security_group_owner_id` - *required* - (String) AWS Account
|
33
33
|
# Number of the owner of the security group specified in the
|
34
34
|
# EC2SecurityGroupName parameter. The AWS Access Key ID is not an
|
35
35
|
# acceptable value.
|
36
36
|
# @return [Core::Response]
|
37
37
|
# The #data method of the response object returns
|
38
38
|
# a hash with the following structure:
|
39
|
-
# *
|
40
|
-
# *
|
41
|
-
# *
|
42
|
-
# *
|
43
|
-
# *
|
44
|
-
# *
|
45
|
-
# *
|
39
|
+
# * `:owner_id` - (String)
|
40
|
+
# * `:cache_security_group_name` - (String)
|
41
|
+
# * `:description` - (String)
|
42
|
+
# * `:ec_2_security_groups` - (Array<Hash>)
|
43
|
+
# * `:status` - (String)
|
44
|
+
# * `:ec2_security_group_name` - (String)
|
45
|
+
# * `:ec2_security_group_owner_id` - (String)
|
46
46
|
|
47
47
|
# @!method create_cache_cluster(options = {})
|
48
48
|
# Calls the CreateCacheCluster API operation.
|
49
49
|
# @param [Hash] options
|
50
|
-
# *
|
50
|
+
# * `:cache_cluster_id` - *required* - (String) The Cache Cluster
|
51
51
|
# identifier. This parameter is stored as a lowercase string.
|
52
52
|
# Constraints: Must contain from 1 to 20 alphanumeric characters or
|
53
53
|
# hyphens. First character must be a letter. Cannot end with a hyphen
|
54
54
|
# or contain two consecutive hyphens. Example: mycachecluster
|
55
|
-
# *
|
55
|
+
# * `:num_cache_nodes` - *required* - (Integer) The number of Cache
|
56
56
|
# Nodes the Cache Cluster should have.
|
57
|
-
# *
|
57
|
+
# * `:cache_node_type` - *required* - (String) The compute and memory
|
58
58
|
# capacity of nodes in a Cache Cluster. Valid values: cache.m1.large
|
59
59
|
# | cache.m1.xlarge | cache.m2.xlarge | cache.m2.2xlarge |
|
60
60
|
# cache.m2.4xlarge | cache.c1.xlarge
|
61
|
-
# *
|
61
|
+
# * `:engine` - *required* - (String) The name of the cache engine to
|
62
62
|
# be used for this Cache Cluster. Currently, memcached is the only
|
63
63
|
# cache engine supported by the service.
|
64
|
-
# *
|
64
|
+
# * `:engine_version` - (String) The version of the cache engine to be
|
65
65
|
# used for this cluster.
|
66
|
-
# *
|
66
|
+
# * `:cache_parameter_group_name` - (String) The name of the cache
|
67
67
|
# parameter group to associate with this Cache cluster. If this
|
68
68
|
# argument is omitted, the default CacheParameterGroup for the
|
69
69
|
# specified engine will be used.
|
70
|
-
# *
|
70
|
+
# * `:cache_subnet_group_name` - (String) The name of the Cache Subnet
|
71
71
|
# Group to be used for the Cache Cluster. Use this parameter only
|
72
72
|
# when you are creating a cluster in an Amazon Virtual Private Cloud
|
73
73
|
# (VPC).
|
74
|
-
# *
|
74
|
+
# * `:cache_security_group_names` - (Array<String>) A list of Cache
|
75
75
|
# Security Group Names to associate with this Cache Cluster.
|
76
|
-
# *
|
76
|
+
# * `:security_group_ids` - (Array<String>) Specifies the VPC Security
|
77
77
|
# Groups associated with the Cache Cluster. Use this parameter only
|
78
78
|
# when you are creating a cluster in an Amazon Virtual Private Cloud
|
79
79
|
# (VPC).
|
80
|
-
# *
|
80
|
+
# * `:preferred_availability_zone` - (String) The EC2 Availability Zone
|
81
81
|
# that the Cache Cluster will be created in. In normal use, all
|
82
82
|
# CacheNodes belonging to a CacheCluster are placed in the preferred
|
83
83
|
# availability zone. In rare circumstances, some of the CacheNodes
|
84
84
|
# might temporarily be in a different availability zone. Default:
|
85
85
|
# System chosen (random) availability zone.
|
86
|
-
# *
|
86
|
+
# * `:preferred_maintenance_window` - (String) The weekly time range
|
87
87
|
# (in UTC) during which system maintenance can occur. Example:
|
88
88
|
# sun:05:00-sun:09:00
|
89
|
-
# *
|
89
|
+
# * `:port` - (Integer) The port number on which each of the Cache
|
90
90
|
# Nodes will accept connections.
|
91
|
-
# *
|
91
|
+
# * `:notification_topic_arn` - (String) The Amazon Resource Name (ARN)
|
92
92
|
# of the Amazon Simple Notification Service (SNS) topic to which
|
93
93
|
# notifications will be sent. The Amazon SNS topic owner must be the
|
94
94
|
# same as the Cache Cluster owner.
|
95
|
-
# *
|
95
|
+
# * `:auto_minor_version_upgrade` - (Boolean) Indicates that minor
|
96
96
|
# engine upgrades will be applied automatically to the Cache Cluster
|
97
|
-
# during the maintenance window. Default:
|
97
|
+
# during the maintenance window. Default: `true`
|
98
98
|
# @return [Core::Response]
|
99
99
|
# The #data method of the response object returns
|
100
100
|
# a hash with the following structure:
|
101
|
-
# *
|
102
|
-
# *
|
103
|
-
# *
|
104
|
-
# *
|
105
|
-
# *
|
106
|
-
# *
|
107
|
-
# *
|
108
|
-
# *
|
109
|
-
# *
|
110
|
-
# *
|
111
|
-
# *
|
112
|
-
# *
|
113
|
-
# *
|
114
|
-
# *
|
115
|
-
# *
|
116
|
-
# *
|
117
|
-
# *
|
118
|
-
# *
|
119
|
-
# *
|
120
|
-
# *
|
121
|
-
# *
|
122
|
-
# *
|
123
|
-
# *
|
124
|
-
# *
|
125
|
-
# *
|
126
|
-
# *
|
127
|
-
# *
|
128
|
-
# *
|
129
|
-
# *
|
130
|
-
# *
|
131
|
-
# *
|
132
|
-
# *
|
133
|
-
# *
|
134
|
-
# *
|
135
|
-
# *
|
136
|
-
# *
|
137
|
-
# *
|
138
|
-
# *
|
139
|
-
# *
|
140
|
-
# *
|
101
|
+
# * `:cache_cluster_id` - (String)
|
102
|
+
# * `:configuration_endpoint` - (Hash)
|
103
|
+
# * `:address` - (String)
|
104
|
+
# * `:port` - (Integer)
|
105
|
+
# * `:client_download_landing_page` - (String)
|
106
|
+
# * `:cache_node_type` - (String)
|
107
|
+
# * `:engine` - (String)
|
108
|
+
# * `:engine_version` - (String)
|
109
|
+
# * `:cache_cluster_status` - (String)
|
110
|
+
# * `:num_cache_nodes` - (Integer)
|
111
|
+
# * `:preferred_availability_zone` - (String)
|
112
|
+
# * `:cache_cluster_create_time` - (Time)
|
113
|
+
# * `:preferred_maintenance_window` - (String)
|
114
|
+
# * `:pending_modified_values` - (Hash)
|
115
|
+
# * `:num_cache_nodes` - (Integer)
|
116
|
+
# * `:cache_node_ids_to_remove` - (Array<String>)
|
117
|
+
# * `:engine_version` - (String)
|
118
|
+
# * `:notification_configuration` - (Hash)
|
119
|
+
# * `:topic_arn` - (String)
|
120
|
+
# * `:topic_status` - (String)
|
121
|
+
# * `:cache_security_groups` - (Array<Hash>)
|
122
|
+
# * `:cache_security_group_name` - (String)
|
123
|
+
# * `:status` - (String)
|
124
|
+
# * `:cache_parameter_group` - (Hash)
|
125
|
+
# * `:cache_parameter_group_name` - (String)
|
126
|
+
# * `:parameter_apply_status` - (String)
|
127
|
+
# * `:cache_node_ids_to_reboot` - (Array<String>)
|
128
|
+
# * `:cache_subnet_group_name` - (String)
|
129
|
+
# * `:cache_nodes` - (Array<Hash>)
|
130
|
+
# * `:cache_node_id` - (String)
|
131
|
+
# * `:cache_node_status` - (String)
|
132
|
+
# * `:cache_node_create_time` - (Time)
|
133
|
+
# * `:endpoint` - (Hash)
|
134
|
+
# * `:address` - (String)
|
135
|
+
# * `:port` - (Integer)
|
136
|
+
# * `:parameter_group_status` - (String)
|
137
|
+
# * `:auto_minor_version_upgrade` - (Boolean)
|
138
|
+
# * `:security_groups` - (Array<Hash>)
|
139
|
+
# * `:security_group_id` - (String)
|
140
|
+
# * `:status` - (String)
|
141
141
|
|
142
142
|
# @!method create_cache_parameter_group(options = {})
|
143
143
|
# Calls the CreateCacheParameterGroup API operation.
|
144
144
|
# @param [Hash] options
|
145
|
-
# *
|
145
|
+
# * `:cache_parameter_group_name` - *required* - (String) The name of
|
146
146
|
# the Cache Parameter Group.
|
147
|
-
# *
|
147
|
+
# * `:cache_parameter_group_family` - *required* - (String) The name of
|
148
148
|
# the Cache Parameter Group Family the Cache Parameter Group can be
|
149
149
|
# used with. Currently, memcached1.4 is the only cache parameter
|
150
150
|
# group family supported by the service.
|
151
|
-
# *
|
151
|
+
# * `:description` - *required* - (String) The description for the
|
152
152
|
# Cache Parameter Group.
|
153
153
|
# @return [Core::Response]
|
154
154
|
# The #data method of the response object returns
|
155
155
|
# a hash with the following structure:
|
156
|
-
# *
|
157
|
-
# *
|
158
|
-
# *
|
156
|
+
# * `:cache_parameter_group_name` - (String)
|
157
|
+
# * `:cache_parameter_group_family` - (String)
|
158
|
+
# * `:description` - (String)
|
159
159
|
|
160
160
|
# @!method create_cache_security_group(options = {})
|
161
161
|
# Calls the CreateCacheSecurityGroup API operation.
|
162
162
|
# @param [Hash] options
|
163
|
-
# *
|
163
|
+
# * `:cache_security_group_name` - *required* - (String) The name for
|
164
164
|
# the Cache Security Group. This value is stored as a lowercase
|
165
165
|
# string. Constraints: Must contain no more than 255 alphanumeric
|
166
166
|
# characters. Must not be "Default". Example: mysecuritygroup
|
167
|
-
# *
|
167
|
+
# * `:description` - *required* - (String) The description for the
|
168
168
|
# Cache Security Group.
|
169
169
|
# @return [Core::Response]
|
170
170
|
# The #data method of the response object returns
|
171
171
|
# a hash with the following structure:
|
172
|
-
# *
|
173
|
-
# *
|
174
|
-
# *
|
175
|
-
# *
|
176
|
-
# *
|
177
|
-
# *
|
178
|
-
# *
|
172
|
+
# * `:owner_id` - (String)
|
173
|
+
# * `:cache_security_group_name` - (String)
|
174
|
+
# * `:description` - (String)
|
175
|
+
# * `:ec_2_security_groups` - (Array<Hash>)
|
176
|
+
# * `:status` - (String)
|
177
|
+
# * `:ec2_security_group_name` - (String)
|
178
|
+
# * `:ec2_security_group_owner_id` - (String)
|
179
179
|
|
180
180
|
# @!method create_cache_subnet_group(options = {})
|
181
181
|
# Calls the CreateCacheSubnetGroup API operation.
|
182
182
|
# @param [Hash] options
|
183
|
-
# *
|
183
|
+
# * `:cache_subnet_group_name` - *required* - (String) The name for the
|
184
184
|
# Cache Subnet Group. This value is stored as a lowercase string.
|
185
185
|
# Constraints: Must contain no more than 255 alphanumeric characters
|
186
186
|
# or hyphens. Example: mysubnetgroup
|
187
|
-
# *
|
187
|
+
# * `:cache_subnet_group_description` - *required* - (String) The
|
188
188
|
# description for the Cache Subnet Group.
|
189
|
-
# *
|
189
|
+
# * `:subnet_ids` - *required* - (Array<String>) The EC2 Subnet IDs for
|
190
190
|
# the Cache Subnet Group.
|
191
191
|
# @return [Core::Response]
|
192
192
|
# The #data method of the response object returns
|
193
193
|
# a hash with the following structure:
|
194
|
-
# *
|
195
|
-
# *
|
196
|
-
# *
|
197
|
-
# *
|
198
|
-
# *
|
199
|
-
# *
|
200
|
-
# *
|
194
|
+
# * `:cache_subnet_group_name` - (String)
|
195
|
+
# * `:cache_subnet_group_description` - (String)
|
196
|
+
# * `:vpc_id` - (String)
|
197
|
+
# * `:subnets` - (Array<Hash>)
|
198
|
+
# * `:subnet_identifier` - (String)
|
199
|
+
# * `:subnet_availability_zone` - (Hash)
|
200
|
+
# * `:name` - (String)
|
201
201
|
|
202
202
|
# @!method delete_cache_cluster(options = {})
|
203
203
|
# Calls the DeleteCacheCluster API operation.
|
204
204
|
# @param [Hash] options
|
205
|
-
# *
|
205
|
+
# * `:cache_cluster_id` - *required* - (String) The Cache Cluster
|
206
206
|
# identifier for the Cache Cluster to be deleted. This parameter
|
207
207
|
# isn't case sensitive.
|
208
208
|
# @return [Core::Response]
|
209
209
|
# The #data method of the response object returns
|
210
210
|
# a hash with the following structure:
|
211
|
-
# *
|
212
|
-
# *
|
213
|
-
# *
|
214
|
-
# *
|
215
|
-
# *
|
216
|
-
# *
|
217
|
-
# *
|
218
|
-
# *
|
219
|
-
# *
|
220
|
-
# *
|
221
|
-
# *
|
222
|
-
# *
|
223
|
-
# *
|
224
|
-
# *
|
225
|
-
# *
|
226
|
-
# *
|
227
|
-
# *
|
228
|
-
# *
|
229
|
-
# *
|
230
|
-
# *
|
231
|
-
# *
|
232
|
-
# *
|
233
|
-
# *
|
234
|
-
# *
|
235
|
-
# *
|
236
|
-
# *
|
237
|
-
# *
|
238
|
-
# *
|
239
|
-
# *
|
240
|
-
# *
|
241
|
-
# *
|
242
|
-
# *
|
243
|
-
# *
|
244
|
-
# *
|
245
|
-
# *
|
246
|
-
# *
|
247
|
-
# *
|
248
|
-
# *
|
249
|
-
# *
|
250
|
-
# *
|
211
|
+
# * `:cache_cluster_id` - (String)
|
212
|
+
# * `:configuration_endpoint` - (Hash)
|
213
|
+
# * `:address` - (String)
|
214
|
+
# * `:port` - (Integer)
|
215
|
+
# * `:client_download_landing_page` - (String)
|
216
|
+
# * `:cache_node_type` - (String)
|
217
|
+
# * `:engine` - (String)
|
218
|
+
# * `:engine_version` - (String)
|
219
|
+
# * `:cache_cluster_status` - (String)
|
220
|
+
# * `:num_cache_nodes` - (Integer)
|
221
|
+
# * `:preferred_availability_zone` - (String)
|
222
|
+
# * `:cache_cluster_create_time` - (Time)
|
223
|
+
# * `:preferred_maintenance_window` - (String)
|
224
|
+
# * `:pending_modified_values` - (Hash)
|
225
|
+
# * `:num_cache_nodes` - (Integer)
|
226
|
+
# * `:cache_node_ids_to_remove` - (Array<String>)
|
227
|
+
# * `:engine_version` - (String)
|
228
|
+
# * `:notification_configuration` - (Hash)
|
229
|
+
# * `:topic_arn` - (String)
|
230
|
+
# * `:topic_status` - (String)
|
231
|
+
# * `:cache_security_groups` - (Array<Hash>)
|
232
|
+
# * `:cache_security_group_name` - (String)
|
233
|
+
# * `:status` - (String)
|
234
|
+
# * `:cache_parameter_group` - (Hash)
|
235
|
+
# * `:cache_parameter_group_name` - (String)
|
236
|
+
# * `:parameter_apply_status` - (String)
|
237
|
+
# * `:cache_node_ids_to_reboot` - (Array<String>)
|
238
|
+
# * `:cache_subnet_group_name` - (String)
|
239
|
+
# * `:cache_nodes` - (Array<Hash>)
|
240
|
+
# * `:cache_node_id` - (String)
|
241
|
+
# * `:cache_node_status` - (String)
|
242
|
+
# * `:cache_node_create_time` - (Time)
|
243
|
+
# * `:endpoint` - (Hash)
|
244
|
+
# * `:address` - (String)
|
245
|
+
# * `:port` - (Integer)
|
246
|
+
# * `:parameter_group_status` - (String)
|
247
|
+
# * `:auto_minor_version_upgrade` - (Boolean)
|
248
|
+
# * `:security_groups` - (Array<Hash>)
|
249
|
+
# * `:security_group_id` - (String)
|
250
|
+
# * `:status` - (String)
|
251
251
|
|
252
252
|
# @!method delete_cache_parameter_group(options = {})
|
253
253
|
# Calls the DeleteCacheParameterGroup API operation.
|
254
254
|
# @param [Hash] options
|
255
|
-
# *
|
255
|
+
# * `:cache_parameter_group_name` - *required* - (String) The name of
|
256
256
|
# the Cache Parameter Group to delete. The specified cache security
|
257
257
|
# group must not be associated with any Cache clusters.
|
258
258
|
# @return [Core::Response]
|
@@ -260,7 +260,7 @@ module AWS
|
|
260
260
|
# @!method delete_cache_security_group(options = {})
|
261
261
|
# Calls the DeleteCacheSecurityGroup API operation.
|
262
262
|
# @param [Hash] options
|
263
|
-
# *
|
263
|
+
# * `:cache_security_group_name` - *required* - (String) The name of
|
264
264
|
# the Cache Security Group to delete. You cannot delete the default
|
265
265
|
# security group.
|
266
266
|
# @return [Core::Response]
|
@@ -268,7 +268,7 @@ module AWS
|
|
268
268
|
# @!method delete_cache_subnet_group(options = {})
|
269
269
|
# Calls the DeleteCacheSubnetGroup API operation.
|
270
270
|
# @param [Hash] options
|
271
|
-
# *
|
271
|
+
# * `:cache_subnet_group_name` - *required* - (String) The name of the
|
272
272
|
# Cache Subnet Group to delete. Constraints: Must contain no more
|
273
273
|
# than 255 alphanumeric characters or hyphens.
|
274
274
|
# @return [Core::Response]
|
@@ -276,640 +276,645 @@ module AWS
|
|
276
276
|
# @!method describe_cache_clusters(options = {})
|
277
277
|
# Calls the DescribeCacheClusters API operation.
|
278
278
|
# @param [Hash] options
|
279
|
-
# *
|
279
|
+
# * `:cache_cluster_id` - (String) The user-supplied cluster
|
280
280
|
# identifier. If this parameter is specified, only information about
|
281
281
|
# that specific Cache Cluster is returned. This parameter isn't case
|
282
282
|
# sensitive.
|
283
|
-
# *
|
283
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
284
284
|
# in the response. If more records exist than the specified
|
285
285
|
# MaxRecords value, a marker is included in the response so that the
|
286
286
|
# remaining results may be retrieved. Default: 100 Constraints:
|
287
287
|
# minimum 20, maximum 100
|
288
|
-
# *
|
288
|
+
# * `:marker` - (String) An optional marker provided in the previous
|
289
289
|
# DescribeCacheClusters request. If this parameter is specified, the
|
290
290
|
# response includes only records beyond the marker, up to the value
|
291
291
|
# specified by MaxRecords.
|
292
|
-
# *
|
292
|
+
# * `:show_cache_node_info` - (Boolean) An optional flag that can be
|
293
293
|
# included in the DescribeCacheCluster request to retrieve Cache
|
294
294
|
# Nodes information.
|
295
295
|
# @return [Core::Response]
|
296
296
|
# The #data method of the response object returns
|
297
297
|
# a hash with the following structure:
|
298
|
-
# *
|
299
|
-
# *
|
300
|
-
# *
|
301
|
-
# *
|
302
|
-
# *
|
303
|
-
# *
|
304
|
-
# *
|
305
|
-
# *
|
306
|
-
# *
|
307
|
-
# *
|
308
|
-
# *
|
309
|
-
# *
|
310
|
-
# *
|
311
|
-
# *
|
312
|
-
# *
|
313
|
-
# *
|
314
|
-
# *
|
315
|
-
# *
|
316
|
-
# *
|
317
|
-
# *
|
318
|
-
# *
|
319
|
-
# *
|
320
|
-
# *
|
321
|
-
# *
|
322
|
-
# *
|
323
|
-
# *
|
324
|
-
# *
|
325
|
-
# *
|
326
|
-
# *
|
327
|
-
# *
|
328
|
-
# *
|
329
|
-
# *
|
330
|
-
# *
|
331
|
-
# *
|
332
|
-
# *
|
333
|
-
# *
|
334
|
-
# *
|
335
|
-
# *
|
336
|
-
# *
|
337
|
-
# *
|
338
|
-
# *
|
339
|
-
# *
|
298
|
+
# * `:marker` - (String)
|
299
|
+
# * `:cache_clusters` - (Array<Hash>)
|
300
|
+
# * `:cache_cluster_id` - (String)
|
301
|
+
# * `:configuration_endpoint` - (Hash)
|
302
|
+
# * `:address` - (String)
|
303
|
+
# * `:port` - (Integer)
|
304
|
+
# * `:client_download_landing_page` - (String)
|
305
|
+
# * `:cache_node_type` - (String)
|
306
|
+
# * `:engine` - (String)
|
307
|
+
# * `:engine_version` - (String)
|
308
|
+
# * `:cache_cluster_status` - (String)
|
309
|
+
# * `:num_cache_nodes` - (Integer)
|
310
|
+
# * `:preferred_availability_zone` - (String)
|
311
|
+
# * `:cache_cluster_create_time` - (Time)
|
312
|
+
# * `:preferred_maintenance_window` - (String)
|
313
|
+
# * `:pending_modified_values` - (Hash)
|
314
|
+
# * `:num_cache_nodes` - (Integer)
|
315
|
+
# * `:cache_node_ids_to_remove` - (Array<String>)
|
316
|
+
# * `:engine_version` - (String)
|
317
|
+
# * `:notification_configuration` - (Hash)
|
318
|
+
# * `:topic_arn` - (String)
|
319
|
+
# * `:topic_status` - (String)
|
320
|
+
# * `:cache_security_groups` - (Array<Hash>)
|
321
|
+
# * `:cache_security_group_name` - (String)
|
322
|
+
# * `:status` - (String)
|
323
|
+
# * `:cache_parameter_group` - (Hash)
|
324
|
+
# * `:cache_parameter_group_name` - (String)
|
325
|
+
# * `:parameter_apply_status` - (String)
|
326
|
+
# * `:cache_node_ids_to_reboot` - (Array<String>)
|
327
|
+
# * `:cache_subnet_group_name` - (String)
|
328
|
+
# * `:cache_nodes` - (Array<Hash>)
|
329
|
+
# * `:cache_node_id` - (String)
|
330
|
+
# * `:cache_node_status` - (String)
|
331
|
+
# * `:cache_node_create_time` - (Time)
|
332
|
+
# * `:endpoint` - (Hash)
|
333
|
+
# * `:address` - (String)
|
334
|
+
# * `:port` - (Integer)
|
335
|
+
# * `:parameter_group_status` - (String)
|
336
|
+
# * `:auto_minor_version_upgrade` - (Boolean)
|
337
|
+
# * `:security_groups` - (Array<Hash>)
|
338
|
+
# * `:security_group_id` - (String)
|
339
|
+
# * `:status` - (String)
|
340
340
|
|
341
341
|
# @!method describe_cache_engine_versions(options = {})
|
342
342
|
# Calls the DescribeCacheEngineVersions API operation.
|
343
343
|
# @param [Hash] options
|
344
|
-
# *
|
345
|
-
# *
|
344
|
+
# * `:engine` - (String) The cache engine to return.
|
345
|
+
# * `:engine_version` - (String) The cache engine version to return.
|
346
346
|
# Example: 1.4.14
|
347
|
-
# *
|
347
|
+
# * `:cache_parameter_group_family` - (String) The name of a specific
|
348
348
|
# Cache Parameter Group family to return details for. Constraints:
|
349
349
|
# Must be 1 to 255 alphanumeric characters First character must be a
|
350
350
|
# letter Cannot end with a hyphen or contain two consecutive hyphens
|
351
|
-
# *
|
351
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
352
352
|
# in the response. If more records exist than the specified
|
353
353
|
# MaxRecords value, a marker is included in the response so that the
|
354
354
|
# remaining results may be retrieved.
|
355
|
-
# *
|
355
|
+
# * `:marker` - (String) An optional marker provided in the previous
|
356
356
|
# DescribeCacheParameterGroups request. If this parameter is
|
357
357
|
# specified, the response includes only records beyond the marker, up
|
358
358
|
# to the value specified by MaxRecords.
|
359
|
-
# *
|
359
|
+
# * `:default_only` - (Boolean) Indicates that only the default version
|
360
360
|
# of the specified engine or engine and major version combination is
|
361
361
|
# returned.
|
362
362
|
# @return [Core::Response]
|
363
363
|
# The #data method of the response object returns
|
364
364
|
# a hash with the following structure:
|
365
|
-
# *
|
366
|
-
# *
|
367
|
-
# *
|
368
|
-
# *
|
369
|
-
# *
|
370
|
-
# *
|
371
|
-
# *
|
365
|
+
# * `:marker` - (String)
|
366
|
+
# * `:cache_engine_versions` - (Array<Hash>)
|
367
|
+
# * `:engine` - (String)
|
368
|
+
# * `:engine_version` - (String)
|
369
|
+
# * `:cache_parameter_group_family` - (String)
|
370
|
+
# * `:cache_engine_description` - (String)
|
371
|
+
# * `:cache_engine_version_description` - (String)
|
372
372
|
|
373
373
|
# @!method describe_cache_parameter_groups(options = {})
|
374
374
|
# Calls the DescribeCacheParameterGroups API operation.
|
375
375
|
# @param [Hash] options
|
376
|
-
# *
|
376
|
+
# * `:cache_parameter_group_name` - (String) The name of a specific
|
377
377
|
# cache parameter group to return details for.
|
378
|
-
# *
|
378
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
379
379
|
# in the response. If more records exist than the specified
|
380
380
|
# MaxRecords value, a marker is included in the response so that the
|
381
381
|
# remaining results may be retrieved.
|
382
|
-
# *
|
382
|
+
# * `:marker` - (String) An optional marker provided in the previous
|
383
383
|
# DescribeCacheParameterGroups request. If this parameter is
|
384
384
|
# specified, the response includes only records beyond the marker, up
|
385
385
|
# to the value specified by MaxRecords.
|
386
386
|
# @return [Core::Response]
|
387
387
|
# The #data method of the response object returns
|
388
388
|
# a hash with the following structure:
|
389
|
-
# *
|
390
|
-
# *
|
391
|
-
# *
|
392
|
-
# *
|
393
|
-
# *
|
389
|
+
# * `:marker` - (String)
|
390
|
+
# * `:cache_parameter_groups` - (Array<Hash>)
|
391
|
+
# * `:cache_parameter_group_name` - (String)
|
392
|
+
# * `:cache_parameter_group_family` - (String)
|
393
|
+
# * `:description` - (String)
|
394
394
|
|
395
395
|
# @!method describe_cache_parameters(options = {})
|
396
396
|
# Calls the DescribeCacheParameters API operation.
|
397
397
|
# @param [Hash] options
|
398
|
-
# *
|
398
|
+
# * `:cache_parameter_group_name` - *required* - (String) The name of a
|
399
399
|
# specific cache parameter group to return details for.
|
400
|
-
# *
|
400
|
+
# * `:source` - (String) The parameter types to return. Valid values:
|
401
401
|
# user | system | engine-default
|
402
|
-
# *
|
402
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
403
403
|
# in the response. If more records exist than the specified
|
404
404
|
# MaxRecords value, a marker is included in the response so that the
|
405
405
|
# remaining results may be retrieved.
|
406
|
-
# *
|
406
|
+
# * `:marker` - (String) An optional marker provided in the previous
|
407
407
|
# DescribeCacheClusters request. If this parameter is specified, the
|
408
408
|
# response includes only records beyond the marker, up to the value
|
409
409
|
# specified by MaxRecords.
|
410
410
|
# @return [Core::Response]
|
411
411
|
# The #data method of the response object returns
|
412
412
|
# a hash with the following structure:
|
413
|
-
# *
|
414
|
-
# *
|
415
|
-
# *
|
416
|
-
# *
|
417
|
-
# *
|
418
|
-
# *
|
419
|
-
# *
|
420
|
-
# *
|
421
|
-
# *
|
422
|
-
# *
|
423
|
-
# *
|
424
|
-
# *
|
425
|
-
# *
|
426
|
-
# *
|
427
|
-
# *
|
428
|
-
# *
|
429
|
-
# *
|
430
|
-
# *
|
431
|
-
# *
|
432
|
-
# *
|
433
|
-
# *
|
413
|
+
# * `:marker` - (String)
|
414
|
+
# * `:parameters` - (Array<Hash>)
|
415
|
+
# * `:parameter_name` - (String)
|
416
|
+
# * `:parameter_value` - (String)
|
417
|
+
# * `:description` - (String)
|
418
|
+
# * `:source` - (String)
|
419
|
+
# * `:data_type` - (String)
|
420
|
+
# * `:allowed_values` - (String)
|
421
|
+
# * `:is_modifiable` - (Boolean)
|
422
|
+
# * `:minimum_engine_version` - (String)
|
423
|
+
# * `:cache_node_type_specific_parameters` - (Array<Hash>)
|
424
|
+
# * `:parameter_name` - (String)
|
425
|
+
# * `:description` - (String)
|
426
|
+
# * `:source` - (String)
|
427
|
+
# * `:data_type` - (String)
|
428
|
+
# * `:allowed_values` - (String)
|
429
|
+
# * `:is_modifiable` - (Boolean)
|
430
|
+
# * `:minimum_engine_version` - (String)
|
431
|
+
# * `:cache_node_type_specific_values` - (Array<Hash>)
|
432
|
+
# * `:cache_node_type` - (String)
|
433
|
+
# * `:value` - (String)
|
434
434
|
|
435
435
|
# @!method describe_cache_security_groups(options = {})
|
436
436
|
# Calls the DescribeCacheSecurityGroups API operation.
|
437
437
|
# @param [Hash] options
|
438
|
-
# *
|
438
|
+
# * `:cache_security_group_name` - (String) The name of the Cache
|
439
439
|
# Security Group to return details for.
|
440
|
-
# *
|
440
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
441
441
|
# in the response. If more records exist than the specified
|
442
442
|
# MaxRecords value, a marker is included in the response so that the
|
443
443
|
# remaining results may be retrieved. Default: 100 Constraints:
|
444
444
|
# minimum 20, maximum 100
|
445
|
-
# *
|
445
|
+
# * `:marker` - (String) An optional marker provided in the previous
|
446
446
|
# DescribeCacheClusters request. If this parameter is specified, the
|
447
447
|
# response includes only records beyond the marker, up to the value
|
448
448
|
# specified by MaxRecords.
|
449
449
|
# @return [Core::Response]
|
450
450
|
# The #data method of the response object returns
|
451
451
|
# a hash with the following structure:
|
452
|
-
# *
|
453
|
-
# *
|
454
|
-
# *
|
455
|
-
# *
|
456
|
-
# *
|
457
|
-
# *
|
458
|
-
# *
|
459
|
-
# *
|
460
|
-
# *
|
452
|
+
# * `:marker` - (String)
|
453
|
+
# * `:cache_security_groups` - (Array<Hash>)
|
454
|
+
# * `:owner_id` - (String)
|
455
|
+
# * `:cache_security_group_name` - (String)
|
456
|
+
# * `:description` - (String)
|
457
|
+
# * `:ec_2_security_groups` - (Array<Hash>)
|
458
|
+
# * `:status` - (String)
|
459
|
+
# * `:ec2_security_group_name` - (String)
|
460
|
+
# * `:ec2_security_group_owner_id` - (String)
|
461
461
|
|
462
462
|
# @!method describe_cache_subnet_groups(options = {})
|
463
463
|
# Calls the DescribeCacheSubnetGroups API operation.
|
464
464
|
# @param [Hash] options
|
465
|
-
# *
|
465
|
+
# * `:cache_subnet_group_name` - (String) The name of the Cache Subnet
|
466
466
|
# Group to return details for.
|
467
|
-
# *
|
467
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
468
468
|
# in the response. If more records exist than the specified
|
469
469
|
# MaxRecords value, a marker is included in the response so that the
|
470
470
|
# remaining results may be retrieved. Default: 100 Constraints:
|
471
471
|
# minimum 20, maximum 100
|
472
|
-
# *
|
472
|
+
# * `:marker` - (String) An optional marker provided in the previous
|
473
473
|
# DescribeCacheSubnetGroups request. If this parameter is specified,
|
474
474
|
# the response includes only records beyond the marker, up to the
|
475
475
|
# value specified by MaxRecords.
|
476
476
|
# @return [Core::Response]
|
477
477
|
# The #data method of the response object returns
|
478
478
|
# a hash with the following structure:
|
479
|
-
# *
|
480
|
-
# *
|
481
|
-
# *
|
482
|
-
# *
|
483
|
-
# *
|
484
|
-
# *
|
485
|
-
# *
|
486
|
-
# *
|
487
|
-
# *
|
479
|
+
# * `:marker` - (String)
|
480
|
+
# * `:cache_subnet_groups` - (Array<Hash>)
|
481
|
+
# * `:cache_subnet_group_name` - (String)
|
482
|
+
# * `:cache_subnet_group_description` - (String)
|
483
|
+
# * `:vpc_id` - (String)
|
484
|
+
# * `:subnets` - (Array<Hash>)
|
485
|
+
# * `:subnet_identifier` - (String)
|
486
|
+
# * `:subnet_availability_zone` - (Hash)
|
487
|
+
# * `:name` - (String)
|
488
488
|
|
489
489
|
# @!method describe_engine_default_parameters(options = {})
|
490
490
|
# Calls the DescribeEngineDefaultParameters API operation.
|
491
491
|
# @param [Hash] options
|
492
|
-
# *
|
492
|
+
# * `:cache_parameter_group_family` - *required* - (String) The name of
|
493
493
|
# the Cache Parameter Group Family. Currently, memcached1.4 is the
|
494
494
|
# only cache parameter group family supported by the service.
|
495
|
-
# *
|
495
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
496
496
|
# in the response. If more records exist than the specified
|
497
497
|
# MaxRecords value, a marker is included in the response so that the
|
498
498
|
# remaining results may be retrieved.
|
499
|
-
# *
|
499
|
+
# * `:marker` - (String) An optional marker provided in the previous
|
500
500
|
# DescribeCacheClusters request. If this parameter is specified, the
|
501
501
|
# response includes only records beyond the marker, up to the value
|
502
502
|
# specified by MaxRecords.
|
503
503
|
# @return [Core::Response]
|
504
504
|
# The #data method of the response object returns
|
505
505
|
# a hash with the following structure:
|
506
|
-
# *
|
507
|
-
# *
|
508
|
-
# *
|
509
|
-
# *
|
510
|
-
# *
|
511
|
-
# *
|
512
|
-
# *
|
513
|
-
# *
|
514
|
-
# *
|
515
|
-
# *
|
516
|
-
# *
|
517
|
-
# *
|
518
|
-
# *
|
519
|
-
# *
|
520
|
-
# *
|
521
|
-
# *
|
522
|
-
# *
|
523
|
-
# *
|
524
|
-
# *
|
525
|
-
# *
|
526
|
-
# *
|
527
|
-
# *
|
506
|
+
# * `:cache_parameter_group_family` - (String)
|
507
|
+
# * `:marker` - (String)
|
508
|
+
# * `:parameters` - (Array<Hash>)
|
509
|
+
# * `:parameter_name` - (String)
|
510
|
+
# * `:parameter_value` - (String)
|
511
|
+
# * `:description` - (String)
|
512
|
+
# * `:source` - (String)
|
513
|
+
# * `:data_type` - (String)
|
514
|
+
# * `:allowed_values` - (String)
|
515
|
+
# * `:is_modifiable` - (Boolean)
|
516
|
+
# * `:minimum_engine_version` - (String)
|
517
|
+
# * `:cache_node_type_specific_parameters` - (Array<Hash>)
|
518
|
+
# * `:parameter_name` - (String)
|
519
|
+
# * `:description` - (String)
|
520
|
+
# * `:source` - (String)
|
521
|
+
# * `:data_type` - (String)
|
522
|
+
# * `:allowed_values` - (String)
|
523
|
+
# * `:is_modifiable` - (Boolean)
|
524
|
+
# * `:minimum_engine_version` - (String)
|
525
|
+
# * `:cache_node_type_specific_values` - (Array<Hash>)
|
526
|
+
# * `:cache_node_type` - (String)
|
527
|
+
# * `:value` - (String)
|
528
528
|
|
529
529
|
# @!method describe_events(options = {})
|
530
530
|
# Calls the DescribeEvents API operation.
|
531
531
|
# @param [Hash] options
|
532
|
-
# *
|
532
|
+
# * `:source_identifier` - (String) The identifier of the event source
|
533
533
|
# for which events will be returned. If not specified, then all
|
534
534
|
# sources are included in the response.
|
535
|
-
# *
|
536
|
-
# If no value is specified, all events are returned.
|
537
|
-
#
|
535
|
+
# * `:source_type` - (String) The event source to retrieve events for.
|
536
|
+
# If no value is specified, all events are returned. Valid values
|
537
|
+
# include:
|
538
|
+
# * `cache-cluster`
|
539
|
+
# * `cache-parameter-group`
|
540
|
+
# * `cache-security-group`
|
541
|
+
# * `cache-subnet-group`
|
542
|
+
# * `:start_time` - (String<ISO8601 datetime>) The beginning of the
|
538
543
|
# time interval to retrieve events for, specified in ISO 8601 format.
|
539
|
-
# *
|
544
|
+
# * `:end_time` - (String<ISO8601 datetime>) The end of the time
|
540
545
|
# interval for which to retrieve events, specified in ISO 8601
|
541
546
|
# format.
|
542
|
-
# *
|
547
|
+
# * `:duration` - (Integer) The number of minutes to retrieve events
|
543
548
|
# for.
|
544
|
-
# *
|
549
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
545
550
|
# in the response. If more records exist than the specified
|
546
551
|
# MaxRecords value, a marker is included in the response so that the
|
547
552
|
# remaining results may be retrieved.
|
548
|
-
# *
|
553
|
+
# * `:marker` - (String) An optional marker provided in the previous
|
549
554
|
# DescribeCacheClusters request. If this parameter is specified, the
|
550
555
|
# response includes only records beyond the marker, up to the value
|
551
556
|
# specified by MaxRecords.
|
552
557
|
# @return [Core::Response]
|
553
558
|
# The #data method of the response object returns
|
554
559
|
# a hash with the following structure:
|
555
|
-
# *
|
556
|
-
# *
|
557
|
-
# *
|
558
|
-
# *
|
559
|
-
# *
|
560
|
-
# *
|
560
|
+
# * `:marker` - (String)
|
561
|
+
# * `:events` - (Array<Hash>)
|
562
|
+
# * `:source_identifier` - (String)
|
563
|
+
# * `:source_type` - (String)
|
564
|
+
# * `:message` - (String)
|
565
|
+
# * `:date` - (Time)
|
561
566
|
|
562
567
|
# @!method describe_reserved_cache_nodes(options = {})
|
563
568
|
# Calls the DescribeReservedCacheNodes API operation.
|
564
569
|
# @param [Hash] options
|
565
|
-
# *
|
570
|
+
# * `:reserved_cache_node_id` - (String) The reserved Cache Node
|
566
571
|
# identifier filter value. Specify this parameter to show only the
|
567
572
|
# reservation that matches the specified reservation ID.
|
568
|
-
# *
|
573
|
+
# * `:reserved_cache_nodes_offering_id` - (String) The offering
|
569
574
|
# identifier filter value. Specify this parameter to show only
|
570
575
|
# purchased reservations matching the specified offering identifier.
|
571
|
-
# *
|
576
|
+
# * `:cache_node_type` - (String) The Cache Node type filter value.
|
572
577
|
# Specify this parameter to show only those reservations matching the
|
573
578
|
# specified Cache Nodes type.
|
574
|
-
# *
|
579
|
+
# * `:duration` - (String) The duration filter value, specified in
|
575
580
|
# years or seconds. Specify this parameter to show only reservations
|
576
581
|
# for this duration. Valid Values: 1 | 3 | 31536000 | 94608000
|
577
|
-
# *
|
582
|
+
# * `:product_description` - (String) The product description filter
|
578
583
|
# value. Specify this parameter to show only those reservations
|
579
584
|
# matching the specified product description.
|
580
|
-
# *
|
585
|
+
# * `:offering_type` - (String) The offering type filter value. Specify
|
581
586
|
# this parameter to show only the available offerings matching the
|
582
587
|
# specified offering type. Valid Values: "Light Utilization" |
|
583
588
|
# "Medium Utilization" | "Heavy Utilization"
|
584
|
-
# *
|
589
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
585
590
|
# in the response. If more than the MaxRecords value is available, a
|
586
591
|
# marker is included in the response so that the following results
|
587
592
|
# can be retrieved. Default: 100 Constraints: minimum 20, maximum 100
|
588
|
-
# *
|
593
|
+
# * `:marker` - (String) The marker provided in the previous request.
|
589
594
|
# If this parameter is specified, the response includes records
|
590
595
|
# beyond the marker only, up to MaxRecords.
|
591
596
|
# @return [Core::Response]
|
592
597
|
# The #data method of the response object returns
|
593
598
|
# a hash with the following structure:
|
594
|
-
# *
|
595
|
-
# *
|
596
|
-
# *
|
597
|
-
# *
|
598
|
-
# *
|
599
|
-
# *
|
600
|
-
# *
|
601
|
-
# *
|
602
|
-
# *
|
603
|
-
# *
|
604
|
-
# *
|
605
|
-
# *
|
606
|
-
# *
|
607
|
-
# *
|
608
|
-
# *
|
609
|
-
# *
|
599
|
+
# * `:marker` - (String)
|
600
|
+
# * `:reserved_cache_nodes` - (Array<Hash>)
|
601
|
+
# * `:reserved_cache_node_id` - (String)
|
602
|
+
# * `:reserved_cache_nodes_offering_id` - (String)
|
603
|
+
# * `:cache_node_type` - (String)
|
604
|
+
# * `:start_time` - (Time)
|
605
|
+
# * `:duration` - (Integer)
|
606
|
+
# * `:fixed_price` - (Numeric)
|
607
|
+
# * `:usage_price` - (Numeric)
|
608
|
+
# * `:cache_node_count` - (Integer)
|
609
|
+
# * `:product_description` - (String)
|
610
|
+
# * `:offering_type` - (String)
|
611
|
+
# * `:state` - (String)
|
612
|
+
# * `:recurring_charges` - (Array<Hash>)
|
613
|
+
# * `:recurring_charge_amount` - (Numeric)
|
614
|
+
# * `:recurring_charge_frequency` - (String)
|
610
615
|
|
611
616
|
# @!method describe_reserved_cache_nodes_offerings(options = {})
|
612
617
|
# Calls the DescribeReservedCacheNodesOfferings API operation.
|
613
618
|
# @param [Hash] options
|
614
|
-
# *
|
619
|
+
# * `:reserved_cache_nodes_offering_id` - (String) The offering
|
615
620
|
# identifier filter value. Specify this parameter to show only the
|
616
621
|
# available offering that matches the specified reservation
|
617
622
|
# identifier. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
|
618
|
-
# *
|
623
|
+
# * `:cache_node_type` - (String) The Cache Node type filter value.
|
619
624
|
# Specify this parameter to show only the available offerings
|
620
625
|
# matching the specified Cache Node type.
|
621
|
-
# *
|
626
|
+
# * `:duration` - (String) Duration filter value, specified in years or
|
622
627
|
# seconds. Specify this parameter to show only reservations for this
|
623
628
|
# duration. Valid Values: 1 | 3 | 31536000 | 94608000
|
624
|
-
# *
|
629
|
+
# * `:product_description` - (String) Product description filter value.
|
625
630
|
# Specify this parameter to show only the available offerings
|
626
631
|
# matching the specified product description.
|
627
|
-
# *
|
632
|
+
# * `:offering_type` - (String) The offering type filter value. Specify
|
628
633
|
# this parameter to show only the available offerings matching the
|
629
634
|
# specified offering type. Valid Values: "Light Utilization" |
|
630
635
|
# "Medium Utilization" | "Heavy Utilization"
|
631
|
-
# *
|
636
|
+
# * `:max_records` - (Integer) The maximum number of records to include
|
632
637
|
# in the response. If more than the MaxRecords value is available, a
|
633
638
|
# marker is included in the response so that the following results
|
634
639
|
# can be retrieved. Default: 100 Constraints: minimum 20, maximum 100
|
635
|
-
# *
|
640
|
+
# * `:marker` - (String) The marker provided in the previous request.
|
636
641
|
# If this parameter is specified, the response includes records
|
637
642
|
# beyond the marker only, up to MaxRecords.
|
638
643
|
# @return [Core::Response]
|
639
644
|
# The #data method of the response object returns
|
640
645
|
# a hash with the following structure:
|
641
|
-
# *
|
642
|
-
# *
|
643
|
-
# *
|
644
|
-
# *
|
645
|
-
# *
|
646
|
-
# *
|
647
|
-
# *
|
648
|
-
# *
|
649
|
-
# *
|
650
|
-
# *
|
651
|
-
# *
|
652
|
-
# *
|
646
|
+
# * `:marker` - (String)
|
647
|
+
# * `:reserved_cache_nodes_offerings` - (Array<Hash>)
|
648
|
+
# * `:reserved_cache_nodes_offering_id` - (String)
|
649
|
+
# * `:cache_node_type` - (String)
|
650
|
+
# * `:duration` - (Integer)
|
651
|
+
# * `:fixed_price` - (Numeric)
|
652
|
+
# * `:usage_price` - (Numeric)
|
653
|
+
# * `:product_description` - (String)
|
654
|
+
# * `:offering_type` - (String)
|
655
|
+
# * `:recurring_charges` - (Array<Hash>)
|
656
|
+
# * `:recurring_charge_amount` - (Numeric)
|
657
|
+
# * `:recurring_charge_frequency` - (String)
|
653
658
|
|
654
659
|
# @!method modify_cache_cluster(options = {})
|
655
660
|
# Calls the ModifyCacheCluster API operation.
|
656
661
|
# @param [Hash] options
|
657
|
-
# *
|
662
|
+
# * `:cache_cluster_id` - *required* - (String) The Cache Cluster
|
658
663
|
# identifier. This value is stored as a lowercase string.
|
659
|
-
# *
|
664
|
+
# * `:num_cache_nodes` - (Integer) The number of Cache Nodes the Cache
|
660
665
|
# Cluster should have. If NumCacheNodes is greater than the existing
|
661
666
|
# number of Cache Nodes, Cache Nodes will be added. If NumCacheNodes
|
662
667
|
# is less than the existing number of Cache Nodes, Cache Nodes will
|
663
668
|
# be removed. When removing Cache Nodes, the Ids of the specific
|
664
669
|
# Cache Nodes to be removed must be supplied using the
|
665
670
|
# CacheNodeIdsToRemove parameter.
|
666
|
-
# *
|
671
|
+
# * `:cache_node_ids_to_remove` - (Array<String>) The list of Cache
|
667
672
|
# Node IDs to be removed. This parameter is only valid when
|
668
673
|
# NumCacheNodes is less than the existing number of Cache Nodes. The
|
669
674
|
# number of Cache Node Ids supplied in this parameter must match the
|
670
675
|
# difference between the existing number of Cache Nodes in the
|
671
676
|
# cluster and the new NumCacheNodes requested.
|
672
|
-
# *
|
677
|
+
# * `:cache_security_group_names` - (Array<String>) A list of Cache
|
673
678
|
# Security Group Names to authorize on this Cache Cluster. This
|
674
679
|
# change is asynchronously applied as soon as possible. Constraints:
|
675
680
|
# Must contain no more than 255 alphanumeric characters. Must not be
|
676
681
|
# "Default".
|
677
|
-
# *
|
682
|
+
# * `:security_group_ids` - (Array<String>) Specifies the VPC Security
|
678
683
|
# Groups associated with the Cache Cluster. This parameter can be
|
679
684
|
# used only with clusters that are created in an Amazon Virtual
|
680
685
|
# Private Cloud (VPC).
|
681
|
-
# *
|
686
|
+
# * `:preferred_maintenance_window` - (String) The weekly time range
|
682
687
|
# (in UTC) during which system maintenance can occur, which may
|
683
688
|
# result in an outage. This change is made immediately. If moving
|
684
689
|
# this window to the current time, there must be at least 120 minutes
|
685
690
|
# between the current time and end of the window to ensure pending
|
686
691
|
# changes are applied.
|
687
|
-
# *
|
692
|
+
# * `:notification_topic_arn` - (String) The Amazon Resource Name (ARN)
|
688
693
|
# of the SNS topic to which notifications will be sent. The SNS topic
|
689
694
|
# owner must be same as the Cache Cluster owner.
|
690
|
-
# *
|
695
|
+
# * `:cache_parameter_group_name` - (String) The name of the Cache
|
691
696
|
# Parameter Group to apply to this Cache Cluster. This change is
|
692
697
|
# asynchronously applied as soon as possible for parameters when the
|
693
|
-
# ApplyImmediately parameter is specified as
|
694
|
-
# *
|
698
|
+
# ApplyImmediately parameter is specified as `true` for this request.
|
699
|
+
# * `:notification_topic_status` - (String) The status of the Amazon
|
695
700
|
# SNS notification topic. The value can be active or inactive.
|
696
701
|
# Notifications are sent only if the status is active.
|
697
|
-
# *
|
702
|
+
# * `:apply_immediately` - (Boolean) Specifies whether or not the
|
698
703
|
# modifications in this request and any pending modifications are
|
699
704
|
# asynchronously applied as soon as possible, regardless of the
|
700
705
|
# PreferredMaintenanceWindow setting for the Cache Cluster. If this
|
701
|
-
# parameter is passed as
|
706
|
+
# parameter is passed as `false` , changes to the Cache Cluster are
|
702
707
|
# applied on the next maintenance reboot, or the next failure reboot,
|
703
|
-
# whichever occurs first. Default:
|
704
|
-
# *
|
708
|
+
# whichever occurs first. Default: `false`
|
709
|
+
# * `:engine_version` - (String) The version of the cache engine to
|
705
710
|
# upgrade this cluster to.
|
706
|
-
# *
|
711
|
+
# * `:auto_minor_version_upgrade` - (Boolean) Indicates that minor
|
707
712
|
# engine upgrades will be applied automatically to the Cache Cluster
|
708
|
-
# during the maintenance window. Default:
|
713
|
+
# during the maintenance window. Default: `true`
|
709
714
|
# @return [Core::Response]
|
710
715
|
# The #data method of the response object returns
|
711
716
|
# a hash with the following structure:
|
712
|
-
# *
|
713
|
-
# *
|
714
|
-
# *
|
715
|
-
# *
|
716
|
-
# *
|
717
|
-
# *
|
718
|
-
# *
|
719
|
-
# *
|
720
|
-
# *
|
721
|
-
# *
|
722
|
-
# *
|
723
|
-
# *
|
724
|
-
# *
|
725
|
-
# *
|
726
|
-
# *
|
727
|
-
# *
|
728
|
-
# *
|
729
|
-
# *
|
730
|
-
# *
|
731
|
-
# *
|
732
|
-
# *
|
733
|
-
# *
|
734
|
-
# *
|
735
|
-
# *
|
736
|
-
# *
|
737
|
-
# *
|
738
|
-
# *
|
739
|
-
# *
|
740
|
-
# *
|
741
|
-
# *
|
742
|
-
# *
|
743
|
-
# *
|
744
|
-
# *
|
745
|
-
# *
|
746
|
-
# *
|
747
|
-
# *
|
748
|
-
# *
|
749
|
-
# *
|
750
|
-
# *
|
751
|
-
# *
|
717
|
+
# * `:cache_cluster_id` - (String)
|
718
|
+
# * `:configuration_endpoint` - (Hash)
|
719
|
+
# * `:address` - (String)
|
720
|
+
# * `:port` - (Integer)
|
721
|
+
# * `:client_download_landing_page` - (String)
|
722
|
+
# * `:cache_node_type` - (String)
|
723
|
+
# * `:engine` - (String)
|
724
|
+
# * `:engine_version` - (String)
|
725
|
+
# * `:cache_cluster_status` - (String)
|
726
|
+
# * `:num_cache_nodes` - (Integer)
|
727
|
+
# * `:preferred_availability_zone` - (String)
|
728
|
+
# * `:cache_cluster_create_time` - (Time)
|
729
|
+
# * `:preferred_maintenance_window` - (String)
|
730
|
+
# * `:pending_modified_values` - (Hash)
|
731
|
+
# * `:num_cache_nodes` - (Integer)
|
732
|
+
# * `:cache_node_ids_to_remove` - (Array<String>)
|
733
|
+
# * `:engine_version` - (String)
|
734
|
+
# * `:notification_configuration` - (Hash)
|
735
|
+
# * `:topic_arn` - (String)
|
736
|
+
# * `:topic_status` - (String)
|
737
|
+
# * `:cache_security_groups` - (Array<Hash>)
|
738
|
+
# * `:cache_security_group_name` - (String)
|
739
|
+
# * `:status` - (String)
|
740
|
+
# * `:cache_parameter_group` - (Hash)
|
741
|
+
# * `:cache_parameter_group_name` - (String)
|
742
|
+
# * `:parameter_apply_status` - (String)
|
743
|
+
# * `:cache_node_ids_to_reboot` - (Array<String>)
|
744
|
+
# * `:cache_subnet_group_name` - (String)
|
745
|
+
# * `:cache_nodes` - (Array<Hash>)
|
746
|
+
# * `:cache_node_id` - (String)
|
747
|
+
# * `:cache_node_status` - (String)
|
748
|
+
# * `:cache_node_create_time` - (Time)
|
749
|
+
# * `:endpoint` - (Hash)
|
750
|
+
# * `:address` - (String)
|
751
|
+
# * `:port` - (Integer)
|
752
|
+
# * `:parameter_group_status` - (String)
|
753
|
+
# * `:auto_minor_version_upgrade` - (Boolean)
|
754
|
+
# * `:security_groups` - (Array<Hash>)
|
755
|
+
# * `:security_group_id` - (String)
|
756
|
+
# * `:status` - (String)
|
752
757
|
|
753
758
|
# @!method modify_cache_parameter_group(options = {})
|
754
759
|
# Calls the ModifyCacheParameterGroup API operation.
|
755
760
|
# @param [Hash] options
|
756
|
-
# *
|
761
|
+
# * `:cache_parameter_group_name` - *required* - (String) The name of
|
757
762
|
# the cache parameter group to modify.
|
758
|
-
# *
|
763
|
+
# * `:parameter_name_values` - *required* - (Array<Hash>) An array of
|
759
764
|
# parameter names and values for the parameter update. At least one
|
760
765
|
# parameter name and value must be supplied; subsequent arguments are
|
761
766
|
# optional. A maximum of 20 parameters may be modified in a single
|
762
767
|
# request.
|
763
|
-
# *
|
764
|
-
# *
|
768
|
+
# * `:parameter_name` - (String) Specifies the name of the parameter.
|
769
|
+
# * `:parameter_value` - (String) Specifies the value of the
|
765
770
|
# parameter.
|
766
771
|
# @return [Core::Response]
|
767
772
|
# The #data method of the response object returns
|
768
773
|
# a hash with the following structure:
|
769
|
-
# *
|
774
|
+
# * `:cache_parameter_group_name` - (String)
|
770
775
|
|
771
776
|
# @!method modify_cache_subnet_group(options = {})
|
772
777
|
# Calls the ModifyCacheSubnetGroup API operation.
|
773
778
|
# @param [Hash] options
|
774
|
-
# *
|
779
|
+
# * `:cache_subnet_group_name` - *required* - (String) The name for the
|
775
780
|
# Cache Subnet Group. This value is stored as a lowercase string.
|
776
781
|
# Constraints: Must contain no more than 255 alphanumeric characters
|
777
782
|
# or hyphens. Example: mysubnetgroup
|
778
|
-
# *
|
783
|
+
# * `:cache_subnet_group_description` - (String) The description for
|
779
784
|
# the Cache Subnet Group.
|
780
|
-
# *
|
785
|
+
# * `:subnet_ids` - (Array<String>) The EC2 Subnet IDs for the Cache
|
781
786
|
# Subnet Group.
|
782
787
|
# @return [Core::Response]
|
783
788
|
# The #data method of the response object returns
|
784
789
|
# a hash with the following structure:
|
785
|
-
# *
|
786
|
-
# *
|
787
|
-
# *
|
788
|
-
# *
|
789
|
-
# *
|
790
|
-
# *
|
791
|
-
# *
|
790
|
+
# * `:cache_subnet_group_name` - (String)
|
791
|
+
# * `:cache_subnet_group_description` - (String)
|
792
|
+
# * `:vpc_id` - (String)
|
793
|
+
# * `:subnets` - (Array<Hash>)
|
794
|
+
# * `:subnet_identifier` - (String)
|
795
|
+
# * `:subnet_availability_zone` - (Hash)
|
796
|
+
# * `:name` - (String)
|
792
797
|
|
793
798
|
# @!method purchase_reserved_cache_nodes_offering(options = {})
|
794
799
|
# Calls the PurchaseReservedCacheNodesOffering API operation.
|
795
800
|
# @param [Hash] options
|
796
|
-
# *
|
801
|
+
# * `:reserved_cache_nodes_offering_id` - *required* - (String) The ID
|
797
802
|
# of the Reserved Cache Node offering to purchase. Example:
|
798
803
|
# 438012d3-4052-4cc7-b2e3-8d3372e0e706
|
799
|
-
# *
|
804
|
+
# * `:reserved_cache_node_id` - (String) Customer-specified identifier
|
800
805
|
# to track this reservation. Example: myreservationID
|
801
|
-
# *
|
806
|
+
# * `:cache_node_count` - (Integer) The number of instances to reserve.
|
802
807
|
# Default: 1
|
803
808
|
# @return [Core::Response]
|
804
809
|
# The #data method of the response object returns
|
805
810
|
# a hash with the following structure:
|
806
|
-
# *
|
807
|
-
# *
|
808
|
-
# *
|
809
|
-
# *
|
810
|
-
# *
|
811
|
-
# *
|
812
|
-
# *
|
813
|
-
# *
|
814
|
-
# *
|
815
|
-
# *
|
816
|
-
# *
|
817
|
-
# *
|
818
|
-
# *
|
819
|
-
# *
|
811
|
+
# * `:reserved_cache_node_id` - (String)
|
812
|
+
# * `:reserved_cache_nodes_offering_id` - (String)
|
813
|
+
# * `:cache_node_type` - (String)
|
814
|
+
# * `:start_time` - (Time)
|
815
|
+
# * `:duration` - (Integer)
|
816
|
+
# * `:fixed_price` - (Numeric)
|
817
|
+
# * `:usage_price` - (Numeric)
|
818
|
+
# * `:cache_node_count` - (Integer)
|
819
|
+
# * `:product_description` - (String)
|
820
|
+
# * `:offering_type` - (String)
|
821
|
+
# * `:state` - (String)
|
822
|
+
# * `:recurring_charges` - (Array<Hash>)
|
823
|
+
# * `:recurring_charge_amount` - (Numeric)
|
824
|
+
# * `:recurring_charge_frequency` - (String)
|
820
825
|
|
821
826
|
# @!method reboot_cache_cluster(options = {})
|
822
827
|
# Calls the RebootCacheCluster API operation.
|
823
828
|
# @param [Hash] options
|
824
|
-
# *
|
829
|
+
# * `:cache_cluster_id` - *required* - (String) The Cache Cluster
|
825
830
|
# identifier. This parameter is stored as a lowercase string.
|
826
|
-
# *
|
831
|
+
# * `:cache_node_ids_to_reboot` - *required* - (Array<String>) A list
|
827
832
|
# of Cache Cluster Node Ids to reboot. To reboot an entire cache
|
828
833
|
# cluster, specify all cache cluster node Ids.
|
829
834
|
# @return [Core::Response]
|
830
835
|
# The #data method of the response object returns
|
831
836
|
# a hash with the following structure:
|
832
|
-
# *
|
833
|
-
# *
|
834
|
-
# *
|
835
|
-
# *
|
836
|
-
# *
|
837
|
-
# *
|
838
|
-
# *
|
839
|
-
# *
|
840
|
-
# *
|
841
|
-
# *
|
842
|
-
# *
|
843
|
-
# *
|
844
|
-
# *
|
845
|
-
# *
|
846
|
-
# *
|
847
|
-
# *
|
848
|
-
# *
|
849
|
-
# *
|
850
|
-
# *
|
851
|
-
# *
|
852
|
-
# *
|
853
|
-
# *
|
854
|
-
# *
|
855
|
-
# *
|
856
|
-
# *
|
857
|
-
# *
|
858
|
-
# *
|
859
|
-
# *
|
860
|
-
# *
|
861
|
-
# *
|
862
|
-
# *
|
863
|
-
# *
|
864
|
-
# *
|
865
|
-
# *
|
866
|
-
# *
|
867
|
-
# *
|
868
|
-
# *
|
869
|
-
# *
|
870
|
-
# *
|
871
|
-
# *
|
837
|
+
# * `:cache_cluster_id` - (String)
|
838
|
+
# * `:configuration_endpoint` - (Hash)
|
839
|
+
# * `:address` - (String)
|
840
|
+
# * `:port` - (Integer)
|
841
|
+
# * `:client_download_landing_page` - (String)
|
842
|
+
# * `:cache_node_type` - (String)
|
843
|
+
# * `:engine` - (String)
|
844
|
+
# * `:engine_version` - (String)
|
845
|
+
# * `:cache_cluster_status` - (String)
|
846
|
+
# * `:num_cache_nodes` - (Integer)
|
847
|
+
# * `:preferred_availability_zone` - (String)
|
848
|
+
# * `:cache_cluster_create_time` - (Time)
|
849
|
+
# * `:preferred_maintenance_window` - (String)
|
850
|
+
# * `:pending_modified_values` - (Hash)
|
851
|
+
# * `:num_cache_nodes` - (Integer)
|
852
|
+
# * `:cache_node_ids_to_remove` - (Array<String>)
|
853
|
+
# * `:engine_version` - (String)
|
854
|
+
# * `:notification_configuration` - (Hash)
|
855
|
+
# * `:topic_arn` - (String)
|
856
|
+
# * `:topic_status` - (String)
|
857
|
+
# * `:cache_security_groups` - (Array<Hash>)
|
858
|
+
# * `:cache_security_group_name` - (String)
|
859
|
+
# * `:status` - (String)
|
860
|
+
# * `:cache_parameter_group` - (Hash)
|
861
|
+
# * `:cache_parameter_group_name` - (String)
|
862
|
+
# * `:parameter_apply_status` - (String)
|
863
|
+
# * `:cache_node_ids_to_reboot` - (Array<String>)
|
864
|
+
# * `:cache_subnet_group_name` - (String)
|
865
|
+
# * `:cache_nodes` - (Array<Hash>)
|
866
|
+
# * `:cache_node_id` - (String)
|
867
|
+
# * `:cache_node_status` - (String)
|
868
|
+
# * `:cache_node_create_time` - (Time)
|
869
|
+
# * `:endpoint` - (Hash)
|
870
|
+
# * `:address` - (String)
|
871
|
+
# * `:port` - (Integer)
|
872
|
+
# * `:parameter_group_status` - (String)
|
873
|
+
# * `:auto_minor_version_upgrade` - (Boolean)
|
874
|
+
# * `:security_groups` - (Array<Hash>)
|
875
|
+
# * `:security_group_id` - (String)
|
876
|
+
# * `:status` - (String)
|
872
877
|
|
873
878
|
# @!method reset_cache_parameter_group(options = {})
|
874
879
|
# Calls the ResetCacheParameterGroup API operation.
|
875
880
|
# @param [Hash] options
|
876
|
-
# *
|
881
|
+
# * `:cache_parameter_group_name` - *required* - (String) The name of
|
877
882
|
# the Cache Parameter Group.
|
878
|
-
# *
|
879
|
-
# not (
|
883
|
+
# * `:reset_all_parameters` - (Boolean) Specifies whether ( `true` ) or
|
884
|
+
# not ( `false` ) to reset all parameters in the Cache Parameter
|
880
885
|
# Group to default values.
|
881
|
-
# *
|
886
|
+
# * `:parameter_name_values` - *required* - (Array<Hash>) An array of
|
882
887
|
# parameter names which should be reset. If not resetting the entire
|
883
888
|
# CacheParameterGroup, at least one parameter name must be supplied.
|
884
|
-
# *
|
885
|
-
# *
|
889
|
+
# * `:parameter_name` - (String) Specifies the name of the parameter.
|
890
|
+
# * `:parameter_value` - (String) Specifies the value of the
|
886
891
|
# parameter.
|
887
892
|
# @return [Core::Response]
|
888
893
|
# The #data method of the response object returns
|
889
894
|
# a hash with the following structure:
|
890
|
-
# *
|
895
|
+
# * `:cache_parameter_group_name` - (String)
|
891
896
|
|
892
897
|
# @!method revoke_cache_security_group_ingress(options = {})
|
893
898
|
# Calls the RevokeCacheSecurityGroupIngress API operation.
|
894
899
|
# @param [Hash] options
|
895
|
-
# *
|
900
|
+
# * `:cache_security_group_name` - *required* - (String) The name of
|
896
901
|
# the Cache Security Group to revoke ingress from.
|
897
|
-
# *
|
902
|
+
# * `:ec2_security_group_name` - *required* - (String) The name of the
|
898
903
|
# EC2 Security Group to revoke access from.
|
899
|
-
# *
|
904
|
+
# * `:ec2_security_group_owner_id` - *required* - (String) The AWS
|
900
905
|
# Account Number of the owner of the security group specified in the
|
901
906
|
# EC2SecurityGroupName parameter. The AWS Access Key ID is not an
|
902
907
|
# acceptable value.
|
903
908
|
# @return [Core::Response]
|
904
909
|
# The #data method of the response object returns
|
905
910
|
# a hash with the following structure:
|
906
|
-
# *
|
907
|
-
# *
|
908
|
-
# *
|
909
|
-
# *
|
910
|
-
# *
|
911
|
-
# *
|
912
|
-
# *
|
911
|
+
# * `:owner_id` - (String)
|
912
|
+
# * `:cache_security_group_name` - (String)
|
913
|
+
# * `:description` - (String)
|
914
|
+
# * `:ec_2_security_groups` - (Array<Hash>)
|
915
|
+
# * `:status` - (String)
|
916
|
+
# * `:ec2_security_group_name` - (String)
|
917
|
+
# * `:ec2_security_group_owner_id` - (String)
|
913
918
|
|
914
919
|
# end client methods #
|
915
920
|
|