Class: Ansible::Ruby::Modules::Ec2_eni

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

Overview

Create and optionally attach an Elastic Network Interface (ENI) to an instance. If an ENI ID or private_ip is provided, the existing ENI (if any) will be modified. The ‘attached’ parameter controls the attachment status of the network interface.

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

#allow_reassignment ⇒ :yes, ...

Returns Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

Returns:

  • (:yes, :no, nil) —

    Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.



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

attribute :allow_reassignment

#attached ⇒ Symbol?

Returns Specifies if network interface should be attached or detached from instance. If omitted, attachment status won’t change.

Returns:

  • (Symbol, nil) —

    Specifies if network interface should be attached or detached from instance. If omitted, attachment status won’t change



43
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_eni.rb', line 43

attribute :attached

#delete_on_termination ⇒ Symbol?

Returns Delete the interface when the instance it is attached to is terminated. You can only specify this flag when the interface is being modified, not on creation.

Returns:

  • (Symbol, nil) —

    Delete the interface when the instance it is attached to is terminated. You can only specify this flag when the interface is being modified, not on creation.



51
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_eni.rb', line 51

attribute :delete_on_termination

#description ⇒ String?

Returns Optional description of the ENI.

Returns:

  • (String, nil) —

    Optional description of the ENI.



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

attribute :description

#device_index ⇒ Integer?

Returns The index of the device for the network interface attachment on the instance.

Returns:

  • (Integer, nil) —

    The index of the device for the network interface attachment on the instance.



39
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_eni.rb', line 39

attribute :device_index

#eni_id ⇒ String?

Returns The ID of the ENI (to modify); if null and state is present, a new eni will be created.

Returns:

  • (String, nil) —

    The ID of the ENI (to modify); if null and state is present, a new eni will be created.



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

attribute :eni_id

#force_detach ⇒ :yes, ...

Returns Force detachment of the interface. This applies either when explicitly detaching the interface by setting instance_id to None or when deleting an interface with state=absent.

Returns:

  • (:yes, :no, nil) —

    Force detachment of the interface. This applies either when explicitly detaching the interface by setting instance_id to None or when deleting an interface with state=absent.



47
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_eni.rb', line 47

attribute :force_detach

#instance_id ⇒ String?

Returns Instance ID that you wish to attach ENI to. Since version 2.2, use the ‘attached’ parameter to attach or detach an ENI. Prior to 2.2, to detach an ENI from an instance, use ‘None’.

Returns:

  • (String, nil) —

    Instance ID that you wish to attach ENI to. Since version 2.2, use the ‘attached’ parameter to attach or detach an ENI. Prior to 2.2, to detach an ENI from an instance, use ‘None’.



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

attribute :instance_id

#private_ip_address ⇒ String?

Returns Private IP address.

Returns:

  • (String, nil) —

    Private IP address.



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

attribute :private_ip_address

#purge_secondary_private_ip_addresses ⇒ Symbol?

Returns To be used with I(secondary_private_ip_addresses) to determine whether or not to remove any secondary IP addresses other than those specified. Set secondary_private_ip_addresses to an empty list to purge all secondary addresses.

Returns:

  • (Symbol, nil) —

    To be used with I(secondary_private_ip_addresses) to determine whether or not to remove any secondary IP addresses other than those specified. Set secondary_private_ip_addresses to an empty list to purge all secondary addresses.



63
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_eni.rb', line 63

attribute :purge_secondary_private_ip_addresses

#secondary_private_ip_address_count ⇒ Integer?

Returns The number of secondary IP addresses to assign to the network interface. This option is mutually exclusive of secondary_private_ip_addresses.

Returns:

  • (Integer, nil) —

    The number of secondary IP addresses to assign to the network interface. This option is mutually exclusive of secondary_private_ip_addresses



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

attribute :secondary_private_ip_address_count

#secondary_private_ip_addresses ⇒ Array<String>, ...

Returns A list of IP addresses to assign as secondary IP addresses to the network interface. This option is mutually exclusive of secondary_private_ip_address_count.

Returns:

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

    A list of IP addresses to assign as secondary IP addresses to the network interface. This option is mutually exclusive of secondary_private_ip_address_count



59
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_eni.rb', line 59

attribute :secondary_private_ip_addresses

#security_groups ⇒ Object?

Returns List of security groups associated with the interface. Only used when state=present. Since version 2.2, you can specify security groups by ID or by name or a combination of both. Prior to 2.2, you can specify only by ID.

Returns:

  • (Object, nil) —

    List of security groups associated with the interface. Only used when state=present. Since version 2.2, you can specify security groups by ID or by name or a combination of both. Prior to 2.2, you can specify only by ID.



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

attribute :security_groups

#source_dest_check ⇒ Symbol?

Returns By default, interfaces perform source/destination checks. NAT instances however need this check to be disabled. You can only specify this flag when the interface is being modified, not on creation.

Returns:

  • (Symbol, nil) —

    By default, interfaces perform source/destination checks. NAT instances however need this check to be disabled. You can only specify this flag when the interface is being modified, not on creation.



55
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_eni.rb', line 55

attribute :source_dest_check

#state ⇒ :present, ...

Returns Create or delete ENI.

Returns:

  • (:present, :absent, nil) —

    Create or delete ENI



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_eni.rb', line 35

attribute :state

#subnet_id ⇒ String?

Returns ID of subnet in which to create the ENI.

Returns:

  • (String, nil) —

    ID of subnet in which to create the ENI.



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

attribute :subnet_id