Google Cloud Native v0.32.0, Nov 29 23

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

google-native.networkconnectivity/v1.getSpoke

Explore with Pulumi AI

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

Using getSpoke

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.

TypeScript
Python
Go
C#
Java
YAML

function getSpoke(args: GetSpokeArgs, opts?: InvokeOptions): Promise<GetSpokeResult>
function getSpokeOutput(args: GetSpokeOutputArgs, opts?: InvokeOptions): Output<GetSpokeResult>

def get_spoke(location: Optional[str] = None,
              project: Optional[str] = None,
              spoke_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetSpokeResult
def get_spoke_output(location: Optional[pulumi.Input[str]] = None,
              project: Optional[pulumi.Input[str]] = None,
              spoke_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetSpokeResult]

func LookupSpoke(ctx *Context, args *LookupSpokeArgs, opts ...InvokeOption) (*LookupSpokeResult, error)
func LookupSpokeOutput(ctx *Context, args *LookupSpokeOutputArgs, opts ...InvokeOption) LookupSpokeResultOutput

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

public static class GetSpoke 
{
    public static Task<GetSpokeResult> InvokeAsync(GetSpokeArgs args, InvokeOptions? opts = null)
    public static Output<GetSpokeResult> Invoke(GetSpokeInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSpokeResult> getSpoke(GetSpokeArgs args, InvokeOptions options)
public static Output<GetSpokeResult> getSpoke(GetSpokeArgs args, InvokeOptions options)

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

The following arguments are supported:

Location string
SpokeId string
Project string

Location string
SpokeId string
Project string

location String
spokeId String
project String

location string
spokeId string
project string

location str
spoke_id str
project str

location String
spokeId String
project String

getSpoke Result

The following output properties are available:

CreateTime string: The time the spoke was created.
Description string: An optional description of the spoke.
Group string: Optional. The name of the group that this spoke is associated with.
Hub string: Immutable. The name of the hub that this spoke is attached to.
Labels Dictionary<string, string>: Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
LinkedInterconnectAttachments Pulumi.GoogleNative.NetworkConnectivity.V1.Outputs.LinkedInterconnectAttachmentsResponse: VLAN attachments that are associated with the spoke.
LinkedRouterApplianceInstances Pulumi.GoogleNative.NetworkConnectivity.V1.Outputs.LinkedRouterApplianceInstancesResponse: Router appliance instances that are associated with the spoke.
LinkedVpcNetwork Pulumi.GoogleNative.NetworkConnectivity.V1.Outputs.LinkedVpcNetworkResponse: Optional. VPC network that is associated with the spoke.
LinkedVpnTunnels Pulumi.GoogleNative.NetworkConnectivity.V1.Outputs.LinkedVpnTunnelsResponse: VPN tunnels that are associated with the spoke.
Name string: Immutable. The name of the spoke. Spoke names must be unique. They use the following form: projects/{project_number}/locations/{region}/spokes/{spoke_id}
Reasons List<Pulumi.GoogleNative.NetworkConnectivity.V1.Outputs.StateReasonResponse>: The reasons for current state of the spoke. Only present when the spoke is in the INACTIVE state.
SpokeType string: The type of resource associated with the spoke.
State string: The current lifecycle state of this spoke.
UniqueId string: The Google-generated UUID for the spoke. This value is unique across all spoke resources. If a spoke is deleted and another with the same name is created, the new spoke is assigned a different unique_id.
UpdateTime string: The time the spoke was last updated.

CreateTime string: The time the spoke was created.
Description string: An optional description of the spoke.
Group string: Optional. The name of the group that this spoke is associated with.
Hub string: Immutable. The name of the hub that this spoke is attached to.
Labels map[string]string: Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
LinkedInterconnectAttachments LinkedInterconnectAttachmentsResponse: VLAN attachments that are associated with the spoke.
LinkedRouterApplianceInstances LinkedRouterApplianceInstancesResponse: Router appliance instances that are associated with the spoke.
LinkedVpcNetwork LinkedVpcNetworkResponse: Optional. VPC network that is associated with the spoke.
LinkedVpnTunnels LinkedVpnTunnelsResponse: VPN tunnels that are associated with the spoke.
Name string: Immutable. The name of the spoke. Spoke names must be unique. They use the following form: projects/{project_number}/locations/{region}/spokes/{spoke_id}
Reasons []StateReasonResponse: The reasons for current state of the spoke. Only present when the spoke is in the INACTIVE state.
SpokeType string: The type of resource associated with the spoke.
State string: The current lifecycle state of this spoke.
UniqueId string: The Google-generated UUID for the spoke. This value is unique across all spoke resources. If a spoke is deleted and another with the same name is created, the new spoke is assigned a different unique_id.
UpdateTime string: The time the spoke was last updated.

createTime String: The time the spoke was created.
description String: An optional description of the spoke.
group String: Optional. The name of the group that this spoke is associated with.
hub String: Immutable. The name of the hub that this spoke is attached to.
labels Map<String,String>: Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
linkedInterconnectAttachments LinkedInterconnectAttachmentsResponse: VLAN attachments that are associated with the spoke.
linkedRouterApplianceInstances LinkedRouterApplianceInstancesResponse: Router appliance instances that are associated with the spoke.
linkedVpcNetwork LinkedVpcNetworkResponse: Optional. VPC network that is associated with the spoke.
linkedVpnTunnels LinkedVpnTunnelsResponse: VPN tunnels that are associated with the spoke.
name String: Immutable. The name of the spoke. Spoke names must be unique. They use the following form: projects/{project_number}/locations/{region}/spokes/{spoke_id}
reasons List<StateReasonResponse>: The reasons for current state of the spoke. Only present when the spoke is in the INACTIVE state.
spokeType String: The type of resource associated with the spoke.
state String: The current lifecycle state of this spoke.
uniqueId String: The Google-generated UUID for the spoke. This value is unique across all spoke resources. If a spoke is deleted and another with the same name is created, the new spoke is assigned a different unique_id.
updateTime String: The time the spoke was last updated.

createTime string: The time the spoke was created.
description string: An optional description of the spoke.
group string: Optional. The name of the group that this spoke is associated with.
hub string: Immutable. The name of the hub that this spoke is attached to.
labels {[key: string]: string}: Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
linkedInterconnectAttachments LinkedInterconnectAttachmentsResponse: VLAN attachments that are associated with the spoke.
linkedRouterApplianceInstances LinkedRouterApplianceInstancesResponse: Router appliance instances that are associated with the spoke.
linkedVpcNetwork LinkedVpcNetworkResponse: Optional. VPC network that is associated with the spoke.
linkedVpnTunnels LinkedVpnTunnelsResponse: VPN tunnels that are associated with the spoke.
name string: Immutable. The name of the spoke. Spoke names must be unique. They use the following form: projects/{project_number}/locations/{region}/spokes/{spoke_id}
reasons StateReasonResponse[]: The reasons for current state of the spoke. Only present when the spoke is in the INACTIVE state.
spokeType string: The type of resource associated with the spoke.
state string: The current lifecycle state of this spoke.
uniqueId string: The Google-generated UUID for the spoke. This value is unique across all spoke resources. If a spoke is deleted and another with the same name is created, the new spoke is assigned a different unique_id.
updateTime string: The time the spoke was last updated.

create_time str: The time the spoke was created.
description str: An optional description of the spoke.
group str: Optional. The name of the group that this spoke is associated with.
hub str: Immutable. The name of the hub that this spoke is attached to.
labels Mapping[str, str]: Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
linked_interconnect_attachments LinkedInterconnectAttachmentsResponse: VLAN attachments that are associated with the spoke.
linked_router_appliance_instances LinkedRouterApplianceInstancesResponse: Router appliance instances that are associated with the spoke.
linked_vpc_network LinkedVpcNetworkResponse: Optional. VPC network that is associated with the spoke.
linked_vpn_tunnels LinkedVpnTunnelsResponse: VPN tunnels that are associated with the spoke.
name str: Immutable. The name of the spoke. Spoke names must be unique. They use the following form: projects/{project_number}/locations/{region}/spokes/{spoke_id}
reasons Sequence[StateReasonResponse]: The reasons for current state of the spoke. Only present when the spoke is in the INACTIVE state.
spoke_type str: The type of resource associated with the spoke.
state str: The current lifecycle state of this spoke.
unique_id str: The Google-generated UUID for the spoke. This value is unique across all spoke resources. If a spoke is deleted and another with the same name is created, the new spoke is assigned a different unique_id.
update_time str: The time the spoke was last updated.

createTime String: The time the spoke was created.
description String: An optional description of the spoke.
group String: Optional. The name of the group that this spoke is associated with.
hub String: Immutable. The name of the hub that this spoke is attached to.
labels Map<String>: Optional labels in key-value pair format. For more information about labels, see Requirements for labels.
linkedInterconnectAttachments Property Map: VLAN attachments that are associated with the spoke.
linkedRouterApplianceInstances Property Map: Router appliance instances that are associated with the spoke.
linkedVpcNetwork Property Map: Optional. VPC network that is associated with the spoke.
linkedVpnTunnels Property Map: VPN tunnels that are associated with the spoke.
name String: Immutable. The name of the spoke. Spoke names must be unique. They use the following form: projects/{project_number}/locations/{region}/spokes/{spoke_id}
reasons List<Property Map>: The reasons for current state of the spoke. Only present when the spoke is in the INACTIVE state.
spokeType String: The type of resource associated with the spoke.
state String: The current lifecycle state of this spoke.
uniqueId String: The Google-generated UUID for the spoke. This value is unique across all spoke resources. If a spoke is deleted and another with the same name is created, the new spoke is assigned a different unique_id.
updateTime String: The time the spoke was last updated.

Supporting Types

LinkedInterconnectAttachmentsResponse

SiteToSiteDataTransfer bool: A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in supported locations.
Uris List<string>: The URIs of linked interconnect attachment resources
VpcNetwork string: The VPC network where these VLAN attachments are located.

SiteToSiteDataTransfer bool: A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in supported locations.
Uris []string: The URIs of linked interconnect attachment resources
VpcNetwork string: The VPC network where these VLAN attachments are located.

siteToSiteDataTransfer Boolean: A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in supported locations.
uris List<String>: The URIs of linked interconnect attachment resources
vpcNetwork String: The VPC network where these VLAN attachments are located.

siteToSiteDataTransfer boolean: A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in supported locations.
uris string[]: The URIs of linked interconnect attachment resources
vpcNetwork string: The VPC network where these VLAN attachments are located.

site_to_site_data_transfer bool: A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in supported locations.
uris Sequence[str]: The URIs of linked interconnect attachment resources
vpc_network str: The VPC network where these VLAN attachments are located.

siteToSiteDataTransfer Boolean: A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in supported locations.
uris List<String>: The URIs of linked interconnect attachment resources
vpcNetwork String: The VPC network where these VLAN attachments are located.

LinkedRouterApplianceInstancesResponse

Instances List<Pulumi.GoogleNative.NetworkConnectivity.V1.Inputs.RouterApplianceInstanceResponse>: The list of router appliance instances.
SiteToSiteDataTransfer bool: A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in supported locations.
VpcNetwork string: The VPC network where these router appliance instances are located.

Instances []RouterApplianceInstanceResponse: The list of router appliance instances.
SiteToSiteDataTransfer bool: A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in supported locations.
VpcNetwork string: The VPC network where these router appliance instances are located.

instances List<RouterApplianceInstanceResponse>: The list of router appliance instances.
siteToSiteDataTransfer Boolean: A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in supported locations.
vpcNetwork String: The VPC network where these router appliance instances are located.

instances RouterApplianceInstanceResponse[]: The list of router appliance instances.
siteToSiteDataTransfer boolean: A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in supported locations.
vpcNetwork string: The VPC network where these router appliance instances are located.

instances Sequence[RouterApplianceInstanceResponse]: The list of router appliance instances.
site_to_site_data_transfer bool: A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in supported locations.
vpc_network str: The VPC network where these router appliance instances are located.

instances List<Property Map>: The list of router appliance instances.
siteToSiteDataTransfer Boolean: A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in supported locations.
vpcNetwork String: The VPC network where these router appliance instances are located.

LinkedVpcNetworkResponse

ExcludeExportRanges List<string>: Optional. IP ranges encompassing the subnets to be excluded from peering.
Uri string: The URI of the VPC network resource.

ExcludeExportRanges []string: Optional. IP ranges encompassing the subnets to be excluded from peering.
Uri string: The URI of the VPC network resource.

excludeExportRanges List<String>: Optional. IP ranges encompassing the subnets to be excluded from peering.
uri String: The URI of the VPC network resource.

excludeExportRanges string[]: Optional. IP ranges encompassing the subnets to be excluded from peering.
uri string: The URI of the VPC network resource.

exclude_export_ranges Sequence[str]: Optional. IP ranges encompassing the subnets to be excluded from peering.
uri str: The URI of the VPC network resource.

excludeExportRanges List<String>: Optional. IP ranges encompassing the subnets to be excluded from peering.
uri String: The URI of the VPC network resource.

LinkedVpnTunnelsResponse

SiteToSiteDataTransfer bool: A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in supported locations.
Uris List<string>: The URIs of linked VPN tunnel resources.
VpcNetwork string: The VPC network where these VPN tunnels are located.

SiteToSiteDataTransfer bool: A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in supported locations.
Uris []string: The URIs of linked VPN tunnel resources.
VpcNetwork string: The VPC network where these VPN tunnels are located.

siteToSiteDataTransfer Boolean: A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in supported locations.
uris List<String>: The URIs of linked VPN tunnel resources.
vpcNetwork String: The VPC network where these VPN tunnels are located.

siteToSiteDataTransfer boolean: A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in supported locations.
uris string[]: The URIs of linked VPN tunnel resources.
vpcNetwork string: The VPC network where these VPN tunnels are located.

site_to_site_data_transfer bool: A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in supported locations.
uris Sequence[str]: The URIs of linked VPN tunnel resources.
vpc_network str: The VPC network where these VPN tunnels are located.

siteToSiteDataTransfer Boolean: A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in supported locations.
uris List<String>: The URIs of linked VPN tunnel resources.
vpcNetwork String: The VPC network where these VPN tunnels are located.

RouterApplianceInstanceResponse

IpAddress string: The IP address on the VM to use for peering.
VirtualMachine string: The URI of the VM.

IpAddress string: The IP address on the VM to use for peering.
VirtualMachine string: The URI of the VM.

ipAddress String: The IP address on the VM to use for peering.
virtualMachine String: The URI of the VM.

ipAddress string: The IP address on the VM to use for peering.
virtualMachine string: The URI of the VM.

ip_address str: The IP address on the VM to use for peering.
virtual_machine str: The URI of the VM.

ipAddress String: The IP address on the VM to use for peering.
virtualMachine String: The URI of the VM.

StateReasonResponse

Code string: The code associated with this reason.
Message string: Human-readable details about this reason.
UserDetails string: Additional information provided by the user in the RejectSpoke call.

Code string: The code associated with this reason.
Message string: Human-readable details about this reason.
UserDetails string: Additional information provided by the user in the RejectSpoke call.

code String: The code associated with this reason.
message String: Human-readable details about this reason.
userDetails String: Additional information provided by the user in the RejectSpoke call.

code string: The code associated with this reason.
message string: Human-readable details about this reason.
userDetails string: Additional information provided by the user in the RejectSpoke call.

code str: The code associated with this reason.
message str: Human-readable details about this reason.
user_details str: Additional information provided by the user in the RejectSpoke call.

code String: The code associated with this reason.
message String: Human-readable details about this reason.
userDetails String: Additional information provided by the user in the RejectSpoke call.

Package Details

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

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

On this page

On this page

Using getSpoke

getSpoke Result

Supporting Types

LinkedInterconnectAttachmentsResponse

LinkedRouterApplianceInstancesResponse

LinkedVpcNetworkResponse

LinkedVpnTunnelsResponse

RouterApplianceInstanceResponse

StateReasonResponse

Package Details

On this page

On this page