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

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/v1alpha1.Spoke

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 Network Connectivity Center spoke.

    Create Spoke Resource

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

    Constructor syntax

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

@overload
def Spoke(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          create_time: Optional[str] = None,
          description: Optional[str] = None,
          hub: Optional[str] = None,
          labels: Optional[Mapping[str, str]] = None,
          linked_interconnect_attachments: Optional[Sequence[str]] = None,
          linked_router_appliance_instances: Optional[Sequence[RouterApplianceInstanceArgs]] = None,
          linked_vpn_tunnels: Optional[Sequence[str]] = None,
          location: Optional[str] = None,
          name: Optional[str] = None,
          project: Optional[str] = None,
          request_id: Optional[str] = None,
          spoke_id: Optional[str] = None,
          update_time: Optional[str] = None)
    func NewSpoke(ctx *Context, name string, args *SpokeArgs, opts ...ResourceOption) (*Spoke, error)
    public Spoke(string name, SpokeArgs? args = null, CustomResourceOptions? opts = null)
    public Spoke(String name, SpokeArgs args)
public Spoke(String name, SpokeArgs args, CustomResourceOptions options)

    type: google-native:networkconnectivity/v1alpha1:Spoke
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 SpokeArgs
    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 SpokeArgs
    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 SpokeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SpokeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SpokeArgs
    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 google_nativeSpokeResource = new GoogleNative.NetworkConnectivity.V1Alpha1.Spoke("google-nativeSpokeResource", new()
{
    CreateTime = "string",
    Description = "string",
    Hub = "string",
    Labels = 
    {
        { "string", "string" },
    },
    LinkedInterconnectAttachments = new[]
    {
        "string",
    },
    LinkedRouterApplianceInstances = new[]
    {
        new GoogleNative.NetworkConnectivity.V1Alpha1.Inputs.RouterApplianceInstanceArgs
        {
            IpAddress = "string",
            NetworkInterface = "string",
            VirtualMachine = "string",
        },
    },
    LinkedVpnTunnels = new[]
    {
        "string",
    },
    Location = "string",
    Name = "string",
    Project = "string",
    RequestId = "string",
    SpokeId = "string",
    UpdateTime = "string",
});

    example, err := networkconnectivityv1alpha1.NewSpoke(ctx, "google-nativeSpokeResource", &networkconnectivityv1alpha1.SpokeArgs{
	CreateTime:  pulumi.String("string"),
	Description: pulumi.String("string"),
	Hub:         pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	LinkedInterconnectAttachments: pulumi.StringArray{
		pulumi.String("string"),
	},
	LinkedRouterApplianceInstances: networkconnectivity.RouterApplianceInstanceArray{
		&networkconnectivity.RouterApplianceInstanceArgs{
			IpAddress:        pulumi.String("string"),
			NetworkInterface: pulumi.String("string"),
			VirtualMachine:   pulumi.String("string"),
		},
	},
	LinkedVpnTunnels: pulumi.StringArray{
		pulumi.String("string"),
	},
	Location:   pulumi.String("string"),
	Name:       pulumi.String("string"),
	Project:    pulumi.String("string"),
	RequestId:  pulumi.String("string"),
	SpokeId:    pulumi.String("string"),
	UpdateTime: pulumi.String("string"),
})

    var google_nativeSpokeResource = new Spoke("google-nativeSpokeResource", SpokeArgs.builder()
    .createTime("string")
    .description("string")
    .hub("string")
    .labels(Map.of("string", "string"))
    .linkedInterconnectAttachments("string")
    .linkedRouterApplianceInstances(RouterApplianceInstanceArgs.builder()
        .ipAddress("string")
        .networkInterface("string")
        .virtualMachine("string")
        .build())
    .linkedVpnTunnels("string")
    .location("string")
    .name("string")
    .project("string")
    .requestId("string")
    .spokeId("string")
    .updateTime("string")
    .build());

    google_native_spoke_resource = google_native.networkconnectivity.v1alpha1.Spoke("google-nativeSpokeResource",
    create_time="string",
    description="string",
    hub="string",
    labels={
        "string": "string",
    },
    linked_interconnect_attachments=["string"],
    linked_router_appliance_instances=[{
        "ip_address": "string",
        "network_interface": "string",
        "virtual_machine": "string",
    }],
    linked_vpn_tunnels=["string"],
    location="string",
    name="string",
    project="string",
    request_id="string",
    spoke_id="string",
    update_time="string")

    const google_nativeSpokeResource = new google_native.networkconnectivity.v1alpha1.Spoke("google-nativeSpokeResource", {
    createTime: "string",
    description: "string",
    hub: "string",
    labels: {
        string: "string",
    },
    linkedInterconnectAttachments: ["string"],
    linkedRouterApplianceInstances: [{
        ipAddress: "string",
        networkInterface: "string",
        virtualMachine: "string",
    }],
    linkedVpnTunnels: ["string"],
    location: "string",
    name: "string",
    project: "string",
    requestId: "string",
    spokeId: "string",
    updateTime: "string",
});

    type: google-native:networkconnectivity/v1alpha1:Spoke
