Sign in
Subscriptions - Pro - Connectivity

Create a Private Link for a specific region

(Active-Active subscriptions only) Creates a new Private Link for a specific region.

post/v1/subscriptions/{subscriptionId}/regions/{regionId}/private-link

Path parameters

subscriptionIdinteger required

Subscription ID.

regionIdinteger required

Region ID - required for Active-Active subscription

Request body

subscriptionIdinteger
regionIdinteger required

Deployment region id as defined by cloud provider

shareNamestring required

Name for the resource share

principalstring required

AWS account ID or ARN of the principal (IAM user, role, or account)

type'aws_account' | 'organization' | 'organization_unit' | 'iam_role' | 'iam_user' | 'service_principal' required

Type of the principal

aliasstring

Alias or friendly name for the principal

commandTypestring

Example request

{
  "shareName": "my-private-link-share",
  "principal": "123456789012",
  "type": "aws_account",
  "alias": "Production Account"
}

Response

No Content

taskIdstring uuid
commandTypestring
status'initialized' | 'received' | 'processing-in-progress' | 'processing-completed' | 'processing-error'
descriptionstring
timestampstring date-time
linksobject[]

Changes

Changed in 3 of the 68 revisions of this API.111