1. Docs
  2. Reference
  3. API
  4. @pulumi/mongodbatlas
  5. types
  6. output

Module types/output

APIs

APIs

interface AlertConfigurationMatcher

interface AlertConfigurationMatcher

property fieldName

fieldName?: undefined | string;

Name of the field in the target object to match on. Host alerts support these fields: - TYPE_NAME - HOSTNAME - PORT - HOSTNAME_AND_PORT - REPLICA_SET_NAME Replica set alerts support these fields: - REPLICA_SET_NAME - SHARD_NAME - CLUSTER_NAME Sharded cluster alerts support these fields: - CLUSTER_NAME - SHARD_NAME

property operator

operator?: undefined | string;

Operator to apply when checking the current metric value against the threshold value. Accepted values are: - GREATER_THAN - LESS_THAN

property value

value?: undefined | string;

Value to test with the specified operator. If fieldName is set to TYPE_NAME, you can match on the following values: - PRIMARY - SECONDARY - STANDALONE - CONFIG - MONGOS

interface AlertConfigurationMetricThreshold

interface AlertConfigurationMetricThreshold

property metricName

metricName?: undefined | string;

Name of the metric to check.

property mode

mode?: undefined | string;

This must be set to AVERAGE. Atlas computes the current metric value as an average.

property operator

operator?: undefined | string;

Operator to apply when checking the current metric value against the threshold value. Accepted values are: - GREATER_THAN - LESS_THAN

property threshold

threshold?: undefined | number;

Threshold value outside of which an alert will be triggered.

property units

units?: undefined | string;

The units for the threshold value. Depends on the type of metric. Accepted values are: - RAW - BITS - BYTES - KILOBITS - KILOBYTES - MEGABITS - MEGABYTES - GIGABITS - GIGABYTES - TERABYTES - PETABYTES - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS

interface AlertConfigurationNotification

interface AlertConfigurationNotification

property apiToken

apiToken?: undefined | string;

Slack API token. Required for the SLACK notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

property channelName

channelName?: undefined | string;

Slack channel name. Required for the SLACK notifications type.

property datadogApiKey

datadogApiKey?: undefined | string;

Datadog API Key. Found in the Datadog dashboard. Required for the DATADOG notifications type.

property datadogRegion

datadogRegion?: undefined | string;

Region that indicates which API URL to use. Accepted regions are: US, EU. The default Datadog region is US.

property delayMin

delayMin?: undefined | number;

Number of minutes to wait after an alert condition is detected before sending out the first notification.

property emailAddress

emailAddress?: undefined | string;

Email address to which alert notifications are sent. Required for the EMAIL notifications type.

property emailEnabled

emailEnabled?: undefined | false | true;

Flag indicating if email notifications should be sent. Configurable for ORG, GROUP, and USER notifications types.

property flowName

flowName?: undefined | string;

Flowdock flow name in lower-case letters. Required for the FLOWDOCK notifications type

property flowdockApiToken

flowdockApiToken?: undefined | string;

The Flowdock personal API token. Required for the FLOWDOCK notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

property intervalMin

intervalMin?: undefined | number;

Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.

property mobileNumber

mobileNumber?: undefined | string;

Mobile number to which alert notifications are sent. Required for the SMS notifications type.

property opsGenieApiKey

opsGenieApiKey?: undefined | string;

Opsgenie API Key. Required for the OPS_GENIE notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

property opsGenieRegion

opsGenieRegion?: undefined | string;

Region that indicates which API URL to use. Accepted regions are: US ,EU. The default Opsgenie region is US.

property orgName

orgName?: undefined | string;

Flowdock organization name in lower-case letters. This is the name that appears after www.flowdock.com/app/ in the URL string. Required for the FLOWDOCK notifications type.

property roles

roles?: string[];

property serviceKey

serviceKey?: undefined | string;

PagerDuty service key. Required for the PAGER_DUTY notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.

property smsEnabled

smsEnabled?: undefined | false | true;

Flag indicating if text message notifications should be sent. Configurable for ORG, GROUP, and USER notifications types.

property teamId

teamId?: undefined | string;

Unique identifier of a team.

property typeName

typeName?: undefined | string;

Type of alert notification. Accepted values are: - DATADOG - EMAIL - FLOWDOCK - GROUP (Project) - OPS_GENIE - ORG - PAGER_DUTY - SLACK - SMS - TEAM - USER - VICTOR_OPS - WEBHOOK

property username

username?: undefined | string;

Name of the Atlas user to which to send notifications. Only a user in the project that owns the alert configuration is allowed here. Required for the USER notifications type.

property victorOpsApiKey

victorOpsApiKey?: undefined | string;

VictorOps API key. Required for the VICTOR_OPS notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.

property victorOpsRoutingKey

victorOpsRoutingKey?: undefined | string;

VictorOps routing key. Optional for the VICTOR_OPS notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.

interface CloudProviderSnapshotBackupPolicyPolicy

interface CloudProviderSnapshotBackupPolicyPolicy

property id

id: string;

property policyItems

policyItems: CloudProviderSnapshotBackupPolicyPolicyPolicyItem[];

interface CloudProviderSnapshotBackupPolicyPolicyPolicyItem

interface CloudProviderSnapshotBackupPolicyPolicyPolicyItem

