Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1462502349.5 KB

Creates a Private Connection to a target resource.

post/v1/private-connections

Request body

namestring required

Unique name for a Private Connection within an account.

tagsobject

Map of tag keys to values.

Response

Success

namestring required

The name of the Private Connection.

type'SELF_MANAGED' | 'SERVICE_MANAGED' required

The type of the Private Connection.

resourceGatewayIdstring

The service-managed Resource Gateway ARN. Only present for service-managed Private Connections.

hostAddressstring

IP address or DNS name of the target resource. Only present for service-managed Private Connections.

vpcIdstring

VPC identifier of the service-managed Resource Gateway. Only present for service-managed Private Connections.

resourceConfigurationIdstring

The Resource Configuration ARN. Only present for self-managed Private Connections.

status'ACTIVE' | 'CREATE_IN_PROGRESS' | 'CREATE_FAILED' | 'DELETE_IN_PROGRESS' | 'DELETE_FAILED' required

The status of the Private Connection.

certificateExpiryTimestring date-time

The expiry time of the certificate associated with the Private Connection. Only present when a certificate is associated.

dnsResolution'PUBLIC' | 'IN_VPC'

DNS resolution mode for the Private Connection's resource gateway.

failureMessagestring

Message describing the reason for a failed Private Connection creation, if applicable.

tagsobject

Tags associated with the created Private Connection.