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

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

Overview

Launches/updates/deletes AWS CloudFormation Stack Sets

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

#accounts ⇒ Array<Integer>, ...

Returns 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. On updates, if fewer regions are specified only the specified regions will have their stack instances updated.

Returns:

  • (Array<Integer>, Integer, nil) —

    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. On updates, if fewer regions are specified only the specified regions will have their stack instances updated.



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

attribute :accounts

#administration_role_arn ⇒ Object?

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

Returns:

  • (Object, nil) —

    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.



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

attribute :administration_role_arn

#capabilities ⇒ :CAPABILITY_IAM, ...

Returns 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’. Either or both may be provided.,The following resources require that one or both of these parameters is specified: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, AWS::IAM::UserToGroupAdditionrn.

Returns:

  • (:CAPABILITY_IAM, :CAPABILITY_NAMED_IAM, nil) —

    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’. Either or both may be provided.,The following resources require that one or both of these parameters is specified: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, AWS::IAM::UserToGroupAdditionrn



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

attribute :capabilities

#description ⇒ String?

Returns A description of what this stack set creates.

Returns:

  • (String, nil) —

    A description of what this stack set creates



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

attribute :description

#execution_role_name ⇒ Object?

Returns 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).

Returns:

  • (Object, nil) —

    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)



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

attribute :execution_role_name

#failure_tolerance ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :failure_tolerance

#name ⇒ String

Returns name of the cloudformation stack set.

Returns:

  • (String) —

    name of the cloudformation stack set



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

attribute :name

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



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

attribute :parameters

#purge_stacks ⇒ Boolean?

Returns Only applicable when I(state=absent). Sets whether, when deleting a stack set, the stack instances should also be deleted.,By default, instances will be deleted. Set to ‘no’ or ‘false’ to keep stacks when stack set is deleted.

Returns:

  • (Boolean, nil) —

    Only applicable when I(state=absent). Sets whether, when deleting a stack set, the stack instances should also be deleted.,By default, instances will be deleted. Set to ‘no’ or ‘false’ to keep stacks when stack set is deleted.



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

attribute :purge_stacks

#regions ⇒ Array<String>, ...

Returns A list of AWS regions to create instances of a stack in. The I(region) parameter chooses where the Stack Set is created, and I(regions) specifies the region for stack instances.,At least one region must be specified to create a stack set. On updates, if fewer regions are specified only the specified regions will have their stack instances updated.

Returns:

  • (Array<String>, String, nil) —

    A list of AWS regions to create instances of a stack in. The I(region) parameter chooses where the Stack Set is created, and I(regions) specifies the region for stack instances.,At least one region must be specified to create a stack set. On updates, if fewer regions are specified only the specified regions will have their stack instances updated.



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

attribute :regions

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



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

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.



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

attribute :tags

#template ⇒ Object?

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:

  • (Object, 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.



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

attribute :template

#template_body ⇒ Object?

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’ is present, the stack does exist, and neither ‘template’, ‘template_body’ nor ‘template_url’ are specified, the previous template will be reused.

Returns:

  • (Object, 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’ is present, the stack does exist, and neither ‘template’, ‘template_body’ nor ‘template_url’ are specified, the previous template will be reused.



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

attribute :template_body

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

    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’ is present, the stack does exist, and neither ‘template’, ‘template_body’ nor ‘template_url’ are specified, the previous template will be reused.



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

attribute :template_url

#wait ⇒ Symbol?

Returns Whether or not to wait for stack operation to complete. This includes waiting for stack instances to reach UPDATE_COMPLETE status.,If you choose not to wait, this module will not notify when stack operations fail because it will not wait for them to finish.

Returns:

  • (Symbol, nil) —

    Whether or not to wait for stack operation to complete. This includes waiting for stack instances to reach UPDATE_COMPLETE status.,If you choose not to wait, this module will not notify when stack operations fail because it will not wait for them to finish.



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

attribute :wait

#wait_timeout ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



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

attribute :wait_timeout