[ aws . networkmanager ]

create-global-network

Description

Creates a new, empty global network.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-global-network
[--description <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--description (string)

A description of the global network.

Length Constraints: Maximum length of 256 characters.

--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.

See ‘aws help’ for descriptions of global parameters.

Examples

To create a global network

The following create-global-network example creates a new global network in your account with the description ‘My global network’.

aws networkmanager create-global-network \
    --description "Head offices global network" \
    --region us-west-2

Output:

{
    "GlobalNetwork": {
        "GlobalNetworkId": "global-network-01231231231231231",
        "GlobalNetworkArn": "arn:aws:networkmanager::123456789012:global-network/global-network-01231231231231231",
        "Description": "Head offices global network",
        "CreatedAt": 1575553525.0,
        "State": "PENDING"
    }
}

For more information, see Global Networks in the Transit Gateway Network Manager Guide.

Output

GlobalNetwork -> (structure)

Information about the global network object.

GlobalNetworkId -> (string)

The ID of the global network.

GlobalNetworkArn -> (string)

The Amazon Resource Name (ARN) of the global network.

Description -> (string)

The description of the global network.

CreatedAt -> (timestamp)

The date and time that the global network was created.

State -> (string)

The state of the global network.

Tags -> (list)

The tags for the global network.

(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.