[ aws . networkmanager ]

create-link

Description

Creates a new link for a specified site.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-link
--global-network-id <value>
[--description <value>]
[--type <value>]
--bandwidth <value>
[--provider <value>]
--site-id <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--global-network-id (string)

The ID of the global network.

--description (string)

A description of the link.

Length Constraints: Maximum length of 256 characters.

--type (string)

The type of the link.

Constraints: Cannot include the following characters: | ^

Length Constraints: Maximum length of 128 characters.

--bandwidth (structure)

The upload speed and download speed in Mbps.

UploadSpeed -> (integer)

Upload speed in Mbps.

DownloadSpeed -> (integer)

Download speed in Mbps.

Shorthand Syntax:

UploadSpeed=integer,DownloadSpeed=integer

JSON Syntax:

{
  "UploadSpeed": integer,
  "DownloadSpeed": integer
}

--provider (string)

The provider of the link.

Constraints: Cannot include the following characters: | ^

Length Constraints: Maximum length of 128 characters.

--site-id (string)

The ID of the site.

--tags (list)

The tags to apply to the resource during creation.

(structure)

Describes a tag.

Key -> (string)

The tag key.

Length Constraints: Maximum length of 128 characters.

Value -> (string)

The tag value.

Length Constraints: Maximum length of 256 characters.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To create a link

The following create-link example creates a link in the specified global network. The link includes a description and details about the link type, bandwidth, and provider. The site ID indicates the site to which the link is associated.

aws networkmanager create-link \
    --global-network-id global-network-01231231231231231 \
    --description "VPN Link" \
    --type "broadband" \
    --bandwidth UploadSpeed=10,DownloadSpeed=20 \
    --provider "AnyCompany" \
    --site-id site-444555aaabbb11223 \
    --region us-west-2

Output:

{
    "Link": {
        "LinkId": "link-11112222aaaabbbb1",
        "LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1",
        "GlobalNetworkId": "global-network-01231231231231231",
        "SiteId": "site-444555aaabbb11223",
        "Description": "VPN Link",
        "Type": "broadband",
        "Bandwidth": {
            "UploadSpeed": 10,
            "DownloadSpeed": 20
        },
        "Provider": "AnyCompany",
        "CreatedAt": 1575555811.0,
        "State": "PENDING"
    }
}

For more information, see Working with Links in the Transit Gateway Network Manager Guide.

Output

Link -> (structure)

Information about the link.

LinkId -> (string)

The ID of the link.

LinkArn -> (string)

The Amazon Resource Name (ARN) of the link.

GlobalNetworkId -> (string)

The ID of the global network.

SiteId -> (string)

The ID of the site.

Description -> (string)

The description of the link.

Type -> (string)

The type of the link.

Bandwidth -> (structure)

The bandwidth for the link.

UploadSpeed -> (integer)

Upload speed in Mbps.

DownloadSpeed -> (integer)

Download speed in Mbps.

Provider -> (string)

The provider of the link.

CreatedAt -> (timestamp)

The date and time that the link was created.

State -> (string)

The state of the link.

Tags -> (list)

The tags for the link.

(structure)

Describes a tag.

Key -> (string)

The tag key.

Length Constraints: Maximum length of 128 characters.

Value -> (string)

The tag value.

Length Constraints: Maximum length of 256 characters.