Class: Ansible::Ruby::Modules::Cloudformation

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/cloud/amazon/cloudformation.rb

Overview

Launches an AWS CloudFormation stack and waits for it complete.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#disable_rollback ⇒ :true, ...

Returns If a stacks fails to form, rollback will remove the stack.

Returns:

  • (:true, :false, nil) —

    If a stacks fails to form, rollback will remove the stack



15
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/cloudformation.rb', line 15

attribute :disable_rollback

#notification_arns ⇒ Object?

Returns The Simple Notification Service (SNS) topic ARNs to publish stack related events.

Returns:

  • (Object, nil) —

    The Simple Notification Service (SNS) topic ARNs to publish stack related events.



30
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/cloudformation.rb', line 30

attribute :notification_arns

#region ⇒ String

Returns The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used.

Returns:

  • (String) —

    The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used.



40
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/cloudformation.rb', line 40

attribute :region

#stack_name ⇒ String

Returns name of the cloudformation stack.

Returns:

  • (String) —

    name of the cloudformation stack



11
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/cloudformation.rb', line 11

attribute :stack_name

#stack_policy ⇒ Object?

Returns the path of the cloudformation stack policy.

Returns:

  • (Object, nil) —

    the path of the cloudformation stack policy



33
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/cloudformation.rb', line 33

attribute :stack_policy

#state ⇒ String

Returns If state is “present”, stack will be created. If state is “present” and if stack exists and template has changed, it will be updated. If state is “absent”, stack will be removed.

Returns:

  • (String) —

    If state is “present”, stack will be created. If state is “present” and if stack exists and template has changed, it will be updated. If state is “absent”, stack will be removed.



22
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/cloudformation.rb', line 22

attribute :state

#tags ⇒ Hash?

Returns Dictionary of tags to associate with stack and it’s resources during stack creation. Cannot be updated later. Requires at least Boto version 2.6.0.

Returns:

  • (Hash, nil) —

    Dictionary of tags to associate with stack and it’s resources during stack creation. Cannot be updated later. Requires at least Boto version 2.6.0.



36
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/cloudformation.rb', line 36

attribute :tags

#template ⇒ String?

Returns The local path of the cloudformation template. This parameter is mutually exclusive with ‘template_url’. Either one of them is required if “state” parameter is “present” Must give full path to the file, relative to the working directory. If using roles this may look like “roles/cloudformation/files/cloudformation-example.json”.

Returns:

  • (String, nil) —

    The local path of the cloudformation template. This parameter is mutually exclusive with ‘template_url’. Either one of them is required if “state” parameter is “present” Must give full path to the file, relative to the working directory. If using roles this may look like “roles/cloudformation/files/cloudformation-example.json”



26
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/cloudformation.rb', line 26

attribute :template

#template_format ⇒ :json, ...

Returns For local templates, allows specification of json or yaml format.

Returns:

  • (:json, :yaml, nil) —

    For local templates, allows specification of json or yaml format



48
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/cloudformation.rb', line 48

attribute :template_format

#template_parameters ⇒ Object?

Returns a list of hashes of all the template variables for the stack.

Returns:

  • (Object, nil) —

    a list of hashes of all the template variables for the stack



19
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/cloudformation.rb', line 19

attribute :template_parameters

#template_url ⇒ String?

Returns Location of file containing the template body. The URL must point to a template (max size 307,200 bytes) located in an S3 bucket in the same region as the stack. This parameter is mutually exclusive with ‘template’. Either one of them is required if “state” parameter is “present”.

Returns:

  • (String, nil) —

    Location of file containing the template body. The URL must point to a template (max size 307,200 bytes) located in an S3 bucket in the same region as the stack. This parameter is mutually exclusive with ‘template’. Either one of them is required if “state” parameter is “present”



44
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/cloudformation.rb', line 44

attribute :template_url