Class: AWS::CloudFormation::Client

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

Overview

Client class for AWS CloudFormation.

Constant Summary collapse

API_VERSION = 
'2010-05-15'

Instance Attribute Summary

Attributes inherited from AWS::Core::Client

#config, #http_read_timeout

Instance Method Summary collapse

Methods inherited from AWS::Core::Client

#initialize, #log_warning, #operations, #with_http_handler, #with_options

Constructor Details

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

Instance Method Details

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

Calls the CreateStack API operation.

Parameters:

  • options (Hash) (defaults to: {}) —

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

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :stack_id - (String)



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

define_client_method :create_stack, 'CreateStack'

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

Calls the CreateUploadBucket API operation.

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :bucket_name - (String)



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

define_client_method :create_upload_bucket, 'CreateUploadBucket'

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

Calls the DeleteStack API operation.

Parameters:

  • options (Hash) (defaults to: {}) —

    • :stack_name - required - (String)

Returns:



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

define_client_method :delete_stack, 'DeleteStack'

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

Calls the DescribeStackEvents API operation.

Parameters:

  • options (Hash) (defaults to: {}) —

    • :stack_name - (String)

    • :next_token - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following 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)



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

define_client_method :describe_stack_events, 'DescribeStackEvents'

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

Calls the DescribeStackResource API operation.

Parameters:

  • options (Hash) (defaults to: {}) —

    • :stack_name - required - (String)

    • :logical_resource_id - required - (String)

Returns:

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



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

define_client_method :describe_stack_resource, 'DescribeStackResource'

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

Calls the DescribeStackResources API operation.

Parameters:

  • options (Hash) (defaults to: {}) —

    • :stack_name - (String)

    • :logical_resource_id - (String)

    • :physical_resource_id - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following 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)



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

define_client_method :describe_stack_resources, 'DescribeStackResources'

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

Calls the DescribeStacks API operation.

Parameters:

  • options (Hash) (defaults to: {}) —

    • :stack_name - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following 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)



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

define_client_method :describe_stacks, 'DescribeStacks'

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

Calls the EstimateTemplateCost API operation.

Parameters:

  • options (Hash) (defaults to: {}) —

    • :template_body - (String)

    • :template_url - (String)

    • :parameters - (Array<Hash>)

      • :parameter_key - (String)

      • :parameter_value - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :url - (String)



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

define_client_method :estimate_template_cost, 'EstimateTemplateCost'

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

Calls the GetTemplate API operation.

Parameters:

  • options (Hash) (defaults to: {}) —

    • :stack_name - required - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :template_body - (String)



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

define_client_method :get_template, 'GetTemplate'

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

Calls the ListStackResources API operation.

Parameters:

  • options (Hash) (defaults to: {}) —

    • :stack_name - required - (String)

    • :next_token - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following 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)



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

define_client_method :list_stack_resources, 'ListStackResources'

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

Calls the ListStacks API operation.

Parameters:

  • options (Hash) (defaults to: {}) —

    • :next_token - (String)

    • :stack_status_filter - (Array<String>)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following 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)



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

define_client_method :list_stacks, 'ListStacks'

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

Calls the UpdateStack API operation.

Parameters:

  • options (Hash) (defaults to: {}) —

    • :stack_name - required - (String)

    • :template_body - (String)

    • :template_url - (String)

    • :parameters - (Array<Hash>)

      • :parameter_key - (String)

      • :parameter_value - (String)

    • :capabilities - (Array<String>)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :stack_id - (String)



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

define_client_method :update_stack, 'UpdateStack'

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

Calls the ValidateTemplate API operation.

Parameters:

  • options (Hash) (defaults to: {}) —

    • :template_body - (String)

    • :template_url - (String)

Returns:

  • (Core::Response) —

    The #data method of the response object returns a hash with the following structure:

    • :parameters - (Array<Hash>)

      • :parameter_key - (String)

      • :default_value - (String)

      • :no_echo - (Boolean)

      • :description - (String)

    • :description - (String)

    • :capabilities - (Array<String>)

    • :capabilities_reason - (String)



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

define_client_method :validate_template, 'ValidateTemplate'