Skip to main content

Gcp/dns

@swamp/gcp/dnsv2026.08.12.2· 10d agoMODELS
01README

Google Cloud dns infrastructure models

02Release Notes
  • Updated: changes, dnskeys, managedzones, policies, projects, resourcerecordsets, responsepolicies, responsepolicyrules
03Models8
@swamp/gcp/dns/changesv2026.08.12.2changes.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
additions?arrayWhich ResourceRecordSets to add?
deletions?arrayWhich ResourceRecordSets to remove? Must match existing data exactly.
isServing?booleanIf the DNS queries for the zone will be served.
managedZonestringIdentifies the managed zone addressed by this request. Can be the managed zone name or ID.
clientOperationId?stringFor mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
fn create()
Create a changes
fn get(identifier: string)
Get a changes
ArgumentTypeDescription
identifierstringThe name of the changes
fn sync(identifier?: string)
Sync changes state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific changes by name (e.g. one discovered by list)
fn list(maxResults?: number, sortBy?: string, sortOrder?: string, maxPages?: number)
List changes resources
ArgumentTypeDescription
maxResults?numberOptional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
sortBy?stringSorting criterion. The only supported value is change sequence.
sortOrder?stringSorting order direction: 'ascending' or 'descending'.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A Change represents a set of `ResourceRecordSet` additions and deletions appl...
@swamp/gcp/dns/dnskeysv2026.08.12.2dnskeys.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
managedZonestringIdentifies the managed zone addressed by this request. Can be the managed zone name or ID.
fn get(identifier: string)
Get a dnsKeys
ArgumentTypeDescription
identifierstringThe name of the dnsKeys
fn sync(identifier?: string)
Sync dnsKeys state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific dnsKeys by name (e.g. one discovered by list)
fn list(digestType?: string, maxResults?: number, maxPages?: number)
List dnsKeys resources
ArgumentTypeDescription
digestType?stringAn optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type is computed and displayed.
maxResults?numberOptional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A DNSSEC key pair.
@swamp/gcp/dns/managedzonesv2026.08.12.2managedzones.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
cloudLoggingConfig?objectCloud Logging configurations for publicly visible zones.
description?stringA mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
dnsName?stringThe DNS name of this managed zone, for instance "example.com.".
dnssecConfig?objectDNSSEC configuration.
forwardingConfig?objectThe presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
labels?recordUser labels.
name?stringUser assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
nameServerSet?stringOptionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team.
peeringConfig?objectThe presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
privateVisibilityConfig?objectFor privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
reverseLookupConfig?objectThe presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS resolves reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
serviceDirectoryConfig?objectThis field links to the associated service directory namespace. Do not set this field for public zones or forwarding zones.
visibility?enumThe zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
clientOperationId?stringFor mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
fn create()
Create a managedZones
fn get(identifier: string)
Get a managedZones
ArgumentTypeDescription
identifierstringThe name of the managedZones
fn update(identifier?: string)
Update managedZones attributes
ArgumentTypeDescription
identifier?stringTarget a specific managedZones by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the managedZones
ArgumentTypeDescription
identifierstringThe name of the managedZones
fn sync(identifier?: string)
Sync managedZones state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific managedZones by name (e.g. one discovered by list)
fn list(dnsName?: string, maxResults?: number, maxPages?: number)
List managedZones resources
ArgumentTypeDescription
dnsName?stringRestricts the list to return only zones with this domain name.
maxResults?numberOptional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_iam_policy(options?: any)
get iam policy
ArgumentTypeDescription
options?any
fn set_iam_policy(policy?: any, updateMask?: any)
set iam policy
ArgumentTypeDescription
policy?any
updateMask?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any

Resources

