Parameter |
Choices/Defaults |
Comments |
credentials_file
|
|
The path to the JSON file associated with the service account email.
|
overwrite
bool |
|
Whether an attempt to overwrite an existing record should succeed or fail. The behavior of this option depends on state.
If state is present and overwrite is True , this module will replace an existing resource record of the same name with the provided record_data. If state is present and overwrite is False , this module will fail if there is an existing resource record with the same name and type, but different resource data.
If state is absent and overwrite is True , this module will remove the given resource record unconditionally. If state is absent and overwrite is False , this module will fail if the provided record_data do not match exactly with the existing resource record's record_data.
|
pem_file
|
|
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 credentials_file instead.
|
project_id
|
|
The Google Cloud Platform project ID to use.
|
record
required |
|
The fully-qualified domain name of the resource record.
aliases: name
|
record_data
|
|
The record_data to use for the resource record.
record_data must be specified if state is present or overwrite is True , or the module will fail.
Valid record_data vary based on the record's 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.
aliases: value
|
service_account_email
|
|
The e-mail address for a service account with access to Google Cloud DNS.
|
state
|
Choices:
present ←
- absent
|
Whether the given resource record should or should not be present.
|
ttl
|
Default:
300
|
The amount of time in seconds that a resource record will remain cached by a caching resolver.
|
type
required |
Choices:
- A
- AAAA
- CNAME
- SRV
- TXT
- SOA
- NS
- MX
- SPF
- PTR
|
The type of resource record to add.
|
zone
|
|
The DNS domain name of the zone (e.g., example.com).
One of either zone or zone_id must be specified as an option, or the module will fail.
If both zone and zone_id are specified, zone_id will be used.
|
zone_id
|
|
The Google Cloud ID of the zone (e.g., example-com).
One of either zone or 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.
zone_id can be faster than zone in projects with a large number of zones.
If both zone and zone_id are specified, zone_id will be used.
|