AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.4.0 published on Wednesday, May 4, 2022 by Pulumi

getLink

Retrieve information about a link.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Aws.NetworkManager.GetLink.InvokeAsync(new Aws.NetworkManager.GetLinkArgs
        {
            GlobalNetworkId = @var.Global_network_id,
            LinkId = @var.Link_id,
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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: _var.Global_network_id,
			LinkId:          _var.Link_id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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

    public static void stack(Context ctx) {
        final var example = Output.of(NetworkmanagerFunctions.getLink(GetLinkArgs.builder()
            .globalNetworkId(var_.getGlobal_network_id())
            .linkId(var_.getLink_id())
            .build()));

        }
}
import pulumi
import pulumi_aws as aws

example = aws.networkmanager.get_link(global_network_id=var["global_network_id"],
    link_id=var["link_id"])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.networkmanager.getLink({
    globalNetworkId: _var.global_network_id,
    linkId: _var.link_id,
});
variables:
  example:
    Fn::Invoke:
      Function: aws:networkmanager:getLink
      Arguments:
        globalNetworkId: ${var.global_network_id}
        linkId: ${var.link_id}

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)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws:networkmanager/getLink:getLink
  Arguments:
    # Arguments dictionary

The following arguments are supported:

GlobalNetworkId string

The ID of the Global Network of the link to retrieve.

LinkId string

The id of the specific link to retrieve.

Tags Dictionary<string, string>

Key-value tags for the link.

GlobalNetworkId string

The ID of the Global Network of the link to retrieve.

LinkId string

The id of the specific link to retrieve.

Tags map[string]string

Key-value tags for the link.

globalNetworkId String

The ID of the Global Network of the link to retrieve.

linkId String

The id of the specific link to retrieve.

tags Map

Key-value tags for the link.

globalNetworkId string

The ID of the Global Network of the link to retrieve.

linkId string

The id of the specific link to retrieve.

tags {[key: string]: string}

Key-value tags for the link.

global_network_id str

The ID of the Global Network of the link to retrieve.

link_id str

The id of the specific link to retrieve.

tags Mapping[str, str]

Key-value tags for the link.

globalNetworkId String

The ID of the Global Network of the link to retrieve.

linkId String

The id of the specific link to retrieve.

tags Map

Key-value tags for the link.

getLink Result

The following output properties are available:

Arn string

The ARN of the link.

Bandwidths List<GetLinkBandwidth>

The upload speed and download speed of the link as documented below

Description string

The description of the link.

GlobalNetworkId string
Id string

The provider-assigned unique ID for this managed resource.

LinkId string
ProviderName string

The provider of the link.

SiteId string

The ID of the site.

Tags Dictionary<string, string>

Key-value tags for the link.

Type string

The type of the link.

Arn string

The ARN of the link.

Bandwidths []GetLinkBandwidth

The upload speed and download speed of the link as documented below

Description string

The description of the link.

GlobalNetworkId string
Id string

The provider-assigned unique ID for this managed resource.

LinkId string
ProviderName string

The provider of the link.

SiteId string

The ID of the site.

Tags map[string]string

Key-value tags for the link.

Type string

The type of the link.

arn String

The ARN of the link.

bandwidths ListLinkBandwidth>

The upload speed and download speed of the link as documented below

description String

The description of the link.

globalNetworkId String
id String

The provider-assigned unique ID for this managed resource.

linkId String
providerName String

The provider of the link.

siteId String

The ID of the site.

tags Map

Key-value tags for the link.

type String

The type of the link.

arn string

The ARN of the link.

bandwidths GetLinkBandwidth[]

The upload speed and download speed of the link as documented below

description string

The description of the link.

globalNetworkId string
id string

The provider-assigned unique ID for this managed resource.

linkId string
providerName string

The provider of the link.

siteId string

The ID of the site.

tags {[key: string]: string}

Key-value tags for the link.

type string

The type of the link.

arn str

The ARN of the link.

bandwidths Sequence[GetLinkBandwidth]

The upload speed and download speed of the link as documented below

description str

The 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

The provider of the link.

site_id str

The ID of the site.

tags Mapping[str, str]

Key-value tags for the link.

type str

The type of the link.

arn String

The ARN of the link.

bandwidths List

The upload speed and download speed of the link as documented below

description String

The description of the link.

globalNetworkId String
id String

The provider-assigned unique ID for this managed resource.

linkId String
providerName String

The provider of the link.

siteId String

The ID of the site.

tags Map

Key-value tags for the link.

type String

The 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
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.