gcp_networkconnectivity_hub
ancestors
Type: UNORDERED_LIST_STRING
create_time
Type: TIMESTAMP
Provider name: createTime
Description: Output only. The time the hub was created.
description
Type: STRING
Provider name: description
Description: Optional. An optional description of the hub.
export_psc
Type: BOOLEAN
Provider name: exportPsc
Description: Optional. Whether Private Service Connect connection propagation is enabled for the hub. If true, Private Service Connect endpoints in VPC spokes attached to the hub are made accessible to other VPC spokes attached to the hub. The default value is false.
labels
Type: UNORDERED_LIST_STRING
name
Type: STRING
Provider name: name
Description: Immutable. The name of the hub. Hub names must be unique. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}
organization_id
Type: STRING
parent
Type: STRING
policy_mode
Type: STRING
Provider name: policyMode
Description: Optional. The policy mode of this hub. This field can be either PRESET or CUSTOM. If unspecified, the policy_mode defaults to PRESET.
Possible values:
POLICY_MODE_UNSPECIFIED
- Policy mode is unspecified. It defaults to PRESET with preset_topology = MESH.
PRESET
- Hub uses one of the preset topologies.
preset_topology
Type: STRING
Provider name: presetTopology
Description: Optional. The topology implemented in this hub. Currently, this field is only used when policy_mode = PRESET. The available preset topologies are MESH and STAR. If preset_topology is unspecified and policy_mode = PRESET, the preset_topology defaults to MESH. When policy_mode = CUSTOM, the preset_topology is set to PRESET_TOPOLOGY_UNSPECIFIED.
Possible values:
PRESET_TOPOLOGY_UNSPECIFIED
- Preset topology is unspecified. When policy_mode = PRESET, it defaults to MESH.
MESH
- Mesh topology is implemented. Group default
is automatically created. All spokes in the hub are added to group default
.
STAR
- Star topology is implemented. Two groups, center
and edge
, are automatically created along with hub creation. Spokes have to join one of the groups during creation.
project_id
Type: STRING
project_number
Type: STRING
resource_name
Type: STRING
route_tables
Type: UNORDERED_LIST_STRING
Provider name: routeTables
Description: Output only. The route tables that belong to this hub. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}
This field is read-only. Network Connectivity Center automatically populates it based on the route tables nested under the hub.
routing_vpcs
Type: UNORDERED_LIST_STRUCT
Provider name: routingVpcs
Description: The VPC networks associated with this hub’s spokes. This field is read-only. Network Connectivity Center automatically populates it based on the set of spokes attached to the hub.
required_for_new_site_to_site_data_transfer_spokes
Type: BOOLEAN
Provider name: requiredForNewSiteToSiteDataTransferSpokes
Description: Output only. If true, indicates that this VPC network is currently associated with spokes that use the data transfer feature (spokes where the site_to_site_data_transfer field is set to true). If you create new spokes that use data transfer, they must be associated with this VPC network. At most, one VPC network will have this field set to true.
uri
Type: STRING
Provider name: uri
Description: The URI of the VPC network.
spoke_summary
Type: STRUCT
Provider name: spokeSummary
Description: Output only. A summary of the spokes associated with a hub. The summary includes a count of spokes according to type and according to state. If any spokes are inactive, the summary also lists the reasons they are inactive, including a count for each reason.
spoke_state_counts
Type: UNORDERED_LIST_STRUCT
Provider name: spokeStateCounts
Description: Output only. Counts the number of spokes that are in each state and associated with a given hub.
count
Type: INT64
Provider name: count
Description: Output only. The total number of spokes that are in this state and associated with a given hub.
state
Type: STRING
Provider name: state
Description: Output only. The state of the spokes.
Possible values:
STATE_UNSPECIFIED
- No state information available
CREATING
- The resource’s create operation is in progress.
ACTIVE
- The resource is active
DELETING
- The resource’s delete operation is in progress.
ACCEPTING
- The resource’s accept operation is in progress.
REJECTING
- The resource’s reject operation is in progress.
UPDATING
- The resource’s update operation is in progress.
INACTIVE
- The resource is inactive.
OBSOLETE
- The hub associated with this spoke resource has been deleted. This state applies to spoke resources only.
FAILED
- The resource is in an undefined state due to resource creation or deletion failure. You can try to delete the resource later or contact support for help.
spoke_state_reason_counts
Type: UNORDERED_LIST_STRUCT
Provider name: spokeStateReasonCounts
Description: Output only. Counts the number of spokes that are inactive for each possible reason and associated with a given hub.
count
Type: INT64
Provider name: count
Description: Output only. The total number of spokes that are inactive for a particular reason and associated with a given hub.
state_reason_code
Type: STRING
Provider name: stateReasonCode
Description: Output only. The reason that a spoke is inactive.
Possible values:
CODE_UNSPECIFIED
- No information available.
PENDING_REVIEW
- The proposed spoke is pending review.
REJECTED
- The proposed spoke has been rejected by the hub administrator.
PAUSED
- The spoke has been deactivated internally.
FAILED
- Network Connectivity Center encountered errors while accepting the spoke.
UPDATE_PENDING_REVIEW
- The proposed spoke update is pending review.
UPDATE_REJECTED
- The proposed spoke update has been rejected by the hub administrator.
UPDATE_FAILED
- Network Connectivity Center encountered errors while accepting the spoke update.
spoke_type_counts
Type: UNORDERED_LIST_STRUCT
Provider name: spokeTypeCounts
Description: Output only. Counts the number of spokes of each type that are associated with a specific hub.
count
Type: INT64
Provider name: count
Description: Output only. The total number of spokes of this type that are associated with the hub.
spoke_type
Type: STRING
Provider name: spokeType
Description: Output only. The type of the spokes.
Possible values:
SPOKE_TYPE_UNSPECIFIED
- Unspecified spoke type.
VPN_TUNNEL
- Spokes associated with VPN tunnels.
INTERCONNECT_ATTACHMENT
- Spokes associated with VLAN attachments.
ROUTER_APPLIANCE
- Spokes associated with router appliance instances.
VPC_NETWORK
- Spokes associated with VPC networks.
PRODUCER_VPC_NETWORK
- Spokes that are backed by a producer VPC network.
state
Type: STRING
Provider name: state
Description: Output only. The current lifecycle state of this hub.
Possible values:
STATE_UNSPECIFIED
- No state information available
CREATING
- The resource’s create operation is in progress.
ACTIVE
- The resource is active
DELETING
- The resource’s delete operation is in progress.
ACCEPTING
- The resource’s accept operation is in progress.
REJECTING
- The resource’s reject operation is in progress.
UPDATING
- The resource’s update operation is in progress.
INACTIVE
- The resource is inactive.
OBSOLETE
- The hub associated with this spoke resource has been deleted. This state applies to spoke resources only.
FAILED
- The resource is in an undefined state due to resource creation or deletion failure. You can try to delete the resource later or contact support for help.
Type: UNORDERED_LIST_STRING
unique_id
Type: STRING
Provider name: uniqueId
Description: Output only. The Google-generated UUID for the hub. This value is unique across all hub resources. If a hub is deleted and another with the same name is created, the new hub is assigned a different unique_id.
update_time
Type: TIMESTAMP
Provider name: updateTime
Description: Output only. The time the hub was last updated.