AwsPrivateDnsResolverResponse

object
idstring(uuid)requiredread-only

Example:1850820b-c69f-4a2a-b9be-bbcdbc5cd618

statestringrequired

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

state_metadataobjectrequired

Metadata describing the backing state of the Private Dns and why it may be in an erroneous state.

* Additional properties are NOT allowed.
Show Child Parameters
entity_versionintegerrequiredread-only

Monotonically-increasing version count of the Private DNS, to indicate the order of updates to the
Private DNS.

Example:1

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of Private DNS creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of Private DNS update date.

Example:2022-11-04T20:10:06.927Z

namestringrequired

Human-readable name of the Private DNS.

Example:us-east-2 private dns

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

AzurePrivateDnsResolverResponse

object
idstring(uuid)requiredread-only

Example:1850820b-c69f-4a2a-b9be-bbcdbc5cd618

statestringrequired

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

state_metadataobjectrequired

Metadata describing the backing state of the Private Dns and why it may be in an erroneous state.

* Additional properties are NOT allowed.
Show Child Parameters
entity_versionintegerrequiredread-only

Monotonically-increasing version count of the Private DNS, to indicate the order of updates to the
Private DNS.

Example:1

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of Private DNS creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of Private DNS update date.

Example:2022-11-04T20:10:06.927Z

namestringrequired

Human-readable name of the Private DNS.

Example:us-east-2 private dns

private_dns_attachment_configobjectrequired

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

AWS Private DNS Resolver Attachment Config

object
* Additional properties are NOT allowed.
kindrequired

Allowed values:aws-outbound-resolver

dns_configobjectrequired

Object that contains mappings from proxied internal domains to remote DNS server IP address for a Private DNS Resolver.

Example:{"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"]}}

Example

Azure Private DNS Resolver Attachment Config

object
* Additional properties are NOT allowed.
kindrequired

Allowed values:azure-outbound-resolver

dns_configobjectrequired

Object that contains mappings from proxied internal domains to remote DNS server IP address for a Private DNS Resolver.

Example:{"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"]}}

Example

Private DNS Resolver Config Item

object

Object that contains mappings from proxied internal domains to remote DNS server IP address for a Private DNS Resolver.

Example