state(infinite)— A zone is a subtree of the DNS namespace under one administrative responsibil...
@swamp/gcp/dns/policiesv2026.08.12.2policies.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
alternativeNameServerConfig?objectSets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as.internal are not available when an alternative name server is specified.
description?stringA mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
dns64Config?objectConfigurations related to DNS64 for this policy.
enableInboundForwarding?booleanAllows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address is allocated from each of the subnetworks that are bound to this policy.
enableLogging?booleanControls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
name?stringUser-assigned name for this policy.
networks?arrayList of network names specifying networks to which this policy is applied.
clientOperationId?stringFor mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
fn create()
Create a policies
fn get(identifier: string)
Get a policies
ArgumentTypeDescription
identifierstringThe name of the policies
fn update(identifier?: string)
Update policies attributes
ArgumentTypeDescription
identifier?stringTarget a specific policies by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the policies
ArgumentTypeDescription
identifierstringThe name of the policies
fn sync(identifier?: string)
Sync policies state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific policies by name (e.g. one discovered by list)
fn list(maxResults?: number, maxPages?: number)
List policies resources
ArgumentTypeDescription
maxResults?numberOptional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A policy is a collection of DNS rules applied to one or more Virtual Private ...
@swamp/gcp/dns/projectsv2026.08.12.2projects.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
fn get(identifier: string)
Get a projects
ArgumentTypeDescription
identifierstringThe name of the projects
fn sync(identifier?: string)
Sync projects state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific projects by name (e.g. one discovered by list)

Resources

state(infinite)— A project resource. The project is a top level container for resources includ...
@swamp/gcp/dns/resourcerecordsetsv2026.08.12.2resourcerecordsets.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
name?stringFor example, www.example.com.
routingPolicy?objectConfigures dynamic query responses based on either the geo location of the querying user or a weighted round robin based routing policy. A valid `ResourceRecordSet` contains only `rrdata` (for static resolution) or a `routing_policy` (for dynamic resolution).
rrdatas?arrayAs defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.
signatureRrdatas?arrayAs defined in RFC 4034 (section 3.2).
ttl?numberNumber of seconds that this `ResourceRecordSet` can be cached by resolvers.
type?stringThe identifier of a supported record type. See the list of Supported DNS record types.
managedZonestringIdentifies the managed zone addressed by this request. Can be the managed zone name or ID.
clientOperationId?stringFor mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
fn create()
Create a resourceRecordSets
fn get(identifier: string)
Get a resourceRecordSets
ArgumentTypeDescription
identifierstringThe name of the resourceRecordSets
fn update(identifier?: string)
Update resourceRecordSets attributes
ArgumentTypeDescription
identifier?stringTarget a specific resourceRecordSets by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the resourceRecordSets
ArgumentTypeDescription
identifierstringThe name of the resourceRecordSets
fn sync(identifier?: string)
Sync resourceRecordSets state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific resourceRecordSets by name (e.g. one discovered by list)
fn list(filter?: string, maxResults?: number, name?: string, type?: string, maxPages?: number)
List resourceRecordSets resources
ArgumentTypeDescription
filter?stringSpecify a filter expression to view records that exactly match the specified domain. Both the `name` and `type` parameters are not supported and must be omitted when you use `filter`. Your `filter` expression must conform to AIP-160 and you must specify a domain in the `name` field. Optionally, you can include the `type` field to filter records by type. You can also include the `has_suffix` function to view records that match by domain suffix. Examples: * `name`="example.com." * `name`="example.
maxResults?numberOptional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
name?stringSpecify a fully qualified domain name to view only those records. The `name` parameter is not supported and must be omitted when you use `filter`.
type?stringSpecify a record type to view only those records. You must also specify the `name` parameter. The `type` parameter is not supported and must be omitted when you use `filter`.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A unit of data that is returned by the DNS servers.
@swamp/gcp/dns/responsepoliciesv2026.08.12.2responsepolicies.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
description?stringUser-provided description for this Response Policy.
gkeClusters?arrayThe list of Google Kubernetes Engine clusters to which this response policy is applied.
labels?recordUser labels.
networks?arrayList of network names specifying networks to which this policy is applied.
responsePolicyName?stringUser assigned name for this Response Policy.
clientOperationId?stringFor mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
fn create()
Create a responsePolicies
fn get(identifier: string)
Get a responsePolicies
ArgumentTypeDescription
identifierstringThe name of the responsePolicies
fn update(identifier?: string)
Update responsePolicies attributes
ArgumentTypeDescription
identifier?stringTarget a specific responsePolicies by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the responsePolicies
ArgumentTypeDescription
identifierstringThe name of the responsePolicies
fn sync(identifier?: string)
Sync responsePolicies state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific responsePolicies by name (e.g. one discovered by list)
fn list(maxResults?: number, maxPages?: number)
List responsePolicies resources
ArgumentTypeDescription
maxResults?numberOptional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A Response Policy is a collection of selectors that apply to queries made aga...
@swamp/gcp/dns/responsepolicyrulesv2026.08.12.2responsepolicyrules.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
behavior?enumAnswer this query with a behavior rather than DNS data.
dnsName?stringThe DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule.
localData?objectAnswer this query directly with DNS data. These ResourceRecordSets override any other DNS behavior for the matched name; in particular they override private zones, the public internet, and GCP internal DNS. No SOA nor NS types are allowed.
ruleName?stringAn identifier for this rule. Must be unique with the ResponsePolicy.
responsePolicystringUser assigned name of the Response Policy containing the Response Policy Rule.
clientOperationId?stringFor mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
fn create()
Create a responsePolicyRules
fn get(identifier: string)
Get a responsePolicyRules
ArgumentTypeDescription
identifierstringThe name of the responsePolicyRules
fn update(identifier?: string)
Update responsePolicyRules attributes
ArgumentTypeDescription
identifier?stringTarget a specific responsePolicyRules by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the responsePolicyRules
ArgumentTypeDescription
identifierstringThe name of the responsePolicyRules
fn sync(identifier?: string)
Sync responsePolicyRules state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific responsePolicyRules by name (e.g. one discovered by list)
fn list(maxResults?: number, maxPages?: number)
List responsePolicyRules resources
ArgumentTypeDescription
maxResults?numberOptional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A Response Policy Rule is a selector that applies its behavior to queries tha...
04Previous Versions19
2026.07.29.1
  • Updated: changes, dnskeys, managedzones, policies, projects, resourcerecordsets, responsepolicies, responsepolicyrules
