[ aws . networkmanager ]

create-core-network

Description

Creates a core network as part of your global network, and optionally, with a core network policy.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-core-network
--global-network-id <value>
[--description <value>]
[--tags <value>]
[--policy-document <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--global-network-id (string)

The ID of the global network that a core network will be a part of.

--description (string)

The description of a core network.

--tags (list)

Key-value tags associated with a core network request.

(structure)

Describes a tag.

Key -> (string)

The tag key.

Constraints: Maximum length of 128 characters.

Value -> (string)

The tag value.

Constraints: Maximum length of 256 characters.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

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

--policy-document (string)

The policy document for creating a core network.

--client-token (string)

The client token associated with a core network request.

--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 core network

The following create-core-network example creates a core network using an optional description and tags within an AWS Cloud WAN global network.

aws networkmanager create-core-network \
    --global-network-id global-network-0d59060f16a73bc41\
    --description "Main headquarters location"\
    --tags Key=Name,Value="New York City office"

Output:

{
    "CoreNetwork": {
        "GlobalNetworkId": "global-network-0d59060f16a73bc41",
        "CoreNetworkId": "core-network-0fab62fe438d94db6",
        "CoreNetworkArn": "arn:aws:networkmanager::987654321012:core-network/core-network-0fab62fe438d94db6",
        "Description": "Main headquarters location",
        "CreatedAt": "2022-01-10T19:53:59+00:00",
        "State": "AVAILABLE",
        "Tags": [
            {
                "Key": "Name",
                "Value": "New York City office"
            }
        ]
    }
}

For more information, see Core networks in the AWS Cloud WAN User Guide.

Output

CoreNetwork -> (structure)

Returns details about a core network.

GlobalNetworkId -> (string)

The ID of the global network that your core network is a part of.

CoreNetworkId -> (string)

The ID of a core network.

CoreNetworkArn -> (string)

The ARN of a core network.

Description -> (string)

The description of a core network.

CreatedAt -> (timestamp)

The timestamp when a core network was created.

State -> (string)

The current state of a core network.

Segments -> (list)

The segments within a core network.

(structure)

Describes a core network segment, which are dedicated routes. Only attachments within this segment can communicate with each other.

Name -> (string)

The name of a core network segment.

EdgeLocations -> (list)

The Regions where the edges are located.

(string)

SharedSegments -> (list)

The shared segments of a core network.

(string)

Edges -> (list)

The edges within a core network.

(structure)

Describes a core network edge.

EdgeLocation -> (string)

The Region where a core network edge is located.

Asn -> (long)

The ASN of a core network edge.

InsideCidrBlocks -> (list)

The inside IP addresses used for core network edges.

(string)

Tags -> (list)

The tags associated with a core network.

(structure)

Describes a tag.

Key -> (string)

The tag key.

Constraints: Maximum length of 128 characters.

Value -> (string)

The tag value.

Constraints: Maximum length of 256 characters.