AWS VPC Peer V2

Operations related to AWS VPC Peering with Cluster Data Centers.

List all AWS VPC Peering requests

SecurityBasic Authentication
Responses
200

Successfully retrieved AWS VPC Peering requests.

get/cluster-management/v2/data-sources/providers/aws/vpc-peers/v2
Request samples
Response samples
application/json
[
  • {
    }
]

Create AWS VPC Peering Request

Creates a new VPC Peering Connection request for the given AWS hosted Cluster Data Centre.

SecurityBasic Authentication
Request
Request Body schema: application/json
peerAwsAccountId
required
string

The AWS account ID of the owner of the accepter VPC.

peerSubnets
required
Array of strings

The subnets for the peering VPC.

peerVpcId
required
string

ID of the VPC with which the peering connection is created.

peerRegion
required
string

Region code for the accepter VPC.

cdcId
required
string <uuid>

ID of the Cluster Data Centre

Responses
202

AWS VPC Peering request created.

post/cluster-management/v2/resources/providers/aws/vpc-peers/v2
Request samples
application/json
{
  • "cdcId": "f3eab841-6952-430d-ba90-1bfc3f15da10",
  • "peerAwsAccountId": "123456789123",
  • "peerRegion": "US_EAST_1",
  • "peerSubnets": [
    ],
  • "peerVpcId": "vpc-123abc456"
}
Response samples
application/json
{
  • "cdcId": "f3eab841-6952-430d-ba90-1bfc3f15da10",
  • "peerAwsAccountId": "123456789123",
  • "peerRegion": "US_EAST_1",
  • "peerSubnets": [
    ],
  • "peerVpcId": "vpc-123abc456"
}

Get AWS VPC Peering Connection info

Fetches the details for a given AWS VPC Peering Connection.

SecurityBasic Authentication
Request
path Parameters
vpcPeerId
required
string <uuid>

ID of the VPC Peering Connection

Responses
200

AWS VPC Peering Connection info retrieved.

404

VPC Peering Connection not found.

get/cluster-management/v2/resources/providers/aws/vpc-peers/v2/{vpcPeerId}
Request samples
Response samples
application/json
{
  • "cdcId": "f3eab841-6952-430d-ba90-1bfc3f15da10",
  • "peerAwsAccountId": "123456789123",
  • "peerRegion": "US_EAST_1",
  • "peerSubnets": [
    ],
  • "peerVpcId": "vpc-123abc456"
}

Update AWS VPC Peering Connection info

SecurityBasic Authentication
Request
path Parameters
vpcPeerId
required
string <uuid>

ID of the VPC Peering Connection

Request Body schema: application/json
peerSubnets
required
Array of strings

The subnets for the peering VPC.

Responses
202

AWS VPC Peering updated

404

VPC Peering Connection not found.

put/cluster-management/v2/resources/providers/aws/vpc-peers/v2/{vpcPeerId}
Request samples
application/json
{
  • "peerSubnets": [
    ]
}
Response samples
application/json
{
  • "cdcId": "f3eab841-6952-430d-ba90-1bfc3f15da10",
  • "peerAwsAccountId": "123456789123",
  • "peerRegion": "US_EAST_1",
  • "peerSubnets": [
    ],
  • "peerVpcId": "vpc-123abc456"
}

Delete AWS VPC Peering Connection

SecurityBasic Authentication
Request
path Parameters
vpcPeerId
required
string <uuid>

ID of the VPC Peering Connection

Responses
204

AWS VPC Peering request deleted

404

VPC Peering Connection not found.

delete/cluster-management/v2/resources/providers/aws/vpc-peers/v2/{vpcPeerId}
Request samples
Response samples
application/json
{
  • "errors": [
    ]
}