property frequencyInterval

frequencyInterval: number;

property frequencyType

frequencyType: string;

property id

id: string;

property retentionUnit

retentionUnit: string;

property retentionValue

retentionValue: number;

interface CloudProviderSnapshotRestoreJobDeliveryType

interface CloudProviderSnapshotRestoreJobDeliveryType

property automated

automated?: undefined | false | true;

property download

download?: undefined | false | true;

property targetClusterName

targetClusterName?: undefined | string;

Name of the target Atlas cluster to which the restore job restores the snapshot. Only required if deliveryType is automated.

property targetProjectId

targetProjectId?: undefined | string;

interface ClusterAdvancedConfiguration

interface ClusterAdvancedConfiguration

property failIndexKeyTooLong

failIndexKeyTooLong: boolean;

When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.

property javascriptEnabled

javascriptEnabled: boolean;

When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.

property minimumEnabledTlsProtocol

minimumEnabledTlsProtocol: string;

Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections.Valid values are:

property noTableScan

noTableScan: boolean;

When true, the cluster disables the execution of any query that requires a collection scan to return results. When false, the cluster allows the execution of those operations.

property oplogSizeMb

oplogSizeMb: number;

The custom oplog size of the cluster. Without a value that indicates that the cluster uses the default oplog size calculated by Atlas.

property sampleRefreshIntervalBiConnector

sampleRefreshIntervalBiConnector: number;

Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

property sampleSizeBiConnector

sampleSizeBiConnector: number;

Number of documents per database to sample when gathering schema information. Defaults to 100. Available only for Atlas deployments in which BI Connector for Atlas is enabled.

interface ClusterBiConnector

interface ClusterBiConnector

property enabled

enabled: string;

Specifies whether or not BI Connector for Atlas is enabled on the cluster. - Set to true to enable BI Connector for Atlas. - Set to false to disable BI Connector for Atlas.

property readPreference

readPreference: string;

Specifies the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

interface ClusterConnectionStrings

interface ClusterConnectionStrings
awsPrivateLink: {[key: string]: any};

property awsPrivateLinkSrv

awsPrivateLinkSrv: {[key: string]: any};

property private

private: string;

property privateSrv

privateSrv: string;

property standard

standard: string;

property standardSrv

standardSrv: string;

interface ClusterLabel

interface ClusterLabel

property key

key: string;

The key that you want to write.

property value

value: string;

The value that you want to write.

interface ClusterReplicationSpec

interface ClusterReplicationSpec

property id

id: string;

Unique identifer of the replication document for a zone in a Global Cluster.

property numShards

numShards: number;

Number of shards to deploy in the specified zone.

property regionsConfigs

regionsConfigs: ClusterReplicationSpecRegionsConfig[];

Physical location of the region. Each regionsConfig document describes the region’s priority in elections and the number and type of MongoDB nodes Atlas deploys to the region. You must order each regionsConfigs document by regionsConfig.priority, descending. See Region Config below for more details.

property zoneName

zoneName?: undefined | string;

Name for the zone in a Global Cluster.

interface ClusterReplicationSpecRegionsConfig

interface ClusterReplicationSpecRegionsConfig

property analyticsNodes

analyticsNodes?: undefined | number;

The number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary.

property electableNodes

electableNodes: number;

Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can facilitate local reads.

property priority

priority: number;

Election priority of the region. For regions with only read-only nodes, set this value to 0.

property readOnlyNodes

readOnlyNodes?: undefined | number;

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can facilitate local-reads. Specify 0 if you do not want any read-only nodes in the region.

property regionName

regionName: string;

Name for the region specified.

interface ClusterSnapshotBackupPolicy

interface ClusterSnapshotBackupPolicy

property clusterId

clusterId: string;

The cluster ID.

property clusterName

clusterName: string;

property nextSnapshot

nextSnapshot: string;

property policies

policies: ClusterSnapshotBackupPolicyPolicy[];

property referenceHourOfDay

referenceHourOfDay: number;

property referenceMinuteOfHour

referenceMinuteOfHour: number;

property restoreWindowDays

restoreWindowDays: number;

property updateSnapshots

updateSnapshots: boolean;

interface ClusterSnapshotBackupPolicyPolicy

interface ClusterSnapshotBackupPolicyPolicy

property id

id: string;

Unique identifer of the replication document for a zone in a Global Cluster.

property policyItems

policyItems: ClusterSnapshotBackupPolicyPolicyPolicyItem[];

interface ClusterSnapshotBackupPolicyPolicyPolicyItem

interface ClusterSnapshotBackupPolicyPolicyPolicyItem

property frequencyInterval

frequencyInterval: number;

property frequencyType

frequencyType: string;

property id

id: string;

Unique identifer of the replication document for a zone in a Global Cluster.

property retentionUnit

retentionUnit: string;

property retentionValue

retentionValue: number;

interface CustomDbRoleAction

interface CustomDbRoleAction

property action

action: string;

Name of the privilege action. For a complete list of actions available in the Atlas API, see Custom Role Actions > Note: The privilege actions available to the Custom Roles API resource represent a subset of the privilege actions available in the Atlas Custom Roles UI.

property resources

resources: CustomDbRoleActionResource[];

Contains information on where the action is granted. Each object in the array either indicates a database and collection on which the action is granted, or indicates that the action is granted on the cluster resource.

