Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. networkconnectivity
  5. networkconnectivity/v1
  6. getHub

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.networkconnectivity/v1.getHub

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Gets details about a Network Connectivity Center hub.

    Using getHub

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getHub(args: GetHubArgs, opts?: InvokeOptions): Promise<GetHubResult>
function getHubOutput(args: GetHubOutputArgs, opts?: InvokeOptions): Output<GetHubResult>
    def get_hub(hub_id: Optional[str] = None,
            project: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetHubResult
def get_hub_output(hub_id: Optional[pulumi.Input[str]] = None,
            project: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetHubResult]
    func LookupHub(ctx *Context, args *LookupHubArgs, opts ...InvokeOption) (*LookupHubResult, error)
func LookupHubOutput(ctx *Context, args *LookupHubOutputArgs, opts ...InvokeOption) LookupHubResultOutput

    > Note: This function is named LookupHub in the Go SDK.

    public static class GetHub 
{
    public static Task<GetHubResult> InvokeAsync(GetHubArgs args, InvokeOptions? opts = null)
    public static Output<GetHubResult> Invoke(GetHubInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetHubResult> getHub(GetHubArgs args, InvokeOptions options)
public static Output<GetHubResult> getHub(GetHubArgs args, InvokeOptions options)

    fn::invoke:
  function: google-native:networkconnectivity/v1:getHub
  arguments:
    # arguments dictionary

    The following arguments are supported:

    HubId string
    Project string
    HubId string
    Project string
    hubId String
    project String
    hubId string
    project string
    hubId String
    project String

    getHub Result

    The following output properties are available:

    CreateTime string
    The time the hub was created.
    Description string
    An optional description of the hub.
    Labels Dictionary<string, string>
    Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
    Name string
    Immutable. The name of the hub. Hub names must be unique. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}
    RouteTables List<string>
    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.
    RoutingVpcs List<Pulumi.GoogleNative.NetworkConnectivity.V1.Outputs.RoutingVPCResponse>
    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.
    SpokeSummary Pulumi.GoogleNative.NetworkConnectivity.V1.Outputs.SpokeSummaryResponse
    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.
    State string
    The current lifecycle state of this hub.
    UniqueId string
    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.
    UpdateTime string
    The time the hub was last updated.
    CreateTime string
    The time the hub was created.
    Description string
    An optional description of the hub.
    Labels map[string]string
    Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
    Name string
    Immutable. The name of the hub. Hub names must be unique. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}
    RouteTables []string
    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.
    RoutingVpcs []RoutingVPCResponse
    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.
    SpokeSummary SpokeSummaryResponse
    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.
    State string
    The current lifecycle state of this hub.
    UniqueId string
    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.
    UpdateTime string
    The time the hub was last updated.
    createTime String
    The time the hub was created.
    description String
    An optional description of the hub.
    labels Map<String,String>
    Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
    name String
    Immutable. The name of the hub. Hub names must be unique. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}
    routeTables List<String>
    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.
    routingVpcs List<RoutingVPCResponse>
    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.
    spokeSummary SpokeSummaryResponse
    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.
    state String
    The current lifecycle state of this hub.
    uniqueId String
    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.
    updateTime String
    The time the hub was last updated.
    createTime string
    The time the hub was created.
    description string
    An optional description of the hub.
    labels {[key: string]: string}
    Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
    name string
    Immutable. The name of the hub. Hub names must be unique. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}
    routeTables string[]
    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.
    routingVpcs RoutingVPCResponse[]
    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.
    spokeSummary SpokeSummaryResponse
    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.
    state string
    The current lifecycle state of this hub.
    uniqueId string
    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.
    updateTime string
    The time the hub was last updated.
    create_time str
    The time the hub was created.
    description str
    An optional description of the hub.
    labels Mapping[str, str]
    Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
    name str
    Immutable. The name of the hub. Hub names must be unique. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}
    route_tables Sequence[str]
    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 Sequence[RoutingVPCResponse]
    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.
    spoke_summary SpokeSummaryResponse
    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.
    state str
    The current lifecycle state of this hub.
    unique_id str
    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 str
    The time the hub was last updated.
    createTime String
    The time the hub was created.
    description String
    An optional description of the hub.
    labels Map<String>
    Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
    name String
    Immutable. The name of the hub. Hub names must be unique. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}
    routeTables List<String>
    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.
    routingVpcs List<Property Map>
    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.
    spokeSummary Property Map
    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.
    state String
    The current lifecycle state of this hub.
    uniqueId String
    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.
    updateTime String
    The time the hub was last updated.

    Supporting Types

    RoutingVPCResponse

    RequiredForNewSiteToSiteDataTransferSpokes bool
    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 string
    The URI of the VPC network.
    RequiredForNewSiteToSiteDataTransferSpokes bool
    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 string
    The URI of the VPC network.
    requiredForNewSiteToSiteDataTransferSpokes Boolean
    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 String
    The URI of the VPC network.
    requiredForNewSiteToSiteDataTransferSpokes boolean
    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 string
    The URI of the VPC network.
    required_for_new_site_to_site_data_transfer_spokes bool
    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 str
    The URI of the VPC network.
    requiredForNewSiteToSiteDataTransferSpokes Boolean
    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 String
    The URI of the VPC network.

    SpokeStateCountResponse

    Count string
    The total number of spokes that are in this state and associated with a given hub.
    State string
    The state of the spokes.
    Count string
    The total number of spokes that are in this state and associated with a given hub.
    State string
    The state of the spokes.
    count String
    The total number of spokes that are in this state and associated with a given hub.
    state String
    The state of the spokes.
    count string
    The total number of spokes that are in this state and associated with a given hub.
    state string
    The state of the spokes.
    count str
    The total number of spokes that are in this state and associated with a given hub.
    state str
    The state of the spokes.
    count String
    The total number of spokes that are in this state and associated with a given hub.
    state String
    The state of the spokes.

    SpokeStateReasonCountResponse

    Count string
    The total number of spokes that are inactive for a particular reason and associated with a given hub.
    StateReasonCode string
    The reason that a spoke is inactive.
    Count string
    The total number of spokes that are inactive for a particular reason and associated with a given hub.
    StateReasonCode string
    The reason that a spoke is inactive.
    count String
    The total number of spokes that are inactive for a particular reason and associated with a given hub.
    stateReasonCode String
    The reason that a spoke is inactive.
    count string
    The total number of spokes that are inactive for a particular reason and associated with a given hub.
    stateReasonCode string
    The reason that a spoke is inactive.
    count str
    The total number of spokes that are inactive for a particular reason and associated with a given hub.
    state_reason_code str
    The reason that a spoke is inactive.
    count String
    The total number of spokes that are inactive for a particular reason and associated with a given hub.
    stateReasonCode String
    The reason that a spoke is inactive.

    SpokeSummaryResponse

    SpokeStateCounts List<Pulumi.GoogleNative.NetworkConnectivity.V1.Inputs.SpokeStateCountResponse>
    Counts the number of spokes that are in each state and associated with a given hub.
    SpokeStateReasonCounts List<Pulumi.GoogleNative.NetworkConnectivity.V1.Inputs.SpokeStateReasonCountResponse>
    Counts the number of spokes that are inactive for each possible reason and associated with a given hub.
    SpokeTypeCounts List<Pulumi.GoogleNative.NetworkConnectivity.V1.Inputs.SpokeTypeCountResponse>
    Counts the number of spokes of each type that are associated with a specific hub.
    SpokeStateCounts []SpokeStateCountResponse
    Counts the number of spokes that are in each state and associated with a given hub.
    SpokeStateReasonCounts []SpokeStateReasonCountResponse
    Counts the number of spokes that are inactive for each possible reason and associated with a given hub.
    SpokeTypeCounts []SpokeTypeCountResponse
    Counts the number of spokes of each type that are associated with a specific hub.
    spokeStateCounts List<SpokeStateCountResponse>
    Counts the number of spokes that are in each state and associated with a given hub.
    spokeStateReasonCounts List<SpokeStateReasonCountResponse>
    Counts the number of spokes that are inactive for each possible reason and associated with a given hub.
    spokeTypeCounts List<SpokeTypeCountResponse>
    Counts the number of spokes of each type that are associated with a specific hub.
    spokeStateCounts SpokeStateCountResponse[]
    Counts the number of spokes that are in each state and associated with a given hub.
    spokeStateReasonCounts SpokeStateReasonCountResponse[]
    Counts the number of spokes that are inactive for each possible reason and associated with a given hub.
    spokeTypeCounts SpokeTypeCountResponse[]
    Counts the number of spokes of each type that are associated with a specific hub.
    spoke_state_counts Sequence[SpokeStateCountResponse]
    Counts the number of spokes that are in each state and associated with a given hub.
    spoke_state_reason_counts Sequence[SpokeStateReasonCountResponse]
    Counts the number of spokes that are inactive for each possible reason and associated with a given hub.
    spoke_type_counts Sequence[SpokeTypeCountResponse]
    Counts the number of spokes of each type that are associated with a specific hub.
    spokeStateCounts List<Property Map>
    Counts the number of spokes that are in each state and associated with a given hub.
    spokeStateReasonCounts List<Property Map>
    Counts the number of spokes that are inactive for each possible reason and associated with a given hub.
    spokeTypeCounts List<Property Map>
    Counts the number of spokes of each type that are associated with a specific hub.

    SpokeTypeCountResponse

    Count string
    The total number of spokes of this type that are associated with the hub.
    SpokeType string
    The type of the spokes.
    Count string
    The total number of spokes of this type that are associated with the hub.
    SpokeType string
    The type of the spokes.
    count String
    The total number of spokes of this type that are associated with the hub.
    spokeType String
    The type of the spokes.
    count string
    The total number of spokes of this type that are associated with the hub.
    spokeType string
    The type of the spokes.
    count str
    The total number of spokes of this type that are associated with the hub.
    spoke_type str
    The type of the spokes.
    count String
    The total number of spokes of this type that are associated with the hub.
    spokeType String
    The type of the spokes.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native