Parameter |
Choices/Defaults |
Comments |
auth_kind
required |
Choices:
- machineaccount
- serviceaccount
- application
|
The type of credential used.
|
bgp
|
|
BGP information specific to this router.
|
|
asn
required |
|
Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
|
|
advertise_mode
|
Choices:
DEFAULT ←
- CUSTOM
|
User-specified flag to indicate which mode to use for advertisement.
Valid values of this enum field are: DEFAULT, CUSTOM .
|
|
advertised_groups
|
|
User-specified list of prefix groups to advertise in custom mode.
This field can only be populated if advertiseMode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.
This enum field has the one valid value: ALL_SUBNETS .
|
|
advertised_ip_ranges
|
|
User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertiseMode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups.
Leave this field blank to advertise no custom IP ranges.
|
|
|
range
|
|
The IP range to advertise. The value must be a CIDR-formatted string.
|
|
|
description
|
|
User-specified description for the IP range.
|
description
|
|
An optional description of this resource.
|
name
required |
|
Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
|
network
required |
|
A reference to the network to which this router belongs.
|
project
|
Default:
None
|
The Google Cloud Platform project to use.
|
region
required |
|
Region where the router resides.
|
scopes
|
|
Array of scopes to be used.
|
service_account_email
|
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
|
service_account_file
|
|
The path of a Service Account JSON file if serviceaccount is selected as type.
|
state
|
Choices:
present ←
- absent
|
Whether the given object should exist in GCP
|