Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--mongodb-atlas-privateendpoint.json
Parent schema serverless-framework-configuration
Type: object

The Private Endpoint creation flow consists of the creation of three related resources in the next order: 1. Atlas Private Endpoint Service 2. Aws VPC private Endpoint 3. Atlas Private Endpoint. Source:- No source definition found, add manually please

Properties

GroupId string | Aws_CF_FunctionString required

Unique 24-hexadecimal digit string that identifies your project.

Region string | Aws_CF_FunctionString required

Aws Region

Profile string | Aws_CF_FunctionString

The profile is defined in AWS Secret manager. See [Secret Manager Profile setup (../../../examples/profile-secret.yaml)

EndpointServiceName string | Aws_CF_FunctionString

Name of the AWS PrivateLink endpoint service. Atlas returns null while it is creating the endpoint service.

ErrorMessage string | Aws_CF_FunctionString

Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors.

Status string | Aws_CF_FunctionString

Status of the Atlas PrivateEndpoint service connection

PrivateEndpoints PrivateEndpoint[]

List of private endpoint associated to the service

Definitions

PrivateEndpoint object
VpcId string | Aws_CF_FunctionString

String Representing the AWS VPC ID (like: vpc-xxxxxxxxxxxxxxxx) (Used For Creating the AWS VPC Endpoint)

SubnetIds string[]

List of string representing the AWS VPC Subnet ID (like: subnet-xxxxxxxxxxxxxxxxx) (Used For Creating the AWS VPC Endpoint)

InterfaceEndpointId string | Aws_CF_FunctionString

Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.

AWSPrivateEndpointStatus string | Aws_CF_FunctionString

Status of the AWS PrivateEndpoint connection.

AtlasPrivateEndpointStatus string | Aws_CF_FunctionString

Status of the Atlas PrivateEndpoint connection.