2026.07.21.4
  • Updated: resourcerecordsets
2026.07.21.1
  • Updated: changes, managedzones, policies, resourcerecordsets, responsepolicies, responsepolicyrules
2026.07.20.2
  • Updated: resourcerecordsets
2026.07.20.1
  • Updated: changes, dnskeys, managedzones, policies, projects, resourcerecordsets, responsepolicies, responsepolicyrules
2026.07.19.2
  • Updated: dnskeys
2026.07.19.1
  • Updated: changes, dnskeys, managedzones, policies, projects, resourcerecordsets, responsepolicies, responsepolicyrules
2026.07.18.2
  • Updated: changes, dnskeys, managedzones, policies, projects, resourcerecordsets, responsepolicies, responsepolicyrules
2026.07.17.2
  • Updated: managedzones, policies, resourcerecordsets
2026.07.17.1
  • Updated: changes, managedzones, policies, resourcerecordsets, responsepolicies, responsepolicyrules
2026.06.08.2
  • Updated: changes, dnskeys, managedzones, policies, projects, resourcerecordsets, responsepolicies, responsepolicyrules
2026.06.07.1
  • Updated: changes, dnskeys, managedzones, policies, projects, resourcerecordsets, responsepolicies, responsepolicyrules
2026.05.26.1
  • Updated: resourcerecordsets
2026.05.25.2
  • Updated: managedzones, policies, responsepolicies

Modified 7 models

2026.05.24.1
  • Updated: changes, dnskeys, managedzones, policies, projects, resourcerecordsets, responsepolicies, responsepolicyrules
2026.05.21.2
  • Updated: changes, dnskeys, managedzones, policies, projects, resourcerecordsets, responsepolicies, responsepolicyrules
2026.05.21.1

Modified 1 models

2026.05.19.2
2026.05.19.1
05Stats
A
100 / 100
Downloads
10
Archive size
113.0 KB
Verified by Swamp
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository2/2earned
06Platforms
07Labels