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

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

Overview

Launches or updates 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, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

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

Instance Method Details

#changeset_name ⇒ Object?

Returns Name given to the changeset when creating a changeset, only used when create_changeset is true. By default a name prefixed with Ansible-STACKNAME is generated based on input parameters. See the AWS Change Sets docs U(docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html).

Returns:



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

attribute :changeset_name

#create_changeset ⇒ String?

Returns If stack already exists create a changeset instead of directly applying changes. See the AWS Change Sets docs U(docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html). WARNING: if the stack does not exist, it will be created without changeset. If the state is absent, the stack will be deleted immediately with no changeset.

Returns:



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

attribute :create_changeset

#create_timeout ⇒ Integer?

Returns The amount of time (in minutes) that can pass before the stack status becomes CREATE_FAILED.

Returns:

  • (Integer, nil) —

    The amount of time (in minutes) that can pass before the stack status becomes CREATE_FAILED



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

attribute :create_timeout

#disable_rollback ⇒ :yes, ...

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

Returns:

  • (:yes, :no, nil) —

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



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

attribute :disable_rollback

#events_limit ⇒ Integer?

Returns Maximum number of CloudFormation events to fetch from a stack when creating or updating it.

Returns:

  • (Integer, nil) —

    Maximum number of CloudFormation events to fetch from a stack when creating or updating it.



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

attribute :events_limit

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



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

attribute :notification_arns

#role_arn ⇒ String?

Returns The role that AWS CloudFormation assumes to create the stack. See the AWS CloudFormation Service Role docs U(docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-servicerole.html).

Returns:



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

attribute :role_arn

#stack_name ⇒ String

Returns name of the cloudformation stack.

Returns:

  • (String) —

    name of the cloudformation stack



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

attribute :stack_name

#stack_policy ⇒ Object?

Returns the path of the cloudformation stack policy. A policy cannot be removed once placed, but it can be modified. (for instance, [allow all updates](docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html#d0e9051).

Returns:



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

attribute :stack_policy

#state ⇒ :present, ...

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:

  • (:present, :absent, nil) —

    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.



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

attribute :state

#tags ⇒ Hash?

Returns Dictionary of tags to associate with stack and its resources during stack creation. Can be updated later, updating tags removes previous entries.

Returns:

  • (Hash, nil) —

    Dictionary of tags to associate with stack and its resources during stack creation. Can be updated later, updating tags removes previous entries.



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

attribute :tags

#template ⇒ String?

Returns The local path of the cloudformation template.,This must be the full path to the file, relative to the working directory. If using roles this may look like “roles/cloudformation/files/cloudformation-example.json”.,If ‘state’ is ‘present’ and the stack does not exist yet, either ‘template’, ‘template_body’ or ‘template_url’ must be specified (but only one of them). If ‘state’ is ‘present’, the stack does exist, and neither ‘template’, ‘template_body’ nor ‘template_url’ are specified, the previous template will be reused.

Returns:

  • (String, nil) —

    The local path of the cloudformation template.,This must be the full path to the file, relative to the working directory. If using roles this may look like “roles/cloudformation/files/cloudformation-example.json”.,If ‘state’ is ‘present’ and the stack does not exist yet, either ‘template’, ‘template_body’ or ‘template_url’ must be specified (but only one of them). If ‘state’ is ‘present’, the stack does exist, and neither ‘template’, ‘template_body’ nor ‘template_url’ are specified, the previous template will be reused.



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

attribute :template

#template_body ⇒ String?

Returns Template body. Use this to pass in the actual body of the Cloudformation template.,If ‘state’ is ‘present’ and the stack does not exist yet, either ‘template’, ‘template_body’ or ‘template_url’ must be specified (but only one of them). If ‘state’ ispresent, the stack does exist, and neither ‘template’, ‘template_body’ nor ‘template_url’ are specified, the previous template will be reused.

Returns:

  • (String, nil) —

    Template body. Use this to pass in the actual body of the Cloudformation template.,If ‘state’ is ‘present’ and the stack does not exist yet, either ‘template’, ‘template_body’ or ‘template_url’ must be specified (but only one of them). If ‘state’ ispresent, the stack does exist, and neither ‘template’, ‘template_body’ nor ‘template_url’ are specified, the previous template will be reused.



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

attribute :template_body

#template_format ⇒ :json, ...

Returns (deprecated) For local templates, allows specification of json or yaml format. Templates are now passed raw to CloudFormation regardless of format. This parameter is ignored since Ansible 2.3.

Returns:

  • (:json, :yaml, nil) —

    (deprecated) For local templates, allows specification of json or yaml format. Templates are now passed raw to CloudFormation regardless of format. This parameter is ignored since Ansible 2.3.



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

attribute :template_format

#template_parameters ⇒ Object?

Returns A list of hashes of all the template variables for the stack. The value can be a string or a dict.,Dict can be used to set additional template parameter attributes like UsePreviousValue (see example).

Returns:

  • (Object, nil) —

    A list of hashes of all the template variables for the stack. The value can be a string or a dict.,Dict can be used to set additional template parameter attributes like UsePreviousValue (see example).



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

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.,If ‘state’ is ‘present’ and the stack does not exist yet, either ‘template’, ‘template_body’ or ‘template_url’ must be specified (but only one of them). If ‘state’ ispresent, the stack does exist, and neither ‘template’, ‘template_body’ nor ‘template_url’ are specified, the previous template will be reused.

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.,If ‘state’ is ‘present’ and the stack does not exist yet, either ‘template’, ‘template_body’ or ‘template_url’ must be specified (but only one of them). If ‘state’ ispresent, the stack does exist, and neither ‘template’, ‘template_body’ nor ‘template_url’ are specified, the previous template will be reused.



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

attribute :template_url

#termination_protection ⇒ Boolean?

Returns enable or disable termination protection on the stack. Only works with botocore >= 1.7.18.

Returns:

  • (Boolean, nil) —

    enable or disable termination protection on the stack. Only works with botocore >= 1.7.18.



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

attribute :termination_protection