Class: Ansible::Ruby::Modules::Terraform

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/misc/terraform.rb

Overview

Provides support for deploying resources with Terraform and pulling resource information back into Ansible.

Instance Method Summary

• #backend_config ⇒ Hash^?

  A group of key-values to provide at init stage to the -backend-config parameter.

• #binary_path ⇒ Object^?

  The path of a terraform binary to use, relative to the ‘service_path’ unless you supply an absolute path.

• #force_init ⇒ Symbol^?

  To avoid duplicating infra, if a state file can’t be found this will force a ‘terraform init`.

• #lock ⇒ Object^?

  Enable statefile locking, if you use a service that accepts locks (such as S3+DynamoDB) to store your statefile.

• #lock_timeout ⇒ Object^?

  How long to maintain the lock on the statefile, if you use a service that accepts locks (such as S3+DynamoDB).

• #plan_file ⇒ Object^?

  The path to an existing Terraform plan file to apply.

• #project_path ⇒ String

  The path to the root of the Terraform directory with the vars.tf/main.tf/etc to use.

• #purge_workspace ⇒ Symbol^?

  Only works with state = absent,If true, the workspace will be deleted after the “terraform destroy” action.,The ‘default’ workspace will not be deleted.

• #state ⇒ :planned, ...

  Goal state of given stage/project.

• #state_file ⇒ Object^?

  The path to an existing Terraform state file to use when building plan.

• #targets ⇒ Object^?

  A list of specific resources to target in this plan/application.

• #variables ⇒ Object^?

  A group of key-values to override template variables or those in variables files.

• #variables_file ⇒ Object^?

  The path to a variables file for Terraform to fill into the TF configurations.

• #workspace ⇒ String^?

  The terraform workspace to work with.

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

#backend_config ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/terraform.rb', line 56

attribute :backend_config

#binary_path ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/terraform.rb', line 16

attribute :binary_path

#force_init ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/terraform.rb', line 52

attribute :force_init

#lock ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/terraform.rb', line 46

attribute :lock

#lock_timeout ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/terraform.rb', line 49

attribute :lock_timeout

#plan_file ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/terraform.rb', line 31

attribute :plan_file

#project_path ⇒ String

# File 'lib/ansible/ruby/modules/generated/cloud/misc/terraform.rb', line 19

attribute :project_path

#purge_workspace ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/terraform.rb', line 27

attribute :purge_workspace

#state ⇒ :planned, ...

# File 'lib/ansible/ruby/modules/generated/cloud/misc/terraform.rb', line 12

attribute :state

#state_file ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/terraform.rb', line 34

attribute :state_file

#targets ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/terraform.rb', line 43

attribute :targets

#variables ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/terraform.rb', line 40

attribute :variables

#variables_file ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/terraform.rb', line 37

attribute :variables_file

#workspace ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/misc/terraform.rb', line 23

attribute :workspace