Class: Ansible::Ruby::Modules::Ec2_vpc_dhcp_options

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

Instance Method Summary collapse

Methods inherited from Base

#to_h

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

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

Constructor Details

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

Instance Method Details

#delete_old ⇒ Boolean?

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:

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



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

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)



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

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.)



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

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



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

attribute :domain_name

#inherit_existing ⇒ Boolean?

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:

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



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

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.



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

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:



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

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.



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

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.



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

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)



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

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.



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

attribute :vpc_id