published on Wednesday, Nov 18, 2026 by Pulumi
published on Wednesday, Nov 18, 2026 by Pulumi
An OutboundEndpoint is a regional resource to enable outbound forwarding from a private IP range in VPCs to on-premise or other networks.
To get more information about OutboundEndpoint, see:
- API documentation
- How-to Guides
Example Usage
Dns Outbound Endpoint Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const network = new gcp.compute.Network("network", {
name: "test-network",
autoCreateSubnetworks: false,
});
const subnetwork = new gcp.compute.Subnetwork("subnetwork", {
name: "test-subnetwork",
network: network.id,
ipCidrRange: "10.0.0.0/24",
region: "us-central1",
});
const proxySubnetwork = new gcp.compute.Subnetwork("proxy_subnetwork", {
name: "test-proxy-subnetwork",
network: network.id,
ipCidrRange: "10.0.1.0/24",
region: "us-central1",
purpose: "REGIONAL_MANAGED_PROXY",
role: "ACTIVE",
});
const example_endpoint = new gcp.dns.OutboundEndpoint("example-endpoint", {
name: "example-endpoint",
location: "us-central1",
network: network.id,
subnetwork: subnetwork.id,
endpointIp: "10.0.0.10",
}, {
dependsOn: [proxySubnetwork],
});
import pulumi
import pulumi_gcp as gcp
network = gcp.compute.Network("network",
name="test-network",
auto_create_subnetworks=False)
subnetwork = gcp.compute.Subnetwork("subnetwork",
name="test-subnetwork",
network=network.id,
ip_cidr_range="10.0.0.0/24",
region="us-central1")
proxy_subnetwork = gcp.compute.Subnetwork("proxy_subnetwork",
name="test-proxy-subnetwork",
network=network.id,
ip_cidr_range="10.0.1.0/24",
region="us-central1",
purpose="REGIONAL_MANAGED_PROXY",
role="ACTIVE")
example_endpoint = gcp.dns.OutboundEndpoint("example-endpoint",
name="example-endpoint",
location="us-central1",
network=network.id,
subnetwork=subnetwork.id,
endpoint_ip="10.0.0.10",
opts = pulumi.ResourceOptions(depends_on=[proxy_subnetwork]))
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/compute"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/dns"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
network, err := compute.NewNetwork(ctx, "network", &compute.NetworkArgs{
Name: pulumi.String("test-network"),
AutoCreateSubnetworks: pulumi.Bool(false),
})
if err != nil {
return err
}
subnetwork, err := compute.NewSubnetwork(ctx, "subnetwork", &compute.SubnetworkArgs{
Name: pulumi.String("test-subnetwork"),
Network: network.ID(),
IpCidrRange: pulumi.String("10.0.0.0/24"),
Region: pulumi.String("us-central1"),
})
if err != nil {
return err
}
proxySubnetwork, err := compute.NewSubnetwork(ctx, "proxy_subnetwork", &compute.SubnetworkArgs{
Name: pulumi.String("test-proxy-subnetwork"),
Network: network.ID(),
IpCidrRange: pulumi.String("10.0.1.0/24"),
Region: pulumi.String("us-central1"),
Purpose: pulumi.String("REGIONAL_MANAGED_PROXY"),
Role: pulumi.String("ACTIVE"),
})
if err != nil {
return err
}
_, err = dns.NewOutboundEndpoint(ctx, "example-endpoint", &dns.OutboundEndpointArgs{
Name: pulumi.String("example-endpoint"),
Location: pulumi.String("us-central1"),
Network: network.ID(),
Subnetwork: subnetwork.ID(),
EndpointIp: pulumi.String("10.0.0.10"),
}, pulumi.DependsOn([]pulumi.Resource{
proxySubnetwork,
}))
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var network = new Gcp.Compute.Network("network", new()
{
Name = "test-network",
AutoCreateSubnetworks = false,
});
var subnetwork = new Gcp.Compute.Subnetwork("subnetwork", new()
{
Name = "test-subnetwork",
Network = network.Id,
IpCidrRange = "10.0.0.0/24",
Region = "us-central1",
});
var proxySubnetwork = new Gcp.Compute.Subnetwork("proxy_subnetwork", new()
{
Name = "test-proxy-subnetwork",
Network = network.Id,
IpCidrRange = "10.0.1.0/24",
Region = "us-central1",
Purpose = "REGIONAL_MANAGED_PROXY",
Role = "ACTIVE",
});
var example_endpoint = new Gcp.Dns.OutboundEndpoint("example-endpoint", new()
{
Name = "example-endpoint",
Location = "us-central1",
Network = network.Id,
Subnetwork = subnetwork.Id,
EndpointIp = "10.0.0.10",
}, new CustomResourceOptions
{
DependsOn =
{
proxySubnetwork,
},
});
});
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.compute.Subnetwork;
import com.pulumi.gcp.compute.SubnetworkArgs;
import com.pulumi.gcp.dns.OutboundEndpoint;
import com.pulumi.gcp.dns.OutboundEndpointArgs;
import com.pulumi.resources.CustomResourceOptions;
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 = new Network("network", NetworkArgs.builder()
.name("test-network")
.autoCreateSubnetworks(false)
.build());
var subnetwork = new Subnetwork("subnetwork", SubnetworkArgs.builder()
.name("test-subnetwork")
.network(network.id())
.ipCidrRange("10.0.0.0/24")
.region("us-central1")
.build());
var proxySubnetwork = new Subnetwork("proxySubnetwork", SubnetworkArgs.builder()
.name("test-proxy-subnetwork")
.network(network.id())
.ipCidrRange("10.0.1.0/24")
.region("us-central1")
.purpose("REGIONAL_MANAGED_PROXY")
.role("ACTIVE")
.build());
var example_endpoint = new OutboundEndpoint("example-endpoint", OutboundEndpointArgs.builder()
.name("example-endpoint")
.location("us-central1")
.network(network.id())
.subnetwork(subnetwork.id())
.endpointIp("10.0.0.10")
.build(), CustomResourceOptions.builder()
.dependsOn(proxySubnetwork)
.build());
}
}
resources:
network:
type: gcp:compute:Network
properties:
name: test-network
autoCreateSubnetworks: false
subnetwork:
type: gcp:compute:Subnetwork
properties:
name: test-subnetwork
network: ${network.id}
ipCidrRange: 10.0.0.0/24
region: us-central1
proxySubnetwork:
type: gcp:compute:Subnetwork
name: proxy_subnetwork
properties:
name: test-proxy-subnetwork
network: ${network.id}
ipCidrRange: 10.0.1.0/24
region: us-central1
purpose: REGIONAL_MANAGED_PROXY
role: ACTIVE
example-endpoint:
type: gcp:dns:OutboundEndpoint
properties:
name: example-endpoint
location: us-central1
network: ${network.id}
subnetwork: ${subnetwork.id}
endpointIp: 10.0.0.10
options:
dependsOn:
- ${proxySubnetwork}
terraform {
required_providers {
gcp = {
source = "pulumi/gcp"
}
}
}
resource "gcp_compute_network" "network" {
lifecycle {
create_before_destroy = true
}
name = "test-network"
auto_create_subnetworks = false
}
resource "gcp_compute_subnetwork" "subnetwork" {
lifecycle {
create_before_destroy = true
}
name = "test-subnetwork"
network = gcp_compute_network.network.id
ip_cidr_range = "10.0.0.0/24"
region = "us-central1"
}
resource "gcp_compute_subnetwork" "proxy_subnetwork" {
lifecycle {
create_before_destroy = true
}
name = "test-proxy-subnetwork"
network = gcp_compute_network.network.id
ip_cidr_range = "10.0.1.0/24"
region = "us-central1"
purpose = "REGIONAL_MANAGED_PROXY"
role = "ACTIVE"
}
resource "gcp_dns_outbound_endpoint" "example-endpoint" {
depends_on = [gcp_compute_subnetwork.proxy_subnetwork]
lifecycle {
create_before_destroy = true
}
name = "example-endpoint"
location = "us-central1"
network = gcp_compute_network.network.id
subnetwork = gcp_compute_subnetwork.subnetwork.id
endpoint_ip = "10.0.0.10"
}
Create OutboundEndpoint Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OutboundEndpoint(name: string, args: OutboundEndpointArgs, opts?: CustomResourceOptions);@overload
def OutboundEndpoint(resource_name: str,
args: OutboundEndpointArgs,
opts: Optional[ResourceOptions] = None)
@overload
def OutboundEndpoint(resource_name: str,
opts: Optional[ResourceOptions] = None,
location: Optional[str] = None,
network: Optional[str] = None,
subnetwork: Optional[str] = None,
annotations: Optional[Mapping[str, str]] = None,
deletion_policy: Optional[str] = None,
description: Optional[str] = None,
endpoint_ip: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
project: Optional[str] = None)func NewOutboundEndpoint(ctx *Context, name string, args OutboundEndpointArgs, opts ...ResourceOption) (*OutboundEndpoint, error)public OutboundEndpoint(string name, OutboundEndpointArgs args, CustomResourceOptions? opts = null)
public OutboundEndpoint(String name, OutboundEndpointArgs args)
public OutboundEndpoint(String name, OutboundEndpointArgs args, CustomResourceOptions options)
type: gcp:dns:OutboundEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "gcp_dns_outbound_endpoint" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args OutboundEndpointArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args OutboundEndpointArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args OutboundEndpointArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OutboundEndpointArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OutboundEndpointArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var outboundEndpointResource = new Gcp.Dns.OutboundEndpoint("outboundEndpointResource", new()
{
Location = "string",
Network = "string",
Subnetwork = "string",
Annotations =
{
{ "string", "string" },
},
DeletionPolicy = "string",
Description = "string",
EndpointIp = "string",
Labels =
{
{ "string", "string" },
},
Name = "string",
Project = "string",
});
example, err := dns.NewOutboundEndpoint(ctx, "outboundEndpointResource", &dns.OutboundEndpointArgs{
Location: pulumi.String("string"),
Network: pulumi.String("string"),
Subnetwork: pulumi.String("string"),
Annotations: pulumi.StringMap{
"string": pulumi.String("string"),
},
DeletionPolicy: pulumi.String("string"),
Description: pulumi.String("string"),
EndpointIp: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
Project: pulumi.String("string"),
})
resource "gcp_dns_outbound_endpoint" "outboundEndpointResource" {
lifecycle {
create_before_destroy = true
}
location = "string"
network = "string"
subnetwork = "string"
annotations = {
"string" = "string"
}
deletion_policy = "string"
description = "string"
endpoint_ip = "string"
labels = {
"string" = "string"
}
name = "string"
project = "string"
}
var outboundEndpointResource = new OutboundEndpoint("outboundEndpointResource", OutboundEndpointArgs.builder()
.location("string")
.network("string")
.subnetwork("string")
.annotations(Map.of("string", "string"))
.deletionPolicy("string")
.description("string")
.endpointIp("string")
.labels(Map.of("string", "string"))
.name("string")
.project("string")
.build());
outbound_endpoint_resource = gcp.dns.OutboundEndpoint("outboundEndpointResource",
location="string",
network="string",
subnetwork="string",
annotations={
"string": "string",
},
deletion_policy="string",
description="string",
endpoint_ip="string",
labels={
"string": "string",
},
name="string",
project="string")
const outboundEndpointResource = new gcp.dns.OutboundEndpoint("outboundEndpointResource", {
location: "string",
network: "string",
subnetwork: "string",
annotations: {
string: "string",
},
deletionPolicy: "string",
description: "string",
endpointIp: "string",
labels: {
string: "string",
},
name: "string",
project: "string",
});
type: gcp:dns:OutboundEndpoint
properties:
annotations:
string: string
deletionPolicy: string
description: string
endpointIp: string
labels:
string: string
location: string
name: string
network: string
project: string
subnetwork: string
OutboundEndpoint Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The OutboundEndpoint resource accepts the following input properties:
- Location string
- The location of the OutboundEndpoint.
- Network string
- The VPC network containing the outbound endpoint, specified as full path.
- Subnetwork string
- The subnetwork holding the endpoint_ip, specified as full path.
- Annotations Dictionary<string, string>
Annotations as key value pairs
Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field
effectiveAnnotationsfor all of the annotations present on the resource.- Deletion
Policy 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.
- Description string
- User provided description.
- Endpoint
Ip string - User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated.
- Labels Dictionary<string, string>
Labels as key value pairs
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- Name string
- The name of the OutboundEndpoint.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Location string
- The location of the OutboundEndpoint.
- Network string
- The VPC network containing the outbound endpoint, specified as full path.
- Subnetwork string
- The subnetwork holding the endpoint_ip, specified as full path.
- Annotations map[string]string
Annotations as key value pairs
Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field
effectiveAnnotationsfor all of the annotations present on the resource.- Deletion
Policy 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.
- Description string
- User provided description.
- Endpoint
Ip string - User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated.
- Labels map[string]string
Labels as key value pairs
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- Name string
- The name of the OutboundEndpoint.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- location string
- The location of the OutboundEndpoint.
- network string
- The VPC network containing the outbound endpoint, specified as full path.
- subnetwork string
- The subnetwork holding the endpoint_ip, specified as full path.
- annotations map(string)
Annotations as key value pairs
Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field
effectiveAnnotationsfor all of the annotations present on the resource.- deletion_
policy 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.
- description string
- User provided description.
- endpoint_
ip string - User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated.
- labels map(string)
Labels as key value pairs
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- name string
- The name of the OutboundEndpoint.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- location String
- The location of the OutboundEndpoint.
- network String
- The VPC network containing the outbound endpoint, specified as full path.
- subnetwork String
- The subnetwork holding the endpoint_ip, specified as full path.
- annotations Map<String,String>
Annotations as key value pairs
Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field
effectiveAnnotationsfor all of the annotations present on the resource.- deletion
Policy 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.
- description String
- User provided description.
- endpoint
Ip String - User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated.
- labels Map<String,String>
Labels as key value pairs
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- name String
- The name of the OutboundEndpoint.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- location string
- The location of the OutboundEndpoint.
- network string
- The VPC network containing the outbound endpoint, specified as full path.
- subnetwork string
- The subnetwork holding the endpoint_ip, specified as full path.
- annotations {[key: string]: string}
Annotations as key value pairs
Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field
effectiveAnnotationsfor all of the annotations present on the resource.- deletion
Policy 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.
- description string
- User provided description.
- endpoint
Ip string - User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated.
- labels {[key: string]: string}
Labels as key value pairs
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- name string
- The name of the OutboundEndpoint.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- location str
- The location of the OutboundEndpoint.
- network str
- The VPC network containing the outbound endpoint, specified as full path.
- subnetwork str
- The subnetwork holding the endpoint_ip, specified as full path.
- annotations Mapping[str, str]
Annotations as key value pairs
Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field
effectiveAnnotationsfor all of the annotations present on the resource.- deletion_
policy str - 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.
- description str
- User provided description.
- endpoint_
ip str - User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated.
- labels Mapping[str, str]
Labels as key value pairs
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- name str
- The name of the OutboundEndpoint.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- location String
- The location of the OutboundEndpoint.
- network String
- The VPC network containing the outbound endpoint, specified as full path.
- subnetwork String
- The subnetwork holding the endpoint_ip, specified as full path.
- annotations Map<String>
Annotations as key value pairs
Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field
effectiveAnnotationsfor all of the annotations present on the resource.- deletion
Policy 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.
- description String
- User provided description.
- endpoint
Ip String - User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated.
- labels Map<String>
Labels as key value pairs
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- name String
- The name of the OutboundEndpoint.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Outputs
All input properties are implicitly available as output properties. Additionally, the OutboundEndpoint resource produces the following output properties:
- Create
Time string - The timestamp when the resource was created.
- Effective
Annotations Dictionary<string, string> - All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
- Effective
Labels Dictionary<string, string> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Id string
- The provider-assigned unique ID for this managed resource.
- Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- Update
Time string - The timestamp when the resource was updated.
- Create
Time string - The timestamp when the resource was created.
- Effective
Annotations map[string]string - All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
- Effective
Labels map[string]string - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Id string
- The provider-assigned unique ID for this managed resource.
- Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- Update
Time string - The timestamp when the resource was updated.
- create_
time string - The timestamp when the resource was created.
- effective_
annotations map(string) - All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
- effective_
labels map(string) - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id string
- The provider-assigned unique ID for this managed resource.
- pulumi_
labels map(string) - The combination of labels configured directly on the resource and default labels configured on the provider.
- update_
time string - The timestamp when the resource was updated.
- create
Time String - The timestamp when the resource was created.
- effective
Annotations Map<String,String> - All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
- effective
Labels Map<String,String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id String
- The provider-assigned unique ID for this managed resource.
- pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- update
Time String - The timestamp when the resource was updated.
- create
Time string - The timestamp when the resource was created.
- effective
Annotations {[key: string]: string} - All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
- effective
Labels {[key: string]: string} - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id string
- The provider-assigned unique ID for this managed resource.
- pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- update
Time string - The timestamp when the resource was updated.
- create_
time str - The timestamp when the resource was created.
- effective_
annotations Mapping[str, str] - All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
- effective_
labels Mapping[str, str] - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id str
- The provider-assigned unique ID for this managed resource.
- pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- update_
time str - The timestamp when the resource was updated.
- create
Time String - The timestamp when the resource was created.
- effective
Annotations Map<String> - All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
- effective
Labels Map<String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id String
- The provider-assigned unique ID for this managed resource.
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- update
Time String - The timestamp when the resource was updated.
Look up Existing OutboundEndpoint Resource
Get an existing OutboundEndpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: OutboundEndpointState, opts?: CustomResourceOptions): OutboundEndpoint@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
annotations: Optional[Mapping[str, str]] = None,
create_time: Optional[str] = None,
deletion_policy: Optional[str] = None,
description: Optional[str] = None,
effective_annotations: Optional[Mapping[str, str]] = None,
effective_labels: Optional[Mapping[str, str]] = None,
endpoint_ip: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
location: Optional[str] = None,
name: Optional[str] = None,
network: Optional[str] = None,
project: Optional[str] = None,
pulumi_labels: Optional[Mapping[str, str]] = None,
subnetwork: Optional[str] = None,
update_time: Optional[str] = None) -> OutboundEndpointfunc GetOutboundEndpoint(ctx *Context, name string, id IDInput, state *OutboundEndpointState, opts ...ResourceOption) (*OutboundEndpoint, error)public static OutboundEndpoint Get(string name, Input<string> id, OutboundEndpointState? state, CustomResourceOptions? opts = null)public static OutboundEndpoint get(String name, Output<String> id, OutboundEndpointState state, CustomResourceOptions options)resources: existingOutboundEndpoint: type: gcp:dns:OutboundEndpoint get: id: ${id}import {
to = gcp_dns_outbound_endpoint.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state OutboundEndpointState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state OutboundEndpointState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state OutboundEndpointState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state OutboundEndpointState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Annotations Dictionary<string, string>
Annotations as key value pairs
Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field
effectiveAnnotationsfor all of the annotations present on the resource.- Create
Time string - The timestamp when the resource was created.
- Deletion
Policy 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.
- Description string
- User provided description.
- Effective
Annotations Dictionary<string, string> - All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
- Effective
Labels Dictionary<string, string> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Endpoint
Ip string - User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated.
- Labels Dictionary<string, string>
Labels as key value pairs
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- Location string
- The location of the OutboundEndpoint.
- Name string
- The name of the OutboundEndpoint.
- Network string
- The VPC network containing the outbound endpoint, specified as full path.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- Subnetwork string
- The subnetwork holding the endpoint_ip, specified as full path.
- Update
Time string - The timestamp when the resource was updated.
- Annotations map[string]string
Annotations as key value pairs
Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field
effectiveAnnotationsfor all of the annotations present on the resource.- Create
Time string - The timestamp when the resource was created.
- Deletion
Policy 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.
- Description string
- User provided description.
- Effective
Annotations map[string]string - All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
- Effective
Labels map[string]string - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Endpoint
Ip string - User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated.
- Labels map[string]string
Labels as key value pairs
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- Location string
- The location of the OutboundEndpoint.
- Name string
- The name of the OutboundEndpoint.
- Network string
- The VPC network containing the outbound endpoint, specified as full path.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- Subnetwork string
- The subnetwork holding the endpoint_ip, specified as full path.
- Update
Time string - The timestamp when the resource was updated.
- annotations map(string)
Annotations as key value pairs
Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field
effectiveAnnotationsfor all of the annotations present on the resource.- create_
time string - The timestamp when the resource was created.
- deletion_
policy 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.
- description string
- User provided description.
- effective_
annotations map(string) - All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
- effective_
labels map(string) - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- endpoint_
ip string - User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated.
- labels map(string)
Labels as key value pairs
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- location string
- The location of the OutboundEndpoint.
- name string
- The name of the OutboundEndpoint.
- network string
- The VPC network containing the outbound endpoint, specified as full path.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi_
labels map(string) - The combination of labels configured directly on the resource and default labels configured on the provider.
- subnetwork string
- The subnetwork holding the endpoint_ip, specified as full path.
- update_
time string - The timestamp when the resource was updated.
- annotations Map<String,String>
Annotations as key value pairs
Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field
effectiveAnnotationsfor all of the annotations present on the resource.- create
Time String - The timestamp when the resource was created.
- deletion
Policy 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.
- description String
- User provided description.
- effective
Annotations Map<String,String> - All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
- effective
Labels Map<String,String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- endpoint
Ip String - User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated.
- labels Map<String,String>
Labels as key value pairs
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- location String
- The location of the OutboundEndpoint.
- name String
- The name of the OutboundEndpoint.
- network String
- The VPC network containing the outbound endpoint, specified as full path.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- subnetwork String
- The subnetwork holding the endpoint_ip, specified as full path.
- update
Time String - The timestamp when the resource was updated.
- annotations {[key: string]: string}
Annotations as key value pairs
Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field
effectiveAnnotationsfor all of the annotations present on the resource.- create
Time string - The timestamp when the resource was created.
- deletion
Policy 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.
- description string
- User provided description.
- effective
Annotations {[key: string]: string} - All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
- effective
Labels {[key: string]: string} - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- endpoint
Ip string - User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated.
- labels {[key: string]: string}
Labels as key value pairs
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- location string
- The location of the OutboundEndpoint.
- name string
- The name of the OutboundEndpoint.
- network string
- The VPC network containing the outbound endpoint, specified as full path.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- subnetwork string
- The subnetwork holding the endpoint_ip, specified as full path.
- update
Time string - The timestamp when the resource was updated.
- annotations Mapping[str, str]
Annotations as key value pairs
Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field
effectiveAnnotationsfor all of the annotations present on the resource.- create_
time str - The timestamp when the resource was created.
- deletion_
policy str - 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.
- description str
- User provided description.
- effective_
annotations Mapping[str, str] - All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
- effective_
labels Mapping[str, str] - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- endpoint_
ip str - User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated.
- labels Mapping[str, str]
Labels as key value pairs
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- location str
- The location of the OutboundEndpoint.
- name str
- The name of the OutboundEndpoint.
- network str
- The VPC network containing the outbound endpoint, specified as full path.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- subnetwork str
- The subnetwork holding the endpoint_ip, specified as full path.
- update_
time str - The timestamp when the resource was updated.
- annotations Map<String>
Annotations as key value pairs
Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field
effectiveAnnotationsfor all of the annotations present on the resource.- create
Time String - The timestamp when the resource was created.
- deletion
Policy 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.
- description String
- User provided description.
- effective
Annotations Map<String> - All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
- effective
Labels Map<String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- endpoint
Ip String - User provided IP address to use for outbound DNS forwarding. This address must be a free address on the subnetwork. If omitted, a free IP address from the subnetwork is automatically allocated.
- labels Map<String>
Labels as key value pairs
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- location String
- The location of the OutboundEndpoint.
- name String
- The name of the OutboundEndpoint.
- network String
- The VPC network containing the outbound endpoint, specified as full path.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- subnetwork String
- The subnetwork holding the endpoint_ip, specified as full path.
- update
Time String - The timestamp when the resource was updated.
Import
OutboundEndpoint can be imported using any of these accepted formats:
projects/{{project}}/locations/{{location}}/outboundEndpoints/{{name}}{{project}}/{{location}}/{{name}}{{location}}/{{name}}
When using the pulumi import command, OutboundEndpoint can be imported using one of the formats above. For example:
$ pulumi import gcp:dns/outboundEndpoint:OutboundEndpoint default projects/{{project}}/locations/{{location}}/outboundEndpoints/{{name}}
$ pulumi import gcp:dns/outboundEndpoint:OutboundEndpoint default {{project}}/{{location}}/{{name}}
$ pulumi import gcp:dns/outboundEndpoint:OutboundEndpoint default {{location}}/{{name}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.
published on Wednesday, Nov 18, 2026 by Pulumi