Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateOdbPeeringConnection

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.

Request Syntax


{
   "clientToken": "string",
   "displayName": "string",
   "odbNetworkId": "string",
   "peerNetworkId": "string",
   "tags": { 
      "string" : "string" 
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

clientToken

The client token for the ODB peering connection request.

Constraints:

Must be unique for each request.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 64.

Pattern: [a-zA-Z0-9_\/.=-]+

Required: No

displayName

The display name for the ODB peering connection.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

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

Required: No

odbNetworkId

The unique identifier of the ODB network that initiates the peering connection.

Type: String

Length Constraints: Minimum length of 6. Maximum length of 2048.

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})

Required: Yes

peerNetworkId

The unique identifier of the peer network. This can be either a VPC ID or another ODB network ID.

Type: String

Length Constraints: Minimum length of 6. Maximum length of 2048.

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})

Required: Yes

tags

The tags to assign to the ODB peering connection.

Type: String to string map

Map Entries: Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


{
   "displayName": "string",
   "odbPeeringConnectionId": "string",
   "status": "string",
   "statusReason": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

displayName

The display name of the ODB peering connection.

Type: String

odbPeeringConnectionId

The unique identifier of the ODB peering connection.

Type: String

status

The status of the ODB peering connection.

Valid Values: provisioning | active | terminating | terminated | failed

Type: String

statusReason

The reason for the current status of the ODB peering connection.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

HTTP Status Code: 400

ConflictException

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

HTTP Status Code: 400

InternalServerException

Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.

HTTP Status Code: 500

ResourceNotFoundException

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The request has failed validation because it is missing required fields or has invalid inputs.

HTTP Status Code: 400