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/cloud_formation.rb
CHANGED
|
@@ -16,154 +16,154 @@ require 'aws/cloud_formation/config'
|
|
|
16
16
|
|
|
17
17
|
module AWS
|
|
18
18
|
|
|
19
|
-
#
|
|
19
|
+
# # AWS::CloudFormation
|
|
20
20
|
#
|
|
21
21
|
# Provides an expressive, object-oriented interface to AWS CloudFormation.
|
|
22
22
|
#
|
|
23
|
-
#
|
|
23
|
+
# ## Credentials
|
|
24
24
|
#
|
|
25
25
|
# You can setup default credentials for all AWS services via
|
|
26
26
|
# AWS.config:
|
|
27
27
|
#
|
|
28
|
-
#
|
|
29
|
-
#
|
|
30
|
-
#
|
|
28
|
+
# AWS.config(
|
|
29
|
+
# :access_key_id => 'YOUR_ACCESS_KEY_ID',
|
|
30
|
+
# :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
|
|
31
31
|
#
|
|
32
32
|
# Or you can set them directly on the CloudFormation interface:
|
|
33
33
|
#
|
|
34
|
-
#
|
|
35
|
-
#
|
|
36
|
-
#
|
|
34
|
+
# cf = AWS::CloudFormation.new(
|
|
35
|
+
# :access_key_id => 'YOUR_ACCESS_KEY_ID',
|
|
36
|
+
# :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
|
|
37
37
|
#
|
|
38
|
-
#
|
|
38
|
+
# # Stacks
|
|
39
39
|
#
|
|
40
40
|
# This is the starting point for working with CloudFormation.
|
|
41
41
|
#
|
|
42
|
-
#
|
|
42
|
+
# ## Creating a Stack
|
|
43
43
|
#
|
|
44
44
|
# You can create a CloudFormation stack with a name and a template.
|
|
45
45
|
#
|
|
46
|
-
#
|
|
47
|
-
#
|
|
48
|
-
#
|
|
49
|
-
#
|
|
50
|
-
#
|
|
51
|
-
#
|
|
52
|
-
#
|
|
53
|
-
#
|
|
54
|
-
#
|
|
46
|
+
# template = <<-TEMPLATE
|
|
47
|
+
# {
|
|
48
|
+
# "AWSTemplateFormatVersion" : "2010-09-09",
|
|
49
|
+
# "Description": "A simple template",
|
|
50
|
+
# "Resources": {
|
|
51
|
+
# "web": {
|
|
52
|
+
# "Type": "AWS::EC2::Instance",
|
|
53
|
+
# "Properties": {
|
|
54
|
+
# "ImageId": "ami-41814f28"
|
|
55
|
+
# }
|
|
55
56
|
# }
|
|
56
57
|
# }
|
|
57
58
|
# }
|
|
58
|
-
#
|
|
59
|
-
# TEMPLATE
|
|
59
|
+
# TEMPLATE
|
|
60
60
|
#
|
|
61
|
-
#
|
|
62
|
-
#
|
|
61
|
+
# cfm = AWS::CloudFormation.new
|
|
62
|
+
# stack = cfm.stacks.create('stack-name', template)
|
|
63
63
|
#
|
|
64
64
|
# See {StackCollection#create} for more information on creating templates
|
|
65
65
|
# with capabilities and parameters.
|
|
66
66
|
#
|
|
67
|
-
#
|
|
68
|
-
#
|
|
67
|
+
# ## Getting a Stack
|
|
68
|
+
#
|
|
69
69
|
# Given a name, you can fetch a {Stack}.
|
|
70
70
|
#
|
|
71
|
-
#
|
|
71
|
+
# stack = cfm.stacks['stack-name']
|
|
72
72
|
#
|
|
73
|
-
#
|
|
73
|
+
# ## Enumerating Stacks
|
|
74
74
|
#
|
|
75
75
|
# You can enumerate stacks in two ways. You can enumerate {Stack}
|
|
76
76
|
# objects or stack summaries (simple hashes). You can filter the stack
|
|
77
77
|
# summary collection by a status.
|
|
78
78
|
#
|
|
79
|
-
#
|
|
80
|
-
#
|
|
81
|
-
#
|
|
82
|
-
#
|
|
79
|
+
# # enumerating all stack objects
|
|
80
|
+
# cfm.stacks.each do |stack|
|
|
81
|
+
# # ...
|
|
82
|
+
# end
|
|
83
83
|
#
|
|
84
|
-
#
|
|
85
|
-
#
|
|
86
|
-
#
|
|
87
|
-
#
|
|
84
|
+
# # enumerating stack summaries (hashes)
|
|
85
|
+
# cfm.stack_summaries.each do |stack_summary|
|
|
86
|
+
# # ...
|
|
87
|
+
# end
|
|
88
88
|
#
|
|
89
|
-
#
|
|
90
|
-
#
|
|
91
|
-
#
|
|
92
|
-
#
|
|
89
|
+
# # filtering stack summaries by status
|
|
90
|
+
# cfm.stack_summaries.with_status(:create_failed).each do |summary|
|
|
91
|
+
# puts summary.to_yaml
|
|
92
|
+
# end
|
|
93
93
|
#
|
|
94
|
-
#
|
|
94
|
+
# ## Template
|
|
95
95
|
#
|
|
96
96
|
# You can fetch the template body for a stack as a JSON string.
|
|
97
97
|
#
|
|
98
|
-
#
|
|
99
|
-
#
|
|
98
|
+
# cfm.stacks['stack-name'].template
|
|
99
|
+
# #=> "{...}"
|
|
100
100
|
#
|
|
101
101
|
# You can update the template for a {Stack} with the {Stack#update} method:
|
|
102
102
|
#
|
|
103
|
-
#
|
|
103
|
+
# cfm.stacks['stack-name'].update(:template => new_template)
|
|
104
104
|
#
|
|
105
|
-
#
|
|
105
|
+
# ## Stack Events
|
|
106
106
|
#
|
|
107
107
|
# You can enumerate events for a stack.
|
|
108
108
|
#
|
|
109
|
-
#
|
|
110
|
-
#
|
|
111
|
-
#
|
|
109
|
+
# stack.events.each do |event|
|
|
110
|
+
# puts "#{event.physical_resource_id}: #{event.resource_status}"
|
|
111
|
+
# end
|
|
112
112
|
#
|
|
113
113
|
# See {StackEvent} for a complete list of event attributes.
|
|
114
114
|
#
|
|
115
|
-
#
|
|
115
|
+
# ## Stack Resources
|
|
116
116
|
#
|
|
117
117
|
# You can enumerate stack resources or request a stack resource by its
|
|
118
118
|
# logical resource id.
|
|
119
119
|
#
|
|
120
|
-
#
|
|
121
|
-
#
|
|
122
|
-
#
|
|
123
|
-
#
|
|
120
|
+
# # enumerating stack resources
|
|
121
|
+
# stack.resources.each do |resource|
|
|
122
|
+
# # ...
|
|
123
|
+
# end
|
|
124
124
|
#
|
|
125
|
-
#
|
|
126
|
-
#
|
|
127
|
-
#
|
|
125
|
+
# # getting a resource by its logical id
|
|
126
|
+
# res = stack.resources['logical-resource-id']
|
|
127
|
+
# puts res.physical_resource_id
|
|
128
128
|
#
|
|
129
|
-
# If you need a stack resource, but only have its physical resource
|
|
129
|
+
# If you need a stack resource, but only have its physical resource
|
|
130
130
|
# id, then you can call {CloudFormation#stack_resource}.
|
|
131
131
|
#
|
|
132
|
-
#
|
|
132
|
+
# stack_resource = cfm.stack_resource('physical-resource-id')
|
|
133
133
|
#
|
|
134
|
-
#
|
|
134
|
+
# ## Stack Resource Summaries
|
|
135
135
|
#
|
|
136
136
|
# As an alternative to stack resources, you can enumerate stack
|
|
137
137
|
# resource summaries (hashes).
|
|
138
138
|
#
|
|
139
|
-
#
|
|
140
|
-
#
|
|
141
|
-
#
|
|
142
|
-
#
|
|
139
|
+
# # enumerate all resources, this collection can not be filtered
|
|
140
|
+
# stack.resource_summaries.each do |summary|
|
|
141
|
+
# # ...
|
|
142
|
+
# end
|
|
143
143
|
#
|
|
144
144
|
# @!attribute [r] client
|
|
145
145
|
# @return [Client] the low-level CloudFormation client object
|
|
146
146
|
class CloudFormation
|
|
147
147
|
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
autoload :StackResourceSummaryCollection, 'stack_resource_summary_collection'
|
|
162
|
-
end
|
|
148
|
+
autoload :Client, 'aws/cloud_formation/client'
|
|
149
|
+
autoload :Errors, 'aws/cloud_formation/errors'
|
|
150
|
+
autoload :Request, 'aws/cloud_formation/request'
|
|
151
|
+
autoload :Stack, 'aws/cloud_formation/stack'
|
|
152
|
+
autoload :StackCollection, 'aws/cloud_formation/stack_collection'
|
|
153
|
+
autoload :StackEvent, 'aws/cloud_formation/stack_event'
|
|
154
|
+
autoload :StackEventCollection, 'aws/cloud_formation/stack_event_collection'
|
|
155
|
+
autoload :StackOptions, 'aws/cloud_formation/stack_options'
|
|
156
|
+
autoload :StackOutput, 'aws/cloud_formation/stack_output'
|
|
157
|
+
autoload :StackSummaryCollection, 'aws/cloud_formation/stack_summary_collection'
|
|
158
|
+
autoload :StackResource, 'aws/cloud_formation/stack_resource'
|
|
159
|
+
autoload :StackResourceCollection, 'aws/cloud_formation/stack_resource_collection'
|
|
160
|
+
autoload :StackResourceSummaryCollection, 'aws/cloud_formation/stack_resource_summary_collection'
|
|
163
161
|
|
|
164
162
|
include Core::ServiceInterface
|
|
165
163
|
include StackOptions
|
|
166
164
|
|
|
165
|
+
endpoint_prefix 'cloudformation'
|
|
166
|
+
|
|
167
167
|
# @return [StackCollection]
|
|
168
168
|
def stacks
|
|
169
169
|
StackCollection.new(:config => config)
|
|
@@ -175,13 +175,13 @@ module AWS
|
|
|
175
175
|
end
|
|
176
176
|
|
|
177
177
|
# Returns a stack resource with the given physical resource
|
|
178
|
-
# id.
|
|
178
|
+
# id.
|
|
179
179
|
#
|
|
180
|
-
#
|
|
180
|
+
# resource = cfm.stack_resource('i-123456789')
|
|
181
181
|
#
|
|
182
182
|
# Alternatively, you may pass a stack name and logical resource id:
|
|
183
183
|
#
|
|
184
|
-
#
|
|
184
|
+
# resource = cfm.stack_resource('stack-name', 'logical-resource-id')
|
|
185
185
|
#
|
|
186
186
|
# @overload stack_resource(physical_resource_id)
|
|
187
187
|
# @param [String] physical_resource_id The physical resource id
|
|
@@ -220,30 +220,30 @@ module AWS
|
|
|
220
220
|
# the returned hash may/will contain the following keys (actual
|
|
221
221
|
# key list depends on the template).
|
|
222
222
|
#
|
|
223
|
-
# *
|
|
224
|
-
# *
|
|
225
|
-
# *
|
|
226
|
-
# *
|
|
223
|
+
# * `:description`
|
|
224
|
+
# * `:capabilities`
|
|
225
|
+
# * `:capabilities_reason`
|
|
226
|
+
# * `:parameters`
|
|
227
227
|
#
|
|
228
228
|
# If the template is not parseable, then a hash will the following
|
|
229
229
|
# keys will be returned:
|
|
230
230
|
#
|
|
231
|
-
# *
|
|
232
|
-
# *
|
|
231
|
+
# * `:code`
|
|
232
|
+
# * `:message`
|
|
233
233
|
#
|
|
234
234
|
# @return [Hash]
|
|
235
|
-
#
|
|
235
|
+
#
|
|
236
236
|
def validate_template template
|
|
237
237
|
begin
|
|
238
238
|
|
|
239
239
|
client_opts = {}
|
|
240
240
|
client_opts[:template] = template
|
|
241
|
-
apply_template(client_opts)
|
|
241
|
+
apply_template(client_opts)
|
|
242
242
|
client.validate_template(client_opts).data
|
|
243
243
|
|
|
244
244
|
rescue CloudFormation::Errors::ValidationError => e
|
|
245
245
|
|
|
246
|
-
results = {}
|
|
246
|
+
results = {}
|
|
247
247
|
results[:code] = e.code
|
|
248
248
|
results[:message] = e.message
|
|
249
249
|
results
|
|
@@ -253,18 +253,19 @@ module AWS
|
|
|
253
253
|
|
|
254
254
|
# @param (see Stack#template=)
|
|
255
255
|
#
|
|
256
|
-
# @param [Hash] parameters A hash that specifies the input
|
|
256
|
+
# @param [Hash] parameters A hash that specifies the input
|
|
257
257
|
# parameters for the template.
|
|
258
258
|
#
|
|
259
|
-
# @return [String] Returns a URL to the AWS Simple Monthly Calculator
|
|
260
|
-
# with a query string that describes the resources required to run
|
|
259
|
+
# @return [String] Returns a URL to the AWS Simple Monthly Calculator
|
|
260
|
+
# with a query string that describes the resources required to run
|
|
261
261
|
# the template.
|
|
262
262
|
#
|
|
263
263
|
def estimate_template_cost template, parameters = {}
|
|
264
264
|
client_opts = {}
|
|
265
265
|
client_opts[:template] = template
|
|
266
|
-
|
|
267
|
-
|
|
266
|
+
client_opts[:parameters] = parameters
|
|
267
|
+
apply_template(client_opts)
|
|
268
|
+
apply_parameters(client_opts)
|
|
268
269
|
client.estimate_template_cost(client_opts).url
|
|
269
270
|
end
|
|
270
271
|
|
|
@@ -38,136 +38,139 @@ module AWS
|
|
|
38
38
|
# @!method cancel_update_stack(options = {})
|
|
39
39
|
# Calls the CancelUpdateStack API operation.
|
|
40
40
|
# @param [Hash] options
|
|
41
|
-
# *
|
|
41
|
+
# * `:stack_name` - *required* - (String) The name or the unique
|
|
42
42
|
# identifier associated with the stack.
|
|
43
43
|
# @return [Core::Response]
|
|
44
44
|
|
|
45
45
|
# @!method create_stack(options = {})
|
|
46
46
|
# Calls the CreateStack API operation.
|
|
47
47
|
# @param [Hash] options
|
|
48
|
-
# *
|
|
48
|
+
# * `:stack_name` - *required* - (String) The name associated with the
|
|
49
49
|
# stack. The name must be unique within your AWS account. Must
|
|
50
50
|
# contain only alphanumeric characters (case sensitive) and start
|
|
51
51
|
# with an alpha character. Maximum length of the name is 255
|
|
52
52
|
# characters.
|
|
53
|
-
# *
|
|
53
|
+
# * `:template_body` - (String) Structure containing the template body.
|
|
54
54
|
# (For more information, go to the AWS CloudFormation User Guide.)
|
|
55
55
|
# Conditional: You must pass TemplateBody or TemplateURL. If both are
|
|
56
56
|
# passed, only TemplateBody is used.
|
|
57
|
-
# *
|
|
57
|
+
# * `:template_url` - (String) Location of file containing the template
|
|
58
58
|
# body. The URL must point to a template (max size: 307,200 bytes)
|
|
59
59
|
# located in an S3 bucket in the same region as the stack. For more
|
|
60
60
|
# information, go to the AWS CloudFormation User Guide. Conditional:
|
|
61
61
|
# You must pass TemplateURL or TemplateBody. If both are passed, only
|
|
62
62
|
# TemplateBody is used.
|
|
63
|
-
# *
|
|
63
|
+
# * `:parameters` - (Array<Hash>) A list of Parameter structures that
|
|
64
64
|
# specify input parameters for the stack.
|
|
65
|
-
# *
|
|
65
|
+
# * `:parameter_key` - (String) The key associated with the
|
|
66
66
|
# parameter.
|
|
67
|
-
# *
|
|
67
|
+
# * `:parameter_value` - (String) The value associated with the
|
|
68
68
|
# parameter.
|
|
69
|
-
# *
|
|
69
|
+
# * `:disable_rollback` - (Boolean) Set to `true` to disable rollback
|
|
70
70
|
# of the stack if stack creation failed. You can specify either
|
|
71
|
-
# DisableRollback or OnFailure, but not both. Default:
|
|
72
|
-
# *
|
|
71
|
+
# DisableRollback or OnFailure, but not both. Default: `false`
|
|
72
|
+
# * `:timeout_in_minutes` - (Integer) The amount of time that can pass
|
|
73
73
|
# before the stack status becomes CREATE_FAILED; if DisableRollback
|
|
74
|
-
# is not set or is set to
|
|
75
|
-
# *
|
|
74
|
+
# is not set or is set to `false` , the stack will be rolled back.
|
|
75
|
+
# * `:notification_arns` - (Array<String>) The Simple Notification
|
|
76
76
|
# Service (SNS) topic ARNs to publish stack related events. You can
|
|
77
77
|
# find your SNS topic ARNs using the SNS console or your Command Line
|
|
78
78
|
# Interface (CLI).
|
|
79
|
-
# *
|
|
79
|
+
# * `:capabilities` - (Array<String>) The list of capabilities that you
|
|
80
80
|
# want to allow in the stack. If your template contains IAM
|
|
81
81
|
# resources, you must specify the CAPABILITY_IAM value for this
|
|
82
82
|
# parameter; otherwise, this action returns an
|
|
83
83
|
# InsufficientCapabilities error. IAM resources are the following:
|
|
84
84
|
# AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::Policy,
|
|
85
85
|
# AWS::IAM::User, and AWS::IAM::UserToGroupAddition.
|
|
86
|
-
# *
|
|
86
|
+
# * `:on_failure` - (String) Determines what action will be taken if
|
|
87
87
|
# stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or
|
|
88
88
|
# DELETE. You can specify either OnFailure or DisableRollback, but
|
|
89
|
-
# not both. Default: ROLLBACK
|
|
90
|
-
#
|
|
89
|
+
# not both. Default: ROLLBACK Valid values include:
|
|
90
|
+
# * `DO_NOTHING`
|
|
91
|
+
# * `ROLLBACK`
|
|
92
|
+
# * `DELETE`
|
|
93
|
+
# * `:tags` - (Array<Hash>) A set of user-defined Tags to associate
|
|
91
94
|
# with this stack, represented by key/value pairs. Tags defined for
|
|
92
95
|
# the stack are propogated to EC2 resources that are created as part
|
|
93
96
|
# of the stack. A maximum number of 10 tags can be specified.
|
|
94
|
-
# *
|
|
97
|
+
# * `:key` - (String) Required. A string used to identify this tag.
|
|
95
98
|
# You can specify a maximum of 128 characters for a tag key. Tags
|
|
96
99
|
# owned by Amazon Web Services (AWS) have the reserved prefix:
|
|
97
100
|
# aws:.
|
|
98
|
-
# *
|
|
101
|
+
# * `:value` - (String) Required. A string containing the value for
|
|
99
102
|
# this tag. You can specify a maximum of 256 characters for a tag
|
|
100
103
|
# value.
|
|
101
104
|
# @return [Core::Response]
|
|
102
105
|
# The #data method of the response object returns
|
|
103
106
|
# a hash with the following structure:
|
|
104
|
-
# *
|
|
107
|
+
# * `:stack_id` - (String)
|
|
105
108
|
|
|
106
109
|
# @!method delete_stack(options = {})
|
|
107
110
|
# Calls the DeleteStack API operation.
|
|
108
111
|
# @param [Hash] options
|
|
109
|
-
# *
|
|
112
|
+
# * `:stack_name` - *required* - (String) The name or the unique
|
|
110
113
|
# identifier associated with the stack.
|
|
111
114
|
# @return [Core::Response]
|
|
112
115
|
|
|
113
116
|
# @!method describe_stack_events(options = {})
|
|
114
117
|
# Calls the DescribeStackEvents API operation.
|
|
115
118
|
# @param [Hash] options
|
|
116
|
-
# *
|
|
119
|
+
# * `:stack_name` - (String) The name or the unique identifier
|
|
117
120
|
# associated with the stack. Default: There is no default value.
|
|
118
|
-
# *
|
|
121
|
+
# * `:next_token` - (String) String that identifies the start of the
|
|
119
122
|
# next list of events, if there is one. Default: There is no default
|
|
120
123
|
# value.
|
|
121
124
|
# @return [Core::Response]
|
|
122
125
|
# The #data method of the response object returns
|
|
123
126
|
# a hash with the following structure:
|
|
124
|
-
# *
|
|
125
|
-
# *
|
|
126
|
-
# *
|
|
127
|
-
# *
|
|
128
|
-
# *
|
|
129
|
-
# *
|
|
130
|
-
# *
|
|
131
|
-
# *
|
|
132
|
-
# *
|
|
133
|
-
# *
|
|
134
|
-
# *
|
|
135
|
-
# *
|
|
127
|
+
# * `:stack_events` - (Array<Hash>)
|
|
128
|
+
# * `:stack_id` - (String)
|
|
129
|
+
# * `:event_id` - (String)
|
|
130
|
+
# * `:stack_name` - (String)
|
|
131
|
+
# * `:logical_resource_id` - (String)
|
|
132
|
+
# * `:physical_resource_id` - (String)
|
|
133
|
+
# * `:resource_type` - (String)
|
|
134
|
+
# * `:timestamp` - (Time)
|
|
135
|
+
# * `:resource_status` - (String)
|
|
136
|
+
# * `:resource_status_reason` - (String)
|
|
137
|
+
# * `:resource_properties` - (String)
|
|
138
|
+
# * `:next_token` - (String)
|
|
136
139
|
|
|
137
140
|
# @!method describe_stack_resource(options = {})
|
|
138
141
|
# Calls the DescribeStackResource API operation.
|
|
139
142
|
# @param [Hash] options
|
|
140
|
-
# *
|
|
143
|
+
# * `:stack_name` - *required* - (String) The name or the unique
|
|
141
144
|
# identifier associated with the stack. Default: There is no default
|
|
142
145
|
# value.
|
|
143
|
-
# *
|
|
146
|
+
# * `:logical_resource_id` - *required* - (String) The logical name of
|
|
144
147
|
# the resource as specified in the template. Default: There is no
|
|
145
148
|
# default value.
|
|
146
149
|
# @return [Core::Response]
|
|
147
150
|
# The #data method of the response object returns
|
|
148
151
|
# a hash with the following structure:
|
|
149
|
-
# *
|
|
150
|
-
# *
|
|
151
|
-
# *
|
|
152
|
-
# *
|
|
153
|
-
# *
|
|
154
|
-
# *
|
|
155
|
-
# *
|
|
156
|
-
# *
|
|
157
|
-
# *
|
|
158
|
-
# *
|
|
159
|
-
# *
|
|
152
|
+
# * `:stack_resource_detail` - (Hash)
|
|
153
|
+
# * `:stack_name` - (String)
|
|
154
|
+
# * `:stack_id` - (String)
|
|
155
|
+
# * `:logical_resource_id` - (String)
|
|
156
|
+
# * `:physical_resource_id` - (String)
|
|
157
|
+
# * `:resource_type` - (String)
|
|
158
|
+
# * `:last_updated_timestamp` - (Time)
|
|
159
|
+
# * `:resource_status` - (String)
|
|
160
|
+
# * `:resource_status_reason` - (String)
|
|
161
|
+
# * `:description` - (String)
|
|
162
|
+
# * `:metadata` - (String)
|
|
160
163
|
|
|
161
164
|
# @!method describe_stack_resources(options = {})
|
|
162
165
|
# Calls the DescribeStackResources API operation.
|
|
163
166
|
# @param [Hash] options
|
|
164
|
-
# *
|
|
167
|
+
# * `:stack_name` - (String) The name or the unique identifier
|
|
165
168
|
# associated with the stack. Required: Conditional. If you do not
|
|
166
169
|
# specify StackName, you must specify PhysicalResourceId. Default:
|
|
167
170
|
# There is no default value.
|
|
168
|
-
# *
|
|
171
|
+
# * `:logical_resource_id` - (String) The logical name of the resource
|
|
169
172
|
# as specified in the template. Default: There is no default value.
|
|
170
|
-
# *
|
|
173
|
+
# * `:physical_resource_id` - (String) The name or unique identifier
|
|
171
174
|
# that corresponds to a physical instance ID of a resource supported
|
|
172
175
|
# by AWS CloudFormation. For example, for an Amazon Elastic Compute
|
|
173
176
|
# Cloud (EC2) instance, PhysicalResourceId corresponds to the
|
|
@@ -179,151 +182,151 @@ module AWS
|
|
|
179
182
|
# @return [Core::Response]
|
|
180
183
|
# The #data method of the response object returns
|
|
181
184
|
# a hash with the following structure:
|
|
182
|
-
# *
|
|
183
|
-
# *
|
|
184
|
-
# *
|
|
185
|
-
# *
|
|
186
|
-
# *
|
|
187
|
-
# *
|
|
188
|
-
# *
|
|
189
|
-
# *
|
|
190
|
-
# *
|
|
191
|
-
# *
|
|
185
|
+
# * `:stack_resources` - (Array<Hash>)
|
|
186
|
+
# * `:stack_name` - (String)
|
|
187
|
+
# * `:stack_id` - (String)
|
|
188
|
+
# * `:logical_resource_id` - (String)
|
|
189
|
+
# * `:physical_resource_id` - (String)
|
|
190
|
+
# * `:resource_type` - (String)
|
|
191
|
+
# * `:timestamp` - (Time)
|
|
192
|
+
# * `:resource_status` - (String)
|
|
193
|
+
# * `:resource_status_reason` - (String)
|
|
194
|
+
# * `:description` - (String)
|
|
192
195
|
|
|
193
196
|
# @!method describe_stacks(options = {})
|
|
194
197
|
# Calls the DescribeStacks API operation.
|
|
195
198
|
# @param [Hash] options
|
|
196
|
-
# *
|
|
199
|
+
# * `:stack_name` - (String) The name or the unique identifier
|
|
197
200
|
# associated with the stack. Default: There is no default value.
|
|
198
|
-
# *
|
|
201
|
+
# * `:next_token` - (String)
|
|
199
202
|
# @return [Core::Response]
|
|
200
203
|
# The #data method of the response object returns
|
|
201
204
|
# a hash with the following structure:
|
|
202
|
-
# *
|
|
203
|
-
# *
|
|
204
|
-
# *
|
|
205
|
-
# *
|
|
206
|
-
# *
|
|
207
|
-
# *
|
|
208
|
-
# *
|
|
209
|
-
# *
|
|
210
|
-
# *
|
|
211
|
-
# *
|
|
212
|
-
# *
|
|
213
|
-
# *
|
|
214
|
-
# *
|
|
215
|
-
# *
|
|
216
|
-
# *
|
|
217
|
-
# *
|
|
218
|
-
# *
|
|
219
|
-
# *
|
|
220
|
-
# *
|
|
221
|
-
# *
|
|
222
|
-
# *
|
|
223
|
-
# *
|
|
224
|
-
# *
|
|
205
|
+
# * `:stacks` - (Array<Hash>)
|
|
206
|
+
# * `:stack_id` - (String)
|
|
207
|
+
# * `:stack_name` - (String)
|
|
208
|
+
# * `:description` - (String)
|
|
209
|
+
# * `:parameters` - (Array<Hash>)
|
|
210
|
+
# * `:parameter_key` - (String)
|
|
211
|
+
# * `:parameter_value` - (String)
|
|
212
|
+
# * `:creation_time` - (Time)
|
|
213
|
+
# * `:last_updated_time` - (Time)
|
|
214
|
+
# * `:stack_status` - (String)
|
|
215
|
+
# * `:stack_status_reason` - (String)
|
|
216
|
+
# * `:disable_rollback` - (Boolean)
|
|
217
|
+
# * `:notification_arns` - (Array<String>)
|
|
218
|
+
# * `:timeout_in_minutes` - (Integer)
|
|
219
|
+
# * `:capabilities` - (Array<String>)
|
|
220
|
+
# * `:outputs` - (Array<Hash>)
|
|
221
|
+
# * `:output_key` - (String)
|
|
222
|
+
# * `:output_value` - (String)
|
|
223
|
+
# * `:description` - (String)
|
|
224
|
+
# * `:tags` - (Array<Hash>)
|
|
225
|
+
# * `:key` - (String)
|
|
226
|
+
# * `:value` - (String)
|
|
227
|
+
# * `:next_token` - (String)
|
|
225
228
|
|
|
226
229
|
# @!method estimate_template_cost(options = {})
|
|
227
230
|
# Calls the EstimateTemplateCost API operation.
|
|
228
231
|
# @param [Hash] options
|
|
229
|
-
# *
|
|
232
|
+
# * `:template_body` - (String) Structure containing the template body.
|
|
230
233
|
# (For more information, go to the AWS CloudFormation User Guide.)
|
|
231
234
|
# Conditional: You must pass TemplateBody or TemplateURL. If both are
|
|
232
235
|
# passed, only TemplateBody is used.
|
|
233
|
-
# *
|
|
236
|
+
# * `:template_url` - (String) Location of file containing the template
|
|
234
237
|
# body. The URL must point to a template located in an S3 bucket in
|
|
235
238
|
# the same region as the stack. For more information, go to the AWS
|
|
236
239
|
# CloudFormation User Guide. Conditional: You must pass TemplateURL
|
|
237
240
|
# or TemplateBody. If both are passed, only TemplateBody is used.
|
|
238
|
-
# *
|
|
241
|
+
# * `:parameters` - (Array<Hash>) A list of Parameter structures that
|
|
239
242
|
# specify input parameters.
|
|
240
|
-
# *
|
|
243
|
+
# * `:parameter_key` - (String) The key associated with the
|
|
241
244
|
# parameter.
|
|
242
|
-
# *
|
|
245
|
+
# * `:parameter_value` - (String) The value associated with the
|
|
243
246
|
# parameter.
|
|
244
247
|
# @return [Core::Response]
|
|
245
248
|
# The #data method of the response object returns
|
|
246
249
|
# a hash with the following structure:
|
|
247
|
-
# *
|
|
250
|
+
# * `:url` - (String)
|
|
248
251
|
|
|
249
252
|
# @!method get_template(options = {})
|
|
250
253
|
# Calls the GetTemplate API operation.
|
|
251
254
|
# @param [Hash] options
|
|
252
|
-
# *
|
|
255
|
+
# * `:stack_name` - *required* - (String) The name or the unique
|
|
253
256
|
# identifier associated with the stack.
|
|
254
257
|
# @return [Core::Response]
|
|
255
258
|
# The #data method of the response object returns
|
|
256
259
|
# a hash with the following structure:
|
|
257
|
-
# *
|
|
260
|
+
# * `:template_body` - (String)
|
|
258
261
|
|
|
259
262
|
# @!method list_stack_resources(options = {})
|
|
260
263
|
# Calls the ListStackResources API operation.
|
|
261
264
|
# @param [Hash] options
|
|
262
|
-
# *
|
|
265
|
+
# * `:stack_name` - *required* - (String) The name or the unique
|
|
263
266
|
# identifier associated with the stack. Default: There is no default
|
|
264
267
|
# value.
|
|
265
|
-
# *
|
|
268
|
+
# * `:next_token` - (String) String that identifies the start of the
|
|
266
269
|
# next list of stack resource summaries, if there is one. Default:
|
|
267
270
|
# There is no default value.
|
|
268
271
|
# @return [Core::Response]
|
|
269
272
|
# The #data method of the response object returns
|
|
270
273
|
# a hash with the following structure:
|
|
271
|
-
# *
|
|
272
|
-
# *
|
|
273
|
-
# *
|
|
274
|
-
# *
|
|
275
|
-
# *
|
|
276
|
-
# *
|
|
277
|
-
# *
|
|
278
|
-
# *
|
|
274
|
+
# * `:stack_resource_summaries` - (Array<Hash>)
|
|
275
|
+
# * `:logical_resource_id` - (String)
|
|
276
|
+
# * `:physical_resource_id` - (String)
|
|
277
|
+
# * `:resource_type` - (String)
|
|
278
|
+
# * `:last_updated_timestamp` - (Time)
|
|
279
|
+
# * `:resource_status` - (String)
|
|
280
|
+
# * `:resource_status_reason` - (String)
|
|
281
|
+
# * `:next_token` - (String)
|
|
279
282
|
|
|
280
283
|
# @!method list_stacks(options = {})
|
|
281
284
|
# Calls the ListStacks API operation.
|
|
282
285
|
# @param [Hash] options
|
|
283
|
-
# *
|
|
286
|
+
# * `:next_token` - (String) String that identifies the start of the
|
|
284
287
|
# next list of stacks, if there is one. Default: There is no default
|
|
285
288
|
# value.
|
|
286
|
-
# *
|
|
289
|
+
# * `:stack_status_filter` - (Array<String>) Stack status to use as a
|
|
287
290
|
# filter. Specify one or more stack status codes to list only stacks
|
|
288
291
|
# with the specified status codes. For a complete list of stack
|
|
289
292
|
# status codes, see the StackStatus parameter of the Stack data type.
|
|
290
293
|
# @return [Core::Response]
|
|
291
294
|
# The #data method of the response object returns
|
|
292
295
|
# a hash with the following structure:
|
|
293
|
-
# *
|
|
294
|
-
# *
|
|
295
|
-
# *
|
|
296
|
-
# *
|
|
297
|
-
# *
|
|
298
|
-
# *
|
|
299
|
-
# *
|
|
300
|
-
# *
|
|
301
|
-
# *
|
|
302
|
-
# *
|
|
296
|
+
# * `:stack_summaries` - (Array<Hash>)
|
|
297
|
+
# * `:stack_id` - (String)
|
|
298
|
+
# * `:stack_name` - (String)
|
|
299
|
+
# * `:template_description` - (String)
|
|
300
|
+
# * `:creation_time` - (Time)
|
|
301
|
+
# * `:last_updated_time` - (Time)
|
|
302
|
+
# * `:deletion_time` - (Time)
|
|
303
|
+
# * `:stack_status` - (String)
|
|
304
|
+
# * `:stack_status_reason` - (String)
|
|
305
|
+
# * `:next_token` - (String)
|
|
303
306
|
|
|
304
307
|
# @!method update_stack(options = {})
|
|
305
308
|
# Calls the UpdateStack API operation.
|
|
306
309
|
# @param [Hash] options
|
|
307
|
-
# *
|
|
310
|
+
# * `:stack_name` - *required* - (String) The name or stack ID of the
|
|
308
311
|
# stack to update. Must contain only alphanumeric characters (case
|
|
309
312
|
# sensitive) and start with an alpha character. Maximum length of the
|
|
310
313
|
# name is 255 characters.
|
|
311
|
-
# *
|
|
314
|
+
# * `:template_body` - (String) Structure containing the template body.
|
|
312
315
|
# (For more information, go to the AWS CloudFormation User Guide.)
|
|
313
316
|
# Conditional: You must pass TemplateBody or TemplateURL. If both are
|
|
314
317
|
# passed, only TemplateBody is used.
|
|
315
|
-
# *
|
|
318
|
+
# * `:template_url` - (String) Location of file containing the template
|
|
316
319
|
# body. The URL must point to a template located in an S3 bucket in
|
|
317
320
|
# the same region as the stack. For more information, go to the AWS
|
|
318
321
|
# CloudFormation User Guide. Conditional: You must pass TemplateURL
|
|
319
322
|
# or TemplateBody. If both are passed, only TemplateBody is used.
|
|
320
|
-
# *
|
|
323
|
+
# * `:parameters` - (Array<Hash>) A list of Parameter structures that
|
|
321
324
|
# specify input parameters for the stack.
|
|
322
|
-
# *
|
|
325
|
+
# * `:parameter_key` - (String) The key associated with the
|
|
323
326
|
# parameter.
|
|
324
|
-
# *
|
|
327
|
+
# * `:parameter_value` - (String) The value associated with the
|
|
325
328
|
# parameter.
|
|
326
|
-
# *
|
|
329
|
+
# * `:capabilities` - (Array<String>) The list of capabilities that you
|
|
327
330
|
# want to allow in the stack. If your stack contains IAM resources,
|
|
328
331
|
# you must specify the CAPABILITY_IAM value for this parameter;
|
|
329
332
|
# otherwise, this action returns an InsufficientCapabilities error.
|
|
@@ -333,16 +336,16 @@ module AWS
|
|
|
333
336
|
# @return [Core::Response]
|
|
334
337
|
# The #data method of the response object returns
|
|
335
338
|
# a hash with the following structure:
|
|
336
|
-
# *
|
|
339
|
+
# * `:stack_id` - (String)
|
|
337
340
|
|
|
338
341
|
# @!method validate_template(options = {})
|
|
339
342
|
# Calls the ValidateTemplate API operation.
|
|
340
343
|
# @param [Hash] options
|
|
341
|
-
# *
|
|
344
|
+
# * `:template_body` - (String) String containing the template body.
|
|
342
345
|
# (For more information, go to the AWS CloudFormation User Guide.)
|
|
343
346
|
# Conditional: You must pass TemplateURL or TemplateBody. If both are
|
|
344
347
|
# passed, only TemplateBody is used.
|
|
345
|
-
# *
|
|
348
|
+
# * `:template_url` - (String) Location of file containing the template
|
|
346
349
|
# body. The URL must point to a template (max size: 307,200 bytes)
|
|
347
350
|
# located in an S3 bucket in the same region as the stack. For more
|
|
348
351
|
# information, go to the AWS CloudFormation User Guide. Conditional:
|
|
@@ -351,14 +354,14 @@ module AWS
|
|
|
351
354
|
# @return [Core::Response]
|
|
352
355
|
# The #data method of the response object returns
|
|
353
356
|
# a hash with the following structure:
|
|
354
|
-
# *
|
|
355
|
-
# *
|
|
356
|
-
# *
|
|
357
|
-
# *
|
|
358
|
-
# *
|
|
359
|
-
# *
|
|
360
|
-
# *
|
|
361
|
-
# *
|
|
357
|
+
# * `:parameters` - (Array<Hash>)
|
|
358
|
+
# * `:parameter_key` - (String)
|
|
359
|
+
# * `:default_value` - (String)
|
|
360
|
+
# * `:no_echo` - (Boolean)
|
|
361
|
+
# * `:description` - (String)
|
|
362
|
+
# * `:description` - (String)
|
|
363
|
+
# * `:capabilities` - (Array<String>)
|
|
364
|
+
# * `:capabilities_reason` - (String)
|
|
362
365
|
|
|
363
366
|
# end client methods #
|
|
364
367
|
|