Private DNS Name

string

Human-readable name of the Private DNS.

Example

Private DNS State

string

The current state of the Private DNS attachment. Possible values:

  • created - The attachment has been created but is not attached to Private DNS.
  • initializing - The attachment is in the process of being initialized and is setting up necessary resources.
  • pending-association The attachment request is awaiting association to the cloud provider infrastructure in order for provisioning to proceed.
  • ready - The attachment is fully operational and can route traffic as configured.
  • error - The attachment is in an error state, and is not operational.
  • terminating - The attachment is in the process of being deleted.
  • terminated - The attachment has been fully deleted and is no longer available.

Allowed values:createdinitializingpending-associationreadyerrorterminatingterminated

PatchAwsPrivateDnsResolver

Request schema for updating a Private DNS AWS Resolver.

namestring

Human-readable name of the Private DNS.

Example:us-east-2 private dns

private_dns_attachment_configobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

PatchAzurePrivateDnsResolver

Request schema for updating a Private DNS Azure Resolver.

namestring

Human-readable name of the Private DNS.

Example:us-east-2 private dns

private_dns_attachment_configobject

Example:{"kind":"azure-outbound-resolver","dns_config":{"global.api.konghq.com":{"remote_dns_server_ip_addresses":["10.0.0.2"]},"us.api.konghq.dev":{"remote_dns_server_ip_addresses":["10.0.0.8"]}}}

* Additional properties are NOT allowed.
Show Child Parameters
Example

CreatePrivateDnsRequest

object

Request schema for creating a Private DNS.

namestring

Human-readable name of the Private DNS.

Example:us-east-2 private dns

private_dns_attachment_configOne Of
AWS Private Hosted Zone Attachment Configobject
* Additional properties are NOT allowed.
Show Child Parameters
Example