interface CustomDbRoleActionResource

interface CustomDbRoleActionResource

property cluster

cluster?: undefined | false | true;

property collectionName

collectionName?: undefined | string;

property databaseName

databaseName?: undefined | string;

Database on which the inherited role is granted.

interface CustomDbRoleInheritedRole

interface CustomDbRoleInheritedRole

property databaseName

databaseName: string;

Database on which the inherited role is granted.

property roleName

roleName: string;

Name of the inherited role. This can either be another custom role or a built-in role.

interface DatabaseUserLabel

interface DatabaseUserLabel

property key

key: string;

The key that you want to write.

property value

value: string;

The value that you want to write.

interface DatabaseUserRole

interface DatabaseUserRole

property collectionName

collectionName: string;

Collection for which the role applies. You can specify a collection for the read and readWrite roles. If you do not specify a collection for read and readWrite, the role applies to all collections in the database (excluding some collections in the system. database).

property databaseName

databaseName: string;

Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

property roleName

roleName: string;

Name of the role to grant. See Create a Database User roles.roleName for valid values and restrictions.

interface EncryptionAtRestAwsKms

interface EncryptionAtRestAwsKms

property accessKeyId

accessKeyId: string;

The IAM access key ID with permissions to access the customer master key specified by customerMasterKeyID.

property customerMasterKeyId

customerMasterKeyId: string;

The AWS customer master key used to encrypt and decrypt the MongoDB master keys.

property enabled

enabled: boolean;

Specifies whether Encryption at Rest is enabled for an Atlas project. To disable Encryption at Rest, pass only this parameter with a value of false. When you disable Encryption at Rest, Atlas also removes the configuration details.

property region

region: string;

The AWS region in which the AWS customer master key exists: CA_CENTRAL_1, US_EAST_1, US_EAST_2, US_WEST_1, US_WEST_2, SA_EAST_1

property secretAccessKey

secretAccessKey: string;

The IAM secret access key with permissions to access the customer master key specified by customerMasterKeyID.

interface EncryptionAtRestAzureKeyVault

interface EncryptionAtRestAzureKeyVault

property azureEnvironment

azureEnvironment: string;

The Azure environment where the Azure account credentials reside. Valid values are the following: AZURE, AZURE_CHINA, AZURE_GERMANY

property clientId

clientId: string;

The client ID, also known as the application ID, for an Azure application associated with the Azure AD tenant.

property enabled

enabled: boolean;

Specifies whether Encryption at Rest is enabled for an Atlas project. To disable Encryption at Rest, pass only this parameter with a value of false. When you disable Encryption at Rest, Atlas also removes the configuration details.

property keyIdentifier

keyIdentifier: string;

The unique identifier of a key in an Azure Key Vault.

property keyVaultName

keyVaultName: string;

The name of an Azure Key Vault containing your key.

property resourceGroupName

resourceGroupName: string;

The name of the Azure Resource group that contains an Azure Key Vault.

property secret

secret: string;

The secret associated with the Azure Key Vault specified by azureKeyVault.tenantID.

property subscriptionId

subscriptionId: string;

The unique identifier associated with an Azure subscription.

property tenantId

tenantId: string;

The unique identifier for an Azure AD tenant within an Azure subscription.

interface EncryptionAtRestGoogleCloudKms

interface EncryptionAtRestGoogleCloudKms

property enabled

enabled: boolean;

Specifies whether Encryption at Rest is enabled for an Atlas project. To disable Encryption at Rest, pass only this parameter with a value of false. When you disable Encryption at Rest, Atlas also removes the configuration details.

property keyVersionResourceId

keyVersionResourceId: string;

The Key Version Resource ID from your GCP account.

property serviceAccountKey

serviceAccountKey: string;

String-formatted JSON object containing GCP KMS credentials from your GCP account.

interface Get509AuthenticationDatabaseUserCertificate

interface Get509AuthenticationDatabaseUserCertificate

property createdAt

createdAt: string;

property groupId

groupId: string;

property id

id: number;

property notAfter

notAfter: string;

property subject

subject: string;

interface GetAlertConfigurationMatcher

interface GetAlertConfigurationMatcher

property fieldName

fieldName: string;

Name of the field in the target object to match on. Host alerts support these fields: - TYPE_NAME - HOSTNAME - PORT - HOSTNAME_AND_PORT - REPLICA_SET_NAME Replica set alerts support these fields: - REPLICA_SET_NAME - SHARD_NAME - CLUSTER_NAME Sharded cluster alerts support these fields: - CLUSTER_NAME - SHARD_NAME

property operator

operator: string;

Operator to apply when checking the current metric value against the threshold value. Accepted values are: - GREATER_THAN - LESS_THAN

property value

value: string;

Value to test with the specified operator. If fieldName is set to TYPE_NAME, you can match on the following values: - PRIMARY - SECONDARY - STANDALONE - CONFIG - MONGOS

interface GetAlertConfigurationMetricThreshold

interface GetAlertConfigurationMetricThreshold

property metricName

metricName: string;

Name of the metric to check.

property mode

mode: string;

This must be set to AVERAGE. Atlas computes the current metric value as an average.

property operator

operator: string;

