Class: Ansible::Ruby::Modules::Cloudformation_stack_set

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Cloudformation_stack_set

Defined in:

lib/ansible/ruby/modules/generated/cloud/amazon/cloudformation_stack_set.rb

Overview

Launches/updates/deletes AWS CloudFormation Stack Sets

Instance Method Summary

• #accounts ⇒ Array<Integer>, ...

  A list of AWS accounts in which to create instance of CloudFormation stacks.,At least one region must be specified to create a stack set.

• #administration_role_arn ⇒ Object^?

  ARN of the administration role, meaning the role that CloudFormation Stack Sets use to assume the roles in your child accounts.,This defaults to I(arn:aws:iam::account ID }:role/AWSCloudFormationStackSetAdministrationRole) where I(account ID }) is replaced with the account number of the current IAM role/user/STS credentials.

• #capabilities ⇒ :CAPABILITY_IAM, ...

  Capabilities allow stacks to create and modify IAM resources, which may include adding users or roles.,Currently the only available values are ‘CAPABILITY_IAM’ and ‘CAPABILITY_NAMED_IAM’.

• #description ⇒ String^?

  A description of what this stack set creates.

• #execution_role_name ⇒ Object^?

  ARN of the execution role, meaning the role that CloudFormation Stack Sets assumes in your child accounts.,This MUST NOT be an ARN, and the roles must exist in each child account specified.,The default name for the execution role is I(AWSCloudFormationStackSetExecutionRole).

• #failure_tolerance ⇒ Object^?

  Settings to change what is considered “failed” when running stack instance updates, and how many to do at a time.

• #name ⇒ String

  Name of the cloudformation stack set.

• #parameters ⇒ Object^?

  A list of hashes of all the template variables for the stack.

• #purge_stacks ⇒ Boolean^?

  Only applicable when I(state=absent).

• #regions ⇒ Array<String>, ...

  A list of AWS regions to create instances of a stack in.

• #state ⇒ :present, ...

  If state is “present”, stack will be created.

• #tags ⇒ Hash^?

  Dictionary of tags to associate with stack and its resources during stack creation.

• #template ⇒ Object^?

  The local path of the cloudformation template.,This must be the full path to the file, relative to the working directory.

• #template_body ⇒ Object^?

  Template body.

• #template_url ⇒ String^?

  Location of file containing the template body.

• #wait ⇒ Symbol^?

  Whether or not to wait for stack operation to complete.

• #wait_timeout ⇒ Integer^?

  How long to wait (in seconds) for stacks to complete create/update/delete operations.

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

#accounts ⇒ Array<Integer>, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudformation_stack_set.rb', line 57

attribute :accounts

#administration_role_arn ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudformation_stack_set.rb', line 61

attribute :administration_role_arn

#capabilities ⇒ :CAPABILITY_IAM, ...

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

attribute :capabilities

#description ⇒ String^?

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

attribute :description

#execution_role_name ⇒ Object^?

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

attribute :execution_role_name

#failure_tolerance ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudformation_stack_set.rb', line 71

attribute :failure_tolerance

#name ⇒ String

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

attribute :name

#parameters ⇒ Object^?

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

attribute :parameters

#purge_stacks ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudformation_stack_set.rb', line 37

attribute :purge_stacks

#regions ⇒ Array<String>, ...

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

attribute :regions

#state ⇒ :present, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudformation_stack_set.rb', line 23

attribute :state

#tags ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudformation_stack_set.rb', line 67

attribute :tags

#template ⇒ Object^?

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

attribute :template

#template_body ⇒ Object^?

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

attribute :template_body

#template_url ⇒ String^?

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

attribute :template_url

#wait ⇒ Symbol^?

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

attribute :wait

#wait_timeout ⇒ Integer^?

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

attribute :wait_timeout