Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. networkmanager
  5. Link
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.networkmanager.Link

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Creates a link for a site.

    Example Usage

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

const example = new aws.networkmanager.Link("example", {
    globalNetworkId: exampleAwsNetworkmanagerGlobalNetwork.id,
    siteId: exampleAwsNetworkmanagerSite.id,
    bandwidth: {
        uploadSpeed: 10,
        downloadSpeed: 50,
    },
    providerName: "MegaCorp",
});

    import pulumi
import pulumi_aws as aws

example = aws.networkmanager.Link("example",
    global_network_id=example_aws_networkmanager_global_network["id"],
    site_id=example_aws_networkmanager_site["id"],
    bandwidth={
        "upload_speed": 10,
        "download_speed": 50,
    },
    provider_name="MegaCorp")

    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.NewLink(ctx, "example", &networkmanager.LinkArgs{
			GlobalNetworkId: pulumi.Any(exampleAwsNetworkmanagerGlobalNetwork.Id),
			SiteId:          pulumi.Any(exampleAwsNetworkmanagerSite.Id),
			Bandwidth: &networkmanager.LinkBandwidthArgs{
				UploadSpeed:   pulumi.Int(10),
				DownloadSpeed: pulumi.Int(50),
			},
			ProviderName: pulumi.String("MegaCorp"),
		})
		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 = new Aws.NetworkManager.Link("example", new()
    {
        GlobalNetworkId = exampleAwsNetworkmanagerGlobalNetwork.Id,
        SiteId = exampleAwsNetworkmanagerSite.Id,
        Bandwidth = new Aws.NetworkManager.Inputs.LinkBandwidthArgs
        {
            UploadSpeed = 10,
            DownloadSpeed = 50,
        },
        ProviderName = "MegaCorp",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.networkmanager.Link;
import com.pulumi.aws.networkmanager.LinkArgs;
import com.pulumi.aws.networkmanager.inputs.LinkBandwidthArgs;
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) {
        var example = new Link("example", LinkArgs.builder()
            .globalNetworkId(exampleAwsNetworkmanagerGlobalNetwork.id())
            .siteId(exampleAwsNetworkmanagerSite.id())
            .bandwidth(LinkBandwidthArgs.builder()
                .uploadSpeed(10)
                .downloadSpeed(50)
                .build())
            .providerName("MegaCorp")
            .build());

    }
}

    resources:
  example:
    type: aws:networkmanager:Link
    properties:
      globalNetworkId: ${exampleAwsNetworkmanagerGlobalNetwork.id}
      siteId: ${exampleAwsNetworkmanagerSite.id}
      bandwidth:
        uploadSpeed: 10
        downloadSpeed: 50
      providerName: MegaCorp

    Create Link Resource

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

    Constructor syntax

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

@overload
def Link(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         bandwidth: Optional[LinkBandwidthArgs] = None,
         global_network_id: Optional[str] = None,
         site_id: Optional[str] = None,
         description: Optional[str] = None,
         provider_name: Optional[str] = None,
         tags: Optional[Mapping[str, str]] = None,
         type: Optional[str] = None)
    func NewLink(ctx *Context, name string, args LinkArgs, opts ...ResourceOption) (*Link, error)
    public Link(string name, LinkArgs args, CustomResourceOptions? opts = null)
    public Link(String name, LinkArgs args)
public Link(String name, LinkArgs args, CustomResourceOptions options)

    type: aws:networkmanager:Link
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 LinkArgs
    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 LinkArgs
    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 LinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LinkArgs
    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 linkResource = new Aws.NetworkManager.Link("linkResource", new()
{
    Bandwidth = new Aws.NetworkManager.Inputs.LinkBandwidthArgs
    {
        DownloadSpeed = 0,
        UploadSpeed = 0,
    },
    GlobalNetworkId = "string",
    SiteId = "string",
    Description = "string",
    ProviderName = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Type = "string",
});

    example, err := networkmanager.NewLink(ctx, "linkResource", &networkmanager.LinkArgs{
	Bandwidth: &networkmanager.LinkBandwidthArgs{
		DownloadSpeed: pulumi.Int(0),
		UploadSpeed:   pulumi.Int(0),
	},
	GlobalNetworkId: pulumi.String("string"),
	SiteId:          pulumi.String("string"),
	Description:     pulumi.String("string"),
	ProviderName:    pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Type: pulumi.String("string"),
})

    var linkResource = new Link("linkResource", LinkArgs.builder()
    .bandwidth(LinkBandwidthArgs.builder()
        .downloadSpeed(0)
        .uploadSpeed(0)
        .build())
    .globalNetworkId("string")
    .siteId("string")
    .description("string")
    .providerName("string")
    .tags(Map.of("string", "string"))
    .type("string")
    .build());

    link_resource = aws.networkmanager.Link("linkResource",
    bandwidth={
        "download_speed": 0,
        "upload_speed": 0,
    },
    global_network_id="string",
    site_id="string",
    description="string",
    provider_name="string",
    tags={
        "string": "string",
    },
    type="string")

    const linkResource = new aws.networkmanager.Link("linkResource", {
    bandwidth: {
        downloadSpeed: 0,
        uploadSpeed: 0,
    },
    globalNetworkId: "string",
    siteId: "string",
    description: "string",
    providerName: "string",
    tags: {
        string: "string",
    },
    type: "string",
});

    type: aws:networkmanager:Link
