Class: AWS::CloudFormation::Client

Inherits:

AWS::Core::QueryClient

• Object
• AWS::Core::Client
• AWS::Core::QueryClient
• AWS::CloudFormation::Client

Defined in:

lib/aws/cloud_formation/client.rb

Overview

Client class for AWS CloudFormation.

Instance Attribute Summary

Attributes inherited from AWS::Core::Client

#config, #http_read_timeout

Instance Method Summary

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

  Calls the CreateStack API operation.

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

  Calls the CreateUploadBucket API operation.

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

  Calls the DeleteStack API operation.

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

  Calls the DescribeStackEvents API operation.

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

  Calls the DescribeStackResource API operation.

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

  Calls the DescribeStackResources API operation.

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

  Calls the DescribeStacks API operation.

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

  Calls the EstimateTemplateCost API operation.

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

  Calls the GetTemplate API operation.

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

  Calls the ListStackResources API operation.

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

  Calls the ListStacks API operation.

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

  Calls the UpdateStack API operation.

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

  Calls the ValidateTemplate API operation.

Methods inherited from AWS::Core::Client

#initialize, #log_warning, #operations, 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_arns - (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)

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

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

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

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

Calls the DeleteStack API operation.

Parameters:

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

  • :stack_name - required - (String)

Returns:

• (Core::Response)

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

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

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

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

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

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

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

#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_arns - (Array<String>)

    • :timeout_in_minutes - (Integer)

    • :capabilities - (Array<String>)

    • :outputs - (Array<Hash>)

      • :output_key - (String)

      • :output_value - (String)

      • :description - (String)

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

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

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

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

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

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

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

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

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

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

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

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

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