Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. networkmanager
  5. getLinks
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.networkmanager.getLinks

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Retrieve information about link.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.networkmanager.getLinks({
    globalNetworkId: globalNetworkId,
    tags: {
        Env: "test",
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.networkmanager.get_links(global_network_id=global_network_id,
    tags={
        "Env": "test",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/networkmanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkmanager.GetLinks(ctx, &networkmanager.GetLinksArgs{
			GlobalNetworkId: globalNetworkId,
			Tags: map[string]interface{}{
				"Env": "test",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.NetworkManager.GetLinks.Invoke(new()
    {
        GlobalNetworkId = globalNetworkId,
        Tags = 
        {
            { "Env", "test" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.networkmanager.NetworkmanagerFunctions;
import com.pulumi.aws.networkmanager.inputs.GetLinksArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = NetworkmanagerFunctions.getLinks(GetLinksArgs.builder()
            .globalNetworkId(globalNetworkId)
            .tags(Map.of("Env", "test"))
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: aws:networkmanager:getLinks
      arguments:
        globalNetworkId: ${globalNetworkId}
        tags:
          Env: test
Copy

Using getLinks

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 getLinks(args: GetLinksArgs, opts?: InvokeOptions): Promise<GetLinksResult>
function getLinksOutput(args: GetLinksOutputArgs, opts?: InvokeOptions): Output<GetLinksResult>
Copy
def get_links(global_network_id: Optional[str] = None,
              provider_name: Optional[str] = None,
              site_id: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None,
              type: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetLinksResult
def get_links_output(global_network_id: Optional[pulumi.Input[str]] = None,
              provider_name: Optional[pulumi.Input[str]] = None,
              site_id: Optional[pulumi.Input[str]] = None,
              tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
              type: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetLinksResult]
Copy
func GetLinks(ctx *Context, args *GetLinksArgs, opts ...InvokeOption) (*GetLinksResult, error)
func GetLinksOutput(ctx *Context, args *GetLinksOutputArgs, opts ...InvokeOption) GetLinksResultOutput
Copy

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

public static class GetLinks 
{
    public static Task<GetLinksResult> InvokeAsync(GetLinksArgs args, InvokeOptions? opts = null)
    public static Output<GetLinksResult> Invoke(GetLinksInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetLinksResult> getLinks(GetLinksArgs args, InvokeOptions options)
public static Output<GetLinksResult> getLinks(GetLinksArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:networkmanager/getLinks:getLinks
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GlobalNetworkId This property is required. string
ID of the Global Network of the links to retrieve.
ProviderName string
Link provider to retrieve.
SiteId string
ID of the site of the links to retrieve.
Tags Dictionary<string, string>
Restricts the list to the links with these tags.
Type string
Link type to retrieve.
GlobalNetworkId This property is required. string
ID of the Global Network of the links to retrieve.
ProviderName string
Link provider to retrieve.
SiteId string
ID of the site of the links to retrieve.
Tags map[string]string
Restricts the list to the links with these tags.
Type string
Link type to retrieve.
globalNetworkId This property is required. String
ID of the Global Network of the links to retrieve.
providerName String
Link provider to retrieve.
siteId String
ID of the site of the links to retrieve.
tags Map<String,String>
Restricts the list to the links with these tags.
type String
Link type to retrieve.
globalNetworkId This property is required. string
ID of the Global Network of the links to retrieve.
providerName string
Link provider to retrieve.
siteId string
ID of the site of the links to retrieve.
tags {[key: string]: string}
Restricts the list to the links with these tags.
type string
Link type to retrieve.
global_network_id This property is required. str
ID of the Global Network of the links to retrieve.
provider_name str
Link provider to retrieve.
site_id str
ID of the site of the links to retrieve.
tags Mapping[str, str]
Restricts the list to the links with these tags.
type str
Link type to retrieve.
globalNetworkId This property is required. String
ID of the Global Network of the links to retrieve.
providerName String
Link provider to retrieve.
siteId String
ID of the site of the links to retrieve.
tags Map<String>
Restricts the list to the links with these tags.
type String
Link type to retrieve.

getLinks Result

The following output properties are available:

GlobalNetworkId string
Id string
The provider-assigned unique ID for this managed resource.
Ids List<string>
IDs of the links.
ProviderName string
SiteId string
Tags Dictionary<string, string>
Type string
GlobalNetworkId string
Id string
The provider-assigned unique ID for this managed resource.
Ids []string
IDs of the links.
ProviderName string
SiteId string
Tags map[string]string
Type string
globalNetworkId String
id String
The provider-assigned unique ID for this managed resource.
ids List<String>
IDs of the links.
providerName String
siteId String
tags Map<String,String>
type String
globalNetworkId string
id string
The provider-assigned unique ID for this managed resource.
ids string[]
IDs of the links.
providerName string
siteId string
tags {[key: string]: string}
type string
global_network_id str
id str
The provider-assigned unique ID for this managed resource.
ids Sequence[str]
IDs of the links.
provider_name str
site_id str
tags Mapping[str, str]
type str
globalNetworkId String
id String
The provider-assigned unique ID for this managed resource.
ids List<String>
IDs of the links.
providerName String
siteId String
tags Map<String>
type String

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws