# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. module AWS class CloudFormation # Client class for AWS CloudFormation. class Client < Core::Client API_VERSION = '2010-05-15' extend Core::QueryClient # @private CACHEABLE_REQUESTS = Set[ :describe_adjustment_types, :describe_auto_scaling_groups, :describe_auto_scaling_instances, :describe_auto_scaling_notification_types, :describe_launch_configurations, :describe_metric_collection_types, :describe_notification_configurations, :describe_policies, :describe_scaling_activities, :describe_scaling_process_types, :describe_scheduled_actions, :describe_tags, ] ## client methods ## # Calls the CreateStack API operation. # @method create_stack(options = {}) # @param [Hash] options # * +:stack_name+ - *required* - (String) # * +:template_body+ - (String) # * +:template_url+ - (String) # * +:parameters+ - (Array) # * +:parameter_key+ - (String) # * +:parameter_value+ - (String) # * +:disable_rollback+ - (Boolean) # * +:timeout_in_minutes+ - (Integer) # * +:notification_ar_ns+ - (Array) # * +:capabilities+ - (Array) # * +:on_failure+ - (String) # @return [Core::Response] # The #data method of the response object returns # a hash with the following structure: # * +:stack_id+ - (String) define_client_method :create_stack, 'CreateStack' # Calls the CreateUploadBucket API operation. # @method create_upload_bucket(options = {}) # @param [Hash] options # @return [Core::Response] # The #data method of the response object returns # a hash with the following structure: # * +:bucket_name+ - (String) define_client_method :create_upload_bucket, 'CreateUploadBucket' # Calls the DeleteStack API operation. # @method delete_stack(options = {}) # @param [Hash] options # * +:stack_name+ - *required* - (String) # @return [Core::Response] define_client_method :delete_stack, 'DeleteStack' # Calls the DescribeStackEvents API operation. # @method describe_stack_events(options = {}) # @param [Hash] options # * +:stack_name+ - (String) # * +:next_token+ - (String) # @return [Core::Response] # The #data method of the response object returns # a hash with the following structure: # * +:stack_events+ - (Array) # * +:stack_id+ - (String) # * +:event_id+ - (String) # * +:stack_name+ - (String) # * +:logical_resource_id+ - (String) # * +:physical_resource_id+ - (String) # * +:resource_type+ - (String) # * +:timestamp+ - (Time) # * +:resource_status+ - (String) # * +:resource_status_reason+ - (String) # * +:resource_properties+ - (String) # * +:next_token+ - (String) define_client_method :describe_stack_events, 'DescribeStackEvents' # Calls the DescribeStackResource API operation. # @method describe_stack_resource(options = {}) # @param [Hash] options # * +:stack_name+ - *required* - (String) # * +:logical_resource_id+ - *required* - (String) # @return [Core::Response] # The #data method of the response object returns # a hash with the following structure: # * +:stack_resource_detail+ - (Hash) # * +:stack_name+ - (String) # * +:stack_id+ - (String) # * +:logical_resource_id+ - (String) # * +:physical_resource_id+ - (String) # * +:resource_type+ - (String) # * +:last_updated_timestamp+ - (Time) # * +:resource_status+ - (String) # * +:resource_status_reason+ - (String) # * +:description+ - (String) # * +:metadata+ - (String) define_client_method :describe_stack_resource, 'DescribeStackResource' # Calls the DescribeStackResources API operation. # @method describe_stack_resources(options = {}) # @param [Hash] options # * +:stack_name+ - (String) # * +:logical_resource_id+ - (String) # * +:physical_resource_id+ - (String) # @return [Core::Response] # The #data method of the response object returns # a hash with the following structure: # * +:stack_resources+ - (Array) # * +:stack_name+ - (String) # * +:stack_id+ - (String) # * +:logical_resource_id+ - (String) # * +:physical_resource_id+ - (String) # * +:resource_type+ - (String) # * +:timestamp+ - (Time) # * +:resource_status+ - (String) # * +:resource_status_reason+ - (String) # * +:description+ - (String) define_client_method :describe_stack_resources, 'DescribeStackResources' # Calls the DescribeStacks API operation. # @method describe_stacks(options = {}) # @param [Hash] options # * +:stack_name+ - (String) # @return [Core::Response] # The #data method of the response object returns # a hash with the following structure: # * +:stacks+ - (Array) # * +:stack_id+ - (String) # * +:stack_name+ - (String) # * +:description+ - (String) # * +:parameters+ - (Array) # * +:parameter_key+ - (String) # * +:parameter_value+ - (String) # * +:creation_time+ - (Time) # * +:last_updated_time+ - (Time) # * +:stack_status+ - (String) # * +:stack_status_reason+ - (String) # * +:disable_rollback+ - (Boolean) # * +:notification_ar_ns+ - (Array) # * +:timeout_in_minutes+ - (Integer) # * +:capabilities+ - (Array) # * +:outputs+ - (Array) # * +:output_key+ - (String) # * +:output_value+ - (String) # * +:description+ - (String) define_client_method :describe_stacks, 'DescribeStacks' # Calls the EstimateTemplateCost API operation. # @method estimate_template_cost(options = {}) # @param [Hash] options # * +:template_body+ - (String) # * +:template_url+ - (String) # * +:parameters+ - (Array) # * +:parameter_key+ - (String) # * +:parameter_value+ - (String) # @return [Core::Response] # The #data method of the response object returns # a hash with the following structure: # * +:url+ - (String) define_client_method :estimate_template_cost, 'EstimateTemplateCost' # Calls the GetTemplate API operation. # @method get_template(options = {}) # @param [Hash] options # * +:stack_name+ - *required* - (String) # @return [Core::Response] # The #data method of the response object returns # a hash with the following structure: # * +:template_body+ - (String) define_client_method :get_template, 'GetTemplate' # Calls the ListStackResources API operation. # @method list_stack_resources(options = {}) # @param [Hash] options # * +:stack_name+ - *required* - (String) # * +:next_token+ - (String) # @return [Core::Response] # The #data method of the response object returns # a hash with the following structure: # * +:stack_resource_summaries+ - (Array) # * +:logical_resource_id+ - (String) # * +:physical_resource_id+ - (String) # * +:resource_type+ - (String) # * +:last_updated_timestamp+ - (Time) # * +:resource_status+ - (String) # * +:resource_status_reason+ - (String) # * +:next_token+ - (String) define_client_method :list_stack_resources, 'ListStackResources' # Calls the ListStacks API operation. # @method list_stacks(options = {}) # @param [Hash] options # * +:next_token+ - (String) # * +:stack_status_filter+ - (Array) # @return [Core::Response] # The #data method of the response object returns # a hash with the following structure: # * +:stack_summaries+ - (Array) # * +:stack_id+ - (String) # * +:stack_name+ - (String) # * +:template_description+ - (String) # * +:creation_time+ - (Time) # * +:last_updated_time+ - (Time) # * +:deletion_time+ - (Time) # * +:stack_status+ - (String) # * +:stack_status_reason+ - (String) # * +:next_token+ - (String) define_client_method :list_stacks, 'ListStacks' # Calls the UpdateStack API operation. # @method update_stack(options = {}) # @param [Hash] options # * +:stack_name+ - *required* - (String) # * +:template_body+ - (String) # * +:template_url+ - (String) # * +:parameters+ - (Array) # * +:parameter_key+ - (String) # * +:parameter_value+ - (String) # * +:capabilities+ - (Array) # @return [Core::Response] # The #data method of the response object returns # a hash with the following structure: # * +:stack_id+ - (String) define_client_method :update_stack, 'UpdateStack' # Calls the ValidateTemplate API operation. # @method validate_template(options = {}) # @param [Hash] options # * +:template_body+ - (String) # * +:template_url+ - (String) # @return [Core::Response] # The #data method of the response object returns # a hash with the following structure: # * +:parameters+ - (Array) # * +:parameter_key+ - (String) # * +:default_value+ - (String) # * +:no_echo+ - (Boolean) # * +:description+ - (String) # * +:description+ - (String) # * +:capabilities+ - (Array) # * +:capabilities_reason+ - (String) define_client_method :validate_template, 'ValidateTemplate' ## end client methods ## end end end