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. Hub

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.Hub

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

    Creates a new Network Connectivity Center hub in the specified project. Auto-naming is currently not supported for this resource.

    Create Hub Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Hub(name: string, args: HubArgs, opts?: CustomResourceOptions);
    @overload
def Hub(resource_name: str,
        args: HubArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def Hub(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        hub_id: Optional[str] = None,
        description: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        request_id: Optional[str] = None,
        routing_vpcs: Optional[Sequence[RoutingVPCArgs]] = None)
    func NewHub(ctx *Context, name string, args HubArgs, opts ...ResourceOption) (*Hub, error)
    public Hub(string name, HubArgs args, CustomResourceOptions? opts = null)
    public Hub(String name, HubArgs args)
public Hub(String name, HubArgs args, CustomResourceOptions options)

    type: google-native:networkconnectivity/v1:Hub
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 HubArgs
    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 HubArgs
    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 HubArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HubArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HubArgs
    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 hubResource = new GoogleNative.NetworkConnectivity.V1.Hub("hubResource", new()
{
    HubId = "string",
    Description = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
    Project = "string",
    RequestId = "string",
    RoutingVpcs = new[]
    {
        new GoogleNative.NetworkConnectivity.V1.Inputs.RoutingVPCArgs
        {
            Uri = "string",
        },
    },
});

    example, err := networkconnectivity.NewHub(ctx, "hubResource", &networkconnectivity.HubArgs{
	HubId:       pulumi.String("string"),
	Description: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:      pulumi.String("string"),
	Project:   pulumi.String("string"),
	RequestId: pulumi.String("string"),
	RoutingVpcs: networkconnectivity.RoutingVPCArray{
		&networkconnectivity.RoutingVPCArgs{
			Uri: pulumi.String("string"),
		},
	},
})

    var hubResource = new Hub("hubResource", HubArgs.builder()
    .hubId("string")
    .description("string")
    .labels(Map.of("string", "string"))
    .name("string")
    .project("string")
    .requestId("string")
    .routingVpcs(RoutingVPCArgs.builder()
        .uri("string")
        .build())
    .build());

    hub_resource = google_native.networkconnectivity.v1.Hub("hubResource",
    hub_id="string",
    description="string",
    labels={
        "string": "string",
    },
    name="string",
    project="string",
    request_id="string",
    routing_vpcs=[{
        "uri": "string",
    }])

    const hubResource = new google_native.networkconnectivity.v1.Hub("hubResource", {
    hubId: "string",
    description: "string",
    labels: {
        string: "string",
    },
    name: "string",
    project: "string",
    requestId: "string",
    routingVpcs: [{
        uri: "string",
    }],
});

    type: google-native:networkconnectivity/v1:Hub
properties:
    description: string
    hubId: string
    labels:
        string: string
    name: string
    project: string
    requestId: string
    routingVpcs:
        - uri: string

    Hub 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 Hub resource accepts the following input properties:

    HubId string
    Required. A unique identifier for the hub.
    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}
    Project string
    RequestId string
    Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    RoutingVpcs List<Pulumi.GoogleNative.NetworkConnectivity.V1.Inputs.RoutingVPC>
    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.
    HubId string
    Required. A unique identifier for the hub.
    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}
    Project string
    RequestId string
    Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    RoutingVpcs []RoutingVPCArgs
    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.
    hubId String
    Required. A unique identifier for the hub.
    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}
    project String
    requestId String
    Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    routingVpcs List<RoutingVPC>
    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.
    hubId string
    Required. A unique identifier for the hub.
    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}
    project string
    requestId string
    Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    routingVpcs RoutingVPC[]
    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.
    hub_id str
    Required. A unique identifier for the hub.
    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}
    project str
    request_id str
    Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    routing_vpcs Sequence[RoutingVPCArgs]
    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.
    hubId String
    Required. A unique identifier for the hub.
    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}
    project String
    requestId String
    Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Hub resource produces the following output properties:

    CreateTime string
    The time the hub was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    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

    RoutingVPC, RoutingVPCArgs

    Uri string
    The URI of the VPC network.
    Uri string
    The URI of the VPC network.
    uri String
    The URI of the VPC network.
    uri string
    The URI of the VPC network.
    uri str
    The URI of the VPC network.
    uri String
    The URI of the VPC network.

    RoutingVPCResponse, RoutingVPCResponseArgs

    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, SpokeStateCountResponseArgs

    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, SpokeStateReasonCountResponseArgs

    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, SpokeSummaryResponseArgs

    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, SpokeTypeCountResponseArgs

    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