Class: AWS::CloudFormation::Client

Inherits:
AWS::Core::Client show all
Extended by:
AWS::Core::Client::QueryXML
Defined in:
lib/aws/cloud_formation/client.rb

Overview

Client class for AWS CloudFormation.

Constant Summary collapse

API_VERSION =
'2010-05-15'
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,
]

Instance Attribute Summary

Attributes inherited from AWS::Core::Client

#config, #endpoint, #port, #service_ruby_name, #signer

Instance Method Summary collapse

Methods included from AWS::Core::Client::QueryXML

extended, option_parsers, xml_parsers

Methods inherited from AWS::Core::Client

#initialize, #new_stub_for, #operations, #stub_for, #with_config, #with_http_handler, #with_options

Methods included from AWS::Core::Naming

#service_name, #service_ruby_name

Constructor Details

This class inherits a constructor from AWS::Core::Client

Instance Method Details

#create_stack(options = {}) ⇒ Core::Response

Calls the CreateStack API operation.

Options:

  • :stack_name - required - (String)

  • :template_body - (String)

  • :template_url - (String)

  • :parameters - (Array<Hash>)

    • :parameter_key - (String)

    • :parameter_value - (String)

  • :disable_rollback - (Boolean)

  • :timeout_in_minutes - (Integer)

  • :notification_ar_ns - (Array<String>)

  • :capabilities - (Array<String>)

  • :on_failure - (String)

Response Structure:

  • :stack_id - (String)

Returns:


65
# File 'lib/aws/cloud_formation/client.rb', line 65

define_client_method :create_stack, 'CreateStack'

#create_upload_bucket(options = {}) ⇒ Core::Response

Calls the CreateUploadBucket API operation.

Options:

This method accepts no options.

Response Structure:

  • :bucket_name - (String)

Returns:


80
# File 'lib/aws/cloud_formation/client.rb', line 80

define_client_method :create_upload_bucket, 'CreateUploadBucket'

#delete_stack(options = {}) ⇒ Core::Response

Calls the DeleteStack API operation.

Options:

  • :stack_name - required - (String)

Response Structure:

This method returns no response data.

Returns:


95
# File 'lib/aws/cloud_formation/client.rb', line 95

define_client_method :delete_stack, 'DeleteStack'

#describe_stack_events(options = {}) ⇒ Core::Response

Calls the DescribeStackEvents API operation.

Options:

  • :stack_name - (String)

  • :next_token - (String)

Response Structure:

  • :stack_events - (Array<Hash>)

    • :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)

Returns:


122
# File 'lib/aws/cloud_formation/client.rb', line 122

define_client_method :describe_stack_events, 'DescribeStackEvents'

#describe_stack_resource(options = {}) ⇒ Core::Response

Calls the DescribeStackResource API operation.

Options:

  • :stack_name - required - (String)

  • :logical_resource_id - required - (String)

Response 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)

Returns:


148
# File 'lib/aws/cloud_formation/client.rb', line 148

define_client_method :describe_stack_resource, 'DescribeStackResource'

#describe_stack_resources(options = {}) ⇒ Core::Response

Calls the DescribeStackResources API operation.

Options:

  • :stack_name - (String)

  • :logical_resource_id - (String)

  • :physical_resource_id - (String)

Response Structure:

  • :stack_resources - (Array<Hash>)

    • :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)

Returns:


174
# File 'lib/aws/cloud_formation/client.rb', line 174

define_client_method :describe_stack_resources, 'DescribeStackResources'

#describe_stacks(options = {}) ⇒ Core::Response

Calls the DescribeStacks API operation.

Options:

  • :stack_name - (String)

Response Structure:

  • :stacks - (Array<Hash>)

    • :stack_id - (String)

    • :stack_name - (String)

    • :description - (String)

    • :parameters - (Array<Hash>)

      • :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<String>)

    • :timeout_in_minutes - (Integer)

    • :capabilities - (Array<String>)

    • :outputs - (Array<Hash>)

      • :output_key - (String)

      • :output_value - (String)

      • :description - (String)

Returns:


207
# File 'lib/aws/cloud_formation/client.rb', line 207

define_client_method :describe_stacks, 'DescribeStacks'

#estimate_template_cost(options = {}) ⇒ Core::Response

Calls the EstimateTemplateCost API operation.

Options:

  • :template_body - (String)

  • :template_url - (String)

  • :parameters - (Array<Hash>)

    • :parameter_key - (String)

    • :parameter_value - (String)

Response Structure:

  • :url - (String)

Returns:


226
# File 'lib/aws/cloud_formation/client.rb', line 226

define_client_method :estimate_template_cost, 'EstimateTemplateCost'

#get_template(options = {}) ⇒ Core::Response

Calls the GetTemplate API operation.

Options:

  • :stack_name - required - (String)

Response Structure:

  • :template_body - (String)

Returns:


241
# File 'lib/aws/cloud_formation/client.rb', line 241

define_client_method :get_template, 'GetTemplate'

#list_stack_resources(options = {}) ⇒ Core::Response

Calls the ListStackResources API operation.

Options:

  • :stack_name - required - (String)

  • :next_token - (String)

Response Structure:

  • :stack_resource_summaries - (Array<Hash>)

    • :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)

Returns:


264
# File 'lib/aws/cloud_formation/client.rb', line 264

define_client_method :list_stack_resources, 'ListStackResources'

#list_stacks(options = {}) ⇒ Core::Response

Calls the ListStacks API operation.

Options:

  • :next_token - (String)

  • :stack_status_filter - (Array<String>)

Response Structure:

  • :stack_summaries - (Array<Hash>)

    • :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)

Returns:


289
# File 'lib/aws/cloud_formation/client.rb', line 289

define_client_method :list_stacks, 'ListStacks'

#update_stack(options = {}) ⇒ Core::Response

Calls the UpdateStack API operation.

Options:

  • :stack_name - required - (String)

  • :template_body - (String)

  • :template_url - (String)

  • :parameters - (Array<Hash>)

    • :parameter_key - (String)

    • :parameter_value - (String)

  • :capabilities - (Array<String>)

Response Structure:

  • :stack_id - (String)

Returns:


310
# File 'lib/aws/cloud_formation/client.rb', line 310

define_client_method :update_stack, 'UpdateStack'

#validate_template(options = {}) ⇒ Core::Response

Calls the ValidateTemplate API operation.

Options:

  • :template_body - (String)

  • :template_url - (String)

Response Structure:

  • :parameters - (Array<Hash>)

    • :parameter_key - (String)

    • :default_value - (String)

    • :no_echo - (Boolean)

    • :description - (String)

  • :description - (String)

  • :capabilities - (Array<String>)

  • :capabilities_reason - (String)

Returns:


333
# File 'lib/aws/cloud_formation/client.rb', line 333

define_client_method :validate_template, 'ValidateTemplate'