Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

CreatePrivateConnectivityConfig

Creates the private connectivity configuration for the specified Outpost. Private connectivity establishes a service link VPN connection between the Outpost and its home AWS Region using a VPC and subnet that you specify, which allows the service link traffic to flow through your VPC and minimizes public internet exposure.

Request Syntax


POST /outposts/OutpostId/privateConnectivity HTTP/1.1
Content-type: application/json

{
   "VpcInformationList": [ 
      { 
         "SubnetIds": [ "string" ],
         "VpcEndpointId": "string",
         "VpcId": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

OutpostId

The ID or ARN of the Outpost.

Note

Despite the parameter name, you can make the request with an ARN. The parameter name is OutpostId for backward compatibility.

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

Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

VpcInformationList

Information about the VPC used for private connectivity, including the VPC, its subnets, and an associated VPC endpoint. You can specify at most one entry.

Type: Array of VpcInformation objects

Array Members: Fixed number of 1 item.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "OutpostId": "string",
   "PrivateConnectivityConfig": { 
      "PrivateConnectivityStatus": "string",
      "ProvisioningRoleArn": "string",
      "RoleArn": "string",
      "VpcInformationList": [ 
         { 
            "SubnetIds": [ "string" ],
            "VpcEndpointId": "string",
            "VpcId": "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.

OutpostId

The ID of the Outpost.

Type: String

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

Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$

PrivateConnectivityConfig

The private connectivity configuration for the Outpost.

Type: PrivateConnectivityConfig object

Errors

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

AccessDeniedException

You do not have permission to perform this operation.

HTTP Status Code: 403

ConflictException

Updating or deleting this resource can cause an inconsistent state.

ResourceId: The ID of the resource causing the conflict.
ResourceType: The type of the resource causing the conflict.

HTTP Status Code: 409

InternalServerException

An internal error has occurred.

HTTP Status Code: 500

NotFoundException

The specified request is not valid.

HTTP Status Code: 404

ValidationException

A parameter is not valid.

HTTP Status Code: 400

Examples

Example

This example creates the private connectivity configuration for the specified Outpost. VpcInformationList is required and specifies the VPC, subnet, and associated VPC endpoint used for private connectivity.

Sample Request


aws outposts create-private-connectivity-config --outpost-id op-1234567890example --vpc-information-list '[{"VpcId":"vpc-0abcd1234example","SubnetIds":["subnet-0abcd1234example"],"VpcEndpointId":"vpce-0ab1234cd5678ef90"}]'

Sample Response


{
  "OutpostId": "op-1234567890example",
  "PrivateConnectivityConfig": {
    "RoleArn": "arn:aws:iam::123456789012:role/aws-service-role/outposts.amazonaws.com/AWSServiceRoleForOutposts_op-1234567890example",
    "PrivateConnectivityStatus": "ENABLED",
    "VpcInformationList": [
      {
        "VpcId": "vpc-0abcd1234example",
        "SubnetIds": [
          "subnet-0abcd1234example"
        ],
        "VpcEndpointId": "vpce-0ab1234cd5678ef90"
      }
    ],
    "ProvisioningRoleArn": "arn:aws:iam::123456789012:role/service-role/AWSOutpostsProvisioningRole_op-1234567890example"
  }
}