Operator to apply when checking the current metric value against the threshold value. Accepted values are: - GREATER_THAN - LESS_THAN

property threshold

threshold: number;

Threshold value outside of which an alert will be triggered.

property units

units: string;

The units for the threshold value. Depends on the type of metric. Accepted values are: - RAW - BITS - BYTES - KILOBITS - KILOBYTES - MEGABITS - MEGABYTES - GIGABITS - GIGABYTES - TERABYTES - PETABYTES - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS

interface GetAlertConfigurationNotification

interface GetAlertConfigurationNotification

property apiToken

apiToken: string;

Slack API token. Required for the SLACK notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

property channelName

channelName: string;

Slack channel name. Required for the SLACK notifications type.

property datadogApiKey

datadogApiKey: string;

Datadog API Key. Found in the Datadog dashboard. Required for the DATADOG notifications type.

property datadogRegion

datadogRegion: string;

Region that indicates which API URL to use. Accepted regions are: US, EU. The default Datadog region is US.

property delayMin

delayMin: number;

Number of minutes to wait after an alert condition is detected before sending out the first notification.

property emailAddress

emailAddress: string;

Email address to which alert notifications are sent. Required for the EMAIL notifications type.

property emailEnabled

emailEnabled: boolean;

Flag indicating if email notifications should be sent. Configurable for ORG, GROUP, and USER notifications types.

property flowName

flowName: string;

Flowdock flow name in lower-case letters. Required for the FLOWDOCK notifications type

property flowdockApiToken

flowdockApiToken: string;

The Flowdock personal API token. Required for the FLOWDOCK notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

property intervalMin

intervalMin: number;

Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.

property mobileNumber

mobileNumber: string;

Mobile number to which alert notifications are sent. Required for the SMS notifications type.

property opsGenieApiKey

opsGenieApiKey: string;

Opsgenie API Key. Required for the OPS_GENIE notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

property opsGenieRegion

opsGenieRegion: string;

Region that indicates which API URL to use. Accepted regions are: US ,EU. The default Opsgenie region is US.

property orgName

orgName: string;

Flowdock organization name in lower-case letters. This is the name that appears after www.flowdock.com/app/ in the URL string. Required for the FLOWDOCK notifications type.

property serviceKey

serviceKey: string;

PagerDuty service key. Required for the PAGER_DUTY notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.

property smsEnabled

smsEnabled: boolean;

Flag indicating if text message notifications should be sent. Configurable for ORG, GROUP, and USER notifications types.

property teamId

teamId: string;

Unique identifier of a team.

property typeName

typeName: string;

Type of alert notification. Accepted values are: - DATADOG - EMAIL - FLOWDOCK - GROUP (Project) - OPS_GENIE - ORG - PAGER_DUTY - SLACK - SMS - TEAM - USER - VICTOR_OPS - WEBHOOK

property username

username: string;

Name of the Atlas user to which to send notifications. Only a user in the project that owns the alert configuration is allowed here. Required for the USER notifications type.

property victorOpsApiKey

victorOpsApiKey: string;

VictorOps API key. Required for the VICTOR_OPS notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.

property victorOpsRoutingKey

victorOpsRoutingKey: string;

VictorOps routing key. Optional for the VICTOR_OPS notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.

interface GetCloudProviderSnapshotBackupPolicyPolicy

interface GetCloudProviderSnapshotBackupPolicyPolicy

property id

id: string;

property policyItems

policyItems: GetCloudProviderSnapshotBackupPolicyPolicyPolicyItem[];

interface GetCloudProviderSnapshotBackupPolicyPolicyPolicyItem

interface GetCloudProviderSnapshotBackupPolicyPolicyPolicyItem

property frequencyInterval

frequencyInterval: number;

property frequencyType

frequencyType: string;

property id

id: string;

property retentionUnit

retentionUnit: string;

property retentionValue

retentionValue: number;

interface GetCloudProviderSnapshotRestoreJobsResult

interface GetCloudProviderSnapshotRestoreJobsResult

property cancelled

cancelled: boolean;

Indicates whether the restore job was canceled.

property createdAt

createdAt: string;

UTC ISO 8601 formatted point in time when Atlas created the restore job.

property deliveryType

deliveryType: string;

Type of restore job to create. Possible values are: automated and download.

property deliveryUrls

deliveryUrls: string[];

One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.

property expired

expired: boolean;

Indicates whether the restore job expired.

property expiresAt

expiresAt: string;

UTC ISO 8601 formatted point in time when the restore job expires.

property finishedAt

finishedAt: string;

UTC ISO 8601 formatted point in time when the restore job completed.

property id

id: string;

The unique identifier of the restore job.

property snapshotId

snapshotId: string;

Unique identifier of the source snapshot ID of the restore job.

property targetClusterName

targetClusterName: string;

Name of the target Atlas cluster to which the restore job restores the snapshot. Only visible if deliveryType is automated.

property targetProjectId

targetProjectId: string;

property timestamp

timestamp: string;

Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.

interface GetCloudProviderSnapshotsResult

interface GetCloudProviderSnapshotsResult

property createdAt

createdAt: string;

UTC ISO 8601 formatted point in time when Atlas took the snapshot.

property description

description: string;

UDescription of the snapshot. Only present for on-demand snapshots.

property expiresAt

expiresAt: string;

UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.

property id

