Policy class

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

To get more information about Policy, see:

Example Usage

Dns Policy Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const network_1 = new gcp.compute.Network("network-1", {
    name: "network-1",
    autoCreateSubnetworks: false,
});
const network_2 = new gcp.compute.Network("network-2", {
    name: "network-2",
    autoCreateSubnetworks: false,
});
const example_policy = new gcp.dns.Policy("example-policy", {
    name: "example-policy",
    enableInboundForwarding: true,
    enableLogging: true,
    alternativeNameServerConfig: {
        targetNameServers: [
            {
                ipv4Address: "172.16.1.10",
                forwardingPath: "private",
            },
            {
                ipv4Address: "172.16.1.20",
            },
        ],
    },
    networks: [
        {
            networkUrl: network_1.id,
        },
        {
            networkUrl: network_2.id,
        },
    ],
});

import pulumi
import pulumi_gcp as gcp

network_1 = gcp.compute.Network("network-1",
    name="network-1",
    auto_create_subnetworks=False)
network_2 = gcp.compute.Network("network-2",
    name="network-2",
    auto_create_subnetworks=False)
example_policy = gcp.dns.Policy("example-policy",
    name="example-policy",
    enable_inbound_forwarding=True,
    enable_logging=True,
    alternative_name_server_config={
        "target_name_servers": [
            {
                "ipv4_address": "172.16.1.10",
                "forwarding_path": "private",
            },
            {
                "ipv4_address": "172.16.1.20",
            },
        ],
    },
    networks=[
        {
            "network_url": network_1.id,
        },
        {
            "network_url": network_2.id,
        },
    ])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var network_1 = new Gcp.Compute.Network("network-1", new()
    {
        Name = "network-1",
        AutoCreateSubnetworks = false,
    });

    var network_2 = new Gcp.Compute.Network("network-2", new()
    {
        Name = "network-2",
        AutoCreateSubnetworks = false,
    });

    var example_policy = new Gcp.Dns.Policy("example-policy", new()
    {
        Name = "example-policy",
        EnableInboundForwarding = true,
        EnableLogging = true,
        AlternativeNameServerConfig = new Gcp.Dns.Inputs.PolicyAlternativeNameServerConfigArgs
        {
            TargetNameServers = new[]
            {
                new Gcp.Dns.Inputs.PolicyAlternativeNameServerConfigTargetNameServerArgs
                {
                    Ipv4Address = "172.16.1.10",
                    ForwardingPath = "private",
                },
                new Gcp.Dns.Inputs.PolicyAlternativeNameServerConfigTargetNameServerArgs
                {
                    Ipv4Address = "172.16.1.20",
                },
            },
        },
        Networks = new[]
        {
            new Gcp.Dns.Inputs.PolicyNetworkArgs
            {
                NetworkUrl = network_1.Id,
            },
            new Gcp.Dns.Inputs.PolicyNetworkArgs
            {
                NetworkUrl = network_2.Id,
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/dns"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		network_1, err := compute.NewNetwork(ctx, "network-1", &compute.NetworkArgs{
			Name:                  pulumi.String("network-1"),
			AutoCreateSubnetworks: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		network_2, err := compute.NewNetwork(ctx, "network-2", &compute.NetworkArgs{
			Name:                  pulumi.String("network-2"),
			AutoCreateSubnetworks: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		_, err = dns.NewPolicy(ctx, "example-policy", &dns.PolicyArgs{
			Name:                    pulumi.String("example-policy"),
			EnableInboundForwarding: pulumi.Bool(true),
			EnableLogging:           pulumi.Bool(true),
			AlternativeNameServerConfig: &dns.PolicyAlternativeNameServerConfigArgs{
				TargetNameServers: dns.PolicyAlternativeNameServerConfigTargetNameServerArray{
					&dns.PolicyAlternativeNameServerConfigTargetNameServerArgs{
						Ipv4Address:    pulumi.String("172.16.1.10"),
						ForwardingPath: pulumi.String("private"),
					},
					&dns.PolicyAlternativeNameServerConfigTargetNameServerArgs{
						Ipv4Address: pulumi.String("172.16.1.20"),
					},
				},
			},
			Networks: dns.PolicyNetworkArray{
				&dns.PolicyNetworkArgs{
					NetworkUrl: network_1.ID().ToIDOutput().ToStringOutput(),
				},
				&dns.PolicyNetworkArgs{
					NetworkUrl: network_2.ID().ToIDOutput().ToStringOutput(),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_dns_policy" "example-policy" {
  name                      = "example-policy"
  enable_inbound_forwarding = true
  enable_logging            = true
  alternative_name_server_config = {
    target_name_servers = [{
      "ipv4Address"    = "172.16.1.10"
      "forwardingPath" = "private"
      }, {
      "ipv4Address" = "172.16.1.20"
    }]
  }
  networks {
    network_url = gcp_compute_network.network-1.id
  }
  networks {
    network_url = gcp_compute_network.network-2.id
  }
}
resource "gcp_compute_network" "network-1" {
  name                    = "network-1"
  auto_create_subnetworks = false
}
resource "gcp_compute_network" "network-2" {
  name                    = "network-2"
  auto_create_subnetworks = false
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.dns.Policy;
import com.pulumi.gcp.dns.PolicyArgs;
import com.pulumi.gcp.dns.inputs.PolicyAlternativeNameServerConfigArgs;
import com.pulumi.gcp.dns.inputs.PolicyAlternativeNameServerConfigTargetNameServerArgs;
import com.pulumi.gcp.dns.inputs.PolicyNetworkArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var network_1 = new Network("network-1", NetworkArgs.builder()
            .name("network-1")
            .autoCreateSubnetworks(false)
            .build());

        var network_2 = new Network("network-2", NetworkArgs.builder()
            .name("network-2")
            .autoCreateSubnetworks(false)
            .build());

        var example_policy = new Policy("example-policy", PolicyArgs.builder()
            .name("example-policy")
            .enableInboundForwarding(true)
            .enableLogging(true)
            .alternativeNameServerConfig(PolicyAlternativeNameServerConfigArgs.builder()
                .targetNameServers(
                    PolicyAlternativeNameServerConfigTargetNameServerArgs.builder()
                        .ipv4Address("172.16.1.10")
                        .forwardingPath("private")
                        .build(),
                    PolicyAlternativeNameServerConfigTargetNameServerArgs.builder()
                        .ipv4Address("172.16.1.20")
                        .build())
                .build())
            .networks(
                PolicyNetworkArgs.builder()
                    .networkUrl(network_1.id())
                    .build(),
                PolicyNetworkArgs.builder()
                    .networkUrl(network_2.id())
                    .build())
            .build());

    }
}

resources:
  example-policy:
    type: gcp:dns:Policy
    properties:
      name: example-policy
      enableInboundForwarding: true
      enableLogging: true
      alternativeNameServerConfig:
        targetNameServers:
          - ipv4Address: 172.16.1.10
            forwardingPath: private
          - ipv4Address: 172.16.1.20
      networks:
        - networkUrl: ${["network-1"].id}
        - networkUrl: ${["network-2"].id}
  network-1:
    type: gcp:compute:Network
    properties:
      name: network-1
      autoCreateSubnetworks: false
  network-2:
    type: gcp:compute:Network
    properties:
      name: network-2
      autoCreateSubnetworks: false

Import

Policy can be imported using any of these accepted formats:

projects/{{project}}/policies/{{name}}
{{project}}/{{name}}
{{name}}

When using the pulumi import command, Policy can be imported using one of the formats above. For example:

$ pulumi import gcp:dns/policy:Policy default projects/{{project}}/policies/{{name}}
$ pulumi import gcp:dns/policy:Policy default {{project}}/{{name}}
$ pulumi import gcp:dns/policy:Policy default {{name}}

Constructors

Policy(String name, {PolicyArgs? args, CustomResourceOptions? options}): Creates a new Policy. name The Pulumi resource name. args Arguments used to configure this Policy. The set of arguments for Policy. options Resource options controlling this resource's behavior.
Policy.reference(String urn): Creates a typed reference to an existing Policy resource.

Properties

alternativeNameServerConfig ↔ Output<PolicyAlternativeNameServerConfig?>: Sets 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. Structure is documented below.
latefinal
childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
deletionPolicy ↔ Output<String>: Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
description ↔ Output<String?>: A textual description field. Defaults to 'Managed by Pulumi'.
latefinal
dns64Config ↔ Output<PolicyDns64Config>: Configurations related to DNS64 for this Policy. Structure is documented below.
latefinal
enableInboundForwarding ↔ Output<bool?>: Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address will be allocated from each of the sub-networks that are bound to this policy.
latefinal
enableLogging ↔ Output<bool?>: Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>: User assigned name for this policy.
latefinal
networks ↔ Output<List<PolicyNetwork>?>: List of network names specifying networks to which this policy is applied. Structure is documented below.
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {PolicyState? state, CustomResourceOptions? options}) → Policy: Gets an existing Policy resource's state with the given name and id.