properties:
    createTime: string
    description: string
    hub: string
    labels:
        string: string
    linkedInterconnectAttachments:
        - string
    linkedRouterApplianceInstances:
        - ipAddress: string
          networkInterface: string
          virtualMachine: string
    linkedVpnTunnels:
        - string
    location: string
    name: string
    project: string
    requestId: string
    spokeId: string
    updateTime: string

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

    CreateTime string
    The time when the Spoke was created.
    Description string
    Short description of the spoke resource
    Hub string
    The resource URL of the hub resource that the spoke is attached to
    Labels Dictionary<string, string>
    User-defined labels.
    LinkedInterconnectAttachments List<string>
    The URIs of linked interconnect attachment resources
    LinkedRouterApplianceInstances List<Pulumi.GoogleNative.NetworkConnectivity.V1Alpha1.Inputs.RouterApplianceInstance>
    The URIs of linked Router appliance resources
    LinkedVpnTunnels List<string>
    The URIs of linked VPN tunnel resources
    Location string
    Name string
    Immutable. The name of a Spoke resource.
    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 will know 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 if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally 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).
    SpokeId string
    Optional. Unique id for the Spoke to create.
    UpdateTime string
    The time when the Spoke was updated.
    CreateTime string
    The time when the Spoke was created.
    Description string
    Short description of the spoke resource
    Hub string
    The resource URL of the hub resource that the spoke is attached to
    Labels map[string]string
    User-defined labels.
    LinkedInterconnectAttachments []string
    The URIs of linked interconnect attachment resources
    LinkedRouterApplianceInstances []RouterApplianceInstanceArgs
    The URIs of linked Router appliance resources
    LinkedVpnTunnels []string
    The URIs of linked VPN tunnel resources
    Location string
    Name string
    Immutable. The name of a Spoke resource.
    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 will know 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 if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally 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).
    SpokeId string
    Optional. Unique id for the Spoke to create.
    UpdateTime string
    The time when the Spoke was updated.
    createTime String
    The time when the Spoke was created.
    description String
    Short description of the spoke resource
    hub String
    The resource URL of the hub resource that the spoke is attached to
    labels Map<String,String>
    User-defined labels.
    linkedInterconnectAttachments List<String>
    The URIs of linked interconnect attachment resources
    linkedRouterApplianceInstances List<RouterApplianceInstance>
    The URIs of linked Router appliance resources
    linkedVpnTunnels List<String>
    The URIs of linked VPN tunnel resources
    location String
    name String
    Immutable. The name of a Spoke resource.
    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 will know 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 if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally 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).
    spokeId String
    Optional. Unique id for the Spoke to create.
    updateTime String
    The time when the Spoke was updated.
    createTime string
    The time when the Spoke was created.
    description string
    Short description of the spoke resource
    hub string
    The resource URL of the hub resource that the spoke is attached to
    labels {[key: string]: string}
    User-defined labels.
    linkedInterconnectAttachments string[]
    The URIs of linked interconnect attachment resources
    linkedRouterApplianceInstances RouterApplianceInstance[]
    The URIs of linked Router appliance resources
    linkedVpnTunnels string[]
    The URIs of linked VPN tunnel resources
    location string
    name string
    Immutable. The name of a Spoke resource.
    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 will know 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 if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally 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).
    spokeId string
    Optional. Unique id for the Spoke to create.
    updateTime string
    The time when the Spoke was updated.
    create_time str
    The time when the Spoke was created.
    description str
    Short description of the spoke resource
    hub str
    The resource URL of the hub resource that the spoke is attached to
    labels Mapping[str, str]
    User-defined labels.
    linked_interconnect_attachments Sequence[str]
    The URIs of linked interconnect attachment resources
    linked_router_appliance_instances Sequence[RouterApplianceInstanceArgs]
    The URIs of linked Router appliance resources
    linked_vpn_tunnels Sequence[str]
    The URIs of linked VPN tunnel resources
    location str
    name str
    Immutable. The name of a Spoke resource.
    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 will know 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 if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally 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).
    spoke_id str
    Optional. Unique id for the Spoke to create.
    update_time str
    The time when the Spoke was updated.
    createTime String
    The time when the Spoke was created.
    description String
    Short description of the spoke resource
    hub String
    The resource URL of the hub resource that the spoke is attached to
    labels Map<String>
    User-defined labels.
    linkedInterconnectAttachments List<String>
    The URIs of linked interconnect attachment resources
    linkedRouterApplianceInstances List<Property Map>
    The URIs of linked Router appliance resources
    linkedVpnTunnels List<String>
    The URIs of linked VPN tunnel resources
    location String
    name String
    Immutable. The name of a Spoke resource.
    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 will know 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 if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally 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).
    spokeId String
    Optional. Unique id for the Spoke to create.
    updateTime String
    The time when the Spoke was updated.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current lifecycle state of this Hub.
    UniqueId string
    Google-generated UUID for this resource. This is unique across all Spoke resources. If a Spoke resource is deleted and another with the same name is created, it gets a different unique_id.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current lifecycle state of this Hub.
    UniqueId string
    Google-generated UUID for this resource. This is unique across all Spoke resources. If a Spoke resource is deleted and another with the same name is created, it gets a different unique_id.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current lifecycle state of this Hub.
    uniqueId String
    Google-generated UUID for this resource. This is unique across all Spoke resources. If a Spoke resource is deleted and another with the same name is created, it gets a different unique_id.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The current lifecycle state of this Hub.
    uniqueId string
    Google-generated UUID for this resource. This is unique across all Spoke resources. If a Spoke resource is deleted and another with the same name is created, it gets a different unique_id.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The current lifecycle state of this Hub.
    unique_id str
    Google-generated UUID for this resource. This is unique across all Spoke resources. If a Spoke resource is deleted and another with the same name is created, it gets a different unique_id.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current lifecycle state of this Hub.
    uniqueId String
    Google-generated UUID for this resource. This is unique across all Spoke resources. If a Spoke resource is deleted and another with the same name is created, it gets a different unique_id.

    Supporting Types

    RouterApplianceInstance, RouterApplianceInstanceArgs

    IpAddress string
    The IP address of the network interface to use for peering.
    NetworkInterface string
    VirtualMachine string
    The URI of the virtual machine resource
    IpAddress string
    The IP address of the network interface to use for peering.
    NetworkInterface string
    VirtualMachine string
    The URI of the virtual machine resource
    ipAddress String
    The IP address of the network interface to use for peering.
    networkInterface String
    virtualMachine String
    The URI of the virtual machine resource
    ipAddress string
    The IP address of the network interface to use for peering.
    networkInterface string
    virtualMachine string
    The URI of the virtual machine resource
    ip_address str
    The IP address of the network interface to use for peering.
    network_interface str
    virtual_machine str
    The URI of the virtual machine resource
    ipAddress String
    The IP address of the network interface to use for peering.
    networkInterface String
    virtualMachine String
    The URI of the virtual machine resource

    RouterApplianceInstanceResponse, RouterApplianceInstanceResponseArgs

    IpAddress string
    The IP address of the network interface to use for peering.
    NetworkInterface string
    VirtualMachine string
    The URI of the virtual machine resource
    IpAddress string
    The IP address of the network interface to use for peering.
    NetworkInterface string
    VirtualMachine string
    The URI of the virtual machine resource
    ipAddress String
    The IP address of the network interface to use for peering.
    networkInterface String
    virtualMachine String
    The URI of the virtual machine resource
    ipAddress string
    The IP address of the network interface to use for peering.
    networkInterface string
    virtualMachine string
    The URI of the virtual machine resource
    ip_address str
    The IP address of the network interface to use for peering.
    network_interface str
    virtual_machine str
    The URI of the virtual machine resource
    ipAddress String
    The IP address of the network interface to use for peering.
    networkInterface String
    virtualMachine String
    The URI of the virtual machine resource

    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