View a markdown version of this page

AWS::NetworkManager::Connection - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::NetworkManager::Connection

Describes a connection.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::NetworkManager::Connection", "Properties" : { "ConnectedDeviceId" : String, "ConnectedLinkId" : String, "Description" : String, "DeviceId" : String, "GlobalNetworkId" : String, "LinkId" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::NetworkManager::Connection Properties: ConnectedDeviceId: String ConnectedLinkId: String Description: String DeviceId: String GlobalNetworkId: String LinkId: String Tags: - Tag

Properties

ConnectedDeviceId

The ID of the second device in the connection.

Required: Yes

Type: String

Pattern: ^device-[a-z0-9-]*$

Minimum: 1

Maximum: 50

Update requires: Replacement

ConnectedLinkId

The ID of the link for the second device in the connection.

Required: No

Type: String

Pattern: ^link-[a-z0-9-]*$

Minimum: 1

Maximum: 50

Update requires: No interruption

Description

The description of the connection.

Required: No

Type: String

Minimum: 1

Maximum: 256

Update requires: No interruption

DeviceId

The ID of the first device in the connection.

Required: Yes

Type: String

Pattern: ^device-[a-z0-9-]*$

Minimum: 1

Maximum: 50

Update requires: Replacement

GlobalNetworkId

The ID of the global network.

Required: Yes

Type: String

Pattern: ^global-network-[a-z0-9-]*$

Minimum: 1

Maximum: 50

Update requires: Replacement

LinkId

The ID of the link for the first device in the connection.

Required: No

Type: String

Pattern: ^link-[a-z0-9-]*$

Minimum: 1

Maximum: 50

Update requires: No interruption

Tags

The tags for the connection.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

ConnectionArn

The Amazon Resource Name (ARN) of the connection.

ConnectionId

The ID of the connection.

CreatedAt

The date and time that the connection was created.

State

The state of the connection.