AWS v6.78.0, Apr 24 25

AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi

aws.networkmanager.getLink

Explore with Pulumi AI

AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi

Example Usage

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

const example = aws.networkmanager.getLink({
    globalNetworkId: globalNetworkId,
    linkId: linkId,
});

import pulumi
import pulumi_aws as aws

example = aws.networkmanager.get_link(global_network_id=global_network_id,
    link_id=link_id)

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.LookupLink(ctx, &networkmanager.LookupLinkArgs{
			GlobalNetworkId: globalNetworkId,
			LinkId:          linkId,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.NetworkManager.GetLink.Invoke(new()
    {
        GlobalNetworkId = globalNetworkId,
        LinkId = linkId,
    });

});

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.GetLinkArgs;
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.getLink(GetLinkArgs.builder()
            .globalNetworkId(globalNetworkId)
            .linkId(linkId)
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: aws:networkmanager:getLink
      arguments:
        globalNetworkId: ${globalNetworkId}
        linkId: ${linkId}

Using getLink

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 getLink(args: GetLinkArgs, opts?: InvokeOptions): Promise<GetLinkResult>
function getLinkOutput(args: GetLinkOutputArgs, opts?: InvokeOptions): Output<GetLinkResult>

def get_link(global_network_id: Optional[str] = None,
             link_id: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None,
             opts: Optional[InvokeOptions] = None) -> GetLinkResult
def get_link_output(global_network_id: Optional[pulumi.Input[str]] = None,
             link_id: Optional[pulumi.Input[str]] = None,
             tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetLinkResult]

func LookupLink(ctx *Context, args *LookupLinkArgs, opts ...InvokeOption) (*LookupLinkResult, error)
func LookupLinkOutput(ctx *Context, args *LookupLinkOutputArgs, opts ...InvokeOption) LookupLinkResultOutput

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

public static class GetLink 
{
    public static Task<GetLinkResult> InvokeAsync(GetLinkArgs args, InvokeOptions? opts = null)
    public static Output<GetLinkResult> Invoke(GetLinkInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetLinkResult> getLink(GetLinkArgs args, InvokeOptions options)
public static Output<GetLinkResult> getLink(GetLinkArgs args, InvokeOptions options)

fn::invoke:
  function: aws:networkmanager/getLink:getLink
  arguments:
    # arguments dictionary

The following arguments are supported:

GlobalNetworkId string: ID of the Global Network of the link to retrieve.
LinkId string: ID of the specific link to retrieve.
Tags Dictionary<string, string>: Key-value tags for the link.

GlobalNetworkId string: ID of the Global Network of the link to retrieve.
LinkId string: ID of the specific link to retrieve.
Tags map[string]string: Key-value tags for the link.

globalNetworkId String: ID of the Global Network of the link to retrieve.
linkId String: ID of the specific link to retrieve.
tags Map<String,String>: Key-value tags for the link.

globalNetworkId string: ID of the Global Network of the link to retrieve.
linkId string: ID of the specific link to retrieve.
tags {[key: string]: string}: Key-value tags for the link.

global_network_id str: ID of the Global Network of the link to retrieve.
link_id str: ID of the specific link to retrieve.
tags Mapping[str, str]: Key-value tags for the link.

globalNetworkId String: ID of the Global Network of the link to retrieve.
linkId String: ID of the specific link to retrieve.
tags Map<String>: Key-value tags for the link.

getLink Result

The following output properties are available:

Arn string: ARN of the link.
Bandwidths List<GetLinkBandwidth>: Upload speed and download speed of the link as documented below
Description string: Description of the link.
GlobalNetworkId string
Id string: The provider-assigned unique ID for this managed resource.
LinkId string
ProviderName string: Provider of the link.
SiteId string: ID of the site.
Tags Dictionary<string, string>: Key-value tags for the link.
Type string: Type of the link.

Arn string: ARN of the link.
Bandwidths []GetLinkBandwidth: Upload speed and download speed of the link as documented below
Description string: Description of the link.
GlobalNetworkId string
Id string: The provider-assigned unique ID for this managed resource.
LinkId string
ProviderName string: Provider of the link.
SiteId string: ID of the site.
Tags map[string]string: Key-value tags for the link.
Type string: Type of the link.

arn String: ARN of the link.
bandwidths List<GetLinkBandwidth>: Upload speed and download speed of the link as documented below
description String: Description of the link.
globalNetworkId String
id String: The provider-assigned unique ID for this managed resource.
linkId String
providerName String: Provider of the link.
siteId String: ID of the site.
tags Map<String,String>: Key-value tags for the link.
type String: Type of the link.

arn string: ARN of the link.
bandwidths GetLinkBandwidth[]: Upload speed and download speed of the link as documented below
description string: Description of the link.
globalNetworkId string
id string: The provider-assigned unique ID for this managed resource.
linkId string
providerName string: Provider of the link.
siteId string: ID of the site.
tags {[key: string]: string}: Key-value tags for the link.
type string: Type of the link.

arn str: ARN of the link.
bandwidths Sequence[GetLinkBandwidth]: Upload speed and download speed of the link as documented below
description str: Description of the link.
global_network_id str
id str: The provider-assigned unique ID for this managed resource.
link_id str
provider_name str: Provider of the link.
site_id str: ID of the site.
tags Mapping[str, str]: Key-value tags for the link.
type str: Type of the link.

arn String: ARN of the link.
bandwidths List<Property Map>: Upload speed and download speed of the link as documented below
description String: Description of the link.
globalNetworkId String
id String: The provider-assigned unique ID for this managed resource.
linkId String
providerName String: Provider of the link.
siteId String: ID of the site.
tags Map<String>: Key-value tags for the link.
type String: Type of the link.

Supporting Types

GetLinkBandwidth

DownloadSpeed int: Download speed in Mbps.
UploadSpeed int: Upload speed in Mbps.

DownloadSpeed int: Download speed in Mbps.
UploadSpeed int: Upload speed in Mbps.

downloadSpeed Integer: Download speed in Mbps.
uploadSpeed Integer: Upload speed in Mbps.

downloadSpeed number: Download speed in Mbps.
uploadSpeed number: Upload speed in Mbps.

download_speed int: Download speed in Mbps.
upload_speed int: Upload speed in Mbps.

downloadSpeed Number: Download speed in Mbps.
uploadSpeed Number: Upload speed in Mbps.

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.78.0 published on Thursday, Apr 24, 2025 by Pulumi

pulumi/pulumi-aws

aws.networkmanager.getLink

On this page

On this page

Example Usage

Using getLink

getLink Result

Supporting Types

GetLinkBandwidth

Package Details

On this page

On this page