Class: Ansible::Ruby::Modules::Ec2_eip

Inherits:
Base show all
Includes:
Helpers::Aws
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/ec2_eip.rb,
lib/ansible/ruby/modules/custom/cloud/core/amazon/ec2_eip.rb

Overview

This module can allocate or release an EIP. This module can associate/disassociate an EIP with instances or network interfaces.

Instance Method Summary collapse

Methods included from Helpers::Aws

included

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

#allow_reassociation ⇒ String?

Returns Specify this option to allow an Elastic IP address that is already associated with another network interface or instance to be re-associated with the specified instance or interface.

Returns:

  • (String, nil) —

    Specify this option to allow an Elastic IP address that is already associated with another network interface or instance to be re-associated with the specified instance or interface.



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

attribute :allow_reassociation

#device_id ⇒ String?

Returns The id of the device for the EIP. Can be an EC2 Instance id or Elastic Network Interface (ENI) id.

Returns:

  • (String, nil) —

    The id of the device for the EIP. Can be an EC2 Instance id or Elastic Network Interface (ENI) id.



13
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_eip.rb', line 13

attribute :device_id

#in_vpc ⇒ String?

Returns Allocate an EIP inside a VPC or not. Required if specifying an ENI.

Returns:

  • (String, nil) —

    Allocate an EIP inside a VPC or not. Required if specifying an ENI.



25
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_eip.rb', line 25

attribute :in_vpc

#private_ip_address ⇒ Object?

Returns The primary or secondary private IP address to associate with the Elastic IP address.

Returns:

  • (Object, nil) —

    The primary or secondary private IP address to associate with the Elastic IP address.



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

attribute :private_ip_address

#public_ip ⇒ String?

Returns The IP address of a previously allocated EIP.,If present and device is specified, the EIP is associated with the device.,If absent and device is specified, the EIP is disassociated from the device.

Returns:

  • (String, nil) —

    The IP address of a previously allocated EIP.,If present and device is specified, the EIP is associated with the device.,If absent and device is specified, the EIP is disassociated from the device.



17
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_eip.rb', line 17

attribute :public_ip

#release_on_disassociation ⇒ String?

Returns whether or not to automatically release the EIP when it is disassociated.

Returns:

  • (String, nil) —

    whether or not to automatically release the EIP when it is disassociated



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

attribute :release_on_disassociation

#reuse_existing_ip_allowed ⇒ String?

Returns Reuse an EIP that is not associated to a device (when available), instead of allocating a new one.

Returns:

  • (String, nil) —

    Reuse an EIP that is not associated to a device (when available), instead of allocating a new one.



29
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_eip.rb', line 29

attribute :reuse_existing_ip_allowed

#state ⇒ :present, ...

Returns If present, allocate an EIP or associate an existing EIP with a device.,If absent, disassociate the EIP from the device and optionally release it.

Returns:

  • (:present, :absent, nil) —

    If present, allocate an EIP or associate an existing EIP with a device.,If absent, disassociate the EIP from the device and optionally release it.



21
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_eip.rb', line 21

attribute :state