id: string;

Unique identifier of the snapshot.

property masterKeyUuid

masterKeyUuid: string;

Unique ID of the AWS KMS Customer Master Key used to encrypt the snapshot. Only visible for clusters using Encryption at Rest via Customer KMS.

property mongodVersion

mongodVersion: string;

Version of the MongoDB server.

property snapshotType

snapshotType: string;

Specified the type of snapshot. Valid values are onDemand and scheduled.

property status

status: string;

Current status of the snapshot. One of the following values: queued, inProgress, completed, failed.

property storageSizeBytes

storageSizeBytes: number;

Specifies the size of the snapshot in bytes.

property type

type: string;

Specifies the type of cluster: replicaSet or shardedCluster.

interface GetClusterBiConnector

interface GetClusterBiConnector

property enabled

enabled: string;

Indicates whether or not BI Connector for Atlas is enabled on the cluster.

property readPreference

readPreference: string;

Indicates the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

interface GetClusterConnectionStrings

interface GetClusterConnectionStrings
awsPrivateLink: {[key: string]: any};

property awsPrivateLinkSrv

awsPrivateLinkSrv: {[key: string]: any};

property private

private: string;

property privateSrv

privateSrv: string;

property standard

standard: string;

property standardSrv

standardSrv: string;

interface GetClusterLabel

interface GetClusterLabel

property key

key: string;

The key that was set.

property value

value: string;

The value that represents the key.

interface GetClusterReplicationSpec

interface GetClusterReplicationSpec

property id

id: string;

Unique identifer of the replication document for a zone in a Global Cluster.

property numShards

numShards: number;

Number of shards to deploy in the specified zone.

property regionsConfigs

regionsConfigs: GetClusterReplicationSpecRegionsConfig[];

Describes the physical location of the region. Each regionsConfig document describes the region’s priority in elections and the number and type of MongoDB nodes Atlas deploys to the region. You must order each regionsConfigs document by regionsConfig.priority, descending. See Region Config below for more details.

property zoneName

zoneName: string;

Indicates the n ame for the zone in a Global Cluster.

interface GetClusterReplicationSpecRegionsConfig

interface GetClusterReplicationSpecRegionsConfig

property analyticsNodes

analyticsNodes: number;

Indicates the number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary.

property electableNodes

electableNodes: number;

Number of electable nodes for Atlas to deploy to the region.

property priority

priority: number;

Election priority of the region. For regions with only read-only nodes, set this value to 0.

property readOnlyNodes

readOnlyNodes: number;

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can facilitate local-reads. Specify 0 if you do not want any read-only nodes in the region.

property regionName

regionName: string;

Name for the region specified.

interface GetClusterSnapshotBackupPolicy

interface GetClusterSnapshotBackupPolicy

property clusterId

clusterId: string;

property clusterName

clusterName: string;

property nextSnapshot

nextSnapshot: string;

property policies

policies: GetClusterSnapshotBackupPolicyPolicy[];

property referenceHourOfDay

referenceHourOfDay: number;

property referenceMinuteOfHour

referenceMinuteOfHour: number;

property restoreWindowDays

restoreWindowDays: number;

property updateSnapshots

updateSnapshots: boolean;

interface GetClusterSnapshotBackupPolicyPolicy

interface GetClusterSnapshotBackupPolicyPolicy

property id

id: string;

Unique identifer of the replication document for a zone in a Global Cluster.

property policyItems

policyItems: GetClusterSnapshotBackupPolicyPolicyPolicyItem[];

interface GetClusterSnapshotBackupPolicyPolicyPolicyItem

interface GetClusterSnapshotBackupPolicyPolicyPolicyItem

property frequencyInterval

frequencyInterval: number;

property frequencyType

frequencyType: string;

property id

id: string;

Unique identifer of the replication document for a zone in a Global Cluster.

property retentionUnit

retentionUnit: string;

property retentionValue

retentionValue: number;

interface GetClustersResult

interface GetClustersResult

property autoScalingDiskGbEnabled

autoScalingDiskGbEnabled: boolean;

Indicates whether disk auto-scaling is enabled.

property backingProviderName

backingProviderName: string;

Indicates Cloud service provider on which the server for a multi-tenant cluster is provisioned.

property backupEnabled

backupEnabled: boolean;

Legacy Option, Indicates whether Atlas continuous backups are enabled for the cluster.

property biConnector

biConnector: GetClustersResultBiConnector;

Indicates BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.

property clusterType

clusterType: string;

Indicates the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

property connectionStrings

connectionStrings: GetClustersResultConnectionStrings;

Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster. - connection_strings.standard - Public mongodb:// connection string for this cluster. - connection_strings.standard_srv - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.standard. - connection_strings.aws_private_link - Private-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. - connection_strings.aws_private_link_srv - Private-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.awsPrivateLink. - connection_strings.private - Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster. - connection_strings.private_srv - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.

property diskSizeGb

diskSizeGb: number;

Indicates the size in gigabytes of the server’s root volume (AWS/GCP Only).

property encryptionAtRestProvider

encryptionAtRestProvider: string;

Indicates whether Encryption at Rest is enabled or disabled.

property labels

labels: GetClustersResultLabel[];

property mongoDbMajorVersion

mongoDbMajorVersion: string;

