URI
/v1/vpc-connection
HTTP methods
OPTIONS
Enable CORS by returning correct headers.
| Status code | Response model | Description |
|---|---|---|
200 | None | Default response for CORS method. |
POST
Operation ID: CreateVpcConnection
Create remote VPC connection.
| Status code | Response model | Description |
|---|---|---|
200 |
CreateVpcConnectionResponse | HTTP Status Code 200: OK. |
400 | Error | The request isn't valid because the input is incorrect. Correct your input and then submit it again. |
401 | Error | The request is not authorized. The provided credentials couldn't be validated. |
403 | Error | Access forbidden. Check your credentials and then retry your request. |
404 | Error | The resource could not be found due to incorrect input. Correct the input, then retry the request. |
429 | Error | 429 response |
500 | Error | There was an unexpected internal server error. Retrying your request might resolve the issue. |
503 | Error | 503 response |
Schemas
Request bodies
{
"authentication": "string",
"clientSubnets": [
"string"
],
"securityGroups": [
"string"
],
"tags": {
},
"targetClusterArn": "string",
"vpcId": "string"
}Response bodies
{
"authentication": "string",
"clientSubnets": [
"string"
],
"creationTime": "string",
"securityGroups": [
"string"
],
"state": enum,
"tags": {
},
"vpcConnectionArn": "string",
"vpcId": "string"
}{
"invalidParameter": "string",
"message": "string"
}Properties
CreateVpcConnectionRequest
Creates a remote VPC connection for account client.
| Property | Type | Required | Description |
|---|---|---|---|
authentication | string MinLength: 3 MaxLength: 10 | True | The authentication type for the client VPC connection. Specify one of these auth type strings: |
clientSubnets | Array of type string | True | The list of subnets in the client VPC to connect to. |
securityGroups | Array of type string | False | The security groups to attach to the ENIs for the broker nodes. |
tags | object | False | Create tags when creating the VPC connection. |
targetClusterArn | string | True | The Amazon Resource Name (ARN) of the cluster. |
vpcId | string | True | The VPC id of the remote client. |
CreateVpcConnectionResponse
Returns information about the created VPC connection.
| Property | Type | Required | Description |
|---|---|---|---|
authentication | string MinLength: 3 MaxLength: 10 | False | The type of authentication to be uses by remote clients. |
clientSubnets | Array of type string | False | The list of subnets in the client VPC to connect to. |
creationTime | string | False | The time when the VPC connection was created. |
securityGroups | Array of type string | False | The security groups to attach to the ENIs for the broker nodes. |
state | False | State of the VPC connection. | |
tags | object | False | Tags attached to the VPC connection. |
vpcConnectionArn | string | False | The Amazon Resource Name (ARN) of the remote VPC connection. |
vpcId | string | False | The VPC id of the remote client. |
Error
Returns information about an error.
| Property | Type | Required | Description |
|---|---|---|---|
invalidParameter | string | False | The parameter that caused the error. |
message | string | False | The description of the error. |
VpcConnectionState
State of the vpc connection
CREATINGAVAILABLEINACTIVEUPDATINGDEACTIVATINGDELETINGFAILEDREJECTEDREJECTING
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
CreateVpcConnection
