Class: Ansible::Ruby::Modules::Gcdns_record

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

Overview

Creates or removes resource records in Google Cloud DNS.

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

#credentials_file ⇒ Object?

Returns The path to the JSON file associated with the service account email.

Returns:

  • (Object, nil) —

    The path to the JSON file associated with the service account email.



50
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcdns_record.rb', line 50

attribute :credentials_file

#overwrite ⇒ :yes, ...

Returns Whether an attempt to overwrite an existing record should succeed or fail. The behavior of this option depends on I(state).,If I(state) is C(present) and I(overwrite) is C(True), this module will replace an existing resource record of the same name with the provided I(record_data). If I(state) is C(present) and I(overwrite) is C(False), this module will fail if there is an existing resource record with the same name and type, but different resource data.,If I(state) is C(absent) and I(overwrite) is C(True), this module will remove the given resource record unconditionally. If I(state) is C(absent) and I(overwrite) is C(False), this module will fail if the provided record_data do not match exactly with the existing resource record’s record_data.

Returns:

  • (:yes, :no, nil) —

    Whether an attempt to overwrite an existing record should succeed or fail. The behavior of this option depends on I(state).,If I(state) is C(present) and I(overwrite) is C(True), this module will replace an existing resource record of the same name with the provided I(record_data). If I(state) is C(present) and I(overwrite) is C(False), this module will fail if there is an existing resource record with the same name and type, but different resource data.,If I(state) is C(absent) and I(overwrite) is C(True), this module will remove the given resource record unconditionally. If I(state) is C(absent) and I(overwrite) is C(False), this module will fail if the provided record_data do not match exactly with the existing resource record’s record_data.



40
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcdns_record.rb', line 40

attribute :overwrite

#pem_file ⇒ Object?

Returns The path to the PEM file associated with the service account email.,This option is deprecated and may be removed in a future release. Use I(credentials_file) instead.

Returns:

  • (Object, nil) —

    The path to the PEM file associated with the service account email.,This option is deprecated and may be removed in a future release. Use I(credentials_file) instead.



47
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcdns_record.rb', line 47

attribute :pem_file

#project_id ⇒ Object?

Returns The Google Cloud Platform project ID to use.

Returns:

  • (Object, nil) —

    The Google Cloud Platform project ID to use.



53
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcdns_record.rb', line 53

attribute :project_id

#record ⇒ String

Returns The fully-qualified domain name of the resource record.

Returns:

  • (String) —

    The fully-qualified domain name of the resource record.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcdns_record.rb', line 16

attribute :record

#record_data ⇒ Array<String>, ...

Returns The record_data to use for the resource record.,I(record_data) must be specified if I(state) is C(present) or I(overwrite) is C(True), or the module will fail.,Valid record_data vary based on the record’s I(type). In addition, resource records that contain a DNS domain name in the value field (e.g., CNAME, PTR, SRV, .etc) MUST include a trailing dot in the value.,Individual string record_data for TXT records must be enclosed in double quotes.,For resource records that have the same name but different record_data (e.g., multiple A records), they must be defined as multiple list entries in a single record.

Returns:

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

    The record_data to use for the resource record.,I(record_data) must be specified if I(state) is C(present) or I(overwrite) is C(True), or the module will fail.,Valid record_data vary based on the record’s I(type). In addition, resource records that contain a DNS domain name in the value field (e.g., CNAME, PTR, SRV, .etc) MUST include a trailing dot in the value.,Individual string record_data for TXT records must be enclosed in double quotes.,For resource records that have the same name but different record_data (e.g., multiple A records), they must be defined as multiple list entries in a single record.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcdns_record.rb', line 32

attribute :record_data

#service_account_email ⇒ Object?

Returns The e-mail address for a service account with access to Google Cloud DNS.

Returns:

  • (Object, nil) —

    The e-mail address for a service account with access to Google Cloud DNS.



44
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcdns_record.rb', line 44

attribute :service_account_email

#state ⇒ :present, ...

Returns Whether the given resource record should or should not be present.

Returns:

  • (:present, :absent, nil) —

    Whether the given resource record should or should not be present.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcdns_record.rb', line 12

attribute :state

#ttl ⇒ Integer?

Returns The amount of time in seconds that a resource record will remain cached by a caching resolver.

Returns:

  • (Integer, nil) —

    The amount of time in seconds that a resource record will remain cached by a caching resolver.



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcdns_record.rb', line 36

attribute :ttl

#type ⇒ :A, ...

Returns The type of resource record to add.

Returns:

  • (:A, :AAAA, :CNAME, :SRV, :TXT, :SOA, :NS, :MX, :SPF, :PTR) —

    The type of resource record to add.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcdns_record.rb', line 28

attribute :type

#zone ⇒ String?

Returns The DNS domain name of the zone (e.g., example.com).,One of either I(zone) or I(zone_id) must be specified as an option, or the module will fail.,If both I(zone) and I(zone_id) are specified, I(zone_id) will be used.

Returns:

  • (String, nil) —

    The DNS domain name of the zone (e.g., example.com).,One of either I(zone) or I(zone_id) must be specified as an option, or the module will fail.,If both I(zone) and I(zone_id) are specified, I(zone_id) will be used.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcdns_record.rb', line 20

attribute :zone

#zone_id ⇒ String?

Returns The Google Cloud ID of the zone (e.g., example-com).,One of either I(zone) or I(zone_id) must be specified as an option, or the module will fail.,These usually take the form of domain names with the dots replaced with dashes. A zone ID will never have any dots in it.,I(zone_id) can be faster than I(zone) in projects with a large number of zones.,If both I(zone) and I(zone_id) are specified, I(zone_id) will be used.

Returns:

  • (String, nil) —

    The Google Cloud ID of the zone (e.g., example-com).,One of either I(zone) or I(zone_id) must be specified as an option, or the module will fail.,These usually take the form of domain names with the dots replaced with dashes. A zone ID will never have any dots in it.,I(zone_id) can be faster than I(zone) in projects with a large number of zones.,If both I(zone) and I(zone_id) are specified, I(zone_id) will be used.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcdns_record.rb', line 24

attribute :zone_id