Indicates the version of the cluster to deploy.

property mongoDbVersion

mongoDbVersion: string;

Version of MongoDB the cluster runs, in major-version.minor-version format.

property mongoUri

mongoUri: string;

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

property mongoUriUpdated

mongoUriUpdated: string;

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

property mongoUriWithOptions

mongoUriWithOptions: string;

Describes connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.

property name

name: string;

The name of the current plugin

property numShards

numShards: number;

Number of shards to deploy in the specified zone.

property paused

paused: boolean;

Flag that indicates whether the cluster is paused or not.

property pitEnabled

pitEnabled: boolean;

Flag that indicates if the cluster uses Point-in-Time backups.

property providerBackupEnabled

providerBackupEnabled: boolean;

Flag indicating if the cluster uses Cloud Provider Snapshots for backups.

property providerDiskIops

providerDiskIops: number;

Indicates the maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected providerSettings.instanceSizeName and diskSizeGB.

property providerDiskTypeName

providerDiskTypeName: string;

Describes Azure disk type of the server’s root volume (Azure Only).

property providerEncryptEbsVolume

providerEncryptEbsVolume: boolean;

Indicates whether the Amazon EBS encryption is enabled. This feature encrypts the server’s root volume for both data at rest within the volume and data moving between the volume and the instance.

property providerInstanceSizeName

providerInstanceSizeName: string;

Atlas provides different instance sizes, each with a default storage capacity and RAM size.

property providerName

providerName: string;

Indicates the cloud service provider on which the servers are provisioned.

property providerRegionName

providerRegionName: string;

Indicates Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas Region name, see the reference list for AWS, GCP, Azure.

property providerVolumeType

providerVolumeType: string;

Indicates the type of the volume. The possible values are: STANDARD and PROVISIONED.

property replicationFactor

replicationFactor: number;

Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.

property replicationSpecs

replicationSpecs: GetClustersResultReplicationSpec[];

Configuration for cluster regions. See Replication Spec below for more details.

property snapshotBackupPolicies

snapshotBackupPolicies: GetClustersResultSnapshotBackupPolicy[];

current snapshot schedule and retention settings for the cluster.

property srvAddress

srvAddress: string;

Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.

property stateName

stateName: string;

Indicates the current state of the cluster. The possible states are: - IDLE - CREATING - UPDATING - DELETING - DELETED - REPAIRING

interface GetClustersResultBiConnector

interface GetClustersResultBiConnector

property enabled

enabled: string;

Indicates whether or not BI Connector for Atlas is enabled on the cluster.

property readPreference

readPreference: string;

Indicates the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

interface GetClustersResultConnectionStrings

interface GetClustersResultConnectionStrings
awsPrivateLink: {[key: string]: any};

property awsPrivateLinkSrv

awsPrivateLinkSrv: {[key: string]: any};

property private

private: string;

property privateSrv

privateSrv: string;

property standard

standard: string;

property standardSrv

standardSrv: string;

interface GetClustersResultLabel

interface GetClustersResultLabel

property key

key: string;

The key that was set.

property value

value: string;

The value that represents the key.

interface GetClustersResultReplicationSpec

interface GetClustersResultReplicationSpec

property id

id: string;

Unique identifer of the replication document for a zone in a Global Cluster.

property numShards

numShards: number;

Number of shards to deploy in the specified zone.

property regionsConfigs

regionsConfigs: GetClustersResultReplicationSpecRegionsConfig[];

Describes the physical location of the region. Each regionsConfig document describes the region’s priority in elections and the number and type of MongoDB nodes Atlas deploys to the region. You must order each regionsConfigs document by regionsConfig.priority, descending. See Region Config below for more details.

property zoneName

zoneName: string;

Indicates the n ame for the zone in a Global Cluster.

interface GetClustersResultReplicationSpecRegionsConfig

interface GetClustersResultReplicationSpecRegionsConfig

property analyticsNodes

analyticsNodes: number;

Indicates the number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary.

property electableNodes

electableNodes: number;

Number of electable nodes for Atlas to deploy to the region.

property priority

priority: number;

Election priority of the region. For regions with only read-only nodes, set this value to 0.

property readOnlyNodes

readOnlyNodes: number;

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can facilitate local-reads. Specify 0 if you do not want any read-only nodes in the region.

property regionName

regionName: string;

Name for the region specified.

interface GetClustersResultSnapshotBackupPolicy

interface GetClustersResultSnapshotBackupPolicy

property clusterId

clusterId: string;

property clusterName

clusterName: string;

property nextSnapshot

nextSnapshot: string;

property policies

policies: GetClustersResultSnapshotBackupPolicyPolicy[];

property referenceHourOfDay

referenceHourOfDay: number;

property referenceMinuteOfHour

referenceMinuteOfHour: number;

property restoreWindowDays

restoreWindowDays: number;

property updateSnapshots

updateSnapshots: boolean;

interface GetClustersResultSnapshotBackupPolicyPolicy

interface GetClustersResultSnapshotBackupPolicyPolicy

property id

id: string;

Unique identifer of the replication document for a zone in a Global Cluster.

property policyItems

policyItems: GetClustersResultSnapshotBackupPolicyPolicyPolicyItem[];

interface GetClustersResultSnapshotBackupPolicyPolicyPolicyItem

