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

Returns, adds, edits, and removes serverless instances.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git

Properties

ContinuousBackupEnabled boolean

Flag that indicates whether the serverless instances uses Serverless Continuous Backup. If this parameter is false, the serverless instance uses Basic Backup. | Option | Description | |---|---| | Serverless Continuous Backup | Atlas takes incremental snapshots of the data in your serverless instance every six hours and lets you restore the data from a selected point in time within the last 72 hours. Atlas also takes daily snapshots and retains these daily snapshots for 35 days. To learn more, see Serverless Instance Costs. | | Basic Backup | Atlas takes incremental snapshots of the data in your serverless instance every six hours and retains only the two most recent snapshots. You can use this option for free.

IncludeCount boolean

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

ItemsPerPage integer

Number of items that the response returns per page.

Name string | Aws_CF_FunctionString

Human-readable label that identifies the serverless instance.

PageNum integer

Number of the page that displays the current set of the total objects that the response returns.

ProjectID string | Aws_CF_FunctionString

Unique 24-hexadecimal digit string that identifies your project.

ProviderSettings object
2 nested properties
ProviderName string | Aws_CF_FunctionString

Human-readable label that identifies the cloud service provider.

RegionName string | Aws_CF_FunctionString

Human-readable label that identifies the geographic location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see AWS, GCP, and Azure.

TerminationProtectionEnabled boolean

Flag that indicates whether termination protection is enabled on the serverless instance. If set to true, MongoDB Cloud won't delete the serverless instance. If set to false, MongoDB cloud will delete the serverless instance."

Profile string | Aws_CF_FunctionString

Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used

Definitions

ServerlessInstanceConnectionStrings object
PrivateEndpoint object[]

List of private endpoint connection strings that you can use to connect to this serverless instance through a private endpoint. This parameter returns only if you created a private endpoint for this serverless instance and it is AVAILABLE.

StandardSrv string | Aws_CF_FunctionString

Public connection string that you can use to connect to this serverless instance. This connection string uses the mongodb+srv:// protocol.

ServerlessInstancePrivateEndpoint object
Endpoints object[]

List that contains the private endpoints through which you connect to MongoDB Cloud when you use connectionStrings.privateEndpoint[n].srvConnectionString.

SrvConnectionString string | Aws_CF_FunctionString

Private endpoint-aware connection string that uses the mongodb+srv:// protocol to connect to MongoDB Cloud through a private endpoint. The mongodb+srv protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS).

Type string | Aws_CF_FunctionString

MongoDB process type to which your application connects.

ServerlessInstancePrivateEndpointEndpoint object
EndpointId string | Aws_CF_FunctionString

Unique provider identifier of the private endpoint.

ProviderName string | Aws_CF_FunctionString

Cloud provider where the private endpoint is deployed.

Region string | Aws_CF_FunctionString

Region where the private endpoint is deployed.

ServerlessInstanceProviderSettings object
ProviderName string | Aws_CF_FunctionString

Human-readable label that identifies the cloud service provider.

RegionName string | Aws_CF_FunctionString

Human-readable label that identifies the geographic location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see AWS, GCP, and Azure.