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

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

Overview

Create and optionally attach an Elastic Network Interface (ENI) to an instance. If an ENI ID is provided, an attempt is made to update the existing ENI. By passing ‘None’ as the instance_id, an ENI can be detached from an instance.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#delete_on_termination ⇒ Boolean?

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:

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



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

attribute :delete_on_termination

#description ⇒ String?

Returns Optional description of the ENI.

Returns:

  • (String, nil) —

    Optional description of the ENI.



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

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.



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

attribute :device_index

#eni_id ⇒ String, ...

Returns The ID of the ENI.

Returns:

  • (String, Hash, nil) —

    The ID of the ENI



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

attribute :eni_id

#force_detach ⇒ Boolean?

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:

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



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

attribute :force_detach

#instance_id ⇒ String?

Returns Instance ID that you wish to attach ENI to. To detach an ENI from an instance, use ‘None’.

Returns:

  • (String, nil) —

    Instance ID that you wish to attach ENI to. To detach an ENI from an instance, use ‘None’.



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

attribute :instance_id

#private_ip_address ⇒ String?

Returns Private IP address.

Returns:

  • (String, nil) —

    Private IP address.



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

attribute :private_ip_address

#security_groups ⇒ Object?

Returns List of security groups associated with the interface. Only used when state=present.

Returns:

  • (Object, nil) —

    List of security groups associated with the interface. Only used when state=present.



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

attribute :security_groups

#source_dest_check ⇒ Object?

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:

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



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

attribute :source_dest_check

#state ⇒ :present, ...

Returns Create or delete ENI.

Returns:

  • (:present, :absent, nil) —

    Create or delete ENI.



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

attribute :state

#subnet_id ⇒ String

Returns ID of subnet in which to create the ENI. Only required when state=present.

Returns:

  • (String) —

    ID of subnet in which to create the ENI. Only required when state=present.



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

attribute :subnet_id