interface GetClustersResultSnapshotBackupPolicyPolicyPolicyItem

property frequencyInterval

frequencyInterval: number;

property frequencyType

frequencyType: string;

property id

id: string;

Unique identifer of the replication document for a zone in a Global Cluster.

property retentionUnit

retentionUnit: string;

property retentionValue

retentionValue: number;

interface GetCustomDbRoleAction

interface GetCustomDbRoleAction

property action

action: string;

(Required) Name of the privilege action. For a complete list of actions available in the Atlas API, see Custom Role Actions.

property resources

resources: GetCustomDbRoleActionResource[];

(Required) Contains information on where the action is granted. Each object in the array either indicates a database and collection on which the action is granted, or indicates that the action is granted on the cluster resource.

interface GetCustomDbRoleActionResource

interface GetCustomDbRoleActionResource

property cluster

cluster: boolean;

property collectionName

collectionName: string;

property databaseName

databaseName: string;

interface GetCustomDbRoleInheritedRole

interface GetCustomDbRoleInheritedRole

property databaseName

databaseName: string;

property roleName

roleName: string;

Name of the custom role.

interface GetCustomDbRolesResult

interface GetCustomDbRolesResult

property actions

actions: GetCustomDbRolesResultAction[];

property inheritedRoles

inheritedRoles: GetCustomDbRolesResultInheritedRole[];

property roleName

roleName: string;

interface GetCustomDbRolesResultAction

interface GetCustomDbRolesResultAction

property action

action: string;

(Required) Name of the privilege action. For a complete list of actions available in the Atlas API, see Custom Role Actions.

property resources

resources: GetCustomDbRolesResultActionResource[];

(Required) Contains information on where the action is granted. Each object in the array either indicates a database and collection on which the action is granted, or indicates that the action is granted on the cluster resource.

interface GetCustomDbRolesResultActionResource

interface GetCustomDbRolesResultActionResource

property cluster

cluster: boolean;

property collectionName

collectionName: string;

property databaseName

databaseName: string;

interface GetCustomDbRolesResultInheritedRole

interface GetCustomDbRolesResultInheritedRole

property databaseName

databaseName: string;

property roleName

roleName: string;

interface GetDatabaseUserLabel

interface GetDatabaseUserLabel

property key

key: string;

The key that you want to write.

property value

value: string;

The value that you want to write.

interface GetDatabaseUserRole

interface GetDatabaseUserRole

property collectionName

collectionName: string;

Collection for which the role applies. You can specify a collection for the read and readWrite roles. If you do not specify a collection for read and readWrite, the role applies to all collections in the database (excluding some collections in the system. database).

property databaseName

databaseName: string;

Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

property roleName

roleName: string;

interface GetDatabaseUsersResult

interface GetDatabaseUsersResult

property authDatabaseName

authDatabaseName: string;

The user’s authentication database. A user must provide both a username and authentication database to log into MongoDB. In Atlas deployments of MongoDB, the authentication database is always the admin database.

property labels

labels: GetDatabaseUsersResultLabel[];

property projectId

projectId: string;

The unique ID for the project to get all database users.

property roles

roles: GetDatabaseUsersResultRole[];

List of user’s roles and the databases / collections on which the roles apply. A role allows the user to perform particular actions on the specified database. A role on the admin database can include privileges that apply to the other databases as well. See Roles below for more details.

property username

username: string;

Username for authenticating to MongoDB.

property x509Type

x509Type: string;

X.509 method by which the provided username is authenticated.

interface GetDatabaseUsersResultLabel

interface GetDatabaseUsersResultLabel

property key

key: string;

The key that you want to write.

property value

value: string;

The value that you want to write.

interface GetDatabaseUsersResultRole

interface GetDatabaseUsersResultRole

property collectionName

collectionName: string;

Collection for which the role applies. You can specify a collection for the read and readWrite roles. If you do not specify a collection for read and readWrite, the role applies to all collections in the database (excluding some collections in the system. database).

property databaseName

databaseName: string;

Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

property roleName

roleName: string;

interface GetGlobalClusterConfigManagedNamespace

interface GetGlobalClusterConfigManagedNamespace

property collection

collection: string;

(Required) The name of the collection associated with the managed namespace.

property customShardKey

customShardKey: string;

(Required) The custom shard key for the collection. Global Clusters require a compound shard key consisting of a location field and a user-selected second key, the custom shard key.

property db

db: string;

(Required) The name of the database containing the collection.

interface GetNetworkContainersResult

interface GetNetworkContainersResult

property atlasCidrBlock

atlasCidrBlock: string;

CIDR block that Atlas uses for your clusters. Atlas uses the specified CIDR block for all other Network Peering connections created in the project. The Atlas CIDR block must be at least a /24 and at most a /21 in one of the following private networks.

property azureSubscriptionId

azureSubscriptionId: string;

Unique identifer of the Azure subscription in which the VNet resides.

property gcpProjectId

gcpProjectId: string;

Unique identifier of the GCP project in which the Network Peering connection resides.

property id

id: string;

The Network Peering Container ID.

property networkName

networkName: string;

Name of the Network Peering connection in the Atlas project.

property providerName

providerName: string;

Cloud provider for this Network peering container. Accepted values are AWS, GCP, and Azure.

property provisioned

