dns

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-gcp repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-google repo.

class pulumi_gcp.dns.AwaitableGetManagedZoneResult(description=None, dns_name=None, name=None, name_servers=None, project=None, id=None)
class pulumi_gcp.dns.GetManagedZoneResult(description=None, dns_name=None, name=None, name_servers=None, project=None, id=None)

A collection of values returned by getManagedZone.

description = None

A textual description field.

dns_name = None

The fully qualified DNS name of this zone, e.g. example.com..

name_servers = None

The list of nameservers that will be authoritative for this domain. Use NS records to redirect from your DNS provider to these names, thus making Google Cloud DNS authoritative for this zone.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_gcp.dns.ManagedZone(resource_name, opts=None, description=None, dns_name=None, dnssec_config=None, forwarding_config=None, labels=None, name=None, peering_config=None, private_visibility_config=None, project=None, visibility=None, __props__=None, __name__=None, __opts__=None)

A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.

To get more information about ManagedZone, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The dnssec_config object supports the following:

  • defaultKeySpecs (pulumi.Input[list])

    • algorithm (pulumi.Input[str])

    • keyLength (pulumi.Input[float])

    • keyType (pulumi.Input[str])

    • kind (pulumi.Input[str])

  • kind (pulumi.Input[str])

  • nonExistence (pulumi.Input[str])

  • state (pulumi.Input[str])

The forwarding_config object supports the following:

  • targetNameServers (pulumi.Input[list])

    • ipv4Address (pulumi.Input[str])

The peering_config object supports the following:

  • targetNetwork (pulumi.Input[dict])

    • networkUrl (pulumi.Input[str])

The private_visibility_config object supports the following:

  • networks (pulumi.Input[list])

    • networkUrl (pulumi.Input[str])

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

static get(resource_name, id, opts=None, description=None, dns_name=None, dnssec_config=None, forwarding_config=None, labels=None, name=None, name_servers=None, peering_config=None, private_visibility_config=None, project=None, visibility=None)

Get an existing ManagedZone resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The dnssec_config object supports the following:

  • defaultKeySpecs (pulumi.Input[list])

    • algorithm (pulumi.Input[str])

    • keyLength (pulumi.Input[float])

    • keyType (pulumi.Input[str])

    • kind (pulumi.Input[str])

  • kind (pulumi.Input[str])

  • nonExistence (pulumi.Input[str])

  • state (pulumi.Input[str])

The forwarding_config object supports the following:

  • targetNameServers (pulumi.Input[list])

    • ipv4Address (pulumi.Input[str])

The peering_config object supports the following:

  • targetNetwork (pulumi.Input[dict])

    • networkUrl (pulumi.Input[str])

The private_visibility_config object supports the following:

  • networks (pulumi.Input[list])

    • networkUrl (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.dns.Policy(resource_name, opts=None, alternative_name_server_config=None, description=None, enable_inbound_forwarding=None, enable_logging=None, name=None, networks=None, project=None, __props__=None, __name__=None, __opts__=None)

A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.

To get more information about Policy, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The alternative_name_server_config object supports the following:

  • targetNameServers (pulumi.Input[list])

    • ipv4Address (pulumi.Input[str])

The networks object supports the following:

  • networkUrl (pulumi.Input[str])

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

static get(resource_name, id, opts=None, alternative_name_server_config=None, description=None, enable_inbound_forwarding=None, enable_logging=None, name=None, networks=None, project=None)

Get an existing Policy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The alternative_name_server_config object supports the following:

  • targetNameServers (pulumi.Input[list])

    • ipv4Address (pulumi.Input[str])

The networks object supports the following:

  • networkUrl (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.dns.RecordSet(resource_name, opts=None, managed_zone=None, name=None, project=None, rrdatas=None, ttl=None, type=None, __props__=None, __name__=None, __opts__=None)

Manages a set of DNS records within Google Cloud DNS. For more information see the official documentation and API.

Note: The provider treats this resource as an authoritative record set. This means existing records (including the default records) for the given type will be overwritten when you create this resource with this provider. In addition, the Google Cloud DNS API requires NS records to be present at all times, so this provider will not actually remove NS records during destroy but will report that it did.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • managed_zone (pulumi.Input[str]) – The name of the zone in which this record set will reside.

  • name (pulumi.Input[str]) – The DNS name this record set will apply to.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • rrdatas (pulumi.Input[list]) – The string data for the records in this record set whose meaning depends on the DNS type. For TXT record, if the string data contains spaces, add surrounding " if you don’t want your string to get split on spaces. To specify a single record value longer than 255 characters such as a TXT record for DKIM, add "" inside this provider’s configuration string (e.g. "first255characters""morecharacters").

  • ttl (pulumi.Input[float]) – The time-to-live of this record set (seconds).

  • type (pulumi.Input[str]) – The DNS record set type.

managed_zone = None

The name of the zone in which this record set will reside.

name = None

The DNS name this record set will apply to.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

rrdatas = None

The string data for the records in this record set whose meaning depends on the DNS type. For TXT record, if the string data contains spaces, add surrounding " if you don’t want your string to get split on spaces. To specify a single record value longer than 255 characters such as a TXT record for DKIM, add "" inside this provider’s configuration string (e.g. "first255characters""morecharacters").

ttl = None

The time-to-live of this record set (seconds).

type = None

The DNS record set type.

static get(resource_name, id, opts=None, managed_zone=None, name=None, project=None, rrdatas=None, ttl=None, type=None)

Get an existing RecordSet resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • managed_zone (pulumi.Input[str]) – The name of the zone in which this record set will reside.

  • name (pulumi.Input[str]) – The DNS name this record set will apply to.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • rrdatas (pulumi.Input[list]) – The string data for the records in this record set whose meaning depends on the DNS type. For TXT record, if the string data contains spaces, add surrounding " if you don’t want your string to get split on spaces. To specify a single record value longer than 255 characters such as a TXT record for DKIM, add "" inside this provider’s configuration string (e.g. "first255characters""morecharacters").

  • ttl (pulumi.Input[float]) – The time-to-live of this record set (seconds).

  • type (pulumi.Input[str]) – The DNS record set type.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_gcp.dns.get_managed_zone(name=None, project=None, opts=None)

Provides access to a zone’s attributes within Google Cloud DNS. For more information see the official documentation and API.

Parameters
  • name (str) – A unique name for the resource.

  • project (str) – The ID of the project for the Google Cloud DNS zone.