MongoDB Atlas v3.7.2, Mar 31 23

mongodbatlas.ServerlessInstance

Explore with Pulumi AI

Import

Serverless Instance can be imported using the group ID and serverless instance name, in the format GROUP_ID-SERVERLESS_INSTANCE_NAME, e.g.

 $ pulumi import mongodbatlas:index/serverlessInstance:ServerlessInstance my_serverless_instance 1112222b3bf99403840e8934-My Serverless Instance

For more information seeMongoDB Atlas API - Serverless Instance Documentation.

Create ServerlessInstance Resource

new ServerlessInstance(name: string, args: ServerlessInstanceArgs, opts?: CustomResourceOptions);

@overload
def ServerlessInstance(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       continuous_backup_enabled: Optional[bool] = None,
                       links: Optional[Sequence[ServerlessInstanceLinkArgs]] = None,
                       name: Optional[str] = None,
                       project_id: Optional[str] = None,
                       provider_settings_backing_provider_name: Optional[str] = None,
                       provider_settings_provider_name: Optional[str] = None,
                       provider_settings_region_name: Optional[str] = None,
                       state_name: Optional[str] = None,
                       termination_protection_enabled: Optional[bool] = None)
@overload
def ServerlessInstance(resource_name: str,
                       args: ServerlessInstanceArgs,
                       opts: Optional[ResourceOptions] = None)

func NewServerlessInstance(ctx *Context, name string, args ServerlessInstanceArgs, opts ...ResourceOption) (*ServerlessInstance, error)

public ServerlessInstance(string name, ServerlessInstanceArgs args, CustomResourceOptions? opts = null)

public ServerlessInstance(String name, ServerlessInstanceArgs args)
public ServerlessInstance(String name, ServerlessInstanceArgs args, CustomResourceOptions options)

type: mongodbatlas:ServerlessInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ServerlessInstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ServerlessInstanceArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ServerlessInstanceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ServerlessInstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ServerlessInstanceArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

ServerlessInstance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ServerlessInstance resource accepts the following input properties:

ProjectId string: The ID of the organization or project you want to create the serverless instance within.
ProviderSettingsBackingProviderName string: Cloud service provider on which MongoDB Cloud provisioned the serverless instance.
ProviderSettingsProviderName string: Cloud service provider that applies to the provisioned the serverless instance.
ProviderSettingsRegionName string: Human-readable label that identifies the physical location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases.
ContinuousBackupEnabled bool: Flag that indicates whether the serverless instance uses Serverless Continuous Backup. If this parameter is false or not used, the serverless instance uses Basic Backup.
Links List<ServerlessInstanceLinkArgs>
Name string: Human-readable label that identifies the serverless instance.
StateName string: Stage of deployment of this serverless instance when the resource made its request.
TerminationProtectionEnabled bool: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

ProjectId string: The ID of the organization or project you want to create the serverless instance within.
ProviderSettingsBackingProviderName string: Cloud service provider on which MongoDB Cloud provisioned the serverless instance.
ProviderSettingsProviderName string: Cloud service provider that applies to the provisioned the serverless instance.
ProviderSettingsRegionName string: Human-readable label that identifies the physical location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases.
ContinuousBackupEnabled bool: Flag that indicates whether the serverless instance uses Serverless Continuous Backup. If this parameter is false or not used, the serverless instance uses Basic Backup.
Links []ServerlessInstanceLinkArgs
Name string: Human-readable label that identifies the serverless instance.
StateName string: Stage of deployment of this serverless instance when the resource made its request.
TerminationProtectionEnabled bool: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

projectId String: The ID of the organization or project you want to create the serverless instance within.
providerSettingsBackingProviderName String: Cloud service provider on which MongoDB Cloud provisioned the serverless instance.
providerSettingsProviderName String: Cloud service provider that applies to the provisioned the serverless instance.
providerSettingsRegionName String: Human-readable label that identifies the physical location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases.
continuousBackupEnabled Boolean: Flag that indicates whether the serverless instance uses Serverless Continuous Backup. If this parameter is false or not used, the serverless instance uses Basic Backup.
links List<ServerlessInstanceLinkArgs>
name String: Human-readable label that identifies the serverless instance.
stateName String: Stage of deployment of this serverless instance when the resource made its request.
terminationProtectionEnabled Boolean: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

projectId string: The ID of the organization or project you want to create the serverless instance within.
providerSettingsBackingProviderName string: Cloud service provider on which MongoDB Cloud provisioned the serverless instance.
providerSettingsProviderName string: Cloud service provider that applies to the provisioned the serverless instance.
providerSettingsRegionName string: Human-readable label that identifies the physical location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases.
continuousBackupEnabled boolean: Flag that indicates whether the serverless instance uses Serverless Continuous Backup. If this parameter is false or not used, the serverless instance uses Basic Backup.
links ServerlessInstanceLinkArgs[]
name string: Human-readable label that identifies the serverless instance.
stateName string: Stage of deployment of this serverless instance when the resource made its request.
terminationProtectionEnabled boolean: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

