AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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

Synopsis

  create-core-network
--global-network-id <value>
[--description <value>]
[--tags <value>]
[--policy-document <value>]
[--client-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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-cdef-EXAMPLE22222 \
    --description "Main headquarters location" \
    --tags Key=Name,Value="New York City office"

Output:

{
    "CoreNetwork": {
        "GlobalNetworkId": "global-network-cdef-EXAMPLE22222",
        "CoreNetworkId": "core-network-cdef-EXAMPLE33333",
        "CoreNetworkArn": "arn:aws:networkmanager::987654321012:core-network/core-network-cdef-EXAMPLE33333",
        "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 Global and 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)

NetworkFunctionGroups -> (list)

The network function groups associated with a core network.

(structure)

Describes a network function group.

Name -> (string)

The name of the network function group.

EdgeLocations -> (list)

The core network edge locations.

(string)

Segments -> (structure)

The segments associated with the network function group.

SendVia -> (list)

The list of segments associated with the send-via action.

(string)

SendTo -> (list)

The list of segments associated with the send-to action.

(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 list of key-value 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.