Class: Ansible::Ruby::Modules::Lightsail

Inherits:

Base

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

Defined in:

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

Overview

Creates or instances in AWS Lightsail and optionally wait for it to be ‘running’.

Instance Method Summary

• #blueprint_id ⇒ String^?

  ID of the instance blueprint image.

• #bundle_id ⇒ String^?

  Bundle of specification info for the instance.

• #key_pair_name ⇒ String^?

  Name of the key pair to use with the instance.

• #name ⇒ String

  Name of the instance.

• #state ⇒ :present, ...

  Indicate desired state of the target.

• #user_data ⇒ String^?

  Launch script that can configure the instance with additional data.

• #wait ⇒ :yes, ...

  Wait for the instance to be in state ‘running’ before returning.

• #wait_timeout ⇒ Integer^?

  How long before wait gives up, in seconds.

• #zone ⇒ String^?

  AWS availability zone in which to launch the instance.

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

#blueprint_id ⇒ String^?

Returns ID of the instance blueprint image. Required when state=‘present’.

Returns:

• (String, nil) —

  ID of the instance blueprint image. Required when state=‘present’

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

attribute :blueprint_id

#bundle_id ⇒ String^?

Returns Bundle of specification info for the instance. Required when state=‘present’.

Returns:

• (String, nil) —

  Bundle of specification info for the instance. Required when state=‘present’

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/lightsail.rb', line 28

attribute :bundle_id

#key_pair_name ⇒ String^?

Returns Name of the key pair to use with the instance.

Returns:

• (String, nil) —

  Name of the key pair to use with the instance

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

attribute :key_pair_name

#name ⇒ String

Returns Name of the instance.

Returns:

• (String) —

  Name of the instance

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

attribute :name

#state ⇒ :present, ...

Returns Indicate desired state of the target.

Returns:

• (:present, :absent, :running, :restarted, :stopped, nil) —

  Indicate desired state of the target.

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

attribute :state

#user_data ⇒ String^?

Returns Launch script that can configure the instance with additional data.

Returns:

• (String, nil) —

  Launch script that can configure the instance with additional data

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/lightsail.rb', line 32

attribute :user_data

#wait ⇒ :yes, ...

Returns Wait for the instance to be in state ‘running’ before returning. If wait is “no” an ip_address may not be returned.

Returns:

• (:yes, :no, nil) —

  Wait for the instance to be in state ‘running’ before returning. If wait is “no” an ip_address may not be returned

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

attribute :wait

#wait_timeout ⇒ Integer^?

Returns How long before wait gives up, in seconds.

Returns:

• (Integer, nil) —

  How long before wait gives up, in seconds.

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

attribute :wait_timeout

#zone ⇒ String^?

Returns AWS availability zone in which to launch the instance. Required when state=‘present’.

Returns:

• (String, nil) —

  AWS availability zone in which to launch the instance. Required when state=‘present’

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

attribute :zone