Class: Ansible::Ruby::Modules::Ec2_vpc_dhcp_option

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

Overview

This module removes, or creates DHCP option sets, and can associate them to a VPC. Optionally, a new DHCP Options set can be created that converges a VPC’s existing DHCP option set with values provided. When dhcp_options_id is provided, the module will 1. remove (with state=‘absent’) 2. ensure tags are applied (if state=‘present’ and tags are provided 3. attach it to a VPC (if state=‘present’ and a vpc_id is provided. If any of the optional values are missing, they will either be treated as a no-op (i.e., inherit what already exists for the VPC) To remove existing options while inheriting, supply an empty value (e.g. set ntp_servers to [] if you want to remove them from the VPC’s options) Most of the options should be self-explanatory.

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

#delete_old ⇒ :yes, ...

Returns Whether to delete the old VPC DHCP option set when associating a new one. This is primarily useful for debugging/development purposes when you want to quickly roll back to the old option set. Note that this setting will be ignored, and the old DHCP option set will be preserved, if it is in use by any other VPC. (Otherwise, AWS will return an error.).

Returns:

  • (:yes, :no, nil) —

    Whether to delete the old VPC DHCP option set when associating a new one. This is primarily useful for debugging/development purposes when you want to quickly roll back to the old option set. Note that this setting will be ignored, and the old DHCP option set will be preserved, if it is in use by any other VPC. (Otherwise, AWS will return an error.)



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

attribute :delete_old

#dhcp_options_id ⇒ String?

Returns The resource_id of an existing DHCP options set. If this is specified, then it will override other settings, except tags (which will be updated to match).

Returns:

  • (String, nil) —

    The resource_id of an existing DHCP options set. If this is specified, then it will override other settings, except tags (which will be updated to match)



48
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_dhcp_option.rb', line 48

attribute :dhcp_options_id

#dns_servers ⇒ Array<String>, ...

Returns A list of hosts to set the DNS servers for the VPC to. (Should be a list of IP addresses rather than host names.).

Returns:

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

    A list of hosts to set the DNS servers for the VPC to. (Should be a list of IP addresses rather than host names.)



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

attribute :dns_servers

#domain_name ⇒ String?

Returns The domain name to set in the DHCP option sets.

Returns:

  • (String, nil) —

    The domain name to set in the DHCP option sets



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

attribute :domain_name

#inherit_existing ⇒ :yes, ...

Returns For any DHCP options not specified in these parameters, whether to inherit them from the options set already applied to vpc_id, or to reset them to be empty.

Returns:

  • (:yes, :no, nil) —

    For any DHCP options not specified in these parameters, whether to inherit them from the options set already applied to vpc_id, or to reset them to be empty.



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

attribute :inherit_existing

#netbios_name_servers ⇒ Array<String>, ...

Returns List of hosts to advertise as NetBIOS servers.

Returns:

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

    List of hosts to advertise as NetBIOS servers.



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

attribute :netbios_name_servers

#netbios_node_type ⇒ Integer?

Returns NetBIOS node type to advertise in the DHCP options. The AWS recommendation is to use 2 (when using netbios name services) docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html.

Returns:



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

attribute :netbios_node_type

#ntp_servers ⇒ Array<String>, ...

Returns List of hosts to advertise as NTP servers for the VPC.

Returns:

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

    List of hosts to advertise as NTP servers for the VPC.



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

attribute :ntp_servers

#state ⇒ :absent, ...

Returns create/assign or remove the DHCP options. If state is set to absent, then a DHCP options set matched either by id, or tags and options will be removed if possible.

Returns:

  • (:absent, :present, nil) —

    create/assign or remove the DHCP options. If state is set to absent, then a DHCP options set matched either by id, or tags and options will be removed if possible.



52
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/ec2_vpc_dhcp_option.rb', line 52

attribute :state

#tags ⇒ Hash?

Returns Tags to be applied to a VPC options set if a new one is created, or if the resource_id is provided. (options must match).

Returns:

  • (Hash, nil) —

    Tags to be applied to a VPC options set if a new one is created, or if the resource_id is provided. (options must match)



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

attribute :tags

#vpc_id ⇒ String?

Returns VPC ID to associate with the requested DHCP option set. If no vpc id is provided, and no matching option set is found then a new DHCP option set is created.

Returns:

  • (String, nil) —

    VPC ID to associate with the requested DHCP option set. If no vpc id is provided, and no matching option set is found then a new DHCP option set is created.



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

attribute :vpc_id