provisioned: boolean;

Indicates whether the project has Network Peering connections deployed in the container.

property region

region: string;

The Atlas Azure region name for where this container exists.

property regionName

regionName: string;

The Atlas AWS region name for where this container exists.

property vnetName

vnetName: string;

The name of the Azure VNet. This value is null until you provision an Azure VNet in the container.

property vpcId

vpcId: string;

Unique identifier of the project’s VPC.

interface GetNetworkPeeringsResult

interface GetNetworkPeeringsResult

property accepterRegionName

accepterRegionName: string;

Specifies the region where the peer VPC resides. For complete lists of supported regions, see Amazon Web Services.

property atlasCidrBlock

atlasCidrBlock: string;

Unique identifier for an Azure AD directory.

property awsAccountId

awsAccountId: string;

Account ID of the owner of the peer VPC.

property azureDirectoryId

azureDirectoryId: string;

Unique identifier for an Azure AD directory.

property azureSubscriptionId

azureSubscriptionId: string;

Unique identifer of the Azure subscription in which the VNet resides.

property connectionId

connectionId: string;

Unique identifier for the peering connection.

property containerId

containerId: string;

property errorMessage

errorMessage: string;

When "status" : "FAILED", Atlas provides a description of the error.

property errorState

errorState: string;

Description of the Atlas error when status is Failed, Otherwise, Atlas returns null.

property errorStateName

errorStateName: string;

Error state, if any. The VPC peering connection error state value can be one of the following: REJECTED, EXPIRED, INVALID_ARGUMENT.

property gcpProjectId

gcpProjectId: string;

GCP project ID of the owner of the network peer.

property networkName

networkName: string;

Name of the network peer to which Atlas connects.

property peeringId

peeringId: string;

Atlas assigned unique ID for the peering connection.

property providerName

providerName: string;

Cloud provider for this VPC peering connection. If omitted, Atlas sets this parameter to AWS. (Possible Values AWS, AZURE, GCP).

property resourceGroupName

resourceGroupName: string;

Name of your Azure resource group.

property routeTableCidrBlock

routeTableCidrBlock: string;

Peer VPC CIDR block or subnet.

property status

status: string;

Status of the Atlas network peering connection: ADDING_PEER, AVAILABLE, FAILED, DELETING, WAITING_FOR_USER.

property statusName

statusName: string;

The VPC peering connection status value can be one of the following: INITIATING, PENDING_ACCEPTANCE, FAILED, FINALIZING, AVAILABLE, TERMINATING.

property vnetName

vnetName: string;

Name of your Azure VNet.

property vpcId

vpcId: string;

Unique identifier of the peer VPC.

interface GetProjectsResult

interface GetProjectsResult

property clusterCount

clusterCount: number;

property created

created: string;

property id

id: string;

Autogenerated Unique ID for this data source.

property name

name: string;

The name of the project you want to create. (Cannot be changed via this Provider after creation.)

property orgId

orgId: string;

The ID of the organization you want to create the project within. *clusterCount - The number of Atlas clusters deployed in the project. *created - The ISO-8601-formatted timestamp of when Atlas created the project. * teams.#.team_id - The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization. * teams.#.role_names - Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The following are valid roles: * GROUP_OWNER * GROUP_READ_ONLY * GROUP_DATA_ACCESS_ADMIN * GROUP_DATA_ACCESS_READ_WRITE * GROUP_DATA_ACCESS_READ_ONLY * GROUP_CLUSTER_MANAGER

property teams

teams: GetProjectsResultTeam[];

interface GetProjectsResultTeam

interface GetProjectsResultTeam

property roleNames

roleNames: string[];

property teamId

teamId: string;

interface GetProjectTeam

interface GetProjectTeam

property roleNames

roleNames: string[];

property teamId

teamId: string;

interface GlobalClusterConfigCustomZoneMapping

interface GlobalClusterConfigCustomZoneMapping

property location

location: string;

The ISO location code to which you want to map a zone in your Global Cluster. You can find a list of all supported location codes here.

property zone

zone: string;

The name of the zone in your Global Cluster that you want to map to location.

interface GlobalClusterConfigManagedNamespace

interface GlobalClusterConfigManagedNamespace

property collection

collection: string;

The name of the collection associated with the managed namespace.

property customShardKey

customShardKey: string;

The custom shard key for the collection. Global Clusters require a compound shard key consisting of a location field and a user-selected second key, the custom shard key.

property db

db: string;

The name of the database containing the collection.

interface ProjectTeam

interface ProjectTeam

property roleNames

roleNames: string[];

Each string in the array represents a project role you want to assign to the team. Every user associated with the team inherits these roles. You must specify an array even if you are only associating a single role with the team. The following are valid roles: * GROUP_OWNER * GROUP_READ_ONLY * GROUP_DATA_ACCESS_ADMIN * GROUP_DATA_ACCESS_READ_WRITE * GROUP_DATA_ACCESS_READ_ONLY * GROUP_CLUSTER_MANAGER

property teamId

teamId: string;

The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.

interface X509AuthenticationDatabaseUserCertificate

interface X509AuthenticationDatabaseUserCertificate

property createdAt

createdAt: string;

property groupId

groupId: string;

property id

id: number;

property notAfter

notAfter: string;

property subject

subject: string;