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-connect-peer

Description

Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

See also: AWS API Documentation

Synopsis

  create-connect-peer
--connect-attachment-id <value>
[--core-network-address <value>]
--peer-address <value>
[--bgp-options <value>]
[--inside-cidr-blocks <value>]
[--tags <value>]
[--client-token <value>]
[--subnet-arn <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

--connect-attachment-id (string)

The ID of the connection attachment.

--core-network-address (string)

A Connect peer core network address. This only applies only when the protocol is GRE .

--peer-address (string)

The Connect peer address.

--bgp-options (structure)

The Connect peer BGP options. This only applies only when the protocol is GRE .

PeerAsn -> (long)

The Peer ASN of the BGP.

Shorthand Syntax:

PeerAsn=long

JSON Syntax:

{
  "PeerAsn": long
}

--inside-cidr-blocks (list)

The inside IP addresses used for BGP peering.

(string)

Syntax:

"string" "string" ...

--tags (list)

The tags associated with the peer 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"
  }
  ...
]

--client-token (string)

The client token associated with the request.

--subnet-arn (string)

The subnet ARN for the Connect peer. This only applies only when the protocol is NO_ENCAP.

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

Output

ConnectPeer -> (structure)

The response to the request.

CoreNetworkId -> (string)

The ID of a core network.

ConnectAttachmentId -> (string)

The ID of the attachment to connect.

ConnectPeerId -> (string)

The ID of the Connect peer.

EdgeLocation -> (string)

The Connect peer Regions where edges are located.

State -> (string)

The state of the Connect peer.

CreatedAt -> (timestamp)

The timestamp when the Connect peer was created.

Configuration -> (structure)

The configuration of the Connect peer.

CoreNetworkAddress -> (string)

The IP address of a core network.

PeerAddress -> (string)

The IP address of the Connect peer.

InsideCidrBlocks -> (list)

The inside IP addresses used for a Connect peer configuration.

(string)

Protocol -> (string)

The protocol used for a Connect peer configuration.

BgpConfigurations -> (list)

The Connect peer BGP configurations.

(structure)

Describes a core network BGP configuration.

CoreNetworkAsn -> (long)

The ASN of the Coret Network.

PeerAsn -> (long)

The ASN of the Connect peer.

CoreNetworkAddress -> (string)

The address of a core network.

PeerAddress -> (string)

The address of a core network Connect peer.

Tags -> (list)

The list of key-value tags associated with the Connect peer.

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

SubnetArn -> (string)

The subnet ARN for the Connect peer. This only applies only when the protocol is NO_ENCAP.

LastModificationErrors -> (list)

Describes the error associated with the attachment request.

(structure)

Describes an error associated with a Connect peer request

Code -> (string)

The error code for the Connect peer request.

Message -> (string)

The message associated with the error code .

ResourceArn -> (string)

The ARN of the requested Connect peer resource.

RequestId -> (string)

The ID of the Connect peer request.