project_id str: The ID of the organization or project you want to create the serverless instance within.
provider_settings_backing_provider_name str: Cloud service provider on which MongoDB Cloud provisioned the serverless instance.
provider_settings_provider_name str: Cloud service provider that applies to the provisioned the serverless instance.
provider_settings_region_name str: Human-readable label that identifies the physical location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases.
continuous_backup_enabled bool: Flag that indicates whether the serverless instance uses Serverless Continuous Backup. If this parameter is false or not used, the serverless instance uses Basic Backup.
links Sequence[ServerlessInstanceLinkArgs]
name str: Human-readable label that identifies the serverless instance.
state_name str: Stage of deployment of this serverless instance when the resource made its request.
termination_protection_enabled bool: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

projectId String: The ID of the organization or project you want to create the serverless instance within.
providerSettingsBackingProviderName String: Cloud service provider on which MongoDB Cloud provisioned the serverless instance.
providerSettingsProviderName String: Cloud service provider that applies to the provisioned the serverless instance.
providerSettingsRegionName String: Human-readable label that identifies the physical location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases.
continuousBackupEnabled Boolean: Flag that indicates whether the serverless instance uses Serverless Continuous Backup. If this parameter is false or not used, the serverless instance uses Basic Backup.
links List<Property Map>
name String: Human-readable label that identifies the serverless instance.
stateName String: Stage of deployment of this serverless instance when the resource made its request.
terminationProtectionEnabled Boolean: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

Outputs

All input properties are implicitly available as output properties. Additionally, the ServerlessInstance resource produces the following output properties:

ConnectionStringsPrivateEndpointSrvs List<string>: List of Serverless Private Endpoint Connections
ConnectionStringsStandardSrv string: Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
CreateDate string: Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
Id string: The provider-assigned unique ID for this managed resource.
MongoDbVersion string: Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.

ConnectionStringsPrivateEndpointSrvs []string: List of Serverless Private Endpoint Connections
ConnectionStringsStandardSrv string: Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
CreateDate string: Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
Id string: The provider-assigned unique ID for this managed resource.
MongoDbVersion string: Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.

connectionStringsPrivateEndpointSrvs List<String>: List of Serverless Private Endpoint Connections
connectionStringsStandardSrv String: Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
createDate String: Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
id String: The provider-assigned unique ID for this managed resource.
mongoDbVersion String: Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.

connectionStringsPrivateEndpointSrvs string[]: List of Serverless Private Endpoint Connections
connectionStringsStandardSrv string: Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
createDate string: Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
id string: The provider-assigned unique ID for this managed resource.
mongoDbVersion string: Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.

connection_strings_private_endpoint_srvs Sequence[str]: List of Serverless Private Endpoint Connections
connection_strings_standard_srv str: Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
create_date str: Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
id str: The provider-assigned unique ID for this managed resource.
mongo_db_version str: Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.

connectionStringsPrivateEndpointSrvs List<String>: List of Serverless Private Endpoint Connections
connectionStringsStandardSrv String: Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
createDate String: Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
id String: The provider-assigned unique ID for this managed resource.
mongoDbVersion String: Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.

Look up Existing ServerlessInstance Resource

Get an existing ServerlessInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ServerlessInstanceState, opts?: CustomResourceOptions): ServerlessInstance

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connection_strings_private_endpoint_srvs: Optional[Sequence[str]] = None,
        connection_strings_standard_srv: Optional[str] = None,
        continuous_backup_enabled: Optional[bool] = None,
        create_date: Optional[str] = None,
        links: Optional[Sequence[ServerlessInstanceLinkArgs]] = None,
        mongo_db_version: Optional[str] = None,
        name: Optional[str] = None,
        project_id: Optional[str] = None,
        provider_settings_backing_provider_name: Optional[str] = None,
        provider_settings_provider_name: Optional[str] = None,
        provider_settings_region_name: Optional[str] = None,
        state_name: Optional[str] = None,
        termination_protection_enabled: Optional[bool] = None) -> ServerlessInstance

func GetServerlessInstance(ctx *Context, name string, id IDInput, state *ServerlessInstanceState, opts ...ResourceOption) (*ServerlessInstance, error)

public static ServerlessInstance Get(string name, Input<string> id, ServerlessInstanceState? state, CustomResourceOptions? opts = null)

public static ServerlessInstance get(String name, Output<String> id, ServerlessInstanceState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ConnectionStringsPrivateEndpointSrvs List<string>: List of Serverless Private Endpoint Connections
ConnectionStringsStandardSrv string: Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
ContinuousBackupEnabled bool: Flag that indicates whether the serverless instance uses Serverless Continuous Backup. If this parameter is false or not used, the serverless instance uses Basic Backup.
CreateDate string: Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
Links List<ServerlessInstanceLinkArgs>
MongoDbVersion string: Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
Name string: Human-readable label that identifies the serverless instance.
ProjectId string: The ID of the organization or project you want to create the serverless instance within.
ProviderSettingsBackingProviderName string: Cloud service provider on which MongoDB Cloud provisioned the serverless instance.
ProviderSettingsProviderName string: Cloud service provider that applies to the provisioned the serverless instance.
ProviderSettingsRegionName string: Human-readable label that identifies the physical location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases.
StateName string: Stage of deployment of this serverless instance when the resource made its request.
TerminationProtectionEnabled bool: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

ConnectionStringsPrivateEndpointSrvs []string: List of Serverless Private Endpoint Connections
ConnectionStringsStandardSrv string: Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
ContinuousBackupEnabled bool: Flag that indicates whether the serverless instance uses Serverless Continuous Backup. If this parameter is false or not used, the serverless instance uses Basic Backup.
CreateDate string: Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
Links []ServerlessInstanceLinkArgs
MongoDbVersion string: Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
Name string: Human-readable label that identifies the serverless instance.
ProjectId string: The ID of the organization or project you want to create the serverless instance within.
ProviderSettingsBackingProviderName string: Cloud service provider on which MongoDB Cloud provisioned the serverless instance.
ProviderSettingsProviderName string: Cloud service provider that applies to the provisioned the serverless instance.
ProviderSettingsRegionName string: Human-readable label that identifies the physical location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases.
StateName string: Stage of deployment of this serverless instance when the resource made its request.
TerminationProtectionEnabled bool: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

connectionStringsPrivateEndpointSrvs List<String>: List of Serverless Private Endpoint Connections
connectionStringsStandardSrv String: Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
continuousBackupEnabled Boolean: Flag that indicates whether the serverless instance uses Serverless Continuous Backup. If this parameter is false or not used, the serverless instance uses Basic Backup.
createDate String: Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
links List<ServerlessInstanceLinkArgs>
mongoDbVersion String: Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
name String: Human-readable label that identifies the serverless instance.
projectId String: The ID of the organization or project you want to create the serverless instance within.
providerSettingsBackingProviderName String: Cloud service provider on which MongoDB Cloud provisioned the serverless instance.
providerSettingsProviderName String: Cloud service provider that applies to the provisioned the serverless instance.
providerSettingsRegionName String: Human-readable label that identifies the physical location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases.
stateName String: Stage of deployment of this serverless instance when the resource made its request.
terminationProtectionEnabled Boolean: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

connectionStringsPrivateEndpointSrvs string[]: List of Serverless Private Endpoint Connections
connectionStringsStandardSrv string: Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
continuousBackupEnabled boolean: Flag that indicates whether the serverless instance uses Serverless Continuous Backup. If this parameter is false or not used, the serverless instance uses Basic Backup.
createDate string: Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
links ServerlessInstanceLinkArgs[]
mongoDbVersion string: Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
name string: Human-readable label that identifies the serverless instance.
projectId string: The ID of the organization or project you want to create the serverless instance within.
providerSettingsBackingProviderName string: Cloud service provider on which MongoDB Cloud provisioned the serverless instance.
providerSettingsProviderName string: Cloud service provider that applies to the provisioned the serverless instance.
providerSettingsRegionName string: Human-readable label that identifies the physical location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases.
stateName string: Stage of deployment of this serverless instance when the resource made its request.
terminationProtectionEnabled boolean: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

connection_strings_private_endpoint_srvs Sequence[str]: List of Serverless Private Endpoint Connections
connection_strings_standard_srv str: Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
continuous_backup_enabled bool: Flag that indicates whether the serverless instance uses Serverless Continuous Backup. If this parameter is false or not used, the serverless instance uses Basic Backup.
create_date str: Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
links Sequence[ServerlessInstanceLinkArgs]
mongo_db_version str: Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
name str: Human-readable label that identifies the serverless instance.
project_id str: The ID of the organization or project you want to create the serverless instance within.
provider_settings_backing_provider_name str: Cloud service provider on which MongoDB Cloud provisioned the serverless instance.
provider_settings_provider_name str: Cloud service provider that applies to the provisioned the serverless instance.
provider_settings_region_name str: Human-readable label that identifies the physical location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases.
state_name str: Stage of deployment of this serverless instance when the resource made its request.
termination_protection_enabled bool: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

connectionStringsPrivateEndpointSrvs List<String>: List of Serverless Private Endpoint Connections
connectionStringsStandardSrv String: Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
continuousBackupEnabled Boolean: Flag that indicates whether the serverless instance uses Serverless Continuous Backup. If this parameter is false or not used, the serverless instance uses Basic Backup.
createDate String: Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
links List<Property Map>
mongoDbVersion String: Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
name String: Human-readable label that identifies the serverless instance.
projectId String: The ID of the organization or project you want to create the serverless instance within.
providerSettingsBackingProviderName String: Cloud service provider on which MongoDB Cloud provisioned the serverless instance.
providerSettingsProviderName String: Cloud service provider that applies to the provisioned the serverless instance.
providerSettingsRegionName String: Human-readable label that identifies the physical location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases.
stateName String: Stage of deployment of this serverless instance when the resource made its request.
terminationProtectionEnabled Boolean: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

Supporting Types

ServerlessInstanceLink

Href string
Rel string

Href string
Rel string

href String
rel String

href string
rel string

href str
rel str

href String
rel String

Package Details

Repository: MongoDB Atlas pulumi/pulumi-mongodbatlas
License: Apache-2.0
Notes: This Pulumi package is based on the mongodbatlas Terraform Provider.