|
| 1 | +# Copyright 2025 Google Inc. |
| 2 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 3 | +# you may not use this file except in compliance with the License. |
| 4 | +# You may obtain a copy of the License at |
| 5 | +# |
| 6 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 7 | +# |
| 8 | +# Unless required by applicable law or agreed to in writing, software |
| 9 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 10 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 11 | +# See the License for the specific language governing permissions and |
| 12 | +# limitations under the License. |
| 13 | + |
| 14 | +--- |
| 15 | +# API resource name |
| 16 | +name: 'GatewayAdvertisedRoute' |
| 17 | +# Resource description for the provider documentation. |
| 18 | +description: | |
| 19 | + A gateway advertised route is a route that a gateway spoke advertises somewhere. |
| 20 | +references: |
| 21 | + guides: |
| 22 | + 'QUICKSTART_TITLE': 'https://docs.cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/ncc-gateway-overview' |
| 23 | + api: 'https://docs.cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest/v1beta/projects.locations.spokes.gatewayAdvertisedRoutes' |
| 24 | +min_version: beta |
| 25 | +base_url: 'projects/{{project}}/locations/{{location}}/spokes/{{spoke}}/gatewayAdvertisedRoutes' |
| 26 | +self_link: 'projects/{{project}}/locations/{{location}}/spokes/{{spoke}}/gatewayAdvertisedRoutes/{{name}}' |
| 27 | +create_url: 'projects/{{project}}/locations/{{location}}/spokes/{{spoke}}/gatewayAdvertisedRoutes?gatewayAdvertisedRouteId={{name}}' |
| 28 | +immutable: true |
| 29 | +autogen_async: true |
| 30 | +async: |
| 31 | + operation: |
| 32 | + base_url: '{{op_id}}' |
| 33 | +examples: |
| 34 | + - name: 'network_connectivity_gateway_advertised_route_basic' |
| 35 | + min_version: beta |
| 36 | + primary_resource_id: 'default' |
| 37 | + vars: |
| 38 | + resource_name: 'gateway-advertised-route-name' |
| 39 | + spoke_name: 'spoke-name' |
| 40 | + network_name: 'net-spoke' |
| 41 | + hub_name: 'hub' |
| 42 | +parameters: |
| 43 | + - name: 'location' |
| 44 | + type: String |
| 45 | + required: true |
| 46 | + immutable: true |
| 47 | + url_param_only: true |
| 48 | + description: | |
| 49 | + The location for the resource |
| 50 | + - name: 'spoke' |
| 51 | + type: String |
| 52 | + required: true |
| 53 | + immutable: true |
| 54 | + url_param_only: true |
| 55 | + description: | |
| 56 | + The name of the spoke |
| 57 | +properties: |
| 58 | + - name: 'name' |
| 59 | + type: String |
| 60 | + description: The name of the gateway advertised route. Route names must be unique. |
| 61 | + required: true |
| 62 | + immutable: true |
| 63 | + custom_flatten: 'templates/terraform/custom_flatten/id_from_name.tmpl' |
| 64 | + - name: 'createTime' |
| 65 | + type: String |
| 66 | + description: The time the gateway advertised route was created. |
| 67 | + output: true |
| 68 | + - name: 'updateTime' |
| 69 | + type: String |
| 70 | + description: The time the gateway advertised route was last updated. |
| 71 | + output: true |
| 72 | + - name: 'labels' |
| 73 | + type: KeyValueLabels |
| 74 | + description: Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements). |
| 75 | + - name: 'description' |
| 76 | + type: String |
| 77 | + description: An optional description of the gateway advertised route. |
| 78 | + - name: 'uniqueId' |
| 79 | + type: String |
| 80 | + description: | |
| 81 | + The Google-generated UUID for the gateway advertised route. |
| 82 | + This value is unique across all gateway advertised route resources. |
| 83 | + If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different uniqueId. |
| 84 | + output: true |
| 85 | + - name: 'state' |
| 86 | + type: Enum |
| 87 | + description: The current lifecycle state of this gateway advertised route. |
| 88 | + enum_values: |
| 89 | + - 'STATE_UNSPECIFIED' |
| 90 | + - 'CREATING' |
| 91 | + - 'ACTIVE' |
| 92 | + - 'DELETING' |
| 93 | + - 'ACCEPTING' |
| 94 | + - 'REJECTING' |
| 95 | + - 'UPDATING' |
| 96 | + - 'INACTIVE' |
| 97 | + - 'OBSOLETE' |
| 98 | + - 'FAILED' |
| 99 | + output: true |
| 100 | + - name: 'ipRange' |
| 101 | + type: String |
| 102 | + description: | |
| 103 | + This route's advertised IP address range. Must be a valid CIDR-formatted prefix. |
| 104 | + 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 |
| 105 | + immutable: true |
| 106 | + - name: 'recipient' |
| 107 | + type: Enum |
| 108 | + description: 'the recipient of this advertised route' |
| 109 | + enum_values: |
| 110 | + - 'RECIPIENT_UNSPECIFIED' |
| 111 | + - 'ADVERTISE_TO_HUB' |
| 112 | + - name: 'priority' |
| 113 | + type: Integer |
| 114 | + description: | |
| 115 | + The priority of this advertised route. You can choose a value from 0 to 65335. |
| 116 | + If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges. |
0 commit comments