[ aws . networkmanager ]

get-connect-peer

Description

Returns information about a core network Connect peer.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-connect-peer
--connect-peer-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--connect-peer-id (string)

The ID of the Connect peer.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

ConnectPeer -> (structure)

Returns information about a core network Connect peer.

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.