AWS::ODB::OdbPeeringConnection - AWS CloudFormation
SyntaxPropertiesReturn values

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

AWS::ODB::OdbPeeringConnection

Creates a peering connection between an ODB network and either another ODB network or a customer-owned VPC.

A peering connection enables private connectivity between the networks for application-tier communication.

Syntax

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

JSON

{
  "Type" : "AWS::ODB::OdbPeeringConnection",
  "Properties" : {
      "DisplayName" : String,
      "OdbNetworkId" : String,
      "PeerNetworkId" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::ODB::OdbPeeringConnection
Properties:
  DisplayName: String
  OdbNetworkId: String
  PeerNetworkId: String
  Tags: 
    - Tag

Properties

DisplayName

The display name of the ODB peering connection.

Required: No

Type: String

Pattern: ^[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*$

Minimum: 1

Maximum: 255

Update requires: Replacement

OdbNetworkId

Property description not available.

Required: No

Type: String

Pattern: ^(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})$

Minimum: 6

Maximum: 2048

Update requires: Replacement

PeerNetworkId

Property description not available.

Required: No

Type: String

Pattern: ^(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})$

Minimum: 6

Maximum: 2048

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

OdbNetworkArn

The Amazon Resource Name (ARN) of the ODB network that initiated the peering connection.

OdbPeeringConnectionArn

The Amazon Resource Name (ARN) of the ODB peering connection.

OdbPeeringConnectionId

The unique identifier of the ODB peering connection. A sample ID is odbpcx-abcdefgh12345678.

PeerNetworkArn

The Amazon Resource Name (ARN) of the peer network.