properties:
    bandwidth:
        downloadSpeed: 0
        uploadSpeed: 0
    description: string
    globalNetworkId: string
    providerName: string
    siteId: string
    tags:
        string: string
    type: string

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

    Bandwidth LinkBandwidth
    The upload speed and download speed in Mbps. Documented below.
    GlobalNetworkId string
    The ID of the global network.
    SiteId string
    The ID of the site.
    Description string
    A description of the link.
    ProviderName string
    The provider of the link.
    Tags Dictionary<string, string>
    Key-value tags for the link. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Type string
    The type of the link.
    Bandwidth LinkBandwidthArgs
    The upload speed and download speed in Mbps. Documented below.
    GlobalNetworkId string
    The ID of the global network.
    SiteId string
    The ID of the site.
    Description string
    A description of the link.
    ProviderName string
    The provider of the link.
    Tags map[string]string
    Key-value tags for the link. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Type string
    The type of the link.
    bandwidth LinkBandwidth
    The upload speed and download speed in Mbps. Documented below.
    globalNetworkId String
    The ID of the global network.
    siteId String
    The ID of the site.
    description String
    A description of the link.
    providerName String
    The provider of the link.
    tags Map<String,String>
    Key-value tags for the link. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    type String
    The type of the link.
    bandwidth LinkBandwidth
    The upload speed and download speed in Mbps. Documented below.
    globalNetworkId string
    The ID of the global network.
    siteId string
    The ID of the site.
    description string
    A description of the link.
    providerName string
    The provider of the link.
    tags {[key: string]: string}
    Key-value tags for the link. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    type string
    The type of the link.
    bandwidth LinkBandwidthArgs
    The upload speed and download speed in Mbps. Documented below.
    global_network_id str
    The ID of the global network.
    site_id str
    The ID of the site.
    description str
    A description of the link.
    provider_name str
    The provider of the link.
    tags Mapping[str, str]
    Key-value tags for the link. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    type str
    The type of the link.
    bandwidth Property Map
    The upload speed and download speed in Mbps. Documented below.
    globalNetworkId String
    The ID of the global network.
    siteId String
    The ID of the site.
    description String
    A description of the link.
    providerName String
    The provider of the link.
    tags Map<String>
    Key-value tags for the link. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    type String
    The type of the link.

    Outputs

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

    Arn string
    Link Amazon Resource Name (ARN).
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    Link Amazon Resource Name (ARN).
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Link Amazon Resource Name (ARN).
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    Link Amazon Resource Name (ARN).
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    Link Amazon Resource Name (ARN).
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Link Amazon Resource Name (ARN).
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Link Resource

    Get an existing Link resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: LinkState, opts?: CustomResourceOptions): Link
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        bandwidth: Optional[LinkBandwidthArgs] = None,
        description: Optional[str] = None,
        global_network_id: Optional[str] = None,
        provider_name: Optional[str] = None,
        site_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        type: Optional[str] = None) -> Link
    func GetLink(ctx *Context, name string, id IDInput, state *LinkState, opts ...ResourceOption) (*Link, error)
    public static Link Get(string name, Input<string> id, LinkState? state, CustomResourceOptions? opts = null)
    public static Link get(String name, Output<String> id, LinkState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    Link Amazon Resource Name (ARN).
    Bandwidth LinkBandwidth
    The upload speed and download speed in Mbps. Documented below.
    Description string
    A description of the link.
    GlobalNetworkId string
    The ID of the global network.
    ProviderName string
    The provider of the link.
    SiteId string
    The ID of the site.
    Tags Dictionary<string, string>
    Key-value tags for the link. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Type string
    The type of the link.
    Arn string
    Link Amazon Resource Name (ARN).
    Bandwidth LinkBandwidthArgs
    The upload speed and download speed in Mbps. Documented below.
    Description string
    A description of the link.
    GlobalNetworkId string
    The ID of the global network.
    ProviderName string
    The provider of the link.
    SiteId string
    The ID of the site.
    Tags map[string]string
    Key-value tags for the link. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Type string
    The type of the link.
    arn String
    Link Amazon Resource Name (ARN).
    bandwidth LinkBandwidth
    The upload speed and download speed in Mbps. Documented below.
    description String
    A description of the link.
    globalNetworkId String
    The ID of the global network.
    providerName String
    The provider of the link.
    siteId String
    The ID of the site.
    tags Map<String,String>
    Key-value tags for the link. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type String
    The type of the link.
    arn string
    Link Amazon Resource Name (ARN).
    bandwidth LinkBandwidth
    The upload speed and download speed in Mbps. Documented below.
    description string
    A description of the link.
    globalNetworkId string
    The ID of the global network.
    providerName string
    The provider of the link.
    siteId string
    The ID of the site.
    tags {[key: string]: string}
    Key-value tags for the link. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type string
    The type of the link.
    arn str
    Link Amazon Resource Name (ARN).
    bandwidth LinkBandwidthArgs
    The upload speed and download speed in Mbps. Documented below.
    description str
    A description of the link.
    global_network_id str
    The ID of the global network.
    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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type str
    The type of the link.
    arn String
    Link Amazon Resource Name (ARN).
    bandwidth Property Map
    The upload speed and download speed in Mbps. Documented below.
    description String
    A description of the link.
    globalNetworkId String
    The ID of the global network.
    providerName String
    The provider of the link.
    siteId String
    The ID of the site.
    tags Map<String>
    Key-value tags for the link. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type String
    The type of the link.

    Supporting Types

    LinkBandwidth, LinkBandwidthArgs

    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.

    Import

    Using pulumi import, import aws_networkmanager_link using the link ARN. For example:

    $ pulumi import aws:networkmanager/link:Link example arn:aws:networkmanager::123456789012:link/global-network-0d47f6t230mz46dy4/link-444555aaabbb11223

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws