A gateway advertised route is a route that a gateway spoke advertises somewhere.
To get more information about GatewayAdvertisedRoute, see:
- API documentation
- How-to Guides
Example Usage
Network Connectivity Gateway Advertised Route Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const network = new gcp.compute.Network("network", {
name: "net-spoke",
autoCreateSubnetworks: false,
});
const subnetwork = new gcp.compute.Subnetwork("subnetwork", {
name: "tf-test-subnet_21563",
ipCidrRange: "10.0.0.0/28",
region: "us-central1",
network: network.selfLink,
});
const basicHub = new gcp.networkconnectivity.Hub("basic_hub", {
name: "hub",
description: "A sample hub",
labels: {
"label-two": "value-one",
},
presetTopology: "HYBRID_INSPECTION",
});
const primary = new gcp.networkconnectivity.Spoke("primary", {
name: "spoke-name",
location: "us-central1",
description: "A sample spoke of type Gateway",
labels: {
"label-one": "value-one",
},
hub: basicHub.id,
gateway: {
ipRangeReservations: [{
ipRange: "10.0.0.0/23",
}],
capacity: "CAPACITY_1_GBPS",
},
group: "gateways",
});
const _default = new gcp.networkconnectivity.GatewayAdvertisedRoute("default", {
spoke: primary.name,
location: "us-central1",
name: "gateway-advertised-route-name",
labels: {
"label-one": "value-one",
},
description: "description of the gateway advertised route",
ipRange: "0.0.0.0/24",
recipient: "ADVERTISE_TO_HUB",
priority: 200,
});
import pulumi
import pulumi_gcp as gcp
network = gcp.compute.Network("network",
name="net-spoke",
auto_create_subnetworks=False)
subnetwork = gcp.compute.Subnetwork("subnetwork",
name="tf-test-subnet_21563",
ip_cidr_range="10.0.0.0/28",
region="us-central1",
network=network.self_link)
basic_hub = gcp.networkconnectivity.Hub("basic_hub",
name="hub",
description="A sample hub",
labels={
"label-two": "value-one",
},
preset_topology="HYBRID_INSPECTION")
primary = gcp.networkconnectivity.Spoke("primary",
name="spoke-name",
location="us-central1",
description="A sample spoke of type Gateway",
labels={
"label-one": "value-one",
},
hub=basic_hub.id,
gateway={
"ip_range_reservations": [{
"ip_range": "10.0.0.0/23",
}],
"capacity": "CAPACITY_1_GBPS",
},
group="gateways")
default = gcp.networkconnectivity.GatewayAdvertisedRoute("default",
spoke=primary.name,
location="us-central1",
name="gateway-advertised-route-name",
labels={
"label-one": "value-one",
},
description="description of the gateway advertised route",
ip_range="0.0.0.0/24",
recipient="ADVERTISE_TO_HUB",
priority=200)
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/networkconnectivity"
"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("net-spoke"),
AutoCreateSubnetworks: pulumi.Bool(false),
})
if err != nil {
return err
}
_, err = compute.NewSubnetwork(ctx, "subnetwork", &compute.SubnetworkArgs{
Name: pulumi.String("tf-test-subnet_21563"),
IpCidrRange: pulumi.String("10.0.0.0/28"),
Region: pulumi.String("us-central1"),
Network: network.SelfLink,
})
if err != nil {
return err
}
basicHub, err := networkconnectivity.NewHub(ctx, "basic_hub", &networkconnectivity.HubArgs{
Name: pulumi.String("hub"),
Description: pulumi.String("A sample hub"),
Labels: pulumi.StringMap{
"label-two": pulumi.String("value-one"),
},
PresetTopology: pulumi.String("HYBRID_INSPECTION"),
})
if err != nil {
return err
}
primary, err := networkconnectivity.NewSpoke(ctx, "primary", &networkconnectivity.SpokeArgs{
Name: pulumi.String("spoke-name"),
Location: pulumi.String("us-central1"),
Description: pulumi.String("A sample spoke of type Gateway"),
Labels: pulumi.StringMap{
"label-one": pulumi.String("value-one"),
},
Hub: basicHub.ID(),
Gateway: &networkconnectivity.SpokeGatewayArgs{
IpRangeReservations: networkconnectivity.SpokeGatewayIpRangeReservationArray{
&networkconnectivity.SpokeGatewayIpRangeReservationArgs{
IpRange: pulumi.String("10.0.0.0/23"),
},
},
Capacity: pulumi.String("CAPACITY_1_GBPS"),
},
Group: pulumi.String("gateways"),
})
if err != nil {
return err
}
_, err = networkconnectivity.NewGatewayAdvertisedRoute(ctx, "default", &networkconnectivity.GatewayAdvertisedRouteArgs{
Spoke: primary.Name,
Location: pulumi.String("us-central1"),
Name: pulumi.String("gateway-advertised-route-name"),
Labels: pulumi.StringMap{
"label-one": pulumi.String("value-one"),
},
Description: pulumi.String("description of the gateway advertised route"),
IpRange: pulumi.String("0.0.0.0/24"),
Recipient: pulumi.String("ADVERTISE_TO_HUB"),
Priority: pulumi.Int(200),
})
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 = "net-spoke",
AutoCreateSubnetworks = false,
});
var subnetwork = new Gcp.Compute.Subnetwork("subnetwork", new()
{
Name = "tf-test-subnet_21563",
IpCidrRange = "10.0.0.0/28",
Region = "us-central1",
Network = network.SelfLink,
});
var basicHub = new Gcp.NetworkConnectivity.Hub("basic_hub", new()
{
Name = "hub",
Description = "A sample hub",
Labels =
{
{ "label-two", "value-one" },
},
PresetTopology = "HYBRID_INSPECTION",
});
var primary = new Gcp.NetworkConnectivity.Spoke("primary", new()
{
Name = "spoke-name",
Location = "us-central1",
Description = "A sample spoke of type Gateway",
Labels =
{
{ "label-one", "value-one" },
},
Hub = basicHub.Id,
Gateway = new Gcp.NetworkConnectivity.Inputs.SpokeGatewayArgs
{
IpRangeReservations = new[]
{
new Gcp.NetworkConnectivity.Inputs.SpokeGatewayIpRangeReservationArgs
{
IpRange = "10.0.0.0/23",
},
},
Capacity = "CAPACITY_1_GBPS",
},
Group = "gateways",
});
var @default = new Gcp.NetworkConnectivity.GatewayAdvertisedRoute("default", new()
{
Spoke = primary.Name,
Location = "us-central1",
Name = "gateway-advertised-route-name",
Labels =
{
{ "label-one", "value-one" },
},
Description = "description of the gateway advertised route",
IpRange = "0.0.0.0/24",
Recipient = "ADVERTISE_TO_HUB",
Priority = 200,
});
});
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.Hub;
import com.pulumi.gcp.networkconnectivity.HubArgs;
import com.pulumi.gcp.networkconnectivity.Spoke;
import com.pulumi.gcp.networkconnectivity.SpokeArgs;
import com.pulumi.gcp.networkconnectivity.inputs.SpokeGatewayArgs;
import com.pulumi.gcp.networkconnectivity.GatewayAdvertisedRoute;
import com.pulumi.gcp.networkconnectivity.GatewayAdvertisedRouteArgs;
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 network = new Network("network", NetworkArgs.builder()
.name("net-spoke")
.autoCreateSubnetworks(false)
.build());
var subnetwork = new Subnetwork("subnetwork", SubnetworkArgs.builder()
.name("tf-test-subnet_21563")
.ipCidrRange("10.0.0.0/28")
.region("us-central1")
.network(network.selfLink())
.build());
var basicHub = new Hub("basicHub", HubArgs.builder()
.name("hub")
.description("A sample hub")
.labels(Map.of("label-two", "value-one"))
.presetTopology("HYBRID_INSPECTION")
.build());
var primary = new Spoke("primary", SpokeArgs.builder()
.name("spoke-name")
.location("us-central1")
.description("A sample spoke of type Gateway")
.labels(Map.of("label-one", "value-one"))
.hub(basicHub.id())
.gateway(SpokeGatewayArgs.builder()
.ipRangeReservations(SpokeGatewayIpRangeReservationArgs.builder()
.ipRange("10.0.0.0/23")
.build())
.capacity("CAPACITY_1_GBPS")
.build())
.group("gateways")
.build());
var default_ = new GatewayAdvertisedRoute("default", GatewayAdvertisedRouteArgs.builder()
.spoke(primary.name())
.location("us-central1")
.name("gateway-advertised-route-name")
.labels(Map.of("label-one", "value-one"))
.description("description of the gateway advertised route")
.ipRange("0.0.0.0/24")
.recipient("ADVERTISE_TO_HUB")
.priority(200)
.build());
}
}
resources:
network:
type: gcp:compute:Network
properties:
name: net-spoke
autoCreateSubnetworks: false
subnetwork:
type: gcp:compute:Subnetwork
properties:
name: tf-test-subnet_21563
ipCidrRange: 10.0.0.0/28
region: us-central1
network: ${network.selfLink}
basicHub:
type: gcp:networkconnectivity:Hub
name: basic_hub
properties:
name: hub
description: A sample hub
labels:
label-two: value-one
presetTopology: HYBRID_INSPECTION
primary:
type: gcp:networkconnectivity:Spoke
properties:
name: spoke-name
location: us-central1
description: A sample spoke of type Gateway
labels:
label-one: value-one
hub: ${basicHub.id}
gateway:
ipRangeReservations:
- ipRange: 10.0.0.0/23
capacity: CAPACITY_1_GBPS
group: gateways
default:
type: gcp:networkconnectivity:GatewayAdvertisedRoute
properties:
spoke: ${primary.name}
location: us-central1
name: gateway-advertised-route-name
labels:
label-one: value-one
description: description of the gateway advertised route
ipRange: 0.0.0.0/24
recipient: ADVERTISE_TO_HUB
priority: 200
Create GatewayAdvertisedRoute Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GatewayAdvertisedRoute(name: string, args: GatewayAdvertisedRouteArgs, opts?: CustomResourceOptions);@overload
def GatewayAdvertisedRoute(resource_name: str,
args: GatewayAdvertisedRouteArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GatewayAdvertisedRoute(resource_name: str,
opts: Optional[ResourceOptions] = None,
location: Optional[str] = None,
spoke: Optional[str] = None,
description: Optional[str] = None,
ip_range: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
priority: Optional[int] = None,
project: Optional[str] = None,
recipient: Optional[str] = None)func NewGatewayAdvertisedRoute(ctx *Context, name string, args GatewayAdvertisedRouteArgs, opts ...ResourceOption) (*GatewayAdvertisedRoute, error)public GatewayAdvertisedRoute(string name, GatewayAdvertisedRouteArgs args, CustomResourceOptions? opts = null)
public GatewayAdvertisedRoute(String name, GatewayAdvertisedRouteArgs args)
public GatewayAdvertisedRoute(String name, GatewayAdvertisedRouteArgs args, CustomResourceOptions options)
type: gcp:networkconnectivity:GatewayAdvertisedRoute
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 GatewayAdvertisedRouteArgs
- 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 GatewayAdvertisedRouteArgs
- 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 GatewayAdvertisedRouteArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GatewayAdvertisedRouteArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GatewayAdvertisedRouteArgs
- 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 gatewayAdvertisedRouteResource = new Gcp.NetworkConnectivity.GatewayAdvertisedRoute("gatewayAdvertisedRouteResource", new()
{
Location = "string",
Spoke = "string",
Description = "string",
IpRange = "string",
Labels =
{
{ "string", "string" },
},
Name = "string",
Priority = 0,
Project = "string",
Recipient = "string",
});
example, err := networkconnectivity.NewGatewayAdvertisedRoute(ctx, "gatewayAdvertisedRouteResource", &networkconnectivity.GatewayAdvertisedRouteArgs{
Location: pulumi.String("string"),
Spoke: pulumi.String("string"),
Description: pulumi.String("string"),
IpRange: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
Priority: pulumi.Int(0),
Project: pulumi.String("string"),
Recipient: pulumi.String("string"),
})
var gatewayAdvertisedRouteResource = new GatewayAdvertisedRoute("gatewayAdvertisedRouteResource", GatewayAdvertisedRouteArgs.builder()
.location("string")
.spoke("string")
.description("string")
.ipRange("string")
.labels(Map.of("string", "string"))
.name("string")
.priority(0)
.project("string")
.recipient("string")
.build());
gateway_advertised_route_resource = gcp.networkconnectivity.GatewayAdvertisedRoute("gatewayAdvertisedRouteResource",
location="string",
spoke="string",
description="string",
ip_range="string",
labels={
"string": "string",
},
name="string",
priority=0,
project="string",
recipient="string")
const gatewayAdvertisedRouteResource = new gcp.networkconnectivity.GatewayAdvertisedRoute("gatewayAdvertisedRouteResource", {
location: "string",
spoke: "string",
description: "string",
ipRange: "string",
labels: {
string: "string",
},
name: "string",
priority: 0,
project: "string",
recipient: "string",
});
type: gcp:networkconnectivity:GatewayAdvertisedRoute
properties:
description: string
ipRange: string
labels:
string: string
location: string
name: string
priority: 0
project: string
recipient: string
spoke: string
GatewayAdvertisedRoute 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 GatewayAdvertisedRoute resource accepts the following input properties:
- Location string
- The location for the resource
- Spoke string
- The name of the spoke
- Description string
- An optional description of the gateway advertised route.
- Ip
Range string - This route's advertised IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128
- Labels Dictionary<string, string>
- Optional labels in key:value format. For more information about labels, see Requirements for labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field
effective_labelsfor all of the labels present on the resource. - Name string
- The name of the gateway advertised route. Route names must be unique.
- Priority int
- The priority of this advertised route. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Recipient string
- the recipient of this advertised route
Possible values are:
RECIPIENT_UNSPECIFIED,ADVERTISE_TO_HUB.
- Location string
- The location for the resource
- Spoke string
- The name of the spoke
- Description string
- An optional description of the gateway advertised route.
- Ip
Range string - This route's advertised IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128
- Labels map[string]string
- Optional labels in key:value format. For more information about labels, see Requirements for labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field
effective_labelsfor all of the labels present on the resource. - Name string
- The name of the gateway advertised route. Route names must be unique.
- Priority int
- The priority of this advertised route. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Recipient string
- the recipient of this advertised route
Possible values are:
RECIPIENT_UNSPECIFIED,ADVERTISE_TO_HUB.
- location String
- The location for the resource
- spoke String
- The name of the spoke
- description String
- An optional description of the gateway advertised route.
- ip
Range String - This route's advertised IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128
- labels Map<String,String>
- Optional labels in key:value format. For more information about labels, see Requirements for labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field
effective_labelsfor all of the labels present on the resource. - name String
- The name of the gateway advertised route. Route names must be unique.
- priority Integer
- The priority of this advertised route. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- recipient String
- the recipient of this advertised route
Possible values are:
RECIPIENT_UNSPECIFIED,ADVERTISE_TO_HUB.
- location string
- The location for the resource
- spoke string
- The name of the spoke
- description string
- An optional description of the gateway advertised route.
- ip
Range string - This route's advertised IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128
- labels {[key: string]: string}
- Optional labels in key:value format. For more information about labels, see Requirements for labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field
effective_labelsfor all of the labels present on the resource. - name string
- The name of the gateway advertised route. Route names must be unique.
- priority number
- The priority of this advertised route. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- recipient string
- the recipient of this advertised route
Possible values are:
RECIPIENT_UNSPECIFIED,ADVERTISE_TO_HUB.
- location str
- The location for the resource
- spoke str
- The name of the spoke
- description str
- An optional description of the gateway advertised route.
- ip_
range str - This route's advertised IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128
- labels Mapping[str, str]
- Optional labels in key:value format. For more information about labels, see Requirements for labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field
effective_labelsfor all of the labels present on the resource. - name str
- The name of the gateway advertised route. Route names must be unique.
- priority int
- The priority of this advertised route. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- recipient str
- the recipient of this advertised route
Possible values are:
RECIPIENT_UNSPECIFIED,ADVERTISE_TO_HUB.
- location String
- The location for the resource
- spoke String
- The name of the spoke
- description String
- An optional description of the gateway advertised route.
- ip
Range String - This route's advertised IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128
- labels Map<String>
- Optional labels in key:value format. For more information about labels, see Requirements for labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field
effective_labelsfor all of the labels present on the resource. - name String
- The name of the gateway advertised route. Route names must be unique.
- priority Number
- The priority of this advertised route. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- recipient String
- the recipient of this advertised route
Possible values are:
RECIPIENT_UNSPECIFIED,ADVERTISE_TO_HUB.
Outputs
All input properties are implicitly available as output properties. Additionally, the GatewayAdvertisedRoute resource produces the following output properties:
- Create
Time string - The time the gateway advertised route 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.
- Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- State string
- The current lifecycle state of this gateway advertised route.
- Unique
Id string - The Google-generated UUID for the gateway advertised route. This value is unique across all gateway advertised route resources. If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different uniqueId.
- Update
Time string - The time the gateway advertised route was last updated.
- Create
Time string - The time the gateway advertised route 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.
- Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- State string
- The current lifecycle state of this gateway advertised route.
- Unique
Id string - The Google-generated UUID for the gateway advertised route. This value is unique across all gateway advertised route resources. If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different uniqueId.
- Update
Time string - The time the gateway advertised route was last updated.
- create
Time String - The time the gateway advertised route 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.
- pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- state String
- The current lifecycle state of this gateway advertised route.
- unique
Id String - The Google-generated UUID for the gateway advertised route. This value is unique across all gateway advertised route resources. If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different uniqueId.
- update
Time String - The time the gateway advertised route was last updated.
- create
Time string - The time the gateway advertised route 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.
- pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- state string
- The current lifecycle state of this gateway advertised route.
- unique
Id string - The Google-generated UUID for the gateway advertised route. This value is unique across all gateway advertised route resources. If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different uniqueId.
- update
Time string - The time the gateway advertised route was last updated.
- create_
time str - The time the gateway advertised route 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.
- pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- state str
- The current lifecycle state of this gateway advertised route.
- unique_
id str - The Google-generated UUID for the gateway advertised route. This value is unique across all gateway advertised route resources. If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different uniqueId.
- update_
time str - The time the gateway advertised route was last updated.
- create
Time String - The time the gateway advertised route 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.
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- state String
- The current lifecycle state of this gateway advertised route.
- unique
Id String - The Google-generated UUID for the gateway advertised route. This value is unique across all gateway advertised route resources. If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different uniqueId.
- update
Time String - The time the gateway advertised route was last updated.
Look up Existing GatewayAdvertisedRoute Resource
Get an existing GatewayAdvertisedRoute 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?: GatewayAdvertisedRouteState, opts?: CustomResourceOptions): GatewayAdvertisedRoute@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
create_time: Optional[str] = None,
description: Optional[str] = None,
effective_labels: Optional[Mapping[str, str]] = None,
ip_range: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
location: Optional[str] = None,
name: Optional[str] = None,
priority: Optional[int] = None,
project: Optional[str] = None,
pulumi_labels: Optional[Mapping[str, str]] = None,
recipient: Optional[str] = None,
spoke: Optional[str] = None,
state: Optional[str] = None,
unique_id: Optional[str] = None,
update_time: Optional[str] = None) -> GatewayAdvertisedRoutefunc GetGatewayAdvertisedRoute(ctx *Context, name string, id IDInput, state *GatewayAdvertisedRouteState, opts ...ResourceOption) (*GatewayAdvertisedRoute, error)public static GatewayAdvertisedRoute Get(string name, Input<string> id, GatewayAdvertisedRouteState? state, CustomResourceOptions? opts = null)public static GatewayAdvertisedRoute get(String name, Output<String> id, GatewayAdvertisedRouteState state, CustomResourceOptions options)resources: _: type: gcp:networkconnectivity:GatewayAdvertisedRoute get: id: ${id}- 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.
- Create
Time string - The time the gateway advertised route was created.
- Description string
- An optional description of the gateway advertised route.
- 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.
- Ip
Range string - This route's advertised IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128
- Labels Dictionary<string, string>
- Optional labels in key:value format. For more information about labels, see Requirements for labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field
effective_labelsfor all of the labels present on the resource. - Location string
- The location for the resource
- Name string
- The name of the gateway advertised route. Route names must be unique.
- Priority int
- The priority of this advertised route. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.
- 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.
- Recipient string
- the recipient of this advertised route
Possible values are:
RECIPIENT_UNSPECIFIED,ADVERTISE_TO_HUB. - Spoke string
- The name of the spoke
- State string
- The current lifecycle state of this gateway advertised route.
- Unique
Id string - The Google-generated UUID for the gateway advertised route. This value is unique across all gateway advertised route resources. If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different uniqueId.
- Update
Time string - The time the gateway advertised route was last updated.
- Create
Time string - The time the gateway advertised route was created.
- Description string
- An optional description of the gateway advertised route.
- 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.
- Ip
Range string - This route's advertised IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128
- Labels map[string]string
- Optional labels in key:value format. For more information about labels, see Requirements for labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field
effective_labelsfor all of the labels present on the resource. - Location string
- The location for the resource
- Name string
- The name of the gateway advertised route. Route names must be unique.
- Priority int
- The priority of this advertised route. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.
- 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.
- Recipient string
- the recipient of this advertised route
Possible values are:
RECIPIENT_UNSPECIFIED,ADVERTISE_TO_HUB. - Spoke string
- The name of the spoke
- State string
- The current lifecycle state of this gateway advertised route.
- Unique
Id string - The Google-generated UUID for the gateway advertised route. This value is unique across all gateway advertised route resources. If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different uniqueId.
- Update
Time string - The time the gateway advertised route was last updated.
- create
Time String - The time the gateway advertised route was created.
- description String
- An optional description of the gateway advertised route.
- 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.
- ip
Range String - This route's advertised IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128
- labels Map<String,String>
- Optional labels in key:value format. For more information about labels, see Requirements for labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field
effective_labelsfor all of the labels present on the resource. - location String
- The location for the resource
- name String
- The name of the gateway advertised route. Route names must be unique.
- priority Integer
- The priority of this advertised route. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.
- 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.
- recipient String
- the recipient of this advertised route
Possible values are:
RECIPIENT_UNSPECIFIED,ADVERTISE_TO_HUB. - spoke String
- The name of the spoke
- state String
- The current lifecycle state of this gateway advertised route.
- unique
Id String - The Google-generated UUID for the gateway advertised route. This value is unique across all gateway advertised route resources. If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different uniqueId.
- update
Time String - The time the gateway advertised route was last updated.
- create
Time string - The time the gateway advertised route was created.
- description string
- An optional description of the gateway advertised route.
- 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.
- ip
Range string - This route's advertised IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128
- labels {[key: string]: string}
- Optional labels in key:value format. For more information about labels, see Requirements for labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field
effective_labelsfor all of the labels present on the resource. - location string
- The location for the resource
- name string
- The name of the gateway advertised route. Route names must be unique.
- priority number
- The priority of this advertised route. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.
- 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.
- recipient string
- the recipient of this advertised route
Possible values are:
RECIPIENT_UNSPECIFIED,ADVERTISE_TO_HUB. - spoke string
- The name of the spoke
- state string
- The current lifecycle state of this gateway advertised route.
- unique
Id string - The Google-generated UUID for the gateway advertised route. This value is unique across all gateway advertised route resources. If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different uniqueId.
- update
Time string - The time the gateway advertised route was last updated.
- create_
time str - The time the gateway advertised route was created.
- description str
- An optional description of the gateway advertised route.
- 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.
- ip_
range str - This route's advertised IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128
- labels Mapping[str, str]
- Optional labels in key:value format. For more information about labels, see Requirements for labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field
effective_labelsfor all of the labels present on the resource. - location str
- The location for the resource
- name str
- The name of the gateway advertised route. Route names must be unique.
- priority int
- The priority of this advertised route. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.
- 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.
- recipient str
- the recipient of this advertised route
Possible values are:
RECIPIENT_UNSPECIFIED,ADVERTISE_TO_HUB. - spoke str
- The name of the spoke
- state str
- The current lifecycle state of this gateway advertised route.
- unique_
id str - The Google-generated UUID for the gateway advertised route. This value is unique across all gateway advertised route resources. If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different uniqueId.
- update_
time str - The time the gateway advertised route was last updated.
- create
Time String - The time the gateway advertised route was created.
- description String
- An optional description of the gateway advertised route.
- 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.
- ip
Range String - This route's advertised IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128
- labels Map<String>
- Optional labels in key:value format. For more information about labels, see Requirements for labels.
Note: This field is non-authoritative, and will only manage the labels present in your configuration.
Please refer to the field
effective_labelsfor all of the labels present on the resource. - location String
- The location for the resource
- name String
- The name of the gateway advertised route. Route names must be unique.
- priority Number
- The priority of this advertised route. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.
- 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.
- recipient String
- the recipient of this advertised route
Possible values are:
RECIPIENT_UNSPECIFIED,ADVERTISE_TO_HUB. - spoke String
- The name of the spoke
- state String
- The current lifecycle state of this gateway advertised route.
- unique
Id String - The Google-generated UUID for the gateway advertised route. This value is unique across all gateway advertised route resources. If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different uniqueId.
- update
Time String - The time the gateway advertised route was last updated.
Import
GatewayAdvertisedRoute can be imported using any of these accepted formats:
projects/{{project}}/locations/{{location}}/spokes/{{spoke}}/gatewayAdvertisedRoutes/{{name}}{{project}}/{{location}}/{{spoke}}/{{name}}{{location}}/{{spoke}}/{{name}}
When using the pulumi import command, GatewayAdvertisedRoute can be imported using one of the formats above. For example:
$ pulumi import gcp:networkconnectivity/gatewayAdvertisedRoute:GatewayAdvertisedRoute default projects/{{project}}/locations/{{location}}/spokes/{{spoke}}/gatewayAdvertisedRoutes/{{name}}
$ pulumi import gcp:networkconnectivity/gatewayAdvertisedRoute:GatewayAdvertisedRoute default {{project}}/{{location}}/{{spoke}}/{{name}}
$ pulumi import gcp:networkconnectivity/gatewayAdvertisedRoute:GatewayAdvertisedRoute default {{location}}/{{spoke}}/{{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-betaTerraform Provider.
