gcp.networkconnectivity.RegionalEndpoint
Explore with Pulumi AI
Regional Private Service Connect (PSC) endpoint resource.
To get more information about RegionalEndpoint, see:
Example Usage
Network Connectivity Regional Endpoint Regional Access
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const myNetwork = new gcp.compute.Network("my_network", {
name: "my-network",
autoCreateSubnetworks: false,
});
const mySubnetwork = new gcp.compute.Subnetwork("my_subnetwork", {
name: "my-subnetwork",
ipCidrRange: "192.168.0.0/24",
region: "us-central1",
network: myNetwork.id,
});
const _default = new gcp.networkconnectivity.RegionalEndpoint("default", {
name: "my-rep",
location: "us-central1",
targetGoogleApi: "storage.us-central1.p.rep.googleapis.com",
accessType: "REGIONAL",
address: "192.168.0.5",
network: myNetwork.id,
subnetwork: mySubnetwork.id,
description: "My RegionalEndpoint targeting Google API storage.us-central1.p.rep.googleapis.com",
labels: {
env: "default",
},
});
import pulumi
import pulumi_gcp as gcp
my_network = gcp.compute.Network("my_network",
name="my-network",
auto_create_subnetworks=False)
my_subnetwork = gcp.compute.Subnetwork("my_subnetwork",
name="my-subnetwork",
ip_cidr_range="192.168.0.0/24",
region="us-central1",
network=my_network.id)
default = gcp.networkconnectivity.RegionalEndpoint("default",
name="my-rep",
location="us-central1",
target_google_api="storage.us-central1.p.rep.googleapis.com",
access_type="REGIONAL",
address="192.168.0.5",
network=my_network.id,
subnetwork=my_subnetwork.id,
description="My RegionalEndpoint targeting Google API storage.us-central1.p.rep.googleapis.com",
labels={
"env": "default",
})
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/networkconnectivity"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
myNetwork, err := compute.NewNetwork(ctx, "my_network", &compute.NetworkArgs{
Name: pulumi.String("my-network"),
AutoCreateSubnetworks: pulumi.Bool(false),
})
if err != nil {
return err
}
mySubnetwork, err := compute.NewSubnetwork(ctx, "my_subnetwork", &compute.SubnetworkArgs{
Name: pulumi.String("my-subnetwork"),
IpCidrRange: pulumi.String("192.168.0.0/24"),
Region: pulumi.String("us-central1"),
Network: myNetwork.ID(),
})
if err != nil {
return err
}
_, err = networkconnectivity.NewRegionalEndpoint(ctx, "default", &networkconnectivity.RegionalEndpointArgs{
Name: pulumi.String("my-rep"),
Location: pulumi.String("us-central1"),
TargetGoogleApi: pulumi.String("storage.us-central1.p.rep.googleapis.com"),
AccessType: pulumi.String("REGIONAL"),
Address: pulumi.String("192.168.0.5"),
Network: myNetwork.ID(),
Subnetwork: mySubnetwork.ID(),
Description: pulumi.String("My RegionalEndpoint targeting Google API storage.us-central1.p.rep.googleapis.com"),
Labels: pulumi.StringMap{
"env": pulumi.String("default"),
},
})
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 myNetwork = new Gcp.Compute.Network("my_network", new()
{
Name = "my-network",
AutoCreateSubnetworks = false,
});
var mySubnetwork = new Gcp.Compute.Subnetwork("my_subnetwork", new()
{
Name = "my-subnetwork",
IpCidrRange = "192.168.0.0/24",
Region = "us-central1",
Network = myNetwork.Id,
});
var @default = new Gcp.NetworkConnectivity.RegionalEndpoint("default", new()
{
Name = "my-rep",
Location = "us-central1",
TargetGoogleApi = "storage.us-central1.p.rep.googleapis.com",
AccessType = "REGIONAL",
Address = "192.168.0.5",
Network = myNetwork.Id,
Subnetwork = mySubnetwork.Id,
Description = "My RegionalEndpoint targeting Google API storage.us-central1.p.rep.googleapis.com",
Labels =
{
{ "env", "default" },
},
});
});
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.networkconnectivity.RegionalEndpoint;
import com.pulumi.gcp.networkconnectivity.RegionalEndpointArgs;
import java.util.List;
import java.util.ArrayList;
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 myNetwork = new Network("myNetwork", NetworkArgs.builder()
.name("my-network")
.autoCreateSubnetworks(false)
.build());
var mySubnetwork = new Subnetwork("mySubnetwork", SubnetworkArgs.builder()
.name("my-subnetwork")
.ipCidrRange("192.168.0.0/24")
.region("us-central1")
.network(myNetwork.id())
.build());
var default_ = new RegionalEndpoint("default", RegionalEndpointArgs.builder()
.name("my-rep")
.location("us-central1")
.targetGoogleApi("storage.us-central1.p.rep.googleapis.com")
.accessType("REGIONAL")
.address("192.168.0.5")
.network(myNetwork.id())
.subnetwork(mySubnetwork.id())
.description("My RegionalEndpoint targeting Google API storage.us-central1.p.rep.googleapis.com")
.labels(Map.of("env", "default"))
.build());
}
}
resources:
myNetwork:
type: gcp:compute:Network
name: my_network
properties:
name: my-network
autoCreateSubnetworks: false
mySubnetwork:
type: gcp:compute:Subnetwork
name: my_subnetwork
properties:
name: my-subnetwork
ipCidrRange: 192.168.0.0/24
region: us-central1
network: ${myNetwork.id}
default:
type: gcp:networkconnectivity:RegionalEndpoint
properties:
name: my-rep
location: us-central1
targetGoogleApi: storage.us-central1.p.rep.googleapis.com
accessType: REGIONAL
address: 192.168.0.5
network: ${myNetwork.id}
subnetwork: ${mySubnetwork.id}
description: My RegionalEndpoint targeting Google API storage.us-central1.p.rep.googleapis.com
labels:
env: default
Network Connectivity Regional Endpoint Global Access
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const myNetwork = new gcp.compute.Network("my_network", {
name: "my-network",
autoCreateSubnetworks: false,
});
const mySubnetwork = new gcp.compute.Subnetwork("my_subnetwork", {
name: "my-subnetwork",
ipCidrRange: "192.168.0.0/24",
region: "us-central1",
network: myNetwork.id,
});
const _default = new gcp.networkconnectivity.RegionalEndpoint("default", {
name: "my-rep",
location: "us-central1",
targetGoogleApi: "storage.us-central1.p.rep.googleapis.com",
accessType: "GLOBAL",
address: "192.168.0.4",
network: myNetwork.id,
subnetwork: mySubnetwork.id,
});
import pulumi
import pulumi_gcp as gcp
my_network = gcp.compute.Network("my_network",
name="my-network",
auto_create_subnetworks=False)
my_subnetwork = gcp.compute.Subnetwork("my_subnetwork",
name="my-subnetwork",
ip_cidr_range="192.168.0.0/24",
region="us-central1",
network=my_network.id)
default = gcp.networkconnectivity.RegionalEndpoint("default",
name="my-rep",
location="us-central1",
target_google_api="storage.us-central1.p.rep.googleapis.com",
access_type="GLOBAL",
address="192.168.0.4",
network=my_network.id,
subnetwork=my_subnetwork.id)
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/networkconnectivity"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
myNetwork, err := compute.NewNetwork(ctx, "my_network", &compute.NetworkArgs{
Name: pulumi.String("my-network"),
AutoCreateSubnetworks: pulumi.Bool(false),
})
if err != nil {
return err
}
mySubnetwork, err := compute.NewSubnetwork(ctx, "my_subnetwork", &compute.SubnetworkArgs{
Name: pulumi.String("my-subnetwork"),
IpCidrRange: pulumi.String("192.168.0.0/24"),
Region: pulumi.String("us-central1"),
Network: myNetwork.ID(),
})
if err != nil {
return err
}
_, err = networkconnectivity.NewRegionalEndpoint(ctx, "default", &networkconnectivity.RegionalEndpointArgs{
Name: pulumi.String("my-rep"),
Location: pulumi.String("us-central1"),
TargetGoogleApi: pulumi.String("storage.us-central1.p.rep.googleapis.com"),
AccessType: pulumi.String("GLOBAL"),
Address: pulumi.String("192.168.0.4"),
Network: myNetwork.ID(),
Subnetwork: mySubnetwork.ID(),
})
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 myNetwork = new Gcp.Compute.Network("my_network", new()
{
Name = "my-network",
AutoCreateSubnetworks = false,
});
var mySubnetwork = new Gcp.Compute.Subnetwork("my_subnetwork", new()
{
Name = "my-subnetwork",
IpCidrRange = "192.168.0.0/24",
Region = "us-central1",
Network = myNetwork.Id,
});
var @default = new Gcp.NetworkConnectivity.RegionalEndpoint("default", new()
{
Name = "my-rep",
Location = "us-central1",
TargetGoogleApi = "storage.us-central1.p.rep.googleapis.com",
AccessType = "GLOBAL",
Address = "192.168.0.4",
Network = myNetwork.Id,
Subnetwork = mySubnetwork.Id,
});
});
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.networkconnectivity.RegionalEndpoint;
import com.pulumi.gcp.networkconnectivity.RegionalEndpointArgs;
import java.util.List;
import java.util.ArrayList;
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 myNetwork = new Network("myNetwork", NetworkArgs.builder()
.name("my-network")
.autoCreateSubnetworks(false)
.build());
var mySubnetwork = new Subnetwork("mySubnetwork", SubnetworkArgs.builder()
.name("my-subnetwork")
.ipCidrRange("192.168.0.0/24")
.region("us-central1")
.network(myNetwork.id())
.build());
var default_ = new RegionalEndpoint("default", RegionalEndpointArgs.builder()
.name("my-rep")
.location("us-central1")
.targetGoogleApi("storage.us-central1.p.rep.googleapis.com")
.accessType("GLOBAL")
.address("192.168.0.4")
.network(myNetwork.id())
.subnetwork(mySubnetwork.id())
.build());
}
}
resources:
myNetwork:
type: gcp:compute:Network
name: my_network
properties:
name: my-network
autoCreateSubnetworks: false
mySubnetwork:
type: gcp:compute:Subnetwork
name: my_subnetwork
properties:
name: my-subnetwork
ipCidrRange: 192.168.0.0/24
region: us-central1
network: ${myNetwork.id}
default:
type: gcp:networkconnectivity:RegionalEndpoint
properties:
name: my-rep
location: us-central1
targetGoogleApi: storage.us-central1.p.rep.googleapis.com
accessType: GLOBAL
address: 192.168.0.4
network: ${myNetwork.id}
subnetwork: ${mySubnetwork.id}
Create RegionalEndpoint Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RegionalEndpoint(name: string, args: RegionalEndpointArgs, opts?: CustomResourceOptions);
@overload
def RegionalEndpoint(resource_name: str,
args: RegionalEndpointArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RegionalEndpoint(resource_name: str,
opts: Optional[ResourceOptions] = None,
access_type: Optional[str] = None,
location: Optional[str] = None,
target_google_api: Optional[str] = None,
address: Optional[str] = None,
description: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
network: Optional[str] = None,
project: Optional[str] = None,
subnetwork: Optional[str] = None)
func NewRegionalEndpoint(ctx *Context, name string, args RegionalEndpointArgs, opts ...ResourceOption) (*RegionalEndpoint, error)
public RegionalEndpoint(string name, RegionalEndpointArgs args, CustomResourceOptions? opts = null)
public RegionalEndpoint(String name, RegionalEndpointArgs args)
public RegionalEndpoint(String name, RegionalEndpointArgs args, CustomResourceOptions options)
type: gcp:networkconnectivity:RegionalEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args RegionalEndpointArgs
- 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 RegionalEndpointArgs
- 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 RegionalEndpointArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RegionalEndpointArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RegionalEndpointArgs
- 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 regionalEndpointResource = new Gcp.NetworkConnectivity.RegionalEndpoint("regionalEndpointResource", new()
{
AccessType = "string",
Location = "string",
TargetGoogleApi = "string",
Address = "string",
Description = "string",
Labels =
{
{ "string", "string" },
},
Name = "string",
Network = "string",
Project = "string",
Subnetwork = "string",
});
example, err := networkconnectivity.NewRegionalEndpoint(ctx, "regionalEndpointResource", &networkconnectivity.RegionalEndpointArgs{
AccessType: pulumi.String("string"),
Location: pulumi.String("string"),
TargetGoogleApi: pulumi.String("string"),
Address: pulumi.String("string"),
Description: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
Network: pulumi.String("string"),
Project: pulumi.String("string"),
Subnetwork: pulumi.String("string"),
})
var regionalEndpointResource = new RegionalEndpoint("regionalEndpointResource", RegionalEndpointArgs.builder()
.accessType("string")
.location("string")
.targetGoogleApi("string")
.address("string")
.description("string")
.labels(Map.of("string", "string"))
.name("string")
.network("string")
.project("string")
.subnetwork("string")
.build());
regional_endpoint_resource = gcp.networkconnectivity.RegionalEndpoint("regionalEndpointResource",
access_type="string",
location="string",
target_google_api="string",
address="string",
description="string",
labels={
"string": "string",
},
name="string",
network="string",
project="string",
subnetwork="string")
const regionalEndpointResource = new gcp.networkconnectivity.RegionalEndpoint("regionalEndpointResource", {
accessType: "string",
location: "string",
targetGoogleApi: "string",
address: "string",
description: "string",
labels: {
string: "string",
},
name: "string",
network: "string",
project: "string",
subnetwork: "string",
});
type: gcp:networkconnectivity:RegionalEndpoint
properties:
accessType: string
address: string
description: string
labels:
string: string
location: string
name: string
network: string
project: string
subnetwork: string
targetGoogleApi: string
RegionalEndpoint 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 RegionalEndpoint resource accepts the following input properties:
- Access
Type string - The access type of this regional endpoint. This field is reflected in the PSC Forwarding Rule configuration to enable global access.
Possible values are:
GLOBAL
,REGIONAL
. - Location string
- The location of the RegionalEndpoint.
- Target
Google stringApi - The service endpoint this private regional endpoint connects to. Format:
{apiname}.{region}.p.rep.googleapis.com
Example: "cloudkms.us-central1.p.rep.googleapis.com". - Address string
The IP Address of the Regional Endpoint. When no address is provided, an IP from the subnetwork is allocated. Use one of the following formats: * IPv4 address as in
10.0.0.1
* Address resource URI as inprojects/{project}/regions/{region}/addresses/{address_name}
Note: This field accepts both a reference to a Compute Address resource, which is the resource name of which format is given in the description, and IP literal value. If the user chooses to input a reserved address value; they need to make sure that the reserved address is in IPv4 version, its purpose is GCE_ENDPOINT, its type is INTERNAL and its status is RESERVED. If the user chooses to input an IP literal, they need to make sure that it's a valid IPv4 address (x.x.x.x) within the subnetwork.
- Description string
- A description of this resource.
- Labels Dictionary<string, string>
User-defined labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- Name string
- The name of the RegionalEndpoint.
- Network string
- The name of the VPC network for this private regional endpoint. Format:
projects/{project}/global/networks/{network}
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Subnetwork string
- The name of the subnetwork from which the IP address will be allocated. Format:
projects/{project}/regions/{region}/subnetworks/{subnetwork}
- Access
Type string - The access type of this regional endpoint. This field is reflected in the PSC Forwarding Rule configuration to enable global access.
Possible values are:
GLOBAL
,REGIONAL
. - Location string
- The location of the RegionalEndpoint.
- Target
Google stringApi - The service endpoint this private regional endpoint connects to. Format:
{apiname}.{region}.p.rep.googleapis.com
Example: "cloudkms.us-central1.p.rep.googleapis.com". - Address string
The IP Address of the Regional Endpoint. When no address is provided, an IP from the subnetwork is allocated. Use one of the following formats: * IPv4 address as in
10.0.0.1
* Address resource URI as inprojects/{project}/regions/{region}/addresses/{address_name}
Note: This field accepts both a reference to a Compute Address resource, which is the resource name of which format is given in the description, and IP literal value. If the user chooses to input a reserved address value; they need to make sure that the reserved address is in IPv4 version, its purpose is GCE_ENDPOINT, its type is INTERNAL and its status is RESERVED. If the user chooses to input an IP literal, they need to make sure that it's a valid IPv4 address (x.x.x.x) within the subnetwork.
- Description string
- A description of this resource.
- Labels map[string]string
User-defined labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- Name string
- The name of the RegionalEndpoint.
- Network string
- The name of the VPC network for this private regional endpoint. Format:
projects/{project}/global/networks/{network}
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Subnetwork string
- The name of the subnetwork from which the IP address will be allocated. Format:
projects/{project}/regions/{region}/subnetworks/{subnetwork}
- access
Type String - The access type of this regional endpoint. This field is reflected in the PSC Forwarding Rule configuration to enable global access.
Possible values are:
GLOBAL
,REGIONAL
. - location String
- The location of the RegionalEndpoint.
- target
Google StringApi - The service endpoint this private regional endpoint connects to. Format:
{apiname}.{region}.p.rep.googleapis.com
Example: "cloudkms.us-central1.p.rep.googleapis.com". - address String
The IP Address of the Regional Endpoint. When no address is provided, an IP from the subnetwork is allocated. Use one of the following formats: * IPv4 address as in
10.0.0.1
* Address resource URI as inprojects/{project}/regions/{region}/addresses/{address_name}
Note: This field accepts both a reference to a Compute Address resource, which is the resource name of which format is given in the description, and IP literal value. If the user chooses to input a reserved address value; they need to make sure that the reserved address is in IPv4 version, its purpose is GCE_ENDPOINT, its type is INTERNAL and its status is RESERVED. If the user chooses to input an IP literal, they need to make sure that it's a valid IPv4 address (x.x.x.x) within the subnetwork.
- description String
- A description of this resource.
- labels Map<String,String>
User-defined labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- name String
- The name of the RegionalEndpoint.
- network String
- The name of the VPC network for this private regional endpoint. Format:
projects/{project}/global/networks/{network}
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- subnetwork String
- The name of the subnetwork from which the IP address will be allocated. Format:
projects/{project}/regions/{region}/subnetworks/{subnetwork}
- access
Type string - The access type of this regional endpoint. This field is reflected in the PSC Forwarding Rule configuration to enable global access.
Possible values are:
GLOBAL
,REGIONAL
. - location string
- The location of the RegionalEndpoint.
- target
Google stringApi - The service endpoint this private regional endpoint connects to. Format:
{apiname}.{region}.p.rep.googleapis.com
Example: "cloudkms.us-central1.p.rep.googleapis.com". - address string
The IP Address of the Regional Endpoint. When no address is provided, an IP from the subnetwork is allocated. Use one of the following formats: * IPv4 address as in
10.0.0.1
* Address resource URI as inprojects/{project}/regions/{region}/addresses/{address_name}
Note: This field accepts both a reference to a Compute Address resource, which is the resource name of which format is given in the description, and IP literal value. If the user chooses to input a reserved address value; they need to make sure that the reserved address is in IPv4 version, its purpose is GCE_ENDPOINT, its type is INTERNAL and its status is RESERVED. If the user chooses to input an IP literal, they need to make sure that it's a valid IPv4 address (x.x.x.x) within the subnetwork.
- description string
- A description of this resource.
- labels {[key: string]: string}
User-defined labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- name string
- The name of the RegionalEndpoint.
- network string
- The name of the VPC network for this private regional endpoint. Format:
projects/{project}/global/networks/{network}
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- subnetwork string
- The name of the subnetwork from which the IP address will be allocated. Format:
projects/{project}/regions/{region}/subnetworks/{subnetwork}
- access_
type str - The access type of this regional endpoint. This field is reflected in the PSC Forwarding Rule configuration to enable global access.
Possible values are:
GLOBAL
,REGIONAL
. - location str
- The location of the RegionalEndpoint.
- target_
google_ strapi - The service endpoint this private regional endpoint connects to. Format:
{apiname}.{region}.p.rep.googleapis.com
Example: "cloudkms.us-central1.p.rep.googleapis.com". - address str
The IP Address of the Regional Endpoint. When no address is provided, an IP from the subnetwork is allocated. Use one of the following formats: * IPv4 address as in
10.0.0.1
* Address resource URI as inprojects/{project}/regions/{region}/addresses/{address_name}
Note: This field accepts both a reference to a Compute Address resource, which is the resource name of which format is given in the description, and IP literal value. If the user chooses to input a reserved address value; they need to make sure that the reserved address is in IPv4 version, its purpose is GCE_ENDPOINT, its type is INTERNAL and its status is RESERVED. If the user chooses to input an IP literal, they need to make sure that it's a valid IPv4 address (x.x.x.x) within the subnetwork.
- description str
- A description of this resource.
- labels Mapping[str, str]
User-defined labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- name str
- The name of the RegionalEndpoint.
- network str
- The name of the VPC network for this private regional endpoint. Format:
projects/{project}/global/networks/{network}
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- subnetwork str
- The name of the subnetwork from which the IP address will be allocated. Format:
projects/{project}/regions/{region}/subnetworks/{subnetwork}
- access
Type String - The access type of this regional endpoint. This field is reflected in the PSC Forwarding Rule configuration to enable global access.
Possible values are:
GLOBAL
,REGIONAL
. - location String
- The location of the RegionalEndpoint.
- target
Google StringApi - The service endpoint this private regional endpoint connects to. Format:
{apiname}.{region}.p.rep.googleapis.com
Example: "cloudkms.us-central1.p.rep.googleapis.com". - address String
The IP Address of the Regional Endpoint. When no address is provided, an IP from the subnetwork is allocated. Use one of the following formats: * IPv4 address as in
10.0.0.1
* Address resource URI as inprojects/{project}/regions/{region}/addresses/{address_name}
Note: This field accepts both a reference to a Compute Address resource, which is the resource name of which format is given in the description, and IP literal value. If the user chooses to input a reserved address value; they need to make sure that the reserved address is in IPv4 version, its purpose is GCE_ENDPOINT, its type is INTERNAL and its status is RESERVED. If the user chooses to input an IP literal, they need to make sure that it's a valid IPv4 address (x.x.x.x) within the subnetwork.
- description String
- A description of this resource.
- labels Map<String>
User-defined labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- name String
- The name of the RegionalEndpoint.
- network String
- The name of the VPC network for this private regional endpoint. Format:
projects/{project}/global/networks/{network}
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- subnetwork String
- The name of the subnetwork from which the IP address will be allocated. Format:
projects/{project}/regions/{region}/subnetworks/{subnetwork}
Outputs
All input properties are implicitly available as output properties. Additionally, the RegionalEndpoint resource produces the following output properties:
- Create
Time string - Time when the RegionalEndpoint was created.
- 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.
- Psc
Forwarding stringRule - The resource reference of the PSC Forwarding Rule created on behalf of the customer. Format:
//compute.googleapis.com/projects/{project}/regions/{region}/forwardingRules/{forwarding_rule_name}
- Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- Update
Time string - Time when the RegionalEndpoint was updated.
- Create
Time string - Time when the RegionalEndpoint was created.
- 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.
- Psc
Forwarding stringRule - The resource reference of the PSC Forwarding Rule created on behalf of the customer. Format:
//compute.googleapis.com/projects/{project}/regions/{region}/forwardingRules/{forwarding_rule_name}
- Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- Update
Time string - Time when the RegionalEndpoint was updated.
- create
Time String - Time when the RegionalEndpoint was created.
- 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.
- psc
Forwarding StringRule - The resource reference of the PSC Forwarding Rule created on behalf of the customer. Format:
//compute.googleapis.com/projects/{project}/regions/{region}/forwardingRules/{forwarding_rule_name}
- pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- update
Time String - Time when the RegionalEndpoint was updated.
- create
Time string - Time when the RegionalEndpoint was created.
- 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.
- psc
Forwarding stringRule - The resource reference of the PSC Forwarding Rule created on behalf of the customer. Format:
//compute.googleapis.com/projects/{project}/regions/{region}/forwardingRules/{forwarding_rule_name}
- pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- update
Time string - Time when the RegionalEndpoint was updated.
- create_
time str - Time when the RegionalEndpoint was created.
- 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.
- psc_
forwarding_ strrule - The resource reference of the PSC Forwarding Rule created on behalf of the customer. Format:
//compute.googleapis.com/projects/{project}/regions/{region}/forwardingRules/{forwarding_rule_name}
- pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- update_
time str - Time when the RegionalEndpoint was updated.
- create
Time String - Time when the RegionalEndpoint was created.
- 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.
- psc
Forwarding StringRule - The resource reference of the PSC Forwarding Rule created on behalf of the customer. Format:
//compute.googleapis.com/projects/{project}/regions/{region}/forwardingRules/{forwarding_rule_name}
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- update
Time String - Time when the RegionalEndpoint was updated.
Look up Existing RegionalEndpoint Resource
Get an existing RegionalEndpoint 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?: RegionalEndpointState, opts?: CustomResourceOptions): RegionalEndpoint
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
access_type: Optional[str] = None,
address: Optional[str] = None,
create_time: Optional[str] = None,
description: Optional[str] = None,
effective_labels: Optional[Mapping[str, str]] = None,
labels: Optional[Mapping[str, str]] = None,
location: Optional[str] = None,
name: Optional[str] = None,
network: Optional[str] = None,
project: Optional[str] = None,
psc_forwarding_rule: Optional[str] = None,
pulumi_labels: Optional[Mapping[str, str]] = None,
subnetwork: Optional[str] = None,
target_google_api: Optional[str] = None,
update_time: Optional[str] = None) -> RegionalEndpoint
func GetRegionalEndpoint(ctx *Context, name string, id IDInput, state *RegionalEndpointState, opts ...ResourceOption) (*RegionalEndpoint, error)
public static RegionalEndpoint Get(string name, Input<string> id, RegionalEndpointState? state, CustomResourceOptions? opts = null)
public static RegionalEndpoint get(String name, Output<String> id, RegionalEndpointState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Access
Type string - The access type of this regional endpoint. This field is reflected in the PSC Forwarding Rule configuration to enable global access.
Possible values are:
GLOBAL
,REGIONAL
. - Address string
The IP Address of the Regional Endpoint. When no address is provided, an IP from the subnetwork is allocated. Use one of the following formats: * IPv4 address as in
10.0.0.1
* Address resource URI as inprojects/{project}/regions/{region}/addresses/{address_name}
Note: This field accepts both a reference to a Compute Address resource, which is the resource name of which format is given in the description, and IP literal value. If the user chooses to input a reserved address value; they need to make sure that the reserved address is in IPv4 version, its purpose is GCE_ENDPOINT, its type is INTERNAL and its status is RESERVED. If the user chooses to input an IP literal, they need to make sure that it's a valid IPv4 address (x.x.x.x) within the subnetwork.
- Create
Time string - Time when the RegionalEndpoint was created.
- Description string
- A description of this resource.
- 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.
- Labels Dictionary<string, string>
User-defined labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- Location string
- The location of the RegionalEndpoint.
- Name string
- The name of the RegionalEndpoint.
- Network string
- The name of the VPC network for this private regional endpoint. Format:
projects/{project}/global/networks/{network}
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Psc
Forwarding stringRule - The resource reference of the PSC Forwarding Rule created on behalf of the customer. Format:
//compute.googleapis.com/projects/{project}/regions/{region}/forwardingRules/{forwarding_rule_name}
- Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- Subnetwork string
- The name of the subnetwork from which the IP address will be allocated. Format:
projects/{project}/regions/{region}/subnetworks/{subnetwork}
- Target
Google stringApi - The service endpoint this private regional endpoint connects to. Format:
{apiname}.{region}.p.rep.googleapis.com
Example: "cloudkms.us-central1.p.rep.googleapis.com". - Update
Time string - Time when the RegionalEndpoint was updated.
- Access
Type string - The access type of this regional endpoint. This field is reflected in the PSC Forwarding Rule configuration to enable global access.
Possible values are:
GLOBAL
,REGIONAL
. - Address string
The IP Address of the Regional Endpoint. When no address is provided, an IP from the subnetwork is allocated. Use one of the following formats: * IPv4 address as in
10.0.0.1
* Address resource URI as inprojects/{project}/regions/{region}/addresses/{address_name}
Note: This field accepts both a reference to a Compute Address resource, which is the resource name of which format is given in the description, and IP literal value. If the user chooses to input a reserved address value; they need to make sure that the reserved address is in IPv4 version, its purpose is GCE_ENDPOINT, its type is INTERNAL and its status is RESERVED. If the user chooses to input an IP literal, they need to make sure that it's a valid IPv4 address (x.x.x.x) within the subnetwork.
- Create
Time string - Time when the RegionalEndpoint was created.
- Description string
- A description of this resource.
- 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.
- Labels map[string]string
User-defined labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- Location string
- The location of the RegionalEndpoint.
- Name string
- The name of the RegionalEndpoint.
- Network string
- The name of the VPC network for this private regional endpoint. Format:
projects/{project}/global/networks/{network}
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Psc
Forwarding stringRule - The resource reference of the PSC Forwarding Rule created on behalf of the customer. Format:
//compute.googleapis.com/projects/{project}/regions/{region}/forwardingRules/{forwarding_rule_name}
- Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- Subnetwork string
- The name of the subnetwork from which the IP address will be allocated. Format:
projects/{project}/regions/{region}/subnetworks/{subnetwork}
- Target
Google stringApi - The service endpoint this private regional endpoint connects to. Format:
{apiname}.{region}.p.rep.googleapis.com
Example: "cloudkms.us-central1.p.rep.googleapis.com". - Update
Time string - Time when the RegionalEndpoint was updated.
- access
Type String - The access type of this regional endpoint. This field is reflected in the PSC Forwarding Rule configuration to enable global access.
Possible values are:
GLOBAL
,REGIONAL
. - address String
The IP Address of the Regional Endpoint. When no address is provided, an IP from the subnetwork is allocated. Use one of the following formats: * IPv4 address as in
10.0.0.1
* Address resource URI as inprojects/{project}/regions/{region}/addresses/{address_name}
Note: This field accepts both a reference to a Compute Address resource, which is the resource name of which format is given in the description, and IP literal value. If the user chooses to input a reserved address value; they need to make sure that the reserved address is in IPv4 version, its purpose is GCE_ENDPOINT, its type is INTERNAL and its status is RESERVED. If the user chooses to input an IP literal, they need to make sure that it's a valid IPv4 address (x.x.x.x) within the subnetwork.
- create
Time String - Time when the RegionalEndpoint was created.
- description String
- A description of this resource.
- 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.
- labels Map<String,String>
User-defined labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- location String
- The location of the RegionalEndpoint.
- name String
- The name of the RegionalEndpoint.
- network String
- The name of the VPC network for this private regional endpoint. Format:
projects/{project}/global/networks/{network}
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- psc
Forwarding StringRule - The resource reference of the PSC Forwarding Rule created on behalf of the customer. Format:
//compute.googleapis.com/projects/{project}/regions/{region}/forwardingRules/{forwarding_rule_name}
- pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- subnetwork String
- The name of the subnetwork from which the IP address will be allocated. Format:
projects/{project}/regions/{region}/subnetworks/{subnetwork}
- target
Google StringApi - The service endpoint this private regional endpoint connects to. Format:
{apiname}.{region}.p.rep.googleapis.com
Example: "cloudkms.us-central1.p.rep.googleapis.com". - update
Time String - Time when the RegionalEndpoint was updated.
- access
Type string - The access type of this regional endpoint. This field is reflected in the PSC Forwarding Rule configuration to enable global access.
Possible values are:
GLOBAL
,REGIONAL
. - address string
The IP Address of the Regional Endpoint. When no address is provided, an IP from the subnetwork is allocated. Use one of the following formats: * IPv4 address as in
10.0.0.1
* Address resource URI as inprojects/{project}/regions/{region}/addresses/{address_name}
Note: This field accepts both a reference to a Compute Address resource, which is the resource name of which format is given in the description, and IP literal value. If the user chooses to input a reserved address value; they need to make sure that the reserved address is in IPv4 version, its purpose is GCE_ENDPOINT, its type is INTERNAL and its status is RESERVED. If the user chooses to input an IP literal, they need to make sure that it's a valid IPv4 address (x.x.x.x) within the subnetwork.
- create
Time string - Time when the RegionalEndpoint was created.
- description string
- A description of this resource.
- 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.
- labels {[key: string]: string}
User-defined labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- location string
- The location of the RegionalEndpoint.
- name string
- The name of the RegionalEndpoint.
- network string
- The name of the VPC network for this private regional endpoint. Format:
projects/{project}/global/networks/{network}
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- psc
Forwarding stringRule - The resource reference of the PSC Forwarding Rule created on behalf of the customer. Format:
//compute.googleapis.com/projects/{project}/regions/{region}/forwardingRules/{forwarding_rule_name}
- pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- subnetwork string
- The name of the subnetwork from which the IP address will be allocated. Format:
projects/{project}/regions/{region}/subnetworks/{subnetwork}
- target
Google stringApi - The service endpoint this private regional endpoint connects to. Format:
{apiname}.{region}.p.rep.googleapis.com
Example: "cloudkms.us-central1.p.rep.googleapis.com". - update
Time string - Time when the RegionalEndpoint was updated.
- access_
type str - The access type of this regional endpoint. This field is reflected in the PSC Forwarding Rule configuration to enable global access.
Possible values are:
GLOBAL
,REGIONAL
. - address str
The IP Address of the Regional Endpoint. When no address is provided, an IP from the subnetwork is allocated. Use one of the following formats: * IPv4 address as in
10.0.0.1
* Address resource URI as inprojects/{project}/regions/{region}/addresses/{address_name}
Note: This field accepts both a reference to a Compute Address resource, which is the resource name of which format is given in the description, and IP literal value. If the user chooses to input a reserved address value; they need to make sure that the reserved address is in IPv4 version, its purpose is GCE_ENDPOINT, its type is INTERNAL and its status is RESERVED. If the user chooses to input an IP literal, they need to make sure that it's a valid IPv4 address (x.x.x.x) within the subnetwork.
- create_
time str - Time when the RegionalEndpoint was created.
- description str
- A description of this resource.
- 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.
- labels Mapping[str, str]
User-defined labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- location str
- The location of the RegionalEndpoint.
- name str
- The name of the RegionalEndpoint.
- network str
- The name of the VPC network for this private regional endpoint. Format:
projects/{project}/global/networks/{network}
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- psc_
forwarding_ strrule - The resource reference of the PSC Forwarding Rule created on behalf of the customer. Format:
//compute.googleapis.com/projects/{project}/regions/{region}/forwardingRules/{forwarding_rule_name}
- pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- subnetwork str
- The name of the subnetwork from which the IP address will be allocated. Format:
projects/{project}/regions/{region}/subnetworks/{subnetwork}
- target_
google_ strapi - The service endpoint this private regional endpoint connects to. Format:
{apiname}.{region}.p.rep.googleapis.com
Example: "cloudkms.us-central1.p.rep.googleapis.com". - update_
time str - Time when the RegionalEndpoint was updated.
- access
Type String - The access type of this regional endpoint. This field is reflected in the PSC Forwarding Rule configuration to enable global access.
Possible values are:
GLOBAL
,REGIONAL
. - address String
The IP Address of the Regional Endpoint. When no address is provided, an IP from the subnetwork is allocated. Use one of the following formats: * IPv4 address as in
10.0.0.1
* Address resource URI as inprojects/{project}/regions/{region}/addresses/{address_name}
Note: This field accepts both a reference to a Compute Address resource, which is the resource name of which format is given in the description, and IP literal value. If the user chooses to input a reserved address value; they need to make sure that the reserved address is in IPv4 version, its purpose is GCE_ENDPOINT, its type is INTERNAL and its status is RESERVED. If the user chooses to input an IP literal, they need to make sure that it's a valid IPv4 address (x.x.x.x) within the subnetwork.
- create
Time String - Time when the RegionalEndpoint was created.
- description String
- A description of this resource.
- 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.
- labels Map<String>
User-defined labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- location String
- The location of the RegionalEndpoint.
- name String
- The name of the RegionalEndpoint.
- network String
- The name of the VPC network for this private regional endpoint. Format:
projects/{project}/global/networks/{network}
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- psc
Forwarding StringRule - The resource reference of the PSC Forwarding Rule created on behalf of the customer. Format:
//compute.googleapis.com/projects/{project}/regions/{region}/forwardingRules/{forwarding_rule_name}
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- subnetwork String
- The name of the subnetwork from which the IP address will be allocated. Format:
projects/{project}/regions/{region}/subnetworks/{subnetwork}
- target
Google StringApi - The service endpoint this private regional endpoint connects to. Format:
{apiname}.{region}.p.rep.googleapis.com
Example: "cloudkms.us-central1.p.rep.googleapis.com". - update
Time String - Time when the RegionalEndpoint was updated.
Import
RegionalEndpoint can be imported using any of these accepted formats:
projects/{{project}}/locations/{{location}}/regionalEndpoints/{{name}}
{{project}}/{{location}}/{{name}}
{{location}}/{{name}}
When using the pulumi import
command, RegionalEndpoint can be imported using one of the formats above. For example:
$ pulumi import gcp:networkconnectivity/regionalEndpoint:RegionalEndpoint default projects/{{project}}/locations/{{location}}/regionalEndpoints/{{name}}
$ pulumi import gcp:networkconnectivity/regionalEndpoint:RegionalEndpoint default {{project}}/{{location}}/{{name}}
$ pulumi import gcp:networkconnectivity/regionalEndpoint:RegionalEndpoint default {{location}}/{{name}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-beta
Terraform Provider.