@pulumi/mongodbatlas 3.39.0-alpha.1766556689 → 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/accessListApiKey.d.ts +3 -0
- package/accessListApiKey.js +3 -0
- package/accessListApiKey.js.map +1 -1
- package/advancedCluster.d.ts +85 -40
- package/advancedCluster.js +4 -2
- package/advancedCluster.js.map +1 -1
- package/alertConfiguration.d.ts +15 -2
- package/alertConfiguration.js +5 -2
- package/alertConfiguration.js.map +1 -1
- package/apiKey.d.ts +3 -0
- package/apiKey.js +3 -0
- package/apiKey.js.map +1 -1
- package/apiKeyProjectAssignment.d.ts +3 -2
- package/apiKeyProjectAssignment.js +3 -2
- package/apiKeyProjectAssignment.js.map +1 -1
- package/auditing.d.ts +0 -2
- package/auditing.js +0 -2
- package/auditing.js.map +1 -1
- package/backupCompliancePolicy.d.ts +3 -0
- package/backupCompliancePolicy.js +3 -0
- package/backupCompliancePolicy.js.map +1 -1
- package/cloudBackupSchedule.d.ts +8 -8
- package/cloudBackupSnapshot.d.ts +16 -2
- package/cloudBackupSnapshot.js +6 -2
- package/cloudBackupSnapshot.js.map +1 -1
- package/cloudBackupSnapshotExportBucket.d.ts +4 -2
- package/cloudBackupSnapshotExportBucket.js +4 -2
- package/cloudBackupSnapshotExportBucket.js.map +1 -1
- package/cloudBackupSnapshotExportJob.d.ts +3 -2
- package/cloudBackupSnapshotExportJob.js +3 -2
- package/cloudBackupSnapshotExportJob.js.map +1 -1
- package/cloudBackupSnapshotRestoreJob.d.ts +3 -3
- package/cloudBackupSnapshotRestoreJob.js +3 -3
- package/cloudProviderAccessAuthorization.d.ts +36 -0
- package/cloudProviderAccessAuthorization.js.map +1 -1
- package/cloudProviderAccessSetup.d.ts +126 -0
- package/cloudProviderAccessSetup.js +59 -0
- package/cloudProviderAccessSetup.js.map +1 -1
- package/cloudUserOrgAssignment.d.ts +221 -0
- package/cloudUserOrgAssignment.js +137 -0
- package/cloudUserOrgAssignment.js.map +1 -0
- package/cloudUserProjectAssignment.d.ts +217 -0
- package/cloudUserProjectAssignment.js +141 -0
- package/cloudUserProjectAssignment.js.map +1 -0
- package/cloudUserTeamAssignment.d.ts +229 -0
- package/cloudUserTeamAssignment.js +139 -0
- package/cloudUserTeamAssignment.js.map +1 -0
- package/cluster.d.ts +4 -0
- package/cluster.js +4 -0
- package/cluster.js.map +1 -1
- package/clusterOutageSimulation.d.ts +15 -2
- package/clusterOutageSimulation.js +5 -2
- package/clusterOutageSimulation.js.map +1 -1
- package/config/vars.d.ts +12 -0
- package/config/vars.js +18 -0
- package/config/vars.js.map +1 -1
- package/customDbRole.d.ts +0 -2
- package/customDbRole.js +0 -2
- package/customDbRole.js.map +1 -1
- package/customDnsConfigurationClusterAws.d.ts +0 -2
- package/customDnsConfigurationClusterAws.js +0 -2
- package/customDnsConfigurationClusterAws.js.map +1 -1
- package/databaseUser.d.ts +3 -2
- package/databaseUser.js +3 -2
- package/databaseUser.js.map +1 -1
- package/encryptionAtRestPrivateEndpoint.d.ts +21 -2
- package/encryptionAtRestPrivateEndpoint.js +8 -2
- package/encryptionAtRestPrivateEndpoint.js.map +1 -1
- package/eventTrigger.d.ts +15 -130
- package/eventTrigger.js +0 -115
- package/eventTrigger.js.map +1 -1
- package/federatedDatabaseInstance.d.ts +16 -14
- package/federatedDatabaseInstance.js +4 -2
- package/federatedDatabaseInstance.js.map +1 -1
- package/federatedQueryLimit.d.ts +3 -2
- package/federatedQueryLimit.js +3 -2
- package/federatedQueryLimit.js.map +1 -1
- package/federatedSettingsIdentityProvider.d.ts +2 -2
- package/federatedSettingsIdentityProvider.js +2 -2
- package/federatedSettingsOrgConfig.d.ts +4 -2
- package/federatedSettingsOrgConfig.js +4 -2
- package/federatedSettingsOrgConfig.js.map +1 -1
- package/federatedSettingsOrgRoleMapping.d.ts +3 -2
- package/federatedSettingsOrgRoleMapping.js +3 -2
- package/federatedSettingsOrgRoleMapping.js.map +1 -1
- package/flexCluster.d.ts +18 -2
- package/flexCluster.js +7 -2
- package/flexCluster.js.map +1 -1
- package/getAdvancedCluster.d.ts +122 -52
- package/getAdvancedCluster.js +104 -30
- package/getAdvancedCluster.js.map +1 -1
- package/getAdvancedClusters.d.ts +153 -35
- package/getAdvancedClusters.js +150 -32
- package/getAdvancedClusters.js.map +1 -1
- package/getAlertConfiguration.d.ts +4 -4
- package/getAlertConfiguration.js +0 -4
- package/getAlertConfiguration.js.map +1 -1
- package/getAlertConfigurations.d.ts +0 -4
- package/getAlertConfigurations.js +0 -4
- package/getAlertConfigurations.js.map +1 -1
- package/getApiKeyProjectAssignment.d.ts +0 -4
- package/getApiKeyProjectAssignment.js +0 -4
- package/getApiKeyProjectAssignment.js.map +1 -1
- package/getApiKeyProjectAssignments.d.ts +0 -4
- package/getApiKeyProjectAssignments.js +0 -4
- package/getApiKeyProjectAssignments.js.map +1 -1
- package/getAtlasUser.d.ts +9 -7
- package/getAtlasUser.js +4 -4
- package/getAtlasUser.js.map +1 -1
- package/getAtlasUsers.d.ts +4 -4
- package/getAtlasUsers.js +4 -4
- package/getAuditing.d.ts +0 -4
- package/getAuditing.js +0 -4
- package/getAuditing.js.map +1 -1
- package/getBackupCompliancePolicy.d.ts +3 -3
- package/getCloudBackupSchedule.d.ts +0 -11
- package/getCloudBackupSchedule.js +0 -4
- package/getCloudBackupSchedule.js.map +1 -1
- package/getCloudBackupSnapshot.d.ts +0 -4
- package/getCloudBackupSnapshot.js +0 -4
- package/getCloudBackupSnapshot.js.map +1 -1
- package/getCloudBackupSnapshotExportBucket.d.ts +0 -4
- package/getCloudBackupSnapshotExportBucket.js +0 -4
- package/getCloudBackupSnapshotExportBucket.js.map +1 -1
- package/getCloudBackupSnapshotExportBuckets.d.ts +0 -4
- package/getCloudBackupSnapshotExportBuckets.js +0 -4
- package/getCloudBackupSnapshotExportBuckets.js.map +1 -1
- package/getCloudBackupSnapshotExportJob.d.ts +0 -4
- package/getCloudBackupSnapshotExportJob.js +0 -4
- package/getCloudBackupSnapshotExportJob.js.map +1 -1
- package/getCloudBackupSnapshotExportJobs.d.ts +0 -4
- package/getCloudBackupSnapshotExportJobs.js +0 -4
- package/getCloudBackupSnapshotExportJobs.js.map +1 -1
- package/getCloudBackupSnapshotRestoreJob.d.ts +0 -4
- package/getCloudBackupSnapshotRestoreJob.js +0 -4
- package/getCloudBackupSnapshotRestoreJob.js.map +1 -1
- package/getCloudBackupSnapshotRestoreJobs.d.ts +0 -4
- package/getCloudBackupSnapshotRestoreJobs.js +0 -4
- package/getCloudBackupSnapshotRestoreJobs.js.map +1 -1
- package/getCloudBackupSnapshots.d.ts +0 -4
- package/getCloudBackupSnapshots.js +0 -4
- package/getCloudBackupSnapshots.js.map +1 -1
- package/getCloudProviderAccessSetup.d.ts +0 -4
- package/getCloudProviderAccessSetup.js +0 -4
- package/getCloudProviderAccessSetup.js.map +1 -1
- package/getCloudUserOrgAssignment.d.ts +171 -0
- package/getCloudUserOrgAssignment.js +90 -0
- package/getCloudUserOrgAssignment.js.map +1 -0
- package/getCloudUserProjectAssignment.d.ts +117 -0
- package/getCloudUserProjectAssignment.js +92 -0
- package/getCloudUserProjectAssignment.js.map +1 -0
- package/getCloudUserTeamAssignment.d.ts +183 -0
- package/getCloudUserTeamAssignment.js +92 -0
- package/getCloudUserTeamAssignment.js.map +1 -0
- package/getClusters.d.ts +4 -4
- package/getClusters.js +4 -4
- package/getControlPlaneIpAddresses.d.ts +0 -4
- package/getControlPlaneIpAddresses.js +0 -4
- package/getControlPlaneIpAddresses.js.map +1 -1
- package/getCustomDbRole.d.ts +0 -4
- package/getCustomDbRole.js +0 -4
- package/getCustomDbRole.js.map +1 -1
- package/getCustomDbRoles.d.ts +0 -4
- package/getCustomDbRoles.js +0 -4
- package/getCustomDbRoles.js.map +1 -1
- package/getCustomDnsConfigurationClusterAws.d.ts +0 -4
- package/getCustomDnsConfigurationClusterAws.js +0 -4
- package/getCustomDnsConfigurationClusterAws.js.map +1 -1
- package/getDatabaseUser.d.ts +1 -5
- package/getDatabaseUser.js +0 -4
- package/getDatabaseUser.js.map +1 -1
- package/getDatabaseUsers.d.ts +0 -4
- package/getDatabaseUsers.js +0 -4
- package/getDatabaseUsers.js.map +1 -1
- package/getEncryptionAtRest.d.ts +0 -4
- package/getEncryptionAtRest.js +0 -4
- package/getEncryptionAtRest.js.map +1 -1
- package/getEncryptionAtRestPrivateEndpoint.d.ts +0 -4
- package/getEncryptionAtRestPrivateEndpoint.js +0 -4
- package/getEncryptionAtRestPrivateEndpoint.js.map +1 -1
- package/getEncryptionAtRestPrivateEndpoints.d.ts +0 -4
- package/getEncryptionAtRestPrivateEndpoints.js +0 -4
- package/getEncryptionAtRestPrivateEndpoints.js.map +1 -1
- package/getEventTrigger.d.ts +0 -4
- package/getEventTrigger.js +0 -4
- package/getEventTrigger.js.map +1 -1
- package/getEventTriggers.d.ts +0 -4
- package/getEventTriggers.js +0 -4
- package/getEventTriggers.js.map +1 -1
- package/getFederatedDatabaseInstance.d.ts +45 -15
- package/getFederatedDatabaseInstance.js +40 -10
- package/getFederatedDatabaseInstance.js.map +1 -1
- package/getFederatedDatabaseInstances.d.ts +0 -4
- package/getFederatedDatabaseInstances.js +0 -4
- package/getFederatedDatabaseInstances.js.map +1 -1
- package/getFederatedQueryLimit.d.ts +0 -4
- package/getFederatedQueryLimit.js +0 -4
- package/getFederatedQueryLimit.js.map +1 -1
- package/getFederatedQueryLimits.d.ts +0 -4
- package/getFederatedQueryLimits.js +0 -4
- package/getFederatedQueryLimits.js.map +1 -1
- package/getFederatedSettings.d.ts +0 -4
- package/getFederatedSettings.js +0 -4
- package/getFederatedSettings.js.map +1 -1
- package/getFederatedSettingsIdentityProvider.d.ts +0 -4
- package/getFederatedSettingsIdentityProvider.js +0 -4
- package/getFederatedSettingsIdentityProvider.js.map +1 -1
- package/getFederatedSettingsIdentityProviders.d.ts +0 -4
- package/getFederatedSettingsIdentityProviders.js +0 -4
- package/getFederatedSettingsIdentityProviders.js.map +1 -1
- package/getFederatedSettingsOrgConfig.d.ts +0 -4
- package/getFederatedSettingsOrgConfig.js +0 -4
- package/getFederatedSettingsOrgConfig.js.map +1 -1
- package/getFederatedSettingsOrgConfigs.d.ts +0 -4
- package/getFederatedSettingsOrgConfigs.js +0 -4
- package/getFederatedSettingsOrgConfigs.js.map +1 -1
- package/getFederatedSettingsOrgRoleMapping.d.ts +0 -4
- package/getFederatedSettingsOrgRoleMapping.js +0 -4
- package/getFederatedSettingsOrgRoleMapping.js.map +1 -1
- package/getFederatedSettingsOrgRoleMappings.d.ts +0 -4
- package/getFederatedSettingsOrgRoleMappings.js +0 -4
- package/getFederatedSettingsOrgRoleMappings.js.map +1 -1
- package/getFlexCluster.d.ts +0 -4
- package/getFlexCluster.js +0 -4
- package/getFlexCluster.js.map +1 -1
- package/getFlexClusters.d.ts +0 -4
- package/getFlexClusters.js +0 -4
- package/getFlexClusters.js.map +1 -1
- package/getFlexRestoreJob.d.ts +0 -4
- package/getFlexRestoreJob.js +0 -4
- package/getFlexRestoreJob.js.map +1 -1
- package/getFlexRestoreJobs.d.ts +0 -4
- package/getFlexRestoreJobs.js +0 -4
- package/getFlexRestoreJobs.js.map +1 -1
- package/getFlexSnapshot.d.ts +0 -4
- package/getFlexSnapshot.js +0 -4
- package/getFlexSnapshot.js.map +1 -1
- package/getFlexSnapshots.d.ts +0 -4
- package/getFlexSnapshots.js +0 -4
- package/getFlexSnapshots.js.map +1 -1
- package/getGlobalClusterConfig.d.ts +0 -12
- package/getGlobalClusterConfig.js +0 -4
- package/getGlobalClusterConfig.js.map +1 -1
- package/getLdapConfiguration.d.ts +0 -4
- package/getLdapConfiguration.js +0 -4
- package/getLdapConfiguration.js.map +1 -1
- package/getLdapVerify.d.ts +0 -4
- package/getLdapVerify.js +0 -4
- package/getLdapVerify.js.map +1 -1
- package/getMaintenanceWindow.d.ts +6 -6
- package/getMaintenanceWindow.js +4 -4
- package/getMongodbEmployeeAccessGrant.d.ts +0 -4
- package/getMongodbEmployeeAccessGrant.js +0 -4
- package/getMongodbEmployeeAccessGrant.js.map +1 -1
- package/getNetworkContainer.d.ts +0 -4
- package/getNetworkContainer.js +0 -4
- package/getNetworkContainer.js.map +1 -1
- package/getNetworkContainers.d.ts +0 -4
- package/getNetworkContainers.js +0 -4
- package/getNetworkContainers.js.map +1 -1
- package/getNetworkPeering.d.ts +0 -4
- package/getNetworkPeering.js +0 -4
- package/getNetworkPeering.js.map +1 -1
- package/getNetworkPeerings.d.ts +0 -4
- package/getNetworkPeerings.js +0 -4
- package/getNetworkPeerings.js.map +1 -1
- package/getOnlineArchive.d.ts +2 -6
- package/getOnlineArchive.js +2 -6
- package/getOnlineArchive.js.map +1 -1
- package/getOnlineArchives.d.ts +2 -6
- package/getOnlineArchives.js +2 -6
- package/getOnlineArchives.js.map +1 -1
- package/getOrgInvitation.d.ts +4 -4
- package/getOrgInvitation.js +4 -4
- package/getOrganization.d.ts +4 -4
- package/getOrganization.js +0 -4
- package/getOrganization.js.map +1 -1
- package/getOrganizations.d.ts +0 -4
- package/getOrganizations.js +0 -4
- package/getOrganizations.js.map +1 -1
- package/getPrivateEndpointRegionalMode.d.ts +0 -4
- package/getPrivateEndpointRegionalMode.js +0 -4
- package/getPrivateEndpointRegionalMode.js.map +1 -1
- package/getPrivateLinkEndpoint.d.ts +0 -4
- package/getPrivateLinkEndpoint.js +0 -4
- package/getPrivateLinkEndpoint.js.map +1 -1
- package/getPrivateLinkEndpointService.d.ts +0 -4
- package/getPrivateLinkEndpointService.js +0 -4
- package/getPrivateLinkEndpointService.js.map +1 -1
- package/getPrivatelinkEndpointServiceDataFederationOnlineArchive.d.ts +2 -6
- package/getPrivatelinkEndpointServiceDataFederationOnlineArchive.js +0 -4
- package/getPrivatelinkEndpointServiceDataFederationOnlineArchive.js.map +1 -1
- package/getPrivatelinkEndpointServiceDataFederationOnlineArchives.d.ts +0 -4
- package/getPrivatelinkEndpointServiceDataFederationOnlineArchives.js +0 -4
- package/getPrivatelinkEndpointServiceDataFederationOnlineArchives.js.map +1 -1
- package/getProject.d.ts +11 -57
- package/getProject.js +0 -56
- package/getProject.js.map +1 -1
- package/getProjectInvitation.d.ts +4 -4
- package/getProjectInvitation.js +4 -4
- package/getProjectIpAccessList.d.ts +0 -4
- package/getProjectIpAccessList.js +0 -4
- package/getProjectIpAccessList.js.map +1 -1
- package/getProjectIpAddresses.d.ts +0 -4
- package/getProjectIpAddresses.js +0 -4
- package/getProjectIpAddresses.js.map +1 -1
- package/getProjects.d.ts +1 -31
- package/getProjects.js +0 -30
- package/getProjects.js.map +1 -1
- package/getPushBasedLogExport.d.ts +0 -4
- package/getPushBasedLogExport.js +0 -4
- package/getPushBasedLogExport.js.map +1 -1
- package/getResourcePolicies.d.ts +0 -4
- package/getResourcePolicies.js +0 -4
- package/getResourcePolicies.js.map +1 -1
- package/getResourcePolicy.d.ts +0 -4
- package/getResourcePolicy.js +0 -4
- package/getResourcePolicy.js.map +1 -1
- package/getRolesOrgId.d.ts +3 -7
- package/getRolesOrgId.js +2 -6
- package/getRolesOrgId.js.map +1 -1
- package/getSearchDeployment.d.ts +0 -4
- package/getSearchDeployment.js +0 -4
- package/getSearchDeployment.js.map +1 -1
- package/getSearchIndex.d.ts +9 -5
- package/getSearchIndex.js +0 -4
- package/getSearchIndex.js.map +1 -1
- package/getSearchIndexes.d.ts +0 -4
- package/getSearchIndexes.js +0 -4
- package/getSearchIndexes.js.map +1 -1
- package/getServerlessInstance.d.ts +2 -20
- package/getServerlessInstance.js +2 -20
- package/getServerlessInstance.js.map +1 -1
- package/getServerlessInstances.d.ts +2 -2
- package/getServerlessInstances.js +2 -2
- package/getStreamAccountDetails.d.ts +0 -4
- package/getStreamAccountDetails.js +0 -4
- package/getStreamAccountDetails.js.map +1 -1
- package/getStreamConnection.d.ts +55 -13
- package/getStreamConnection.js +30 -6
- package/getStreamConnection.js.map +1 -1
- package/getStreamConnections.d.ts +28 -12
- package/getStreamConnections.js +4 -6
- package/getStreamConnections.js.map +1 -1
- package/getStreamInstance.d.ts +42 -2
- package/getStreamInstance.js +42 -2
- package/getStreamInstance.js.map +1 -1
- package/getStreamInstances.d.ts +38 -2
- package/getStreamInstances.js +38 -2
- package/getStreamInstances.js.map +1 -1
- package/getStreamPrivatelinkEndpoint.d.ts +53 -4
- package/getStreamPrivatelinkEndpoint.js +52 -4
- package/getStreamPrivatelinkEndpoint.js.map +1 -1
- package/getStreamPrivatelinkEndpoints.d.ts +52 -4
- package/getStreamPrivatelinkEndpoints.js +52 -4
- package/getStreamPrivatelinkEndpoints.js.map +1 -1
- package/getStreamProcessor.d.ts +28 -29
- package/getStreamProcessor.js +18 -20
- package/getStreamProcessor.js.map +1 -1
- package/getStreamProcessors.d.ts +25 -26
- package/getStreamProcessors.js +18 -20
- package/getStreamProcessors.js.map +1 -1
- package/getStreamWorkspace.d.ts +92 -0
- package/getStreamWorkspace.js +66 -0
- package/getStreamWorkspace.js.map +1 -0
- package/getStreamWorkspaces.d.ts +101 -0
- package/getStreamWorkspaces.js +66 -0
- package/getStreamWorkspaces.js.map +1 -0
- package/getTeam.d.ts +8 -5
- package/getTeam.js +0 -4
- package/getTeam.js.map +1 -1
- package/getTeamProjectAssignment.d.ts +88 -0
- package/getTeamProjectAssignment.js +74 -0
- package/getTeamProjectAssignment.js.map +1 -0
- package/getThirdPartyIntegration.d.ts +0 -4
- package/getThirdPartyIntegration.js +0 -4
- package/getThirdPartyIntegration.js.map +1 -1
- package/getThirdPartyIntegrations.d.ts +0 -4
- package/getThirdPartyIntegrations.js +0 -4
- package/getThirdPartyIntegrations.js.map +1 -1
- package/getX509AuthenticationDatabaseUser.d.ts +0 -4
- package/getX509AuthenticationDatabaseUser.js +0 -4
- package/getX509AuthenticationDatabaseUser.js.map +1 -1
- package/globalClusterConfig.d.ts +0 -18
- package/globalClusterConfig.js +0 -4
- package/globalClusterConfig.js.map +1 -1
- package/index.d.ts +33 -36
- package/index.js +49 -50
- package/index.js.map +1 -1
- package/ldapConfiguration.d.ts +0 -2
- package/ldapConfiguration.js +0 -2
- package/ldapConfiguration.js.map +1 -1
- package/ldapVerify.d.ts +0 -2
- package/ldapVerify.js +0 -2
- package/ldapVerify.js.map +1 -1
- package/maintenanceWindow.d.ts +19 -11
- package/maintenanceWindow.js +9 -3
- package/maintenanceWindow.js.map +1 -1
- package/mongodbEmployeeAccessGrant.d.ts +3 -2
- package/mongodbEmployeeAccessGrant.js +3 -2
- package/mongodbEmployeeAccessGrant.js.map +1 -1
- package/networkContainer.d.ts +3 -2
- package/networkContainer.js +3 -2
- package/networkContainer.js.map +1 -1
- package/networkPeering.d.ts +18 -8
- package/networkPeering.js +2 -2
- package/networkPeering.js.map +1 -1
- package/onlineArchive.d.ts +17 -5
- package/onlineArchive.js +4 -2
- package/onlineArchive.js.map +1 -1
- package/orgInvitation.d.ts +3 -0
- package/orgInvitation.js +3 -0
- package/orgInvitation.js.map +1 -1
- package/organization.d.ts +5 -2
- package/organization.js +5 -2
- package/organization.js.map +1 -1
- package/package.json +2 -2
- package/privateEndpointRegionalMode.d.ts +0 -2
- package/privateEndpointRegionalMode.js +0 -2
- package/privateEndpointRegionalMode.js.map +1 -1
- package/privateLinkEndpoint.d.ts +16 -2
- package/privateLinkEndpoint.js +6 -2
- package/privateLinkEndpoint.js.map +1 -1
- package/privateLinkEndpointService.d.ts +12 -0
- package/privateLinkEndpointService.js +2 -0
- package/privateLinkEndpointService.js.map +1 -1
- package/privatelinkEndpointServiceDataFederationOnlineArchive.d.ts +6 -5
- package/privatelinkEndpointServiceDataFederationOnlineArchive.js +3 -2
- package/privatelinkEndpointServiceDataFederationOnlineArchive.js.map +1 -1
- package/project.d.ts +12 -15
- package/project.js +3 -15
- package/project.js.map +1 -1
- package/projectApiKey.d.ts +3 -0
- package/projectApiKey.js +3 -0
- package/projectApiKey.js.map +1 -1
- package/projectInvitation.d.ts +3 -0
- package/projectInvitation.js +3 -0
- package/projectInvitation.js.map +1 -1
- package/projectIpAccessList.d.ts +5 -2
- package/projectIpAccessList.js +5 -2
- package/projectIpAccessList.js.map +1 -1
- package/provider.d.ts +24 -0
- package/provider.js +3 -0
- package/provider.js.map +1 -1
- package/pushBasedLogExport.d.ts +15 -0
- package/pushBasedLogExport.js +5 -0
- package/pushBasedLogExport.js.map +1 -1
- package/resourcePolicy.d.ts +0 -2
- package/resourcePolicy.js +0 -2
- package/resourcePolicy.js.map +1 -1
- package/searchDeployment.d.ts +7 -6
- package/searchDeployment.js +3 -2
- package/searchDeployment.js.map +1 -1
- package/searchIndex.d.ts +50 -5
- package/searchIndex.js +27 -2
- package/searchIndex.js.map +1 -1
- package/serverlessInstance.d.ts +1 -10
- package/serverlessInstance.js +1 -10
- package/serverlessInstance.js.map +1 -1
- package/streamConnection.d.ts +77 -17
- package/streamConnection.js +47 -12
- package/streamConnection.js.map +1 -1
- package/streamInstance.d.ts +4 -4
- package/streamInstance.js +4 -4
- package/streamPrivatelinkEndpoint.d.ts +55 -5
- package/streamPrivatelinkEndpoint.js +36 -2
- package/streamPrivatelinkEndpoint.js.map +1 -1
- package/streamProcessor.d.ts +52 -18
- package/streamProcessor.js +17 -13
- package/streamProcessor.js.map +1 -1
- package/streamWorkspace.d.ts +144 -0
- package/streamWorkspace.js +116 -0
- package/streamWorkspace.js.map +1 -0
- package/team.d.ts +14 -6
- package/team.js +4 -5
- package/team.js.map +1 -1
- package/teamProjectAssignment.d.ts +108 -0
- package/teamProjectAssignment.js +98 -0
- package/teamProjectAssignment.js.map +1 -0
- package/thirdPartyIntegration.d.ts +3 -2
- package/thirdPartyIntegration.js +3 -2
- package/thirdPartyIntegration.js.map +1 -1
- package/types/input.d.ts +252 -249
- package/types/output.d.ts +1078 -751
- package/x509authenticationDatabaseUser.d.ts +0 -2
- package/x509authenticationDatabaseUser.js +0 -2
- package/x509authenticationDatabaseUser.js.map +1 -1
- package/dataLakePipeline.d.ts +0 -239
- package/dataLakePipeline.js +0 -145
- package/dataLakePipeline.js.map +0 -1
- package/get509AuthenticationDatabaseUser.d.ts +0 -190
- package/get509AuthenticationDatabaseUser.js +0 -170
- package/get509AuthenticationDatabaseUser.js.map +0 -1
- package/getDataLakePipeline.d.ts +0 -230
- package/getDataLakePipeline.js +0 -162
- package/getDataLakePipeline.js.map +0 -1
- package/getDataLakePipelineRun.d.ts +0 -104
- package/getDataLakePipelineRun.js +0 -44
- package/getDataLakePipelineRun.js.map +0 -1
- package/getDataLakePipelineRuns.d.ts +0 -137
- package/getDataLakePipelineRuns.js +0 -116
- package/getDataLakePipelineRuns.js.map +0 -1
- package/getDataLakePipelines.d.ts +0 -58
- package/getDataLakePipelines.js +0 -40
- package/getDataLakePipelines.js.map +0 -1
- package/getPrivatelinkEndpointServiceServerless.d.ts +0 -220
- package/getPrivatelinkEndpointServiceServerless.js +0 -178
- package/getPrivatelinkEndpointServiceServerless.js.map +0 -1
- package/getPrivatelinkEndpointsServiceServerless.d.ts +0 -187
- package/getPrivatelinkEndpointsServiceServerless.js +0 -166
- package/getPrivatelinkEndpointsServiceServerless.js.map +0 -1
- package/getTeams.d.ts +0 -46
- package/getTeams.js +0 -40
- package/getTeams.js.map +0 -1
- package/privatelinkEndpointServerless.d.ts +0 -143
- package/privatelinkEndpointServerless.js +0 -109
- package/privatelinkEndpointServerless.js.map +0 -1
- package/privatelinkEndpointServiceServerless.d.ts +0 -236
- package/privatelinkEndpointServiceServerless.js +0 -177
- package/privatelinkEndpointServiceServerless.js.map +0 -1
- package/teams.d.ts +0 -52
- package/teams.js +0 -66
- package/teams.js.map +0 -1
package/types/output.d.ts
CHANGED
|
@@ -1,63 +1,51 @@
|
|
|
1
1
|
import * as outputs from "../types/output";
|
|
2
2
|
export interface AdvancedClusterAdvancedConfiguration {
|
|
3
3
|
/**
|
|
4
|
-
* The minimum pre- and post-image retention time in seconds.
|
|
4
|
+
* The minimum pre- and post-image retention time in seconds.
|
|
5
5
|
*/
|
|
6
|
-
changeStreamOptionsPreAndPostImagesExpireAfterSeconds
|
|
6
|
+
changeStreamOptionsPreAndPostImagesExpireAfterSeconds: number;
|
|
7
7
|
/**
|
|
8
8
|
* The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when `tlsCipherConfigMode` is set to `CUSTOM`.
|
|
9
9
|
*/
|
|
10
|
-
customOpensslCipherConfigTls12s
|
|
10
|
+
customOpensslCipherConfigTls12s: string[];
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
12
|
+
* The custom OpenSSL cipher suite list for TLS 1.3. This field is only valid when `tlsCipherConfigMode` is set to `CUSTOM`.
|
|
13
13
|
*/
|
|
14
|
-
|
|
14
|
+
customOpensslCipherConfigTls13s: string[];
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide
|
|
16
|
+
* Default time limit in milliseconds for individual read operations to complete. This parameter is supported only for MongoDB version 8.0 and above.
|
|
19
17
|
*/
|
|
20
|
-
|
|
18
|
+
defaultMaxTimeMs: number;
|
|
21
19
|
/**
|
|
22
|
-
*
|
|
20
|
+
* Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.
|
|
23
21
|
*/
|
|
24
22
|
defaultWriteConcern: string;
|
|
25
23
|
/**
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide
|
|
29
|
-
*/
|
|
30
|
-
failIndexKeyTooLong: boolean;
|
|
31
|
-
/**
|
|
32
|
-
* When true (default), the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
|
|
24
|
+
* Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript. When using 8.0+, we recommend disabling server-side JavaScript and using operators of aggregation pipeline as more performant alternative.
|
|
33
25
|
*/
|
|
34
26
|
javascriptEnabled: boolean;
|
|
35
27
|
/**
|
|
36
|
-
*
|
|
37
|
-
* - TLS1_0
|
|
38
|
-
* - TLS1_1
|
|
39
|
-
* - TLS1_2
|
|
28
|
+
* Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.
|
|
40
29
|
*/
|
|
41
30
|
minimumEnabledTlsProtocol: string;
|
|
42
31
|
/**
|
|
43
|
-
*
|
|
32
|
+
* Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.
|
|
44
33
|
*/
|
|
45
34
|
noTableScan: boolean;
|
|
46
35
|
/**
|
|
47
36
|
* Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.
|
|
48
|
-
* * **Note** A minimum oplog retention is required when seeking to change a cluster's class to Local NVMe SSD. To learn more and for latest guidance see [`oplogMinRetentionHours`](https://www.mongodb.com/docs/manual/core/replica-set-oplog/#std-label-replica-set-minimum-oplog-size)
|
|
49
37
|
*/
|
|
50
|
-
oplogMinRetentionHours
|
|
38
|
+
oplogMinRetentionHours: number;
|
|
51
39
|
/**
|
|
52
|
-
*
|
|
40
|
+
* Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.
|
|
53
41
|
*/
|
|
54
42
|
oplogSizeMb: number;
|
|
55
43
|
/**
|
|
56
|
-
* Interval in seconds at which the mongosqld process re-samples data to create its relational schema.
|
|
44
|
+
* Interval in seconds at which the mongosqld process re-samples data to create its relational schema.
|
|
57
45
|
*/
|
|
58
46
|
sampleRefreshIntervalBiConnector: number;
|
|
59
47
|
/**
|
|
60
|
-
* Number of documents per database to sample when gathering schema information.
|
|
48
|
+
* Number of documents per database to sample when gathering schema information.
|
|
61
49
|
*/
|
|
62
50
|
sampleSizeBiConnector: number;
|
|
63
51
|
/**
|
|
@@ -65,7 +53,7 @@ export interface AdvancedClusterAdvancedConfiguration {
|
|
|
65
53
|
*/
|
|
66
54
|
tlsCipherConfigMode: string;
|
|
67
55
|
/**
|
|
68
|
-
* Lifetime, in seconds, of multi-document transactions.
|
|
56
|
+
* Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.
|
|
69
57
|
*/
|
|
70
58
|
transactionLifetimeLimitSeconds: number;
|
|
71
59
|
}
|
|
@@ -88,23 +76,23 @@ export interface AdvancedClusterBiConnectorConfig {
|
|
|
88
76
|
*/
|
|
89
77
|
readPreference: string;
|
|
90
78
|
}
|
|
91
|
-
export interface
|
|
79
|
+
export interface AdvancedClusterConnectionStrings {
|
|
92
80
|
/**
|
|
93
81
|
* [Network-peering-endpoint-aware](https://docs.atlas.mongodb.com/security-vpc-peering/#vpc-peering) 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.
|
|
94
82
|
*/
|
|
95
83
|
private: string;
|
|
96
84
|
/**
|
|
97
85
|
* Private endpoint connection strings. Each object describes the connection strings you can use to connect to this cluster through a private endpoint. Atlas returns this parameter only if you deployed a private endpoint to all regions to which you deployed this cluster's nodes.
|
|
98
|
-
* - `connection_strings.private_endpoint
|
|
99
|
-
* - `connection_strings.private_endpoint
|
|
100
|
-
* - `connection_strings.private_endpoint
|
|
101
|
-
* - `connection_strings.private_endpoint
|
|
102
|
-
* - `connection_strings.private_endpoint
|
|
103
|
-
* - `connection_strings.private_endpoint
|
|
104
|
-
* - `connection_strings.private_endpoint
|
|
105
|
-
* - `connection_strings.private_endpoint
|
|
86
|
+
* - `connection_strings.private_endpoint[#].connection_string` - Private-endpoint-aware `mongodb://`connection string for this private endpoint.
|
|
87
|
+
* - `connection_strings.private_endpoint[#].srv_connection_string` - Private-endpoint-aware `mongodb+srv://` connection string for this private endpoint. 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 `connection_strings.private_endpoint[#].connection_string`
|
|
88
|
+
* - `connection_strings.private_endpoint[#].srv_shard_optimized_connection_string` - Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster support it. If it doesn't, use and consult the documentation for `connection_strings.private_endpoint[#].srv_connection_string`.
|
|
89
|
+
* - `connection_strings.private_endpoint[#].type` - Type of MongoDB process that you connect to with the connection strings. Atlas returns `MONGOD` for replica sets, or `MONGOS` for sharded clusters.
|
|
90
|
+
* - `connection_strings.private_endpoint[#].endpoints` - Private endpoint through which you connect to Atlas when you use `connection_strings.private_endpoint[#].connection_string` or `connection_strings.private_endpoint[#].srv_connection_string`
|
|
91
|
+
* - `connection_strings.private_endpoint[#].endpoints[#].endpoint_id` - Unique identifier of the private endpoint.
|
|
92
|
+
* - `connection_strings.private_endpoint[#].endpoints[#].provider_name` - Cloud provider to which you deployed the private endpoint. Atlas returns `AWS` or `AZURE`.
|
|
93
|
+
* - `connection_strings.private_endpoint[#].endpoints[#].region` - Region to which you deployed the private endpoint.
|
|
106
94
|
*/
|
|
107
|
-
privateEndpoints: outputs.
|
|
95
|
+
privateEndpoints: outputs.AdvancedClusterConnectionStringsPrivateEndpoint[];
|
|
108
96
|
/**
|
|
109
97
|
* [Network-peering-endpoint-aware](https://docs.atlas.mongodb.com/security-vpc-peering/#vpc-peering) 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.
|
|
110
98
|
*/
|
|
@@ -118,37 +106,41 @@ export interface AdvancedClusterConnectionString {
|
|
|
118
106
|
*/
|
|
119
107
|
standardSrv: string;
|
|
120
108
|
}
|
|
121
|
-
export interface
|
|
109
|
+
export interface AdvancedClusterConnectionStringsPrivateEndpoint {
|
|
110
|
+
/**
|
|
111
|
+
* Private endpoint-aware connection string that uses the `mongodb://` protocol to connect to MongoDB Cloud through a private endpoint.
|
|
112
|
+
*/
|
|
122
113
|
connectionString: string;
|
|
123
|
-
|
|
114
|
+
/**
|
|
115
|
+
* List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].connectionString** or **connectionStrings.privateEndpoint[n].srvConnectionString**.
|
|
116
|
+
*/
|
|
117
|
+
endpoints: outputs.AdvancedClusterConnectionStringsPrivateEndpointEndpoint[];
|
|
118
|
+
/**
|
|
119
|
+
* 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). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application supports it. If it doesn't, use connectionStrings.privateEndpoint[n].connectionString.
|
|
120
|
+
*/
|
|
124
121
|
srvConnectionString: string;
|
|
122
|
+
/**
|
|
123
|
+
* Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.
|
|
124
|
+
*/
|
|
125
125
|
srvShardOptimizedConnectionString: string;
|
|
126
|
+
/**
|
|
127
|
+
* MongoDB process type to which your application connects. Use `MONGOD` for replica sets and `MONGOS` for sharded clusters.
|
|
128
|
+
*/
|
|
126
129
|
type: string;
|
|
127
130
|
}
|
|
128
|
-
export interface
|
|
129
|
-
endpointId: string;
|
|
131
|
+
export interface AdvancedClusterConnectionStringsPrivateEndpointEndpoint {
|
|
130
132
|
/**
|
|
131
|
-
*
|
|
132
|
-
* The possible values are:
|
|
133
|
-
* - `AWS` - Amazon AWS
|
|
134
|
-
* - `GCP` - Google Cloud Platform
|
|
135
|
-
* - `AZURE` - Microsoft Azure
|
|
136
|
-
* - `TENANT` - M0 multi-tenant cluster. Use `replication_specs.#.region_configs.#.backing_provider_name` to set the cloud service provider.
|
|
133
|
+
* Unique string that the cloud provider uses to identify the private endpoint.
|
|
137
134
|
*/
|
|
138
|
-
|
|
139
|
-
region: string;
|
|
140
|
-
}
|
|
141
|
-
export interface AdvancedClusterLabel {
|
|
135
|
+
endpointId: string;
|
|
142
136
|
/**
|
|
143
|
-
*
|
|
137
|
+
* Cloud provider in which MongoDB Cloud deploys the private endpoint.
|
|
144
138
|
*/
|
|
145
|
-
|
|
139
|
+
providerName: string;
|
|
146
140
|
/**
|
|
147
|
-
*
|
|
148
|
-
*
|
|
149
|
-
* > **NOTE:** MongoDB Atlas doesn't display your labels.
|
|
141
|
+
* Region where the private endpoint is deployed.
|
|
150
142
|
*/
|
|
151
|
-
|
|
143
|
+
region: string;
|
|
152
144
|
}
|
|
153
145
|
export interface AdvancedClusterPinnedFcv {
|
|
154
146
|
/**
|
|
@@ -161,26 +153,16 @@ export interface AdvancedClusterPinnedFcv {
|
|
|
161
153
|
version: string;
|
|
162
154
|
}
|
|
163
155
|
export interface AdvancedClusterReplicationSpec {
|
|
156
|
+
/**
|
|
157
|
+
* A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created.
|
|
158
|
+
*/
|
|
164
159
|
containerId: {
|
|
165
160
|
[key: string]: string;
|
|
166
161
|
};
|
|
167
162
|
/**
|
|
168
|
-
* Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. This value corresponds to Shard ID displayed in the UI.
|
|
163
|
+
* Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. This value corresponds to Shard ID displayed in the UI.
|
|
169
164
|
*/
|
|
170
165
|
externalId: string;
|
|
171
|
-
/**
|
|
172
|
-
* **(DEPRECATED)** Unique identifer of the replication document for a zone in a Global Cluster. This value corresponds to the legacy sharding schema (no independent shard scaling) and is different from the Shard ID you may see in the Atlas UI. This value is not populated (empty string) when a sharded cluster has independently scaled shards.
|
|
173
|
-
*
|
|
174
|
-
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide
|
|
175
|
-
*/
|
|
176
|
-
id: string;
|
|
177
|
-
/**
|
|
178
|
-
* Provide this value if you set a `clusterType` of SHARDED or GEOSHARDED. Omit this value if you selected a `clusterType` of REPLICASET. This API resource accepts 1 through 50, inclusive. This parameter defaults to 1. If you specify a `numShards` value of 1 and a `clusterType` of SHARDED, Atlas deploys a single-shard [sharded cluster](https://docs.atlas.mongodb.com/reference/glossary/#std-term-sharded-cluster). Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.
|
|
179
|
-
* If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards. To learn more, see [Convert a replica set to a sharded cluster documentation](https://www.mongodb.com/docs/atlas/scale-cluster/#convert-a-replica-set-to-a-sharded-cluster) and [Convert a replica set to a sharded cluster tutorial](https://www.mongodb.com/docs/upcoming/tutorial/convert-replica-set-to-replicated-shard-cluster). **(DEPRECATED)** To learn more, see the 1.18.0 Upgrade Guide.
|
|
180
|
-
*
|
|
181
|
-
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide
|
|
182
|
-
*/
|
|
183
|
-
numShards?: number;
|
|
184
166
|
/**
|
|
185
167
|
* Configuration for the hardware specifications for nodes set for a given region. Each `regionConfigs` object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each `regionConfigs` object must have either an `analyticsSpecs` object, `electableSpecs` object, or `readOnlySpecs` object. See below.
|
|
186
168
|
*/
|
|
@@ -192,7 +174,7 @@ export interface AdvancedClusterReplicationSpec {
|
|
|
192
174
|
/**
|
|
193
175
|
* Name for the zone in a Global Cluster.
|
|
194
176
|
*/
|
|
195
|
-
zoneName
|
|
177
|
+
zoneName: string;
|
|
196
178
|
}
|
|
197
179
|
export interface AdvancedClusterReplicationSpecRegionConfig {
|
|
198
180
|
/**
|
|
@@ -208,7 +190,7 @@ export interface AdvancedClusterReplicationSpecRegionConfig {
|
|
|
208
190
|
*/
|
|
209
191
|
autoScaling: outputs.AdvancedClusterReplicationSpecRegionConfigAutoScaling;
|
|
210
192
|
/**
|
|
211
|
-
* Cloud service provider on which you provision the host for a multi-tenant cluster. Use this only when
|
|
193
|
+
* Cloud service provider on which you provision the host for a multi-tenant cluster. Use this only when the `providerName` is `TENANT` and `instanceSize` is `M0`, or when the `providerName` is `FLEX`.
|
|
212
194
|
*/
|
|
213
195
|
backingProviderName?: string;
|
|
214
196
|
/**
|
|
@@ -218,7 +200,7 @@ export interface AdvancedClusterReplicationSpecRegionConfig {
|
|
|
218
200
|
/**
|
|
219
201
|
* Election priority of the region. For regions with only read-only nodes, set this value to 0.
|
|
220
202
|
* * If you have multiple `regionConfigs` objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is 7.
|
|
221
|
-
* * If your region has set `region_configs
|
|
203
|
+
* * If your region has set `region_configs[#].electable_specs.node_count` to 1 or higher, it must have a priority of exactly one (1) less than another region in the `replication_specs[#].region_configs[#]` array. The highest-priority region must have a priority of 7. The lowest possible priority is 1.
|
|
222
204
|
*/
|
|
223
205
|
priority: number;
|
|
224
206
|
/**
|
|
@@ -227,7 +209,8 @@ export interface AdvancedClusterReplicationSpecRegionConfig {
|
|
|
227
209
|
* - `AWS` - Amazon AWS
|
|
228
210
|
* - `GCP` - Google Cloud Platform
|
|
229
211
|
* - `AZURE` - Microsoft Azure
|
|
230
|
-
* - `TENANT` - M0 multi-tenant cluster. Use `replication_specs
|
|
212
|
+
* - `TENANT` - M0 multi-tenant cluster. Use `replication_specs.[0].region_configs[0].backing_provider_name` to set the cloud service provider.
|
|
213
|
+
* - `FLEX` - Flex cluster. Use `replication_specs.[0].region_configs[0].backing_provider_name` to set the cloud service provider.
|
|
231
214
|
*/
|
|
232
215
|
providerName: string;
|
|
233
216
|
/**
|
|
@@ -240,17 +223,22 @@ export interface AdvancedClusterReplicationSpecRegionConfig {
|
|
|
240
223
|
regionName: string;
|
|
241
224
|
}
|
|
242
225
|
export interface AdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScaling {
|
|
226
|
+
/**
|
|
227
|
+
* Flag that indicates whether analytics instance size auto-scaling is enabled. This parameter defaults to false. If a sharded cluster is making use of the New Sharding Configuration, auto-scaling of analytics instance size will be independent for each individual shard. Please reference the Use Auto-Scaling Per Shard section for more details.
|
|
228
|
+
*/
|
|
243
229
|
computeEnabled: boolean;
|
|
244
230
|
/**
|
|
245
|
-
* Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if `replication_specs
|
|
231
|
+
* Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if `replication_specs[#].region_configs[#].analytics_auto_scaling.compute_enabled` is true.
|
|
232
|
+
*
|
|
233
|
+
* **Note:** The configuration options and considerations for analytics auto-scaling are similar to those described in auto_scaling. When using `useEffectiveFields = true`, you can read scaled values using `effectiveAnalyticsSpecs` in the data source. When not using `useEffectiveFields`, you may need lifecycle ignore customizations for `analyticsSpecs` fields similar to the example shown in the autoScaling section.
|
|
246
234
|
*/
|
|
247
235
|
computeMaxInstanceSize: string;
|
|
248
236
|
/**
|
|
249
|
-
* Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if `replication_specs
|
|
237
|
+
* Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if `replication_specs[#].region_configs[#].analytics_auto_scaling.compute_scale_down_enabled` is true.
|
|
250
238
|
*/
|
|
251
239
|
computeMinInstanceSize: string;
|
|
252
240
|
/**
|
|
253
|
-
* Flag that indicates whether the instance size may scale down. Atlas requires this parameter if `replication_specs
|
|
241
|
+
* Flag that indicates whether the instance size may scale down. Atlas requires this parameter if `replication_specs[#].region_configs[#].analytics_auto_scaling.compute_enabled` : true. If you enable this option, specify a value for `replication_specs[#].region_configs[#].analytics_auto_scaling.compute_min_instance_size`.
|
|
254
242
|
*/
|
|
255
243
|
computeScaleDownEnabled: boolean;
|
|
256
244
|
/**
|
|
@@ -280,20 +268,23 @@ export interface AdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs {
|
|
|
280
268
|
/**
|
|
281
269
|
* Number of nodes of the given type for MongoDB Atlas to deploy to the region.
|
|
282
270
|
*/
|
|
283
|
-
nodeCount
|
|
271
|
+
nodeCount: number;
|
|
284
272
|
}
|
|
285
273
|
export interface AdvancedClusterReplicationSpecRegionConfigAutoScaling {
|
|
274
|
+
/**
|
|
275
|
+
* Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false. If a sharded cluster is making use of the New Sharding Configuration, auto-scaling of the instance size will be independent for each individual shard. Please reference the Use Auto-Scaling Per Shard section for more details.
|
|
276
|
+
*/
|
|
286
277
|
computeEnabled: boolean;
|
|
287
278
|
/**
|
|
288
|
-
*
|
|
279
|
+
* Minimum instance size to which your cluster can automatically scale. MongoDB Cloud requires this parameter if `"replicationSpecs[n].regionConfigs[m].autoScaling.compute.scaleDownEnabled" : true`.
|
|
289
280
|
*/
|
|
290
281
|
computeMaxInstanceSize: string;
|
|
291
282
|
/**
|
|
292
|
-
* Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if `replication_specs
|
|
283
|
+
* Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if `replication_specs[#].region_configs[#].auto_scaling.compute_scale_down_enabled` is true.
|
|
293
284
|
*/
|
|
294
285
|
computeMinInstanceSize: string;
|
|
295
286
|
/**
|
|
296
|
-
* Flag that indicates whether the instance size may scale down. Atlas requires this parameter if `replication_specs
|
|
287
|
+
* Flag that indicates whether the instance size may scale down. Atlas requires this parameter if `replication_specs[#].region_configs[#].auto_scaling.compute_enabled` : true. If you enable this option, specify a value for `replication_specs[#].region_configs[#].auto_scaling.compute_min_instance_size`.
|
|
297
288
|
*/
|
|
298
289
|
computeScaleDownEnabled: boolean;
|
|
299
290
|
/**
|
|
@@ -323,7 +314,7 @@ export interface AdvancedClusterReplicationSpecRegionConfigElectableSpecs {
|
|
|
323
314
|
/**
|
|
324
315
|
* Number of nodes of the given type for MongoDB Atlas to deploy to the region.
|
|
325
316
|
*/
|
|
326
|
-
nodeCount
|
|
317
|
+
nodeCount: number;
|
|
327
318
|
}
|
|
328
319
|
export interface AdvancedClusterReplicationSpecRegionConfigReadOnlySpecs {
|
|
329
320
|
/**
|
|
@@ -347,19 +338,21 @@ export interface AdvancedClusterReplicationSpecRegionConfigReadOnlySpecs {
|
|
|
347
338
|
/**
|
|
348
339
|
* Number of nodes of the given type for MongoDB Atlas to deploy to the region.
|
|
349
340
|
*/
|
|
350
|
-
nodeCount
|
|
341
|
+
nodeCount: number;
|
|
351
342
|
}
|
|
352
|
-
export interface
|
|
343
|
+
export interface AdvancedClusterTimeouts {
|
|
353
344
|
/**
|
|
354
|
-
*
|
|
345
|
+
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
|
|
355
346
|
*/
|
|
356
|
-
|
|
347
|
+
create?: string;
|
|
357
348
|
/**
|
|
358
|
-
*
|
|
359
|
-
*
|
|
360
|
-
* To learn more, see [Resource Tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas).
|
|
349
|
+
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
|
|
361
350
|
*/
|
|
362
|
-
|
|
351
|
+
delete?: string;
|
|
352
|
+
/**
|
|
353
|
+
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
|
|
354
|
+
*/
|
|
355
|
+
update?: string;
|
|
363
356
|
}
|
|
364
357
|
export interface AlertConfigurationMatcher {
|
|
365
358
|
/**
|
|
@@ -678,12 +671,6 @@ export interface CloudBackupScheduleCopySetting {
|
|
|
678
671
|
* Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under https://www.mongodb.com/docs/atlas/reference/cloud-providers/ 'regions' link
|
|
679
672
|
*/
|
|
680
673
|
regionName: string;
|
|
681
|
-
/**
|
|
682
|
-
* Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, consult the replicationSpecs array returned from [Return One Multi-Cloud Cluster in One Project](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcluster). **(DEPRECATED)** Use `zoneId` instead. To learn more, see the 1.18.0 upgrade guide.
|
|
683
|
-
*
|
|
684
|
-
* @deprecated This parameter is deprecated. Please transition to `copy_settings.#.zone_id`. To learn more, see our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide
|
|
685
|
-
*/
|
|
686
|
-
replicationSpecId: string;
|
|
687
674
|
/**
|
|
688
675
|
* Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores.
|
|
689
676
|
*/
|
|
@@ -864,11 +851,23 @@ export interface CloudBackupSnapshotRestoreJobDeliveryTypeConfig {
|
|
|
864
851
|
targetProjectId?: string;
|
|
865
852
|
}
|
|
866
853
|
export interface CloudProviderAccessAuthorizationAws {
|
|
854
|
+
/**
|
|
855
|
+
* ARN of the IAM Role that Atlas assumes when accessing resources in your AWS account. This value is required after the creation (register of the role) as part of [Set Up Unified AWS Access](https://docs.atlas.mongodb.com/security/set-up-unified-aws-access/#set-up-unified-aws-access).
|
|
856
|
+
*/
|
|
867
857
|
iamAssumedRoleArn: string;
|
|
868
858
|
}
|
|
869
859
|
export interface CloudProviderAccessAuthorizationAzure {
|
|
860
|
+
/**
|
|
861
|
+
* Azure Active Directory Application ID of Atlas.
|
|
862
|
+
*/
|
|
870
863
|
atlasAzureAppId: string;
|
|
864
|
+
/**
|
|
865
|
+
* UUID string that identifies the Azure Service Principal.
|
|
866
|
+
*/
|
|
871
867
|
servicePrincipalId: string;
|
|
868
|
+
/**
|
|
869
|
+
* UUID String that identifies the Azure Active Directory Tenant ID.
|
|
870
|
+
*/
|
|
872
871
|
tenantId: string;
|
|
873
872
|
}
|
|
874
873
|
export interface CloudProviderAccessAuthorizationFeatureUsage {
|
|
@@ -878,21 +877,85 @@ export interface CloudProviderAccessAuthorizationFeatureUsage {
|
|
|
878
877
|
featureType: string;
|
|
879
878
|
}
|
|
880
879
|
export interface CloudProviderAccessAuthorizationGcp {
|
|
880
|
+
/**
|
|
881
|
+
* Email address for the Google Service Account created by Atlas.
|
|
882
|
+
*/
|
|
881
883
|
serviceAccountForAtlas: string;
|
|
882
884
|
}
|
|
883
885
|
export interface CloudProviderAccessSetupAwsConfig {
|
|
886
|
+
/**
|
|
887
|
+
* Unique external ID Atlas uses when assuming the IAM role in your AWS account.
|
|
888
|
+
*/
|
|
884
889
|
atlasAssumedRoleExternalId: string;
|
|
890
|
+
/**
|
|
891
|
+
* ARN associated with the Atlas AWS account used to assume IAM roles in your AWS account.
|
|
892
|
+
*/
|
|
885
893
|
atlasAwsAccountArn: string;
|
|
886
894
|
}
|
|
887
895
|
export interface CloudProviderAccessSetupAzureConfig {
|
|
896
|
+
/**
|
|
897
|
+
* Azure Active Directory Application ID of Atlas. This property is required when `providerName = "AZURE".`
|
|
898
|
+
*/
|
|
888
899
|
atlasAzureAppId: string;
|
|
900
|
+
/**
|
|
901
|
+
* UUID string that identifies the Azure Service Principal. This property is required when `providerName = "AZURE".`
|
|
902
|
+
*/
|
|
889
903
|
servicePrincipalId: string;
|
|
904
|
+
/**
|
|
905
|
+
* UUID String that identifies the Azure Active Directory Tenant ID. This property is required when `providerName = "AZURE".`
|
|
906
|
+
*/
|
|
890
907
|
tenantId: string;
|
|
891
908
|
}
|
|
892
909
|
export interface CloudProviderAccessSetupGcpConfig {
|
|
910
|
+
/**
|
|
911
|
+
* The GCP service account email that Atlas uses.
|
|
912
|
+
*/
|
|
893
913
|
serviceAccountForAtlas: string;
|
|
914
|
+
/**
|
|
915
|
+
* The status of the GCP cloud provider access setup. See [MongoDB Atlas API](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupcloudprovideraccess#operation-getgroupcloudprovideraccess-200-body-application-vnd-atlas-2023-01-01-json-gcp-object-status).
|
|
916
|
+
*/
|
|
894
917
|
status: string;
|
|
895
918
|
}
|
|
919
|
+
export interface CloudUserOrgAssignmentRoles {
|
|
920
|
+
/**
|
|
921
|
+
* One or more organization level roles to assign the MongoDB Cloud user.
|
|
922
|
+
*/
|
|
923
|
+
orgRoles?: string[];
|
|
924
|
+
/**
|
|
925
|
+
* List of project level role assignments to assign the MongoDB Cloud user.
|
|
926
|
+
*/
|
|
927
|
+
projectRoleAssignments: outputs.CloudUserOrgAssignmentRolesProjectRoleAssignment[];
|
|
928
|
+
}
|
|
929
|
+
export interface CloudUserOrgAssignmentRolesProjectRoleAssignment {
|
|
930
|
+
/**
|
|
931
|
+
* Unique 24-hexadecimal digit string that identifies the project to which these roles belong.
|
|
932
|
+
*/
|
|
933
|
+
projectId: string;
|
|
934
|
+
/**
|
|
935
|
+
* One or more project-level roles assigned to the MongoDB Cloud user.
|
|
936
|
+
*/
|
|
937
|
+
projectRoles: string[];
|
|
938
|
+
}
|
|
939
|
+
export interface CloudUserTeamAssignmentRoles {
|
|
940
|
+
/**
|
|
941
|
+
* One or more organization level roles to assign the MongoDB Cloud user.
|
|
942
|
+
*/
|
|
943
|
+
orgRoles: string[];
|
|
944
|
+
/**
|
|
945
|
+
* List of project level role assignments to assign the MongoDB Cloud user.
|
|
946
|
+
*/
|
|
947
|
+
projectRoleAssignments: outputs.CloudUserTeamAssignmentRolesProjectRoleAssignment[];
|
|
948
|
+
}
|
|
949
|
+
export interface CloudUserTeamAssignmentRolesProjectRoleAssignment {
|
|
950
|
+
/**
|
|
951
|
+
* Unique 24-hexadecimal digit string that identifies the project to which these roles belong.
|
|
952
|
+
*/
|
|
953
|
+
projectId: string;
|
|
954
|
+
/**
|
|
955
|
+
* One or more project-level roles assigned to the MongoDB Cloud user.
|
|
956
|
+
*/
|
|
957
|
+
projectRoles: string[];
|
|
958
|
+
}
|
|
896
959
|
export interface ClusterAdvancedConfiguration {
|
|
897
960
|
/**
|
|
898
961
|
* The minimum pre- and post-image retention time in seconds. This option corresponds to the `changeStreamOptions.preAndPostImages.expireAfterSeconds` cluster parameter. Defaults to `-1`(off). This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively.`expireAfterSeconds` controls how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. This parameter is only supported for MongoDB version 6.0 and above.
|
|
@@ -925,9 +988,8 @@ export interface ClusterAdvancedConfiguration {
|
|
|
925
988
|
javascriptEnabled: boolean;
|
|
926
989
|
/**
|
|
927
990
|
* Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections. Valid values are:
|
|
928
|
-
* - TLS1_0
|
|
929
|
-
* - TLS1_1
|
|
930
991
|
* - TLS1_2
|
|
992
|
+
* - TLS1_3
|
|
931
993
|
*/
|
|
932
994
|
minimumEnabledTlsProtocol: string;
|
|
933
995
|
/**
|
|
@@ -980,33 +1042,10 @@ export interface ClusterBiConnectorConfig {
|
|
|
980
1042
|
readPreference: string;
|
|
981
1043
|
}
|
|
982
1044
|
export interface ClusterConnectionString {
|
|
983
|
-
/**
|
|
984
|
-
* [Network-peering-endpoint-aware](https://docs.atlas.mongodb.com/security-vpc-peering/#vpc-peering) 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.
|
|
985
|
-
*/
|
|
986
1045
|
private: string;
|
|
987
|
-
/**
|
|
988
|
-
* Private endpoint connection strings. Each object describes the connection strings you can use to connect to this cluster through a private endpoint. Atlas returns this parameter only if you deployed a private endpoint to all regions to which you deployed this cluster's nodes.
|
|
989
|
-
* - `connection_strings.private_endpoint.#.connection_string` - Private-endpoint-aware `mongodb://`connection string for this private endpoint.
|
|
990
|
-
* - `connection_strings.private_endpoint.#.srv_connection_string` - Private-endpoint-aware `mongodb+srv://` connection string for this private endpoint. 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 `connection_strings.private_endpoint[#].connection_string`
|
|
991
|
-
* - `connection_strings.private_endpoint.#.srv_shard_optimized_connection_string` - Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster support it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[#].srvConnectionString.
|
|
992
|
-
* - `connection_strings.private_endpoint.#.type` - Type of MongoDB process that you connect to with the connection strings. Atlas returns `MONGOD` for replica sets, or `MONGOS` for sharded clusters.
|
|
993
|
-
* - `connection_strings.private_endpoint.#.endpoints` - Private endpoint through which you connect to Atlas when you use `connection_strings.private_endpoint[#].connection_string` or `connection_strings.private_endpoint[#].srv_connection_string`
|
|
994
|
-
* - `connection_strings.private_endpoint.#.endpoints.#.endpoint_id` - Unique identifier of the private endpoint.
|
|
995
|
-
* - `connection_strings.private_endpoint.#.endpoints.#.provider_name` - Cloud provider to which you deployed the private endpoint. Atlas returns `AWS` or `AZURE`.
|
|
996
|
-
* - `connection_strings.private_endpoint.#.endpoints.#.region` - Region to which you deployed the private endpoint.
|
|
997
|
-
*/
|
|
998
1046
|
privateEndpoints: outputs.ClusterConnectionStringPrivateEndpoint[];
|
|
999
|
-
/**
|
|
1000
|
-
* [Network-peering-endpoint-aware](https://docs.atlas.mongodb.com/security-vpc-peering/#vpc-peering) 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.
|
|
1001
|
-
*/
|
|
1002
1047
|
privateSrv: string;
|
|
1003
|
-
/**
|
|
1004
|
-
* Public mongodb:// connection string for this cluster.
|
|
1005
|
-
*/
|
|
1006
1048
|
standard: string;
|
|
1007
|
-
/**
|
|
1008
|
-
* 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.
|
|
1009
|
-
*/
|
|
1010
1049
|
standardSrv: string;
|
|
1011
1050
|
}
|
|
1012
1051
|
export interface ClusterConnectionStringPrivateEndpoint {
|
|
@@ -1207,95 +1246,6 @@ export interface CustomDbRoleInheritedRole {
|
|
|
1207
1246
|
*/
|
|
1208
1247
|
roleName: string;
|
|
1209
1248
|
}
|
|
1210
|
-
export interface DataLakePipelineIngestionSchedule {
|
|
1211
|
-
frequencyInterval: number;
|
|
1212
|
-
frequencyType: string;
|
|
1213
|
-
/**
|
|
1214
|
-
* Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.
|
|
1215
|
-
*/
|
|
1216
|
-
id: string;
|
|
1217
|
-
retentionUnit: string;
|
|
1218
|
-
retentionValue: number;
|
|
1219
|
-
}
|
|
1220
|
-
export interface DataLakePipelineSink {
|
|
1221
|
-
/**
|
|
1222
|
-
* Ordered fields used to physically organize data in the destination.
|
|
1223
|
-
* * `partition_fields.#.field_name` - Human-readable label that identifies the field name used to partition data.
|
|
1224
|
-
* * `partition_fields.#.order` - Sequence in which MongoDB Atlas slices the collection data to create partitions. The resource expresses this sequence starting with zero.
|
|
1225
|
-
*/
|
|
1226
|
-
partitionFields?: outputs.DataLakePipelineSinkPartitionField[];
|
|
1227
|
-
/**
|
|
1228
|
-
* Target cloud provider for this Data Lake Pipeline.
|
|
1229
|
-
*/
|
|
1230
|
-
provider: string;
|
|
1231
|
-
/**
|
|
1232
|
-
* Target cloud provider region for this Data Lake Pipeline. [Supported cloud provider regions](https://www.mongodb.com/docs/datalake/limitations).
|
|
1233
|
-
*/
|
|
1234
|
-
region: string;
|
|
1235
|
-
/**
|
|
1236
|
-
* Type of ingestion source of this Data Lake Pipeline.
|
|
1237
|
-
*/
|
|
1238
|
-
type?: string;
|
|
1239
|
-
}
|
|
1240
|
-
export interface DataLakePipelineSinkPartitionField {
|
|
1241
|
-
fieldName: string;
|
|
1242
|
-
order: number;
|
|
1243
|
-
}
|
|
1244
|
-
export interface DataLakePipelineSnapshot {
|
|
1245
|
-
copyRegion: string;
|
|
1246
|
-
createdAt: string;
|
|
1247
|
-
expiresAt: string;
|
|
1248
|
-
frequencyYype: string;
|
|
1249
|
-
/**
|
|
1250
|
-
* Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.
|
|
1251
|
-
*/
|
|
1252
|
-
id: string;
|
|
1253
|
-
masterKey: string;
|
|
1254
|
-
mongodVersion: string;
|
|
1255
|
-
policies?: string[];
|
|
1256
|
-
/**
|
|
1257
|
-
* Target cloud provider for this Data Lake Pipeline.
|
|
1258
|
-
*/
|
|
1259
|
-
provider?: string;
|
|
1260
|
-
replicaSetName: string;
|
|
1261
|
-
size: number;
|
|
1262
|
-
snapshotType: string;
|
|
1263
|
-
status: string;
|
|
1264
|
-
/**
|
|
1265
|
-
* Type of ingestion source of this Data Lake Pipeline.
|
|
1266
|
-
*/
|
|
1267
|
-
type: string;
|
|
1268
|
-
}
|
|
1269
|
-
export interface DataLakePipelineSource {
|
|
1270
|
-
/**
|
|
1271
|
-
* Human-readable name that identifies the cluster.
|
|
1272
|
-
*/
|
|
1273
|
-
clusterName?: string;
|
|
1274
|
-
/**
|
|
1275
|
-
* Human-readable name that identifies the collection.
|
|
1276
|
-
*/
|
|
1277
|
-
collectionName?: string;
|
|
1278
|
-
/**
|
|
1279
|
-
* Human-readable name that identifies the database.
|
|
1280
|
-
*/
|
|
1281
|
-
databaseName?: string;
|
|
1282
|
-
policyItemId?: string;
|
|
1283
|
-
/**
|
|
1284
|
-
* The unique ID for the project to create a data lake pipeline.
|
|
1285
|
-
*/
|
|
1286
|
-
projectId: string;
|
|
1287
|
-
/**
|
|
1288
|
-
* Type of ingestion source of this Data Lake Pipeline.
|
|
1289
|
-
*/
|
|
1290
|
-
type?: string;
|
|
1291
|
-
}
|
|
1292
|
-
export interface DataLakePipelineTransformation {
|
|
1293
|
-
field?: string;
|
|
1294
|
-
/**
|
|
1295
|
-
* Type of ingestion source of this Data Lake Pipeline.
|
|
1296
|
-
*/
|
|
1297
|
-
type?: string;
|
|
1298
|
-
}
|
|
1299
1249
|
export interface DatabaseUserLabel {
|
|
1300
1250
|
/**
|
|
1301
1251
|
* The key that you want to write.
|
|
@@ -1322,7 +1272,7 @@ export interface DatabaseUserRole {
|
|
|
1322
1272
|
}
|
|
1323
1273
|
export interface DatabaseUserScope {
|
|
1324
1274
|
/**
|
|
1325
|
-
* Name of the cluster or Atlas Data
|
|
1275
|
+
* Name of the cluster or Atlas Data Federation that the user has access to.
|
|
1326
1276
|
*/
|
|
1327
1277
|
name?: string;
|
|
1328
1278
|
/**
|
|
@@ -1432,6 +1382,16 @@ export interface EncryptionAtRestGoogleCloudKmsConfig {
|
|
|
1432
1382
|
*/
|
|
1433
1383
|
valid: boolean;
|
|
1434
1384
|
}
|
|
1385
|
+
export interface EncryptionAtRestPrivateEndpointTimeouts {
|
|
1386
|
+
/**
|
|
1387
|
+
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
|
|
1388
|
+
*/
|
|
1389
|
+
create?: string;
|
|
1390
|
+
/**
|
|
1391
|
+
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
|
|
1392
|
+
*/
|
|
1393
|
+
delete?: string;
|
|
1394
|
+
}
|
|
1435
1395
|
export interface EventTriggerEventProcessors {
|
|
1436
1396
|
awsEventbridge?: outputs.EventTriggerEventProcessorsAwsEventbridge;
|
|
1437
1397
|
}
|
|
@@ -1441,7 +1401,7 @@ export interface EventTriggerEventProcessorsAwsEventbridge {
|
|
|
1441
1401
|
}
|
|
1442
1402
|
export interface FederatedDatabaseInstanceCloudProviderConfig {
|
|
1443
1403
|
/**
|
|
1444
|
-
* Name of the cloud service that hosts the
|
|
1404
|
+
* Name of the cloud service that hosts the Atlas Data Federation data stores.
|
|
1445
1405
|
*/
|
|
1446
1406
|
aws?: outputs.FederatedDatabaseInstanceCloudProviderConfigAws;
|
|
1447
1407
|
/**
|
|
@@ -1630,12 +1590,19 @@ export interface FlexClusterProviderSettings {
|
|
|
1630
1590
|
*/
|
|
1631
1591
|
regionName: string;
|
|
1632
1592
|
}
|
|
1633
|
-
export interface
|
|
1634
|
-
|
|
1635
|
-
|
|
1636
|
-
|
|
1637
|
-
|
|
1638
|
-
|
|
1593
|
+
export interface FlexClusterTimeouts {
|
|
1594
|
+
/**
|
|
1595
|
+
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
|
|
1596
|
+
*/
|
|
1597
|
+
create?: string;
|
|
1598
|
+
/**
|
|
1599
|
+
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
|
|
1600
|
+
*/
|
|
1601
|
+
delete?: string;
|
|
1602
|
+
/**
|
|
1603
|
+
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
|
|
1604
|
+
*/
|
|
1605
|
+
update?: string;
|
|
1639
1606
|
}
|
|
1640
1607
|
export interface GetAccessListApiKeysResult {
|
|
1641
1608
|
accessCount: number;
|
|
@@ -1661,34 +1628,25 @@ export interface GetAdvancedClusterAdvancedConfiguration {
|
|
|
1661
1628
|
*/
|
|
1662
1629
|
customOpensslCipherConfigTls12s: string[];
|
|
1663
1630
|
/**
|
|
1664
|
-
*
|
|
1631
|
+
* The custom OpenSSL cipher suite list for TLS 1.3. This field is only valid when `tlsCipherConfigMode` is set to `CUSTOM`.
|
|
1665
1632
|
*/
|
|
1666
|
-
|
|
1633
|
+
customOpensslCipherConfigTls13s: string[];
|
|
1667
1634
|
/**
|
|
1668
|
-
*
|
|
1669
|
-
*
|
|
1670
|
-
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide
|
|
1635
|
+
* Default time limit in milliseconds for individual read operations to complete. This option corresponds to the [defaultMaxTimeMS](https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/) cluster parameter. This parameter is supported only for MongoDB version 8.0 and above.
|
|
1671
1636
|
*/
|
|
1672
|
-
|
|
1637
|
+
defaultMaxTimeMs: number;
|
|
1673
1638
|
/**
|
|
1674
1639
|
* [Default level of acknowledgment requested from MongoDB for write operations](https://docs.mongodb.com/manual/reference/write-concern/) set for this cluster. MongoDB 6.0 clusters default to [majority](https://docs.mongodb.com/manual/reference/write-concern/).
|
|
1675
1640
|
*/
|
|
1676
1641
|
defaultWriteConcern: string;
|
|
1677
|
-
/**
|
|
1678
|
-
* **(DEPRECATED)** 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.
|
|
1679
|
-
*
|
|
1680
|
-
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide
|
|
1681
|
-
*/
|
|
1682
|
-
failIndexKeyTooLong: boolean;
|
|
1683
1642
|
/**
|
|
1684
1643
|
* When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
|
|
1685
1644
|
*/
|
|
1686
1645
|
javascriptEnabled: boolean;
|
|
1687
1646
|
/**
|
|
1688
1647
|
* Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections. Valid values are:
|
|
1689
|
-
* - TLS1_0
|
|
1690
|
-
* - TLS1_1
|
|
1691
1648
|
* - TLS1_2
|
|
1649
|
+
* - TLS1_3
|
|
1692
1650
|
*/
|
|
1693
1651
|
minimumEnabledTlsProtocol: string;
|
|
1694
1652
|
/**
|
|
@@ -1730,23 +1688,23 @@ export interface GetAdvancedClusterBiConnectorConfig {
|
|
|
1730
1688
|
*/
|
|
1731
1689
|
readPreference: string;
|
|
1732
1690
|
}
|
|
1733
|
-
export interface
|
|
1691
|
+
export interface GetAdvancedClusterConnectionStrings {
|
|
1734
1692
|
/**
|
|
1735
1693
|
* [Network-peering-endpoint-aware](https://docs.atlas.mongodb.com/security-vpc-peering/#vpc-peering) 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.
|
|
1736
1694
|
*/
|
|
1737
1695
|
private: string;
|
|
1738
1696
|
/**
|
|
1739
1697
|
* Private endpoint connection strings. Each object describes the connection strings you can use to connect to this cluster through a private endpoint. Atlas returns this parameter only if you deployed a private endpoint to all regions to which you deployed this cluster's nodes.
|
|
1740
|
-
* - `connection_strings.private_endpoint
|
|
1741
|
-
* - `connection_strings.private_endpoint
|
|
1742
|
-
* - `connection_strings.private_endpoint
|
|
1743
|
-
* - `connection_strings.private_endpoint
|
|
1744
|
-
* - `connection_strings.private_endpoint
|
|
1745
|
-
* - `connection_strings.private_endpoint
|
|
1746
|
-
* - `connection_strings.private_endpoint
|
|
1747
|
-
* - `connection_strings.private_endpoint
|
|
1698
|
+
* - `connection_strings.private_endpoint[#].connection_string` - Private-endpoint-aware `mongodb://`connection string for this private endpoint.
|
|
1699
|
+
* - `connection_strings.private_endpoint[#].srv_connection_string` - Private-endpoint-aware `mongodb+srv://` connection string for this private endpoint. 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 `connection_strings.private_endpoint[#].connection_string`
|
|
1700
|
+
* - `connection_strings.private_endpoint[#].srv_shard_optimized_connection_string` - Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster support it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[#].srvConnectionString.
|
|
1701
|
+
* - `connection_strings.private_endpoint[#].type` - Type of MongoDB process that you connect to with the connection strings. Atlas returns `MONGOD` for replica sets, or `MONGOS` for sharded clusters.
|
|
1702
|
+
* - `connection_strings.private_endpoint[#].endpoints` - Private endpoint through which you connect to Atlas when you use `connection_strings.private_endpoint[#].connection_string` or `connection_strings.private_endpoint[#].srv_connection_string`
|
|
1703
|
+
* - `connection_strings.private_endpoint[#].endpoints[#].endpoint_id` - Unique identifier of the private endpoint.
|
|
1704
|
+
* - `connection_strings.private_endpoint[#].endpoints[#].provider_name` - Cloud provider to which you deployed the private endpoint. Atlas returns `AWS` or `AZURE`.
|
|
1705
|
+
* - `connection_strings.private_endpoint[#].endpoints[#].region` - Region to which you deployed the private endpoint.
|
|
1748
1706
|
*/
|
|
1749
|
-
privateEndpoints: outputs.
|
|
1707
|
+
privateEndpoints: outputs.GetAdvancedClusterConnectionStringsPrivateEndpoint[];
|
|
1750
1708
|
/**
|
|
1751
1709
|
* [Network-peering-endpoint-aware](https://docs.atlas.mongodb.com/security-vpc-peering/#vpc-peering) 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.
|
|
1752
1710
|
*/
|
|
@@ -1760,30 +1718,41 @@ export interface GetAdvancedClusterConnectionString {
|
|
|
1760
1718
|
*/
|
|
1761
1719
|
standardSrv: string;
|
|
1762
1720
|
}
|
|
1763
|
-
export interface
|
|
1721
|
+
export interface GetAdvancedClusterConnectionStringsPrivateEndpoint {
|
|
1722
|
+
/**
|
|
1723
|
+
* Private endpoint-aware connection string that uses the `mongodb://` protocol to connect to MongoDB Cloud through a private endpoint.
|
|
1724
|
+
*/
|
|
1764
1725
|
connectionString: string;
|
|
1765
|
-
|
|
1726
|
+
/**
|
|
1727
|
+
* List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].connectionString** or **connectionStrings.privateEndpoint[n].srvConnectionString**.
|
|
1728
|
+
*/
|
|
1729
|
+
endpoints: outputs.GetAdvancedClusterConnectionStringsPrivateEndpointEndpoint[];
|
|
1730
|
+
/**
|
|
1731
|
+
* 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). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application supports it. If it doesn't, use connectionStrings.privateEndpoint[n].connectionString.
|
|
1732
|
+
*/
|
|
1766
1733
|
srvConnectionString: string;
|
|
1734
|
+
/**
|
|
1735
|
+
* Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.
|
|
1736
|
+
*/
|
|
1767
1737
|
srvShardOptimizedConnectionString: string;
|
|
1738
|
+
/**
|
|
1739
|
+
* MongoDB process type to which your application connects. Use `MONGOD` for replica sets and `MONGOS` for sharded clusters.
|
|
1740
|
+
*/
|
|
1768
1741
|
type: string;
|
|
1769
1742
|
}
|
|
1770
|
-
export interface
|
|
1743
|
+
export interface GetAdvancedClusterConnectionStringsPrivateEndpointEndpoint {
|
|
1744
|
+
/**
|
|
1745
|
+
* Unique string that the cloud provider uses to identify the private endpoint.
|
|
1746
|
+
*/
|
|
1771
1747
|
endpointId: string;
|
|
1772
1748
|
/**
|
|
1773
1749
|
* Cloud service provider on which the servers are provisioned.
|
|
1774
1750
|
*/
|
|
1775
1751
|
providerName: string;
|
|
1776
|
-
region: string;
|
|
1777
|
-
}
|
|
1778
|
-
export interface GetAdvancedClusterLabel {
|
|
1779
|
-
/**
|
|
1780
|
-
* The key that you want to write.
|
|
1781
|
-
*/
|
|
1782
|
-
key: string;
|
|
1783
1752
|
/**
|
|
1784
|
-
*
|
|
1753
|
+
* Region where the private endpoint is deployed.
|
|
1785
1754
|
*/
|
|
1786
|
-
|
|
1755
|
+
region: string;
|
|
1787
1756
|
}
|
|
1788
1757
|
export interface GetAdvancedClusterPinnedFcv {
|
|
1789
1758
|
/**
|
|
@@ -1803,19 +1772,9 @@ export interface GetAdvancedClusterReplicationSpec {
|
|
|
1803
1772
|
[key: string]: string;
|
|
1804
1773
|
};
|
|
1805
1774
|
/**
|
|
1806
|
-
* Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. This value corresponds to Shard ID displayed in the UI.
|
|
1775
|
+
* Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. This value corresponds to Shard ID displayed in the UI.
|
|
1807
1776
|
*/
|
|
1808
1777
|
externalId: string;
|
|
1809
|
-
/**
|
|
1810
|
-
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide
|
|
1811
|
-
*/
|
|
1812
|
-
id: string;
|
|
1813
|
-
/**
|
|
1814
|
-
* Provide this value if you set a `clusterType` of `SHARDED` or `GEOSHARDED`. **(DEPRECATED)** To learn more, see the Migration Guide.
|
|
1815
|
-
*
|
|
1816
|
-
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide
|
|
1817
|
-
*/
|
|
1818
|
-
numShards: number;
|
|
1819
1778
|
/**
|
|
1820
1779
|
* Configuration for the hardware specifications for nodes set for a given region. Each `regionConfigs` object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each `regionConfigs` object must have either an `analyticsSpecs` object, `electableSpecs` object, or `readOnlySpecs` object. See below.
|
|
1821
1780
|
*/
|
|
@@ -1833,7 +1792,7 @@ export interface GetAdvancedClusterReplicationSpecRegionConfig {
|
|
|
1833
1792
|
/**
|
|
1834
1793
|
* Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. See below.
|
|
1835
1794
|
*/
|
|
1836
|
-
|
|
1795
|
+
analyticsAutoScaling: outputs.GetAdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScaling;
|
|
1837
1796
|
/**
|
|
1838
1797
|
* Hardware specifications for [analytics nodes](https://docs.atlas.mongodb.com/reference/faq/deployment/#std-label-analytics-nodes-overview) needed in the region. See below.
|
|
1839
1798
|
*/
|
|
@@ -1841,33 +1800,92 @@ export interface GetAdvancedClusterReplicationSpecRegionConfig {
|
|
|
1841
1800
|
/**
|
|
1842
1801
|
* Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below.
|
|
1843
1802
|
*/
|
|
1844
|
-
|
|
1803
|
+
autoScaling: outputs.GetAdvancedClusterReplicationSpecRegionConfigAutoScaling;
|
|
1845
1804
|
/**
|
|
1846
1805
|
* Cloud service provider on which you provision the host for a multi-tenant cluster.
|
|
1847
1806
|
*/
|
|
1848
1807
|
backingProviderName: string;
|
|
1808
|
+
/**
|
|
1809
|
+
* Effective hardware specifications for analytics nodes in the region, reflecting actual Atlas-managed values including auto-scaling changes. See below.
|
|
1810
|
+
*/
|
|
1811
|
+
effectiveAnalyticsSpecs: outputs.GetAdvancedClusterReplicationSpecRegionConfigEffectiveAnalyticsSpecs;
|
|
1812
|
+
/**
|
|
1813
|
+
* Effective hardware specifications for electable nodes in the region, reflecting actual Atlas-managed values including auto-scaling changes. See below.
|
|
1814
|
+
*/
|
|
1815
|
+
effectiveElectableSpecs: outputs.GetAdvancedClusterReplicationSpecRegionConfigEffectiveElectableSpecs;
|
|
1816
|
+
/**
|
|
1817
|
+
* Effective hardware specifications for read-only nodes in the region, reflecting actual Atlas-managed values including auto-scaling changes. See below.
|
|
1818
|
+
*/
|
|
1819
|
+
effectiveReadOnlySpecs: outputs.GetAdvancedClusterReplicationSpecRegionConfigEffectiveReadOnlySpecs;
|
|
1849
1820
|
/**
|
|
1850
1821
|
* Hardware specifications for electable nodes in the region.
|
|
1851
1822
|
*/
|
|
1852
1823
|
electableSpecs: outputs.GetAdvancedClusterReplicationSpecRegionConfigElectableSpecs;
|
|
1853
1824
|
/**
|
|
1854
|
-
* Election priority of the region.
|
|
1825
|
+
* Election priority of the region.
|
|
1826
|
+
*/
|
|
1827
|
+
priority: number;
|
|
1828
|
+
/**
|
|
1829
|
+
* Cloud service provider on which the servers are provisioned.
|
|
1830
|
+
*/
|
|
1831
|
+
providerName: string;
|
|
1832
|
+
/**
|
|
1833
|
+
* Hardware specifications for read-only nodes in the region. See below.
|
|
1834
|
+
*/
|
|
1835
|
+
readOnlySpecs: outputs.GetAdvancedClusterReplicationSpecRegionConfigReadOnlySpecs;
|
|
1836
|
+
/**
|
|
1837
|
+
* Physical location of your MongoDB cluster.
|
|
1838
|
+
*/
|
|
1839
|
+
regionName: string;
|
|
1840
|
+
}
|
|
1841
|
+
export interface GetAdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScaling {
|
|
1842
|
+
/**
|
|
1843
|
+
* Flag that indicates whether instance size auto-scaling is enabled.
|
|
1844
|
+
*/
|
|
1845
|
+
computeEnabled: boolean;
|
|
1846
|
+
/**
|
|
1847
|
+
* Maximum instance size to which your cluster can automatically scale (such as M40).
|
|
1848
|
+
* #### Advanced Configuration
|
|
1849
|
+
*/
|
|
1850
|
+
computeMaxInstanceSize: string;
|
|
1851
|
+
/**
|
|
1852
|
+
* Minimum instance size to which your cluster can automatically scale (such as M10).
|
|
1853
|
+
*/
|
|
1854
|
+
computeMinInstanceSize: string;
|
|
1855
|
+
/**
|
|
1856
|
+
* Flag that indicates whether the instance size may scale down.
|
|
1857
|
+
*/
|
|
1858
|
+
computeScaleDownEnabled: boolean;
|
|
1859
|
+
/**
|
|
1860
|
+
* Flag that indicates whether this cluster enables disk auto-scaling.
|
|
1861
|
+
*/
|
|
1862
|
+
diskGbEnabled: boolean;
|
|
1863
|
+
}
|
|
1864
|
+
export interface GetAdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs {
|
|
1865
|
+
/**
|
|
1866
|
+
* Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.
|
|
1867
|
+
*/
|
|
1868
|
+
diskIops: number;
|
|
1869
|
+
/**
|
|
1870
|
+
* Storage capacity that the host's root volume possesses expressed in gigabytes. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.
|
|
1855
1871
|
*/
|
|
1856
|
-
|
|
1872
|
+
diskSizeGb: number;
|
|
1857
1873
|
/**
|
|
1858
|
-
*
|
|
1874
|
+
* Type of storage you want to attach to your AWS-provisioned cluster.
|
|
1875
|
+
* * `STANDARD` volume types can't exceed the default IOPS rate for the selected volume size.
|
|
1876
|
+
* * `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size.
|
|
1859
1877
|
*/
|
|
1860
|
-
|
|
1878
|
+
ebsVolumeType: string;
|
|
1861
1879
|
/**
|
|
1862
|
-
* Hardware
|
|
1880
|
+
* Hardware specification for the instance sizes in this region.
|
|
1863
1881
|
*/
|
|
1864
|
-
|
|
1882
|
+
instanceSize: string;
|
|
1865
1883
|
/**
|
|
1866
|
-
*
|
|
1884
|
+
* Number of nodes of the given type for MongoDB Atlas to deploy to the region.
|
|
1867
1885
|
*/
|
|
1868
|
-
|
|
1886
|
+
nodeCount: number;
|
|
1869
1887
|
}
|
|
1870
|
-
export interface
|
|
1888
|
+
export interface GetAdvancedClusterReplicationSpecRegionConfigAutoScaling {
|
|
1871
1889
|
/**
|
|
1872
1890
|
* Flag that indicates whether instance size auto-scaling is enabled.
|
|
1873
1891
|
*/
|
|
@@ -1890,7 +1908,7 @@ export interface GetAdvancedClusterReplicationSpecRegionConfigAnalyticsAutoScali
|
|
|
1890
1908
|
*/
|
|
1891
1909
|
diskGbEnabled: boolean;
|
|
1892
1910
|
}
|
|
1893
|
-
export interface
|
|
1911
|
+
export interface GetAdvancedClusterReplicationSpecRegionConfigEffectiveAnalyticsSpecs {
|
|
1894
1912
|
/**
|
|
1895
1913
|
* Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.
|
|
1896
1914
|
*/
|
|
@@ -1912,32 +1930,33 @@ export interface GetAdvancedClusterReplicationSpecRegionConfigAnalyticsSpecs {
|
|
|
1912
1930
|
/**
|
|
1913
1931
|
* Number of nodes of the given type for MongoDB Atlas to deploy to the region.
|
|
1914
1932
|
*/
|
|
1915
|
-
nodeCount
|
|
1933
|
+
nodeCount: number;
|
|
1916
1934
|
}
|
|
1917
|
-
export interface
|
|
1935
|
+
export interface GetAdvancedClusterReplicationSpecRegionConfigEffectiveElectableSpecs {
|
|
1918
1936
|
/**
|
|
1919
|
-
*
|
|
1937
|
+
* Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.
|
|
1920
1938
|
*/
|
|
1921
|
-
|
|
1939
|
+
diskIops: number;
|
|
1922
1940
|
/**
|
|
1923
|
-
*
|
|
1924
|
-
* #### Advanced Configuration
|
|
1941
|
+
* Storage capacity that the host's root volume possesses expressed in gigabytes. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.
|
|
1925
1942
|
*/
|
|
1926
|
-
|
|
1943
|
+
diskSizeGb: number;
|
|
1927
1944
|
/**
|
|
1928
|
-
*
|
|
1945
|
+
* Type of storage you want to attach to your AWS-provisioned cluster.
|
|
1946
|
+
* * `STANDARD` volume types can't exceed the default IOPS rate for the selected volume size.
|
|
1947
|
+
* * `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size.
|
|
1929
1948
|
*/
|
|
1930
|
-
|
|
1949
|
+
ebsVolumeType: string;
|
|
1931
1950
|
/**
|
|
1932
|
-
*
|
|
1951
|
+
* Hardware specification for the instance sizes in this region.
|
|
1933
1952
|
*/
|
|
1934
|
-
|
|
1953
|
+
instanceSize: string;
|
|
1935
1954
|
/**
|
|
1936
|
-
*
|
|
1955
|
+
* Number of nodes of the given type for MongoDB Atlas to deploy to the region.
|
|
1937
1956
|
*/
|
|
1938
|
-
|
|
1957
|
+
nodeCount: number;
|
|
1939
1958
|
}
|
|
1940
|
-
export interface
|
|
1959
|
+
export interface GetAdvancedClusterReplicationSpecRegionConfigEffectiveReadOnlySpecs {
|
|
1941
1960
|
/**
|
|
1942
1961
|
* Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.
|
|
1943
1962
|
*/
|
|
@@ -1959,9 +1978,9 @@ export interface GetAdvancedClusterReplicationSpecRegionConfigElectableSpecs {
|
|
|
1959
1978
|
/**
|
|
1960
1979
|
* Number of nodes of the given type for MongoDB Atlas to deploy to the region.
|
|
1961
1980
|
*/
|
|
1962
|
-
nodeCount
|
|
1981
|
+
nodeCount: number;
|
|
1963
1982
|
}
|
|
1964
|
-
export interface
|
|
1983
|
+
export interface GetAdvancedClusterReplicationSpecRegionConfigElectableSpecs {
|
|
1965
1984
|
/**
|
|
1966
1985
|
* Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.
|
|
1967
1986
|
*/
|
|
@@ -1983,25 +2002,49 @@ export interface GetAdvancedClusterReplicationSpecRegionConfigReadOnlySpecs {
|
|
|
1983
2002
|
/**
|
|
1984
2003
|
* Number of nodes of the given type for MongoDB Atlas to deploy to the region.
|
|
1985
2004
|
*/
|
|
1986
|
-
nodeCount
|
|
2005
|
+
nodeCount: number;
|
|
1987
2006
|
}
|
|
1988
|
-
export interface
|
|
2007
|
+
export interface GetAdvancedClusterReplicationSpecRegionConfigReadOnlySpecs {
|
|
1989
2008
|
/**
|
|
1990
|
-
*
|
|
2009
|
+
* Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.
|
|
1991
2010
|
*/
|
|
1992
|
-
|
|
2011
|
+
diskIops: number;
|
|
1993
2012
|
/**
|
|
1994
|
-
* The value
|
|
2013
|
+
* Storage capacity that the host's root volume possesses expressed in gigabytes. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.
|
|
1995
2014
|
*/
|
|
1996
|
-
|
|
2015
|
+
diskSizeGb: number;
|
|
2016
|
+
/**
|
|
2017
|
+
* Type of storage you want to attach to your AWS-provisioned cluster.
|
|
2018
|
+
* * `STANDARD` volume types can't exceed the default IOPS rate for the selected volume size.
|
|
2019
|
+
* * `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size.
|
|
2020
|
+
*/
|
|
2021
|
+
ebsVolumeType: string;
|
|
2022
|
+
/**
|
|
2023
|
+
* Hardware specification for the instance sizes in this region.
|
|
2024
|
+
*/
|
|
2025
|
+
instanceSize: string;
|
|
2026
|
+
/**
|
|
2027
|
+
* Number of nodes of the given type for MongoDB Atlas to deploy to the region.
|
|
2028
|
+
*/
|
|
2029
|
+
nodeCount: number;
|
|
1997
2030
|
}
|
|
1998
2031
|
export interface GetAdvancedClustersResult {
|
|
1999
2032
|
/**
|
|
2000
2033
|
* Get the advanced configuration options. See Advanced Configuration below for more details.
|
|
2001
2034
|
*/
|
|
2002
|
-
|
|
2035
|
+
advancedConfiguration: outputs.GetAdvancedClustersResultAdvancedConfiguration;
|
|
2036
|
+
/**
|
|
2037
|
+
* Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups.
|
|
2038
|
+
*/
|
|
2003
2039
|
backupEnabled: boolean;
|
|
2004
|
-
|
|
2040
|
+
/**
|
|
2041
|
+
* Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.
|
|
2042
|
+
*/
|
|
2043
|
+
biConnectorConfig: outputs.GetAdvancedClustersResultBiConnectorConfig;
|
|
2044
|
+
/**
|
|
2045
|
+
* The cluster ID.
|
|
2046
|
+
*/
|
|
2047
|
+
clusterId: string;
|
|
2005
2048
|
/**
|
|
2006
2049
|
* Type of the cluster that you want to create.
|
|
2007
2050
|
*/
|
|
@@ -2017,14 +2060,11 @@ export interface GetAdvancedClustersResult {
|
|
|
2017
2060
|
/**
|
|
2018
2061
|
* Set of connection strings that your applications use to connect to this cluster. More information in [Connection-strings](https://docs.mongodb.com/manual/reference/connection-string/). 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](https://docs.atlas.mongodb.com/reference/faq/connection-changes/). NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.
|
|
2019
2062
|
*/
|
|
2020
|
-
connectionStrings: outputs.
|
|
2021
|
-
createDate: string;
|
|
2063
|
+
connectionStrings: outputs.GetAdvancedClustersResultConnectionStrings;
|
|
2022
2064
|
/**
|
|
2023
|
-
*
|
|
2024
|
-
*
|
|
2025
|
-
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide
|
|
2065
|
+
* Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.
|
|
2026
2066
|
*/
|
|
2027
|
-
|
|
2067
|
+
createDate: string;
|
|
2028
2068
|
/**
|
|
2029
2069
|
* Possible values are AWS, GCP, AZURE or NONE.
|
|
2030
2070
|
*/
|
|
@@ -2036,7 +2076,9 @@ export interface GetAdvancedClustersResult {
|
|
|
2036
2076
|
/**
|
|
2037
2077
|
* Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
|
|
2038
2078
|
*/
|
|
2039
|
-
labels:
|
|
2079
|
+
labels: {
|
|
2080
|
+
[key: string]: string;
|
|
2081
|
+
};
|
|
2040
2082
|
/**
|
|
2041
2083
|
* Version of the cluster to deploy.
|
|
2042
2084
|
*/
|
|
@@ -2045,6 +2087,9 @@ export interface GetAdvancedClustersResult {
|
|
|
2045
2087
|
* Version of MongoDB the cluster runs, in `major-version`.`minor-version` format.
|
|
2046
2088
|
*/
|
|
2047
2089
|
mongoDbVersion: string;
|
|
2090
|
+
/**
|
|
2091
|
+
* Human-readable label that identifies this cluster.
|
|
2092
|
+
*/
|
|
2048
2093
|
name: string;
|
|
2049
2094
|
/**
|
|
2050
2095
|
* Flag that indicates whether the cluster is paused or not.
|
|
@@ -2053,11 +2098,15 @@ export interface GetAdvancedClustersResult {
|
|
|
2053
2098
|
/**
|
|
2054
2099
|
* The pinned Feature Compatibility Version (FCV) with its associated expiration date. See below.
|
|
2055
2100
|
*/
|
|
2056
|
-
|
|
2101
|
+
pinnedFcv: outputs.GetAdvancedClustersResultPinnedFcv;
|
|
2057
2102
|
/**
|
|
2058
2103
|
* Flag that indicates if the cluster uses Continuous Cloud Backup.
|
|
2059
2104
|
*/
|
|
2060
2105
|
pitEnabled: boolean;
|
|
2106
|
+
/**
|
|
2107
|
+
* The unique ID for the project to get the clusters.
|
|
2108
|
+
*/
|
|
2109
|
+
projectId: string;
|
|
2061
2110
|
/**
|
|
2062
2111
|
* (Optional) Flag that enables or disables log redaction, see the [manual](https://www.mongodb.com/docs/manual/administration/monitoring/#log-redaction) for more information.
|
|
2063
2112
|
*/
|
|
@@ -2067,7 +2116,7 @@ export interface GetAdvancedClustersResult {
|
|
|
2067
2116
|
*/
|
|
2068
2117
|
replicaSetScalingStrategy: string;
|
|
2069
2118
|
/**
|
|
2070
|
-
* List of settings that configure your cluster regions.
|
|
2119
|
+
* List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. See below
|
|
2071
2120
|
*/
|
|
2072
2121
|
replicationSpecs: outputs.GetAdvancedClustersResultReplicationSpec[];
|
|
2073
2122
|
/**
|
|
@@ -2081,11 +2130,17 @@ export interface GetAdvancedClustersResult {
|
|
|
2081
2130
|
/**
|
|
2082
2131
|
* Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
|
|
2083
2132
|
*/
|
|
2084
|
-
tags:
|
|
2133
|
+
tags: {
|
|
2134
|
+
[key: string]: string;
|
|
2135
|
+
};
|
|
2085
2136
|
/**
|
|
2086
2137
|
* 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.
|
|
2087
2138
|
*/
|
|
2088
2139
|
terminationProtectionEnabled: boolean;
|
|
2140
|
+
/**
|
|
2141
|
+
* Controls how hardware specification fields are returned in the response. When set to true, the non-effective specs (`electableSpecs`, `readOnlySpecs`, `analyticsSpecs`) fields return the hardware specifications that the client provided. When set to false (default), the non-effective specs fields show the **current** hardware specifications. Cluster auto-scaling is the primary cause for differences between initial and current hardware specifications. This attribute applies to dedicated clusters, not to tenant or flex clusters. **Note:** Effective specs (`effectiveElectableSpecs`, `effectiveReadOnlySpecs`, `effectiveAnalyticsSpecs`) are always returned for dedicated clusters regardless of the flag value and always report the **current** hardware specifications. See the resource documentation for Auto-Scaling with Effective Fields for more details.
|
|
2142
|
+
*/
|
|
2143
|
+
useEffectiveFields?: boolean;
|
|
2089
2144
|
/**
|
|
2090
2145
|
* Release cadence that Atlas uses for this cluster.
|
|
2091
2146
|
*/
|
|
@@ -2101,34 +2156,25 @@ export interface GetAdvancedClustersResultAdvancedConfiguration {
|
|
|
2101
2156
|
*/
|
|
2102
2157
|
customOpensslCipherConfigTls12s: string[];
|
|
2103
2158
|
/**
|
|
2104
|
-
*
|
|
2159
|
+
* The custom OpenSSL cipher suite list for TLS 1.3. This field is only valid when `tlsCipherConfigMode` is set to `CUSTOM`.
|
|
2105
2160
|
*/
|
|
2106
|
-
|
|
2161
|
+
customOpensslCipherConfigTls13s: string[];
|
|
2107
2162
|
/**
|
|
2108
|
-
*
|
|
2109
|
-
*
|
|
2110
|
-
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide
|
|
2163
|
+
* Default time limit in milliseconds for individual read operations to complete. This option corresponds to the [defaultMaxTimeMS](https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/) cluster parameter. This parameter is supported only for MongoDB version 8.0 and above.
|
|
2111
2164
|
*/
|
|
2112
|
-
|
|
2165
|
+
defaultMaxTimeMs: number;
|
|
2113
2166
|
/**
|
|
2114
2167
|
* [Default level of acknowledgment requested from MongoDB for write operations](https://docs.mongodb.com/manual/reference/write-concern/) set for this cluster. MongoDB 6.0 clusters default to [majority](https://docs.mongodb.com/manual/reference/write-concern/).
|
|
2115
2168
|
*/
|
|
2116
2169
|
defaultWriteConcern: string;
|
|
2117
|
-
/**
|
|
2118
|
-
* **(DEPRECATED)** 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.
|
|
2119
|
-
*
|
|
2120
|
-
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide
|
|
2121
|
-
*/
|
|
2122
|
-
failIndexKeyTooLong: boolean;
|
|
2123
2170
|
/**
|
|
2124
2171
|
* When true, the cluster allows execution of operations that perform server-side executions of JavaScript. When false, the cluster disables execution of those operations.
|
|
2125
2172
|
*/
|
|
2126
2173
|
javascriptEnabled: boolean;
|
|
2127
2174
|
/**
|
|
2128
2175
|
* Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections. Valid values are:
|
|
2129
|
-
* - TLS1_0
|
|
2130
|
-
* - TLS1_1
|
|
2131
2176
|
* - TLS1_2
|
|
2177
|
+
* - TLS1_3
|
|
2132
2178
|
*/
|
|
2133
2179
|
minimumEnabledTlsProtocol: string;
|
|
2134
2180
|
/**
|
|
@@ -2170,23 +2216,23 @@ export interface GetAdvancedClustersResultBiConnectorConfig {
|
|
|
2170
2216
|
*/
|
|
2171
2217
|
readPreference: string;
|
|
2172
2218
|
}
|
|
2173
|
-
export interface
|
|
2219
|
+
export interface GetAdvancedClustersResultConnectionStrings {
|
|
2174
2220
|
/**
|
|
2175
2221
|
* [Network-peering-endpoint-aware](https://docs.atlas.mongodb.com/security-vpc-peering/#vpc-peering) 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.
|
|
2176
2222
|
*/
|
|
2177
2223
|
private: string;
|
|
2178
2224
|
/**
|
|
2179
2225
|
* Private endpoint connection strings. Each object describes the connection strings you can use to connect to this cluster through a private endpoint. Atlas returns this parameter only if you deployed a private endpoint to all regions to which you deployed this cluster's nodes.
|
|
2180
|
-
* - `connection_strings.private_endpoint
|
|
2181
|
-
* - `connection_strings.private_endpoint
|
|
2182
|
-
* - `connection_strings.private_endpoint
|
|
2183
|
-
* - `connection_strings.private_endpoint
|
|
2184
|
-
* - `connection_strings.private_endpoint
|
|
2185
|
-
* - `connection_strings.private_endpoint
|
|
2186
|
-
* - `connection_strings.private_endpoint
|
|
2187
|
-
* - `connection_strings.private_endpoint
|
|
2226
|
+
* - `connection_strings.private_endpoint[#].connection_string` - Private-endpoint-aware `mongodb://`connection string for this private endpoint.
|
|
2227
|
+
* - `connection_strings.private_endpoint[#].srv_connection_string` - Private-endpoint-aware `mongodb+srv://` connection string for this private endpoint. 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 `connection_strings.private_endpoint[#].connection_string`
|
|
2228
|
+
* - `connection_strings.private_endpoint[#].srv_shard_optimized_connection_string` - Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster support it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[#].srvConnectionString.
|
|
2229
|
+
* - `connection_strings.private_endpoint[#].type` - Type of MongoDB process that you connect to with the connection strings. Atlas returns `MONGOD` for replica sets, or `MONGOS` for sharded clusters.
|
|
2230
|
+
* - `connection_strings.private_endpoint[#].endpoints` - Private endpoint through which you connect to Atlas when you use `connection_strings.private_endpoint[#].connection_string` or `connection_strings.private_endpoint[#].srv_connection_string`
|
|
2231
|
+
* - `connection_strings.private_endpoint[#].endpoints[#].endpoint_id` - Unique identifier of the private endpoint.
|
|
2232
|
+
* - `connection_strings.private_endpoint[#].endpoints[#].provider_name` - Cloud provider to which you deployed the private endpoint. Atlas returns `AWS` or `AZURE`.
|
|
2233
|
+
* - `connection_strings.private_endpoint[#].endpoints[#].region` - Region to which you deployed the private endpoint.
|
|
2188
2234
|
*/
|
|
2189
|
-
privateEndpoints: outputs.
|
|
2235
|
+
privateEndpoints: outputs.GetAdvancedClustersResultConnectionStringsPrivateEndpoint[];
|
|
2190
2236
|
/**
|
|
2191
2237
|
* [Network-peering-endpoint-aware](https://docs.atlas.mongodb.com/security-vpc-peering/#vpc-peering) 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.
|
|
2192
2238
|
*/
|
|
@@ -2200,30 +2246,41 @@ export interface GetAdvancedClustersResultConnectionString {
|
|
|
2200
2246
|
*/
|
|
2201
2247
|
standardSrv: string;
|
|
2202
2248
|
}
|
|
2203
|
-
export interface
|
|
2249
|
+
export interface GetAdvancedClustersResultConnectionStringsPrivateEndpoint {
|
|
2250
|
+
/**
|
|
2251
|
+
* Private endpoint-aware connection string that uses the `mongodb://` protocol to connect to MongoDB Cloud through a private endpoint.
|
|
2252
|
+
*/
|
|
2204
2253
|
connectionString: string;
|
|
2205
|
-
|
|
2254
|
+
/**
|
|
2255
|
+
* List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].connectionString** or **connectionStrings.privateEndpoint[n].srvConnectionString**.
|
|
2256
|
+
*/
|
|
2257
|
+
endpoints: outputs.GetAdvancedClustersResultConnectionStringsPrivateEndpointEndpoint[];
|
|
2258
|
+
/**
|
|
2259
|
+
* 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). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application supports it. If it doesn't, use connectionStrings.privateEndpoint[n].connectionString.
|
|
2260
|
+
*/
|
|
2206
2261
|
srvConnectionString: string;
|
|
2262
|
+
/**
|
|
2263
|
+
* Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.
|
|
2264
|
+
*/
|
|
2207
2265
|
srvShardOptimizedConnectionString: string;
|
|
2266
|
+
/**
|
|
2267
|
+
* MongoDB process type to which your application connects. Use `MONGOD` for replica sets and `MONGOS` for sharded clusters.
|
|
2268
|
+
*/
|
|
2208
2269
|
type: string;
|
|
2209
2270
|
}
|
|
2210
|
-
export interface
|
|
2271
|
+
export interface GetAdvancedClustersResultConnectionStringsPrivateEndpointEndpoint {
|
|
2272
|
+
/**
|
|
2273
|
+
* Unique string that the cloud provider uses to identify the private endpoint.
|
|
2274
|
+
*/
|
|
2211
2275
|
endpointId: string;
|
|
2212
2276
|
/**
|
|
2213
2277
|
* Cloud service provider on which the servers are provisioned.
|
|
2214
2278
|
*/
|
|
2215
2279
|
providerName: string;
|
|
2216
|
-
region: string;
|
|
2217
|
-
}
|
|
2218
|
-
export interface GetAdvancedClustersResultLabel {
|
|
2219
2280
|
/**
|
|
2220
|
-
*
|
|
2221
|
-
*/
|
|
2222
|
-
key: string;
|
|
2223
|
-
/**
|
|
2224
|
-
* The value that you want to write.
|
|
2281
|
+
* Region where the private endpoint is deployed.
|
|
2225
2282
|
*/
|
|
2226
|
-
|
|
2283
|
+
region: string;
|
|
2227
2284
|
}
|
|
2228
2285
|
export interface GetAdvancedClustersResultPinnedFcv {
|
|
2229
2286
|
/**
|
|
@@ -2243,19 +2300,9 @@ export interface GetAdvancedClustersResultReplicationSpec {
|
|
|
2243
2300
|
[key: string]: string;
|
|
2244
2301
|
};
|
|
2245
2302
|
/**
|
|
2246
|
-
* Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. This value corresponds to Shard ID displayed in the UI.
|
|
2303
|
+
* Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. This value corresponds to Shard ID displayed in the UI.
|
|
2247
2304
|
*/
|
|
2248
2305
|
externalId: string;
|
|
2249
|
-
/**
|
|
2250
|
-
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide
|
|
2251
|
-
*/
|
|
2252
|
-
id: string;
|
|
2253
|
-
/**
|
|
2254
|
-
* Provide this value if you set a `clusterType` of SHARDED or GEOSHARDED. **(DEPRECATED)** To learn more, see the Migration Guide for more details.
|
|
2255
|
-
*
|
|
2256
|
-
* @deprecated This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide
|
|
2257
|
-
*/
|
|
2258
|
-
numShards: number;
|
|
2259
2306
|
/**
|
|
2260
2307
|
* Configuration for the hardware specifications for nodes set for a given region. Each `regionConfigs` object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each `regionConfigs` object must have either an `analyticsSpecs` object, `electableSpecs` object, or `readOnlySpecs` object. See below.
|
|
2261
2308
|
*/
|
|
@@ -2273,7 +2320,7 @@ export interface GetAdvancedClustersResultReplicationSpecRegionConfig {
|
|
|
2273
2320
|
/**
|
|
2274
2321
|
* Configuration for the Collection of settings that configures analytis-auto-scaling information for the cluster. See below.
|
|
2275
2322
|
*/
|
|
2276
|
-
|
|
2323
|
+
analyticsAutoScaling: outputs.GetAdvancedClustersResultReplicationSpecRegionConfigAnalyticsAutoScaling;
|
|
2277
2324
|
/**
|
|
2278
2325
|
* Hardware specifications for [analytics nodes](https://docs.atlas.mongodb.com/reference/faq/deployment/#std-label-analytics-nodes-overview) needed in the region. See below.
|
|
2279
2326
|
*/
|
|
@@ -2281,11 +2328,23 @@ export interface GetAdvancedClustersResultReplicationSpecRegionConfig {
|
|
|
2281
2328
|
/**
|
|
2282
2329
|
* Configuration for the Collection of settings that configures auto-scaling information for the cluster. See below.
|
|
2283
2330
|
*/
|
|
2284
|
-
|
|
2331
|
+
autoScaling: outputs.GetAdvancedClustersResultReplicationSpecRegionConfigAutoScaling;
|
|
2285
2332
|
/**
|
|
2286
2333
|
* Cloud service provider on which you provision the host for a multi-tenant cluster.
|
|
2287
2334
|
*/
|
|
2288
2335
|
backingProviderName: string;
|
|
2336
|
+
/**
|
|
2337
|
+
* Effective hardware specifications for analytics nodes in the region, reflecting actual Atlas-managed values including auto-scaling changes. See below.
|
|
2338
|
+
*/
|
|
2339
|
+
effectiveAnalyticsSpecs: outputs.GetAdvancedClustersResultReplicationSpecRegionConfigEffectiveAnalyticsSpecs;
|
|
2340
|
+
/**
|
|
2341
|
+
* Effective hardware specifications for electable nodes in the region, reflecting actual Atlas-managed values including auto-scaling changes. See below.
|
|
2342
|
+
*/
|
|
2343
|
+
effectiveElectableSpecs: outputs.GetAdvancedClustersResultReplicationSpecRegionConfigEffectiveElectableSpecs;
|
|
2344
|
+
/**
|
|
2345
|
+
* Effective hardware specifications for read-only nodes in the region, reflecting actual Atlas-managed values including auto-scaling changes. See below.
|
|
2346
|
+
*/
|
|
2347
|
+
effectiveReadOnlySpecs: outputs.GetAdvancedClustersResultReplicationSpecRegionConfigEffectiveReadOnlySpecs;
|
|
2289
2348
|
/**
|
|
2290
2349
|
* Hardware specifications for electable nodes in the region.
|
|
2291
2350
|
*/
|
|
@@ -2351,7 +2410,7 @@ export interface GetAdvancedClustersResultReplicationSpecRegionConfigAnalyticsSp
|
|
|
2351
2410
|
/**
|
|
2352
2411
|
* Number of nodes of the given type for MongoDB Atlas to deploy to the region.
|
|
2353
2412
|
*/
|
|
2354
|
-
nodeCount
|
|
2413
|
+
nodeCount: number;
|
|
2355
2414
|
}
|
|
2356
2415
|
export interface GetAdvancedClustersResultReplicationSpecRegionConfigAutoScaling {
|
|
2357
2416
|
/**
|
|
@@ -2375,7 +2434,7 @@ export interface GetAdvancedClustersResultReplicationSpecRegionConfigAutoScaling
|
|
|
2375
2434
|
*/
|
|
2376
2435
|
diskGbEnabled: boolean;
|
|
2377
2436
|
}
|
|
2378
|
-
export interface
|
|
2437
|
+
export interface GetAdvancedClustersResultReplicationSpecRegionConfigEffectiveAnalyticsSpecs {
|
|
2379
2438
|
/**
|
|
2380
2439
|
* Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.
|
|
2381
2440
|
*/
|
|
@@ -2397,9 +2456,9 @@ export interface GetAdvancedClustersResultReplicationSpecRegionConfigElectableSp
|
|
|
2397
2456
|
/**
|
|
2398
2457
|
* Number of nodes of the given type for MongoDB Atlas to deploy to the region.
|
|
2399
2458
|
*/
|
|
2400
|
-
nodeCount
|
|
2459
|
+
nodeCount: number;
|
|
2401
2460
|
}
|
|
2402
|
-
export interface
|
|
2461
|
+
export interface GetAdvancedClustersResultReplicationSpecRegionConfigEffectiveElectableSpecs {
|
|
2403
2462
|
/**
|
|
2404
2463
|
* Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.
|
|
2405
2464
|
*/
|
|
@@ -2421,17 +2480,79 @@ export interface GetAdvancedClustersResultReplicationSpecRegionConfigReadOnlySpe
|
|
|
2421
2480
|
/**
|
|
2422
2481
|
* Number of nodes of the given type for MongoDB Atlas to deploy to the region.
|
|
2423
2482
|
*/
|
|
2424
|
-
nodeCount
|
|
2483
|
+
nodeCount: number;
|
|
2425
2484
|
}
|
|
2426
|
-
export interface
|
|
2485
|
+
export interface GetAdvancedClustersResultReplicationSpecRegionConfigEffectiveReadOnlySpecs {
|
|
2427
2486
|
/**
|
|
2428
|
-
*
|
|
2487
|
+
* Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.
|
|
2429
2488
|
*/
|
|
2430
|
-
|
|
2489
|
+
diskIops: number;
|
|
2431
2490
|
/**
|
|
2432
|
-
* The value
|
|
2491
|
+
* Storage capacity that the host's root volume possesses expressed in gigabytes. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.
|
|
2433
2492
|
*/
|
|
2434
|
-
|
|
2493
|
+
diskSizeGb: number;
|
|
2494
|
+
/**
|
|
2495
|
+
* Type of storage you want to attach to your AWS-provisioned cluster.
|
|
2496
|
+
* * `STANDARD` volume types can't exceed the default IOPS rate for the selected volume size.
|
|
2497
|
+
* * `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size.
|
|
2498
|
+
*/
|
|
2499
|
+
ebsVolumeType: string;
|
|
2500
|
+
/**
|
|
2501
|
+
* Hardware specification for the instance sizes in this region.
|
|
2502
|
+
*/
|
|
2503
|
+
instanceSize: string;
|
|
2504
|
+
/**
|
|
2505
|
+
* Number of nodes of the given type for MongoDB Atlas to deploy to the region.
|
|
2506
|
+
*/
|
|
2507
|
+
nodeCount: number;
|
|
2508
|
+
}
|
|
2509
|
+
export interface GetAdvancedClustersResultReplicationSpecRegionConfigElectableSpecs {
|
|
2510
|
+
/**
|
|
2511
|
+
* Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.
|
|
2512
|
+
*/
|
|
2513
|
+
diskIops: number;
|
|
2514
|
+
/**
|
|
2515
|
+
* Storage capacity that the host's root volume possesses expressed in gigabytes. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.
|
|
2516
|
+
*/
|
|
2517
|
+
diskSizeGb: number;
|
|
2518
|
+
/**
|
|
2519
|
+
* Type of storage you want to attach to your AWS-provisioned cluster.
|
|
2520
|
+
* * `STANDARD` volume types can't exceed the default IOPS rate for the selected volume size.
|
|
2521
|
+
* * `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size.
|
|
2522
|
+
*/
|
|
2523
|
+
ebsVolumeType: string;
|
|
2524
|
+
/**
|
|
2525
|
+
* Hardware specification for the instance sizes in this region.
|
|
2526
|
+
*/
|
|
2527
|
+
instanceSize: string;
|
|
2528
|
+
/**
|
|
2529
|
+
* Number of nodes of the given type for MongoDB Atlas to deploy to the region.
|
|
2530
|
+
*/
|
|
2531
|
+
nodeCount: number;
|
|
2532
|
+
}
|
|
2533
|
+
export interface GetAdvancedClustersResultReplicationSpecRegionConfigReadOnlySpecs {
|
|
2534
|
+
/**
|
|
2535
|
+
* Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. This parameter defaults to the cluster tier's standard IOPS value.
|
|
2536
|
+
*/
|
|
2537
|
+
diskIops: number;
|
|
2538
|
+
/**
|
|
2539
|
+
* Storage capacity that the host's root volume possesses expressed in gigabytes. If disk size specified is below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.
|
|
2540
|
+
*/
|
|
2541
|
+
diskSizeGb: number;
|
|
2542
|
+
/**
|
|
2543
|
+
* Type of storage you want to attach to your AWS-provisioned cluster.
|
|
2544
|
+
* * `STANDARD` volume types can't exceed the default IOPS rate for the selected volume size.
|
|
2545
|
+
* * `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size.
|
|
2546
|
+
*/
|
|
2547
|
+
ebsVolumeType: string;
|
|
2548
|
+
/**
|
|
2549
|
+
* Hardware specification for the instance sizes in this region.
|
|
2550
|
+
*/
|
|
2551
|
+
instanceSize: string;
|
|
2552
|
+
/**
|
|
2553
|
+
* Number of nodes of the given type for MongoDB Atlas to deploy to the region.
|
|
2554
|
+
*/
|
|
2555
|
+
nodeCount: number;
|
|
2435
2556
|
}
|
|
2436
2557
|
export interface GetAlertConfigurationMatcher {
|
|
2437
2558
|
/**
|
|
@@ -2668,6 +2789,10 @@ export interface GetAlertConfigurationsResult {
|
|
|
2668
2789
|
* The unique ID for the project to get the alert configurations.
|
|
2669
2790
|
*/
|
|
2670
2791
|
projectId: string;
|
|
2792
|
+
/**
|
|
2793
|
+
* Severity of the event.
|
|
2794
|
+
*/
|
|
2795
|
+
severityOverride: string;
|
|
2671
2796
|
/**
|
|
2672
2797
|
* Threshold that triggers an alert. Required if `eventTypeName` is any value other than `OUTSIDE_METRIC_THRESHOLD` or `OUTSIDE_SERVERLESS_METRIC_THRESHOLD`. See threshold config.
|
|
2673
2798
|
*/
|
|
@@ -2929,7 +3054,9 @@ export interface GetAtlasUsersResult {
|
|
|
2929
3054
|
*/
|
|
2930
3055
|
createdAt: string;
|
|
2931
3056
|
/**
|
|
2932
|
-
* Email address that belongs to the MongoDB Atlas user.
|
|
3057
|
+
* **(DEPRECATED)** Email address that belongs to the MongoDB Atlas user. This attribute is deprecated and will be removed in the next major release. Please transition to `data.mongodbatlas_organization.users.username`, `data.mongodbatlas_team.users.username` or `data.mongodbatlas_project.users.username` attributes. For more details, see Migration Guide: Migrate off deprecated `mongodbatlas.getAtlasUser` and `mongodbatlas.getAtlasUsers`."
|
|
3058
|
+
*
|
|
3059
|
+
* @deprecated This attribute is deprecated and will be removed in the next major release. Please transition to `data.mongodbatlas_organization.users.username, data.mongodbatlas_team.users.username or data.mongodbatlas_project.users.username attributes`. For more details, see https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/atlas-user-management.
|
|
2933
3060
|
*/
|
|
2934
3061
|
emailAddress: string;
|
|
2935
3062
|
/**
|
|
@@ -3126,12 +3253,6 @@ export interface GetCloudBackupScheduleCopySetting {
|
|
|
3126
3253
|
* Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under https://www.mongodb.com/docs/atlas/reference/cloud-providers/ 'regions' link
|
|
3127
3254
|
*/
|
|
3128
3255
|
regionName: string;
|
|
3129
|
-
/**
|
|
3130
|
-
* Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, consult the replicationSpecs array returned from [Return One Multi-Cloud Cluster in One Project](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getcluster). **(DEPRECATED)** Use `zoneId` instead. To learn more, see the 1.18.0 upgrade guide.
|
|
3131
|
-
*
|
|
3132
|
-
* @deprecated This parameter is deprecated. Please transition to `copy_settings.#.zone_id`. To learn more, see our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide
|
|
3133
|
-
*/
|
|
3134
|
-
replicationSpecId: string;
|
|
3135
3256
|
/**
|
|
3136
3257
|
* Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores.
|
|
3137
3258
|
*/
|
|
@@ -3544,13 +3665,53 @@ export interface GetCloudProviderAccessSetupAzureConfig {
|
|
|
3544
3665
|
}
|
|
3545
3666
|
export interface GetCloudProviderAccessSetupGcpConfig {
|
|
3546
3667
|
/**
|
|
3547
|
-
* The GCP service account email that Atlas uses.
|
|
3668
|
+
* The GCP service account email that Atlas uses.
|
|
3669
|
+
*/
|
|
3670
|
+
serviceAccountForAtlas: string;
|
|
3671
|
+
/**
|
|
3672
|
+
* The status of the GCP cloud provider access setup. See [MongoDB Atlas API](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupcloudprovideraccess#operation-getgroupcloudprovideraccess-200-body-application-vnd-atlas-2023-01-01-json-gcp-object-status).
|
|
3673
|
+
*/
|
|
3674
|
+
status: string;
|
|
3675
|
+
}
|
|
3676
|
+
export interface GetCloudUserOrgAssignmentRoles {
|
|
3677
|
+
/**
|
|
3678
|
+
* One or more organization level roles to assign the MongoDB Cloud user.
|
|
3679
|
+
*/
|
|
3680
|
+
orgRoles: string[];
|
|
3681
|
+
/**
|
|
3682
|
+
* List of project level role assignments to assign the MongoDB Cloud user.
|
|
3683
|
+
*/
|
|
3684
|
+
projectRoleAssignments: outputs.GetCloudUserOrgAssignmentRolesProjectRoleAssignment[];
|
|
3685
|
+
}
|
|
3686
|
+
export interface GetCloudUserOrgAssignmentRolesProjectRoleAssignment {
|
|
3687
|
+
/**
|
|
3688
|
+
* Unique 24-hexadecimal digit string that identifies the project to which these roles belong.
|
|
3689
|
+
*/
|
|
3690
|
+
projectId: string;
|
|
3691
|
+
/**
|
|
3692
|
+
* One or more project-level roles assigned to the MongoDB Cloud user.
|
|
3693
|
+
*/
|
|
3694
|
+
projectRoles: string[];
|
|
3695
|
+
}
|
|
3696
|
+
export interface GetCloudUserTeamAssignmentRoles {
|
|
3697
|
+
/**
|
|
3698
|
+
* One or more organization level roles to assign the MongoDB Cloud user.
|
|
3699
|
+
*/
|
|
3700
|
+
orgRoles: string[];
|
|
3701
|
+
/**
|
|
3702
|
+
* List of project level role assignments to assign the MongoDB Cloud user.
|
|
3703
|
+
*/
|
|
3704
|
+
projectRoleAssignments: outputs.GetCloudUserTeamAssignmentRolesProjectRoleAssignment[];
|
|
3705
|
+
}
|
|
3706
|
+
export interface GetCloudUserTeamAssignmentRolesProjectRoleAssignment {
|
|
3707
|
+
/**
|
|
3708
|
+
* Unique 24-hexadecimal digit string that identifies the project to which these roles belong.
|
|
3548
3709
|
*/
|
|
3549
|
-
|
|
3710
|
+
projectId: string;
|
|
3550
3711
|
/**
|
|
3551
|
-
*
|
|
3712
|
+
* One or more project-level roles assigned to the MongoDB Cloud user.
|
|
3552
3713
|
*/
|
|
3553
|
-
|
|
3714
|
+
projectRoles: string[];
|
|
3554
3715
|
}
|
|
3555
3716
|
export interface GetClusterAdvancedConfiguration {
|
|
3556
3717
|
/**
|
|
@@ -3584,9 +3745,8 @@ export interface GetClusterAdvancedConfiguration {
|
|
|
3584
3745
|
javascriptEnabled: boolean;
|
|
3585
3746
|
/**
|
|
3586
3747
|
* Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections. Valid values are:
|
|
3587
|
-
* - TLS1_0
|
|
3588
|
-
* - TLS1_1
|
|
3589
3748
|
* - TLS1_2
|
|
3749
|
+
* - TLS1_3
|
|
3590
3750
|
*/
|
|
3591
3751
|
minimumEnabledTlsProtocol: string;
|
|
3592
3752
|
/**
|
|
@@ -3635,30 +3795,10 @@ export interface GetClusterConnectionString {
|
|
|
3635
3795
|
awsPrivateLinkSrv: {
|
|
3636
3796
|
[key: string]: string;
|
|
3637
3797
|
};
|
|
3638
|
-
/**
|
|
3639
|
-
* [Network-peering-endpoint-aware](https://docs.atlas.mongodb.com/security-vpc-peering/#vpc-peering) 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.
|
|
3640
|
-
*/
|
|
3641
3798
|
private: string;
|
|
3642
3799
|
privateEndpoints: outputs.GetClusterConnectionStringPrivateEndpoint[];
|
|
3643
|
-
/**
|
|
3644
|
-
* [Network-peering-endpoint-aware](https://docs.atlas.mongodb.com/security-vpc-peering/#vpc-peering) 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.
|
|
3645
|
-
* - `connection_strings.private_endpoint.#.connection_string` - Private-endpoint-aware `mongodb://`connection string for this private endpoint.
|
|
3646
|
-
* - `connection_strings.private_endpoint.#.srv_connection_string` - Private-endpoint-aware `mongodb+srv://` connection string for this private endpoint.
|
|
3647
|
-
* - `connection_strings.private_endpoint.#.srv_shard_optimized_connection_string` - Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint.
|
|
3648
|
-
* - `connection_strings.private_endpoint.#.type` - Type of MongoDB process that you connect to with the connection strings. Atlas returns `MONGOD` for replica sets, or `MONGOS` for sharded clusters.
|
|
3649
|
-
* - `connection_strings.private_endpoint.#.endpoints` - Private endpoint through which you connect to Atlas when you use `connection_strings.private_endpoint[#].connection_string` or `connection_strings.private_endpoint[#].srv_connection_string`
|
|
3650
|
-
* - `connection_strings.private_endpoint.#.endpoints.#.endpoint_id` - Unique identifier of the private endpoint.
|
|
3651
|
-
* - `connection_strings.private_endpoint.#.endpoints.#.provider_name` - Cloud provider to which you deployed the private endpoint. Atlas returns `AWS` or `AZURE`.
|
|
3652
|
-
* - `connection_strings.private_endpoint.#.endpoints.#.region` - Region to which you deployed the private endpoint.
|
|
3653
|
-
*/
|
|
3654
3800
|
privateSrv: string;
|
|
3655
|
-
/**
|
|
3656
|
-
* Public mongodb:// connection string for this cluster.
|
|
3657
|
-
*/
|
|
3658
3801
|
standard: string;
|
|
3659
|
-
/**
|
|
3660
|
-
* 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.
|
|
3661
|
-
*/
|
|
3662
3802
|
standardSrv: string;
|
|
3663
3803
|
}
|
|
3664
3804
|
export interface GetClusterConnectionStringPrivateEndpoint {
|
|
@@ -3826,6 +3966,18 @@ export interface GetClustersResult {
|
|
|
3826
3966
|
clusterType: string;
|
|
3827
3967
|
/**
|
|
3828
3968
|
* Set of connection strings that your applications use to connect to this cluster. More information in [Connection-strings](https://docs.mongodb.com/manual/reference/connection-string/). 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](https://docs.atlas.mongodb.com/reference/faq/connection-changes/). NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.
|
|
3969
|
+
* - `connection_strings.#.standard` - Public mongodb:// connection string for this cluster.
|
|
3970
|
+
* - `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.
|
|
3971
|
+
* - `connection_strings.#.private` - [Network-peering-endpoint-aware](https://docs.atlas.mongodb.com/security-vpc-peering/#vpc-peering) 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.
|
|
3972
|
+
* - `connection_strings.#.private_srv` - [Network-peering-endpoint-aware](https://docs.atlas.mongodb.com/security-vpc-peering/#vpc-peering) 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.
|
|
3973
|
+
* - `connection_strings.#.private_endpoint.#.connection_string` - Private-endpoint-aware `mongodb://`connection string for this private endpoint.
|
|
3974
|
+
* - `connection_strings.#.private_endpoint.#.srv_connection_string` - Private-endpoint-aware `mongodb+srv://` connection string for this private endpoint.
|
|
3975
|
+
* - `connection_strings.#.private_endpoint.#.srv_shard_optimized_connection_string` - Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint.
|
|
3976
|
+
* - `connection_strings.#.private_endpoint.#.type` - Type of MongoDB process that you connect to with the connection strings. Atlas returns `MONGOD` for replica sets, or `MONGOS` for sharded clusters.
|
|
3977
|
+
* - `connection_strings.#.private_endpoint.#.endpoints` - Private endpoint through which you connect to Atlas when you use `connection_strings.#.private_endpoint.#.connection_string` or `connection_strings.#.private_endpoint.#.srv_connection_string`
|
|
3978
|
+
* - `connection_strings.#.private_endpoint.#.endpoints.#.endpoint_id` - Unique identifier of the private endpoint.
|
|
3979
|
+
* - `connection_strings.#.private_endpoint.#.endpoints.#.provider_name` - Cloud provider to which you deployed the private endpoint. Atlas returns `AWS` or `AZURE`.
|
|
3980
|
+
* - `connection_strings.#.private_endpoint.#.endpoints.#.region` - Region to which you deployed the private endpoint.
|
|
3829
3981
|
*/
|
|
3830
3982
|
connectionStrings: outputs.GetClustersResultConnectionString[];
|
|
3831
3983
|
/**
|
|
@@ -4000,9 +4152,8 @@ export interface GetClustersResultAdvancedConfiguration {
|
|
|
4000
4152
|
javascriptEnabled: boolean;
|
|
4001
4153
|
/**
|
|
4002
4154
|
* Sets the minimum Transport Layer Security (TLS) version the cluster accepts for incoming connections. Valid values are:
|
|
4003
|
-
* - TLS1_0
|
|
4004
|
-
* - TLS1_1
|
|
4005
4155
|
* - TLS1_2
|
|
4156
|
+
* - TLS1_3
|
|
4006
4157
|
*/
|
|
4007
4158
|
minimumEnabledTlsProtocol: string;
|
|
4008
4159
|
/**
|
|
@@ -4048,30 +4199,10 @@ export interface GetClustersResultConnectionString {
|
|
|
4048
4199
|
awsPrivateLinkSrv: {
|
|
4049
4200
|
[key: string]: string;
|
|
4050
4201
|
};
|
|
4051
|
-
/**
|
|
4052
|
-
* [Network-peering-endpoint-aware](https://docs.atlas.mongodb.com/security-vpc-peering/#vpc-peering) 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.
|
|
4053
|
-
*/
|
|
4054
4202
|
private: string;
|
|
4055
4203
|
privateEndpoints: outputs.GetClustersResultConnectionStringPrivateEndpoint[];
|
|
4056
|
-
/**
|
|
4057
|
-
* [Network-peering-endpoint-aware](https://docs.atlas.mongodb.com/security-vpc-peering/#vpc-peering) 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.
|
|
4058
|
-
* - `connection_strings.private_endpoint.#.connection_string` - Private-endpoint-aware `mongodb://`connection string for this private endpoint.
|
|
4059
|
-
* - `connection_strings.private_endpoint.#.srv_connection_string` - Private-endpoint-aware `mongodb+srv://` connection string for this private endpoint.
|
|
4060
|
-
* - `connection_strings.private_endpoint.#.srv_shard_optimized_connection_string` - Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint.
|
|
4061
|
-
* - `connection_strings.private_endpoint.#.type` - Type of MongoDB process that you connect to with the connection strings. Atlas returns `MONGOD` for replica sets, or `MONGOS` for sharded clusters.
|
|
4062
|
-
* - `connection_strings.private_endpoint.#.endpoints` - Private endpoint through which you connect to Atlas when you use `connection_strings.private_endpoint[#].connection_string` or `connection_strings.private_endpoint[#].srv_connection_string`
|
|
4063
|
-
* - `connection_strings.private_endpoint.#.endpoints.#.endpoint_id` - Unique identifier of the private endpoint.
|
|
4064
|
-
* - `connection_strings.private_endpoint.#.endpoints.#.provider_name` - Cloud provider to which you deployed the private endpoint. Atlas returns `AWS` or `AZURE`.
|
|
4065
|
-
* - `connection_strings.private_endpoint.#.endpoints.#.region` - Region to which you deployed the private endpoint.
|
|
4066
|
-
*/
|
|
4067
4204
|
privateSrv: string;
|
|
4068
|
-
/**
|
|
4069
|
-
* Public mongodb:// connection string for this cluster.
|
|
4070
|
-
*/
|
|
4071
4205
|
standard: string;
|
|
4072
|
-
/**
|
|
4073
|
-
* 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.
|
|
4074
|
-
*/
|
|
4075
4206
|
standardSrv: string;
|
|
4076
4207
|
}
|
|
4077
4208
|
export interface GetClustersResultConnectionStringPrivateEndpoint {
|
|
@@ -4290,239 +4421,6 @@ export interface GetCustomDbRolesResultInheritedRole {
|
|
|
4290
4421
|
*/
|
|
4291
4422
|
roleName: string;
|
|
4292
4423
|
}
|
|
4293
|
-
export interface GetDataLakePipelineIngestionSchedule {
|
|
4294
|
-
frequencyInterval: number;
|
|
4295
|
-
frequencyType: string;
|
|
4296
|
-
/**
|
|
4297
|
-
* Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.
|
|
4298
|
-
*/
|
|
4299
|
-
id: string;
|
|
4300
|
-
retentionUnit: string;
|
|
4301
|
-
retentionValue: number;
|
|
4302
|
-
}
|
|
4303
|
-
export interface GetDataLakePipelineRunStat {
|
|
4304
|
-
/**
|
|
4305
|
-
* Total data size in bytes exported for this pipeline run.
|
|
4306
|
-
*/
|
|
4307
|
-
bytesExported: number;
|
|
4308
|
-
/**
|
|
4309
|
-
* Number of docs ingested for a this pipeline run.
|
|
4310
|
-
*/
|
|
4311
|
-
numDocs: number;
|
|
4312
|
-
}
|
|
4313
|
-
export interface GetDataLakePipelineRunsResult {
|
|
4314
|
-
/**
|
|
4315
|
-
* Backup schedule interval of the Data Lake Pipeline.
|
|
4316
|
-
*/
|
|
4317
|
-
backupFrequencyType: string;
|
|
4318
|
-
/**
|
|
4319
|
-
* Timestamp that indicates when the pipeline run was created.
|
|
4320
|
-
*/
|
|
4321
|
-
createdDate: string;
|
|
4322
|
-
/**
|
|
4323
|
-
* Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
|
|
4324
|
-
*/
|
|
4325
|
-
id: string;
|
|
4326
|
-
/**
|
|
4327
|
-
* Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
|
|
4328
|
-
*/
|
|
4329
|
-
lastUpdatedDate: string;
|
|
4330
|
-
/**
|
|
4331
|
-
* Processing phase of the Data Lake Pipeline.
|
|
4332
|
-
*/
|
|
4333
|
-
phase: string;
|
|
4334
|
-
/**
|
|
4335
|
-
* Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.
|
|
4336
|
-
*/
|
|
4337
|
-
pipelineId: string;
|
|
4338
|
-
/**
|
|
4339
|
-
* Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.
|
|
4340
|
-
*/
|
|
4341
|
-
pipelineRunId: string;
|
|
4342
|
-
/**
|
|
4343
|
-
* Unique 24-hexadecimal character string that identifies the snapshot of a cluster.
|
|
4344
|
-
*/
|
|
4345
|
-
snapshotId: string;
|
|
4346
|
-
/**
|
|
4347
|
-
* State of the pipeline run.
|
|
4348
|
-
*/
|
|
4349
|
-
state: string;
|
|
4350
|
-
/**
|
|
4351
|
-
* Runtime statistics for this Data Lake Pipeline run.
|
|
4352
|
-
*/
|
|
4353
|
-
stats: outputs.GetDataLakePipelineRunsResultStat[];
|
|
4354
|
-
}
|
|
4355
|
-
export interface GetDataLakePipelineRunsResultStat {
|
|
4356
|
-
/**
|
|
4357
|
-
* Total data size in bytes exported for this pipeline run.
|
|
4358
|
-
*/
|
|
4359
|
-
bytesExported: number;
|
|
4360
|
-
/**
|
|
4361
|
-
* Number of docs ingested for a this pipeline run.
|
|
4362
|
-
*/
|
|
4363
|
-
numDocs: number;
|
|
4364
|
-
}
|
|
4365
|
-
export interface GetDataLakePipelineSink {
|
|
4366
|
-
/**
|
|
4367
|
-
* Ordered fields used to physically organize data in the destination.
|
|
4368
|
-
* * `partition_fields.#.field_name` - Human-readable label that identifies the field name used to partition data.
|
|
4369
|
-
* * `partition_fields.#.order` - Sequence in which MongoDB Atlas slices the collection data to create partitions. The resource expresses this sequence starting with zero.
|
|
4370
|
-
*/
|
|
4371
|
-
partitionFields: outputs.GetDataLakePipelineSinkPartitionField[];
|
|
4372
|
-
/**
|
|
4373
|
-
* Target cloud provider for this Data Lake Pipeline.
|
|
4374
|
-
*/
|
|
4375
|
-
provider: string;
|
|
4376
|
-
/**
|
|
4377
|
-
* Target cloud provider region for this Data Lake Pipeline. [Supported cloud provider regions](https://www.mongodb.com/docs/datalake/limitations).
|
|
4378
|
-
*/
|
|
4379
|
-
region: string;
|
|
4380
|
-
/**
|
|
4381
|
-
* Type of ingestion source of this Data Lake Pipeline.
|
|
4382
|
-
*/
|
|
4383
|
-
type: string;
|
|
4384
|
-
}
|
|
4385
|
-
export interface GetDataLakePipelineSinkPartitionField {
|
|
4386
|
-
fieldName: string;
|
|
4387
|
-
order: number;
|
|
4388
|
-
}
|
|
4389
|
-
export interface GetDataLakePipelineSnapshot {
|
|
4390
|
-
copyRegion: string;
|
|
4391
|
-
createdAt: string;
|
|
4392
|
-
expiresAt: string;
|
|
4393
|
-
frequencyYype: string;
|
|
4394
|
-
/**
|
|
4395
|
-
* Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.
|
|
4396
|
-
*/
|
|
4397
|
-
id: string;
|
|
4398
|
-
masterKey: string;
|
|
4399
|
-
mongodVersion: string;
|
|
4400
|
-
policies: string[];
|
|
4401
|
-
/**
|
|
4402
|
-
* Target cloud provider for this Data Lake Pipeline.
|
|
4403
|
-
*/
|
|
4404
|
-
provider: string;
|
|
4405
|
-
replicaSetName: string;
|
|
4406
|
-
size: number;
|
|
4407
|
-
status: string;
|
|
4408
|
-
/**
|
|
4409
|
-
* Type of ingestion source of this Data Lake Pipeline.
|
|
4410
|
-
*/
|
|
4411
|
-
type: string;
|
|
4412
|
-
}
|
|
4413
|
-
export interface GetDataLakePipelineSource {
|
|
4414
|
-
/**
|
|
4415
|
-
* Human-readable name that identifies the cluster.
|
|
4416
|
-
*/
|
|
4417
|
-
clusterName: string;
|
|
4418
|
-
/**
|
|
4419
|
-
* Human-readable name that identifies the collection.
|
|
4420
|
-
*/
|
|
4421
|
-
collectionName: string;
|
|
4422
|
-
/**
|
|
4423
|
-
* Human-readable name that identifies the database.
|
|
4424
|
-
*/
|
|
4425
|
-
databaseName: string;
|
|
4426
|
-
/**
|
|
4427
|
-
* The unique ID for the project to create a Data Lake Pipeline.
|
|
4428
|
-
*/
|
|
4429
|
-
projectId: string;
|
|
4430
|
-
/**
|
|
4431
|
-
* Type of ingestion source of this Data Lake Pipeline.
|
|
4432
|
-
*/
|
|
4433
|
-
type: string;
|
|
4434
|
-
}
|
|
4435
|
-
export interface GetDataLakePipelineTransformation {
|
|
4436
|
-
field: string;
|
|
4437
|
-
/**
|
|
4438
|
-
* Type of ingestion source of this Data Lake Pipeline.
|
|
4439
|
-
*/
|
|
4440
|
-
type: string;
|
|
4441
|
-
}
|
|
4442
|
-
export interface GetDataLakePipelinesResult {
|
|
4443
|
-
/**
|
|
4444
|
-
* Timestamp that indicates when the Data Lake Pipeline was created.
|
|
4445
|
-
*/
|
|
4446
|
-
createdDate: string;
|
|
4447
|
-
/**
|
|
4448
|
-
* Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.
|
|
4449
|
-
*/
|
|
4450
|
-
id: string;
|
|
4451
|
-
/**
|
|
4452
|
-
* Timestamp that indicates the last time that the Data Lake Pipeline was updated.
|
|
4453
|
-
*/
|
|
4454
|
-
lastUpdatedDate: string;
|
|
4455
|
-
name: string;
|
|
4456
|
-
/**
|
|
4457
|
-
* The unique ID for the project to create a data lake pipeline.
|
|
4458
|
-
*/
|
|
4459
|
-
projectId: string;
|
|
4460
|
-
sinks: outputs.GetDataLakePipelinesResultSink[];
|
|
4461
|
-
sources: outputs.GetDataLakePipelinesResultSource[];
|
|
4462
|
-
/**
|
|
4463
|
-
* State of this Data Lake Pipeline.
|
|
4464
|
-
*/
|
|
4465
|
-
state: string;
|
|
4466
|
-
/**
|
|
4467
|
-
* Fields to be excluded for this Data Lake Pipeline.
|
|
4468
|
-
* * `transformations.#.field` - Key in the document.
|
|
4469
|
-
* * `transformations.#.type` - Type of transformation applied during the export of the namespace in a Data Lake Pipeline.
|
|
4470
|
-
*/
|
|
4471
|
-
transformations: outputs.GetDataLakePipelinesResultTransformation[];
|
|
4472
|
-
}
|
|
4473
|
-
export interface GetDataLakePipelinesResultSink {
|
|
4474
|
-
/**
|
|
4475
|
-
* Ordered fields used to physically organize data in the destination.
|
|
4476
|
-
* * `partition_fields.#.field_name` - Human-readable label that identifies the field name used to partition data.
|
|
4477
|
-
* * `partition_fields.#.order` - Sequence in which MongoDB Atlas slices the collection data to create partitions. The resource expresses this sequence starting with zero.
|
|
4478
|
-
*/
|
|
4479
|
-
partitionFields: outputs.GetDataLakePipelinesResultSinkPartitionField[];
|
|
4480
|
-
/**
|
|
4481
|
-
* Target cloud provider for this Data Lake Pipeline.
|
|
4482
|
-
*/
|
|
4483
|
-
provider: string;
|
|
4484
|
-
/**
|
|
4485
|
-
* Target cloud provider region for this Data Lake Pipeline. [Supported cloud provider regions](https://www.mongodb.com/docs/datalake/limitations).
|
|
4486
|
-
*/
|
|
4487
|
-
region: string;
|
|
4488
|
-
/**
|
|
4489
|
-
* Type of ingestion source of this Data Lake Pipeline.
|
|
4490
|
-
*/
|
|
4491
|
-
type: string;
|
|
4492
|
-
}
|
|
4493
|
-
export interface GetDataLakePipelinesResultSinkPartitionField {
|
|
4494
|
-
fieldName: string;
|
|
4495
|
-
order: number;
|
|
4496
|
-
}
|
|
4497
|
-
export interface GetDataLakePipelinesResultSource {
|
|
4498
|
-
/**
|
|
4499
|
-
* Human-readable name that identifies the cluster.
|
|
4500
|
-
*/
|
|
4501
|
-
clusterName: string;
|
|
4502
|
-
/**
|
|
4503
|
-
* Human-readable name that identifies the collection.
|
|
4504
|
-
*/
|
|
4505
|
-
collectionName: string;
|
|
4506
|
-
/**
|
|
4507
|
-
* Human-readable name that identifies the database.
|
|
4508
|
-
*/
|
|
4509
|
-
databaseName: string;
|
|
4510
|
-
/**
|
|
4511
|
-
* The unique ID for the project to create a data lake pipeline.
|
|
4512
|
-
*/
|
|
4513
|
-
projectId: string;
|
|
4514
|
-
/**
|
|
4515
|
-
* Type of ingestion source of this Data Lake Pipeline.
|
|
4516
|
-
*/
|
|
4517
|
-
type: string;
|
|
4518
|
-
}
|
|
4519
|
-
export interface GetDataLakePipelinesResultTransformation {
|
|
4520
|
-
field: string;
|
|
4521
|
-
/**
|
|
4522
|
-
* Type of ingestion source of this Data Lake Pipeline.
|
|
4523
|
-
*/
|
|
4524
|
-
type: string;
|
|
4525
|
-
}
|
|
4526
4424
|
export interface GetDatabaseUserLabel {
|
|
4527
4425
|
/**
|
|
4528
4426
|
* The key that you want to write.
|
|
@@ -4593,7 +4491,7 @@ export interface GetDatabaseUsersResult {
|
|
|
4593
4491
|
*/
|
|
4594
4492
|
roles: outputs.GetDatabaseUsersResultRole[];
|
|
4595
4493
|
/**
|
|
4596
|
-
* Array of clusters and Atlas Data
|
|
4494
|
+
* Array of clusters and Atlas Data Federation that this user has access to.
|
|
4597
4495
|
*/
|
|
4598
4496
|
scopes: outputs.GetDatabaseUsersResultScope[];
|
|
4599
4497
|
/**
|
|
@@ -4868,10 +4766,10 @@ export interface GetEventTriggersResultEventProcessorAwsEventbridge {
|
|
|
4868
4766
|
configRegion: string;
|
|
4869
4767
|
}
|
|
4870
4768
|
export interface GetFederatedDatabaseInstanceCloudProviderConfig {
|
|
4871
|
-
aws: outputs.
|
|
4769
|
+
aws: outputs.GetFederatedDatabaseInstanceCloudProviderConfigAw[];
|
|
4872
4770
|
azures: outputs.GetFederatedDatabaseInstanceCloudProviderConfigAzure[];
|
|
4873
4771
|
}
|
|
4874
|
-
export interface
|
|
4772
|
+
export interface GetFederatedDatabaseInstanceCloudProviderConfigAw {
|
|
4875
4773
|
/**
|
|
4876
4774
|
* Unique identifier associated with the IAM Role that the Federated Database Instance assumes when accessing the data stores.
|
|
4877
4775
|
*/
|
|
@@ -4997,7 +4895,7 @@ export interface GetFederatedDatabaseInstanceStorageStoreReadPreferenceTagSetTag
|
|
|
4997
4895
|
value: string;
|
|
4998
4896
|
}
|
|
4999
4897
|
export interface GetFederatedDatabaseInstancesResult {
|
|
5000
|
-
|
|
4898
|
+
cloudProviderConfigs: outputs.GetFederatedDatabaseInstancesResultCloudProviderConfig[];
|
|
5001
4899
|
dataProcessRegions: outputs.GetFederatedDatabaseInstancesResultDataProcessRegion[];
|
|
5002
4900
|
/**
|
|
5003
4901
|
* The list of hostnames assigned to the Federated Database Instance. Each string in the array is a hostname assigned to the Federated Database Instance.
|
|
@@ -5015,9 +4913,9 @@ export interface GetFederatedDatabaseInstancesResult {
|
|
|
5015
4913
|
*/
|
|
5016
4914
|
state: string;
|
|
5017
4915
|
/**
|
|
5018
|
-
* Configuration details for mapping each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see [databases](https://
|
|
4916
|
+
* Configuration details for mapping each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see [databases](https://www.mongodb.com/docs/atlas/data-federation/config/config-oa/#databases). An empty object indicates that the Federated Database Instance has no mapping configuration for any data store.
|
|
5019
4917
|
* * `storage_databases.#.name` - Name of the database to which the Federated Database Instance maps the data contained in the data store.
|
|
5020
|
-
* * `storage_databases.#.collections` - Array of objects where each object represents a collection and data sources that map to a [stores](https://
|
|
4918
|
+
* * `storage_databases.#.collections` - Array of objects where each object represents a collection and data sources that map to a [stores](https://www.mongodb.com/docs/atlas/data-federation/config/config-oa/#stores) data store.
|
|
5021
4919
|
* * `storage_databases.#.collections.#.name` - Name of the collection.
|
|
5022
4920
|
* * `storage_databases.#.collections.#.data_sources` - Array of objects where each object represents a stores data store to map with the collection.
|
|
5023
4921
|
* * `storage_databases.#.collections.#.data_sources.#.store_name` - Name of a data store to map to the `<collection>`. Must match the name of an object in the stores array.
|
|
@@ -5039,7 +4937,7 @@ export interface GetFederatedDatabaseInstancesResult {
|
|
|
5039
4937
|
*/
|
|
5040
4938
|
storageDatabases: outputs.GetFederatedDatabaseInstancesResultStorageDatabase[];
|
|
5041
4939
|
/**
|
|
5042
|
-
* Each object in the array represents a data store. Federated Database uses the storage.databases configuration details to map data in each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see [stores](https://
|
|
4940
|
+
* Each object in the array represents a data store. Federated Database uses the `storage.databases` configuration details to map data in each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see [stores](https://www.mongodb.com/docs/atlas/data-federation/config/config-oa/#stores). An empty object indicates that the Federated Database Instance has no configured data stores.
|
|
5043
4941
|
* * `storage_stores.#.name` - Name of the data store.
|
|
5044
4942
|
* * `storage_stores.#.provider` - Defines where the data is stored.
|
|
5045
4943
|
* * `storage_stores.#.region` - Name of the AWS region in which the S3 bucket is hosted.
|
|
@@ -5050,7 +4948,7 @@ export interface GetFederatedDatabaseInstancesResult {
|
|
|
5050
4948
|
* * `storage_stores.#.cluster_name` - Human-readable label of the MongoDB Cloud cluster on which the store is based.
|
|
5051
4949
|
* * `storage_stores.#.allow_insecure` - Flag that validates the scheme in the specified URLs.
|
|
5052
4950
|
* * `storage_stores.#.public` - Flag that indicates whether the bucket is public.
|
|
5053
|
-
* * `storage_stores.#.default_format` - Default format that Data
|
|
4951
|
+
* * `storage_stores.#.default_format` - Default format that Atlas Data Federation assumes if it encounters a file without an extension while searching the storeName.
|
|
5054
4952
|
* * `storage_stores.#.urls` - Comma-separated list of publicly accessible HTTP URLs where data is stored.
|
|
5055
4953
|
* * `storage_stores.#.read_preference` - MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.
|
|
5056
4954
|
* * `storage_stores.#.read_preference.maxStalenessSeconds` - Maximum replication lag, or staleness, for reads from secondaries.
|
|
@@ -5063,10 +4961,10 @@ export interface GetFederatedDatabaseInstancesResult {
|
|
|
5063
4961
|
storageStores: outputs.GetFederatedDatabaseInstancesResultStorageStore[];
|
|
5064
4962
|
}
|
|
5065
4963
|
export interface GetFederatedDatabaseInstancesResultCloudProviderConfig {
|
|
5066
|
-
aws: outputs.
|
|
4964
|
+
aws: outputs.GetFederatedDatabaseInstancesResultCloudProviderConfigAw[];
|
|
5067
4965
|
azures: outputs.GetFederatedDatabaseInstancesResultCloudProviderConfigAzure[];
|
|
5068
4966
|
}
|
|
5069
|
-
export interface
|
|
4967
|
+
export interface GetFederatedDatabaseInstancesResultCloudProviderConfigAw {
|
|
5070
4968
|
/**
|
|
5071
4969
|
* Unique identifier associated with the IAM Role that the Federated Database Instance assumes when accessing the data stores.
|
|
5072
4970
|
*/
|
|
@@ -6137,6 +6035,72 @@ export interface GetOrganizationLink {
|
|
|
6137
6035
|
href: string;
|
|
6138
6036
|
rel: string;
|
|
6139
6037
|
}
|
|
6038
|
+
export interface GetOrganizationUser {
|
|
6039
|
+
/**
|
|
6040
|
+
* Two-character alphabetical string that identifies the MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.
|
|
6041
|
+
*/
|
|
6042
|
+
country: string;
|
|
6043
|
+
/**
|
|
6044
|
+
* Date and time when MongoDB Cloud created the current account. This value is in the ISO 8601 timestamp format in UTC.
|
|
6045
|
+
*/
|
|
6046
|
+
createdAt: string;
|
|
6047
|
+
/**
|
|
6048
|
+
* First or given name that belongs to the MongoDB Cloud user.
|
|
6049
|
+
*/
|
|
6050
|
+
firstName: string;
|
|
6051
|
+
/**
|
|
6052
|
+
* Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.
|
|
6053
|
+
*/
|
|
6054
|
+
id: string;
|
|
6055
|
+
/**
|
|
6056
|
+
* Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
|
|
6057
|
+
*/
|
|
6058
|
+
invitationCreatedAt: string;
|
|
6059
|
+
/**
|
|
6060
|
+
* Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
|
|
6061
|
+
*/
|
|
6062
|
+
invitationExpiresAt: string;
|
|
6063
|
+
/**
|
|
6064
|
+
* Username of the MongoDB Cloud user who sent the invitation to join the organization.
|
|
6065
|
+
*/
|
|
6066
|
+
inviterUsername: string;
|
|
6067
|
+
/**
|
|
6068
|
+
* Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.
|
|
6069
|
+
*/
|
|
6070
|
+
lastAuth: string;
|
|
6071
|
+
/**
|
|
6072
|
+
* Last name, family name, or surname that belongs to the MongoDB Cloud user.
|
|
6073
|
+
*/
|
|
6074
|
+
lastName: string;
|
|
6075
|
+
/**
|
|
6076
|
+
* Mobile phone number that belongs to the MongoDB Cloud user.
|
|
6077
|
+
*/
|
|
6078
|
+
mobileNumber: string;
|
|
6079
|
+
/**
|
|
6080
|
+
* String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.
|
|
6081
|
+
*/
|
|
6082
|
+
orgMembershipStatus: string;
|
|
6083
|
+
/**
|
|
6084
|
+
* Organization- and project-level roles assigned to one MongoDB Cloud user within one organization.
|
|
6085
|
+
*/
|
|
6086
|
+
roles: outputs.GetOrganizationUserRole[];
|
|
6087
|
+
/**
|
|
6088
|
+
* List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.
|
|
6089
|
+
*/
|
|
6090
|
+
teamIds: string[];
|
|
6091
|
+
/**
|
|
6092
|
+
* Email address that represents the username of the MongoDB Cloud user.
|
|
6093
|
+
*/
|
|
6094
|
+
username: string;
|
|
6095
|
+
}
|
|
6096
|
+
export interface GetOrganizationUserRole {
|
|
6097
|
+
orgRoles: string[];
|
|
6098
|
+
projectRoleAssignments: outputs.GetOrganizationUserRoleProjectRoleAssignment[];
|
|
6099
|
+
}
|
|
6100
|
+
export interface GetOrganizationUserRoleProjectRoleAssignment {
|
|
6101
|
+
projectId: string;
|
|
6102
|
+
projectRoles: string[];
|
|
6103
|
+
}
|
|
6140
6104
|
export interface GetOrganizationsResult {
|
|
6141
6105
|
/**
|
|
6142
6106
|
* Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization.
|
|
@@ -6172,11 +6136,76 @@ export interface GetOrganizationsResult {
|
|
|
6172
6136
|
*/
|
|
6173
6137
|
securityContact: string;
|
|
6174
6138
|
skipDefaultAlertsSettings: boolean;
|
|
6139
|
+
/**
|
|
6140
|
+
* Returns list of all pending and active MongoDB Cloud users associated with the specified organization.
|
|
6141
|
+
*/
|
|
6142
|
+
users: outputs.GetOrganizationsResultUser[];
|
|
6175
6143
|
}
|
|
6176
6144
|
export interface GetOrganizationsResultLink {
|
|
6177
6145
|
href: string;
|
|
6178
6146
|
rel: string;
|
|
6179
6147
|
}
|
|
6148
|
+
export interface GetOrganizationsResultUser {
|
|
6149
|
+
/**
|
|
6150
|
+
* Two-character alphabetical string that identifies the MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.
|
|
6151
|
+
*/
|
|
6152
|
+
country: string;
|
|
6153
|
+
/**
|
|
6154
|
+
* Date and time when MongoDB Cloud created the current account. This value is in the ISO 8601 timestamp format in UTC.
|
|
6155
|
+
*/
|
|
6156
|
+
createdAt: string;
|
|
6157
|
+
/**
|
|
6158
|
+
* First or given name that belongs to the MongoDB Cloud user.
|
|
6159
|
+
*/
|
|
6160
|
+
firstName: string;
|
|
6161
|
+
/**
|
|
6162
|
+
* Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.
|
|
6163
|
+
*/
|
|
6164
|
+
id: string;
|
|
6165
|
+
/**
|
|
6166
|
+
* Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
|
|
6167
|
+
*/
|
|
6168
|
+
invitationCreatedAt: string;
|
|
6169
|
+
/**
|
|
6170
|
+
* Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
|
|
6171
|
+
*/
|
|
6172
|
+
invitationExpiresAt: string;
|
|
6173
|
+
/**
|
|
6174
|
+
* Username of the MongoDB Cloud user who sent the invitation to join the organization.
|
|
6175
|
+
*/
|
|
6176
|
+
inviterUsername: string;
|
|
6177
|
+
/**
|
|
6178
|
+
* Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.
|
|
6179
|
+
*/
|
|
6180
|
+
lastAuth: string;
|
|
6181
|
+
/**
|
|
6182
|
+
* Last name, family name, or surname that belongs to the MongoDB Cloud user.
|
|
6183
|
+
*/
|
|
6184
|
+
lastName: string;
|
|
6185
|
+
mobileNumber: string;
|
|
6186
|
+
/**
|
|
6187
|
+
* String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.
|
|
6188
|
+
*/
|
|
6189
|
+
orgMembershipStatus: string;
|
|
6190
|
+
/**
|
|
6191
|
+
* Organization- and project-level roles assigned to one MongoDB Cloud user within one organization.
|
|
6192
|
+
* * `teamIds` - List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.
|
|
6193
|
+
*/
|
|
6194
|
+
roles: outputs.GetOrganizationsResultUserRole[];
|
|
6195
|
+
teamIds: string[];
|
|
6196
|
+
/**
|
|
6197
|
+
* Email address that represents the username of the MongoDB Cloud user.
|
|
6198
|
+
*/
|
|
6199
|
+
username: string;
|
|
6200
|
+
}
|
|
6201
|
+
export interface GetOrganizationsResultUserRole {
|
|
6202
|
+
orgRoles: string[];
|
|
6203
|
+
projectRoleAssignments: outputs.GetOrganizationsResultUserRoleProjectRoleAssignment[];
|
|
6204
|
+
}
|
|
6205
|
+
export interface GetOrganizationsResultUserRoleProjectRoleAssignment {
|
|
6206
|
+
projectId: string;
|
|
6207
|
+
projectRoles: string[];
|
|
6208
|
+
}
|
|
6180
6209
|
export interface GetPrivateLinkEndpointServiceEndpoint {
|
|
6181
6210
|
/**
|
|
6182
6211
|
* Forwarding rule that corresponds to the endpoint you created in GCP.
|
|
@@ -6201,7 +6230,7 @@ export interface GetPrivatelinkEndpointServiceDataFederationOnlineArchivesResult
|
|
|
6201
6230
|
*/
|
|
6202
6231
|
customerEndpointDnsName: string;
|
|
6203
6232
|
/**
|
|
6204
|
-
* Unique 22-character alphanumeric string that identifies the private endpoint. See [Atlas Data
|
|
6233
|
+
* Unique 22-character alphanumeric string that identifies the private endpoint. See [Atlas Data Federation supports Amazon Web Services private endpoints using the AWS PrivateLink feature](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Data-Federation/operation/createDataFederationPrivateEndpoint).
|
|
6205
6234
|
*/
|
|
6206
6235
|
endpointId: string;
|
|
6207
6236
|
/**
|
|
@@ -6217,37 +6246,6 @@ export interface GetPrivatelinkEndpointServiceDataFederationOnlineArchivesResult
|
|
|
6217
6246
|
*/
|
|
6218
6247
|
type: string;
|
|
6219
6248
|
}
|
|
6220
|
-
export interface GetPrivatelinkEndpointsServiceServerlessResult {
|
|
6221
|
-
/**
|
|
6222
|
-
* Unique string that identifies the private endpoint's network interface.
|
|
6223
|
-
*/
|
|
6224
|
-
cloudProviderEndpointId: string;
|
|
6225
|
-
/**
|
|
6226
|
-
* Human-readable string to associate with this private endpoint.
|
|
6227
|
-
*/
|
|
6228
|
-
comment: string;
|
|
6229
|
-
/**
|
|
6230
|
-
* (Required) Unique 22-character alphanumeric string that identifies the private endpoint. Atlas supports AWS private endpoints using the [AWS PrivateLink](https://aws.amazon.com/privatelink/) feature.
|
|
6231
|
-
*/
|
|
6232
|
-
endpointId: string;
|
|
6233
|
-
/**
|
|
6234
|
-
* Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.
|
|
6235
|
-
*/
|
|
6236
|
-
endpointServiceName: string;
|
|
6237
|
-
errorMessage: string;
|
|
6238
|
-
/**
|
|
6239
|
-
* IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.
|
|
6240
|
-
*/
|
|
6241
|
-
privateEndpointIpAddress: string;
|
|
6242
|
-
/**
|
|
6243
|
-
* Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
|
|
6244
|
-
*/
|
|
6245
|
-
privateLinkServiceResourceId: string;
|
|
6246
|
-
/**
|
|
6247
|
-
* Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.
|
|
6248
|
-
*/
|
|
6249
|
-
status: string;
|
|
6250
|
-
}
|
|
6251
6249
|
export interface GetProjectApiKeyProjectAssignment {
|
|
6252
6250
|
/**
|
|
6253
6251
|
* The unique ID for the project.
|
|
@@ -6346,6 +6344,39 @@ export interface GetProjectTeam {
|
|
|
6346
6344
|
*/
|
|
6347
6345
|
teamId: string;
|
|
6348
6346
|
}
|
|
6347
|
+
export interface GetProjectUser {
|
|
6348
|
+
/**
|
|
6349
|
+
* Two-character alphabetical string that identifies the MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.
|
|
6350
|
+
* * `createdAt`- Date and time when MongoDB Cloud created the current account. This value is in the ISO 8601 timestamp format in UTC.
|
|
6351
|
+
* * `firstName`- First or given name that belongs to the MongoDB Cloud user.
|
|
6352
|
+
* * `lastAuth` - Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.
|
|
6353
|
+
* * `lastName`- Last name, family name, or surname that belongs to the MongoDB Cloud user.
|
|
6354
|
+
* * `mobileNumber` - Mobile phone number that belongs to the MongoDB Cloud user.
|
|
6355
|
+
*/
|
|
6356
|
+
country: string;
|
|
6357
|
+
createdAt: string;
|
|
6358
|
+
firstName: string;
|
|
6359
|
+
/**
|
|
6360
|
+
* Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.
|
|
6361
|
+
* * `orgMembershipStatus`- String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.
|
|
6362
|
+
*/
|
|
6363
|
+
id: string;
|
|
6364
|
+
invitationCreatedAt: string;
|
|
6365
|
+
invitationExpiresAt: string;
|
|
6366
|
+
inviterUsername: string;
|
|
6367
|
+
lastAuth: string;
|
|
6368
|
+
lastName: string;
|
|
6369
|
+
mobileNumber: string;
|
|
6370
|
+
orgMembershipStatus: string;
|
|
6371
|
+
/**
|
|
6372
|
+
* One or more project-level roles assigned to the MongoDB Cloud user.
|
|
6373
|
+
*/
|
|
6374
|
+
roles: string[];
|
|
6375
|
+
/**
|
|
6376
|
+
* Email address that represents the username of the MongoDB Cloud user.
|
|
6377
|
+
*/
|
|
6378
|
+
username: string;
|
|
6379
|
+
}
|
|
6349
6380
|
export interface GetProjectsResult {
|
|
6350
6381
|
/**
|
|
6351
6382
|
* The number of Atlas clusters deployed in the project.
|
|
@@ -6399,12 +6430,15 @@ export interface GetProjectsResult {
|
|
|
6399
6430
|
* The limits for the specified project. See Limits.
|
|
6400
6431
|
*/
|
|
6401
6432
|
limits: outputs.GetProjectsResultLimit[];
|
|
6402
|
-
name
|
|
6433
|
+
name?: string;
|
|
6403
6434
|
/**
|
|
6404
6435
|
* The ID of the organization you want to create the project within.
|
|
6405
6436
|
*/
|
|
6406
6437
|
orgId: string;
|
|
6407
|
-
|
|
6438
|
+
/**
|
|
6439
|
+
* Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.
|
|
6440
|
+
*/
|
|
6441
|
+
projectId?: string;
|
|
6408
6442
|
/**
|
|
6409
6443
|
* If GOV_REGIONS_ONLY the project can be used for government regions only, otherwise defaults to standard regions. For more information see [MongoDB Atlas for Government](https://www.mongodb.com/docs/atlas/government/api/#creating-a-project).
|
|
6410
6444
|
*/
|
|
@@ -6416,9 +6450,15 @@ export interface GetProjectsResult {
|
|
|
6416
6450
|
[key: string]: string;
|
|
6417
6451
|
};
|
|
6418
6452
|
/**
|
|
6419
|
-
* Returns all teams to which the authenticated user has access in the project. See Teams.
|
|
6453
|
+
* **(DEPRECATED)** Returns all teams to which the authenticated user has access in the project. See Teams.
|
|
6454
|
+
*
|
|
6455
|
+
* @deprecated This parameter is deprecated and will be removed in the next major release. Please transition to `mongodbatlas.TeamProjectAssignment`. For more details, see https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/atlas-user-management.
|
|
6420
6456
|
*/
|
|
6421
6457
|
teams: outputs.GetProjectsResultTeam[];
|
|
6458
|
+
/**
|
|
6459
|
+
* Returns list of all pending and active MongoDB Cloud users associated with the specified project.
|
|
6460
|
+
*/
|
|
6461
|
+
users: outputs.GetProjectsResultUser[];
|
|
6422
6462
|
}
|
|
6423
6463
|
export interface GetProjectsResultIpAddresses {
|
|
6424
6464
|
services: outputs.GetProjectsResultIpAddressesServices;
|
|
@@ -6463,6 +6503,43 @@ export interface GetProjectsResultTeam {
|
|
|
6463
6503
|
*/
|
|
6464
6504
|
teamId: string;
|
|
6465
6505
|
}
|
|
6506
|
+
export interface GetProjectsResultUser {
|
|
6507
|
+
/**
|
|
6508
|
+
* Two-character alphabetical string that identifies the MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.
|
|
6509
|
+
* * `createdAt`- Date and time when MongoDB Cloud created the current account. This value is in the ISO 8601 timestamp format in UTC.
|
|
6510
|
+
* * `firstName`- First or given name that belongs to the MongoDB Cloud user.
|
|
6511
|
+
* * `lastAuth` - Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.
|
|
6512
|
+
* * `lastName`- Last name, family name, or surname that belongs to the MongoDB Cloud user.
|
|
6513
|
+
* * `mobileNumber` - Mobile phone number that belongs to the MongoDB Cloud user.
|
|
6514
|
+
*
|
|
6515
|
+
* > **NOTE:** - Does not return pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectinvitation) endpoint or pending invitations created using `mongodbatlas.ProjectInvitation` resource.
|
|
6516
|
+
*
|
|
6517
|
+
* See [MongoDB Atlas API - Projects](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Projects) Documentation for more information.
|
|
6518
|
+
*/
|
|
6519
|
+
country: string;
|
|
6520
|
+
createdAt: string;
|
|
6521
|
+
firstName: string;
|
|
6522
|
+
/**
|
|
6523
|
+
* Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.
|
|
6524
|
+
* * `orgMembershipStatus`- String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.
|
|
6525
|
+
*/
|
|
6526
|
+
id: string;
|
|
6527
|
+
invitationCreatedAt: string;
|
|
6528
|
+
invitationExpiresAt: string;
|
|
6529
|
+
inviterUsername: string;
|
|
6530
|
+
lastAuth: string;
|
|
6531
|
+
lastName: string;
|
|
6532
|
+
mobileNumber: string;
|
|
6533
|
+
orgMembershipStatus: string;
|
|
6534
|
+
/**
|
|
6535
|
+
* One or more project-level roles assigned to the MongoDB Cloud user.
|
|
6536
|
+
*/
|
|
6537
|
+
roles: string[];
|
|
6538
|
+
/**
|
|
6539
|
+
* Email address that represents the username of the MongoDB Cloud user.
|
|
6540
|
+
*/
|
|
6541
|
+
username: string;
|
|
6542
|
+
}
|
|
6466
6543
|
export interface GetResourcePoliciesResourcePolicy {
|
|
6467
6544
|
/**
|
|
6468
6545
|
* The user that last updated the Atlas resource policy.
|
|
@@ -6653,11 +6730,21 @@ export interface GetSearchIndexSynonym {
|
|
|
6653
6730
|
*/
|
|
6654
6731
|
analyzer: string;
|
|
6655
6732
|
/**
|
|
6656
|
-
*
|
|
6733
|
+
* Type set name.
|
|
6657
6734
|
*/
|
|
6658
6735
|
name: string;
|
|
6659
6736
|
sourceCollection: string;
|
|
6660
6737
|
}
|
|
6738
|
+
export interface GetSearchIndexTypeSet {
|
|
6739
|
+
/**
|
|
6740
|
+
* Type set name.
|
|
6741
|
+
*/
|
|
6742
|
+
name: string;
|
|
6743
|
+
/**
|
|
6744
|
+
* JSON array string describing the types for the set.
|
|
6745
|
+
*/
|
|
6746
|
+
types: string;
|
|
6747
|
+
}
|
|
6661
6748
|
export interface GetSearchIndexesResult {
|
|
6662
6749
|
/**
|
|
6663
6750
|
* [Analyzer](https://docs.atlas.mongodb.com/reference/atlas-search/analyzers/#std-label-analyzers-ref) to use when creating the index.
|
|
@@ -6685,15 +6772,19 @@ export interface GetSearchIndexesResult {
|
|
|
6685
6772
|
*/
|
|
6686
6773
|
indexId: string;
|
|
6687
6774
|
/**
|
|
6688
|
-
* Flag indicating whether the index uses dynamic or static mappings.
|
|
6775
|
+
* Flag indicating whether the index uses dynamic or static mappings. Mutually exclusive with `mappingsDynamicConfig`.
|
|
6689
6776
|
*/
|
|
6690
6777
|
mappingsDynamic: boolean;
|
|
6778
|
+
/**
|
|
6779
|
+
* JSON object for `mappings.dynamic` when Atlas returns an object (Please see the documentation for [dynamic and static mappings](https://www.mongodb.com/docs/atlas/atlas-search/index-definitions/#field-mapping-examples)). Mutually exclusive with `mappingsDynamic`.
|
|
6780
|
+
*/
|
|
6781
|
+
mappingsDynamicConfig: string;
|
|
6691
6782
|
/**
|
|
6692
6783
|
* Object containing one or more field specifications.
|
|
6693
6784
|
*/
|
|
6694
6785
|
mappingsFields: string;
|
|
6695
6786
|
/**
|
|
6696
|
-
*
|
|
6787
|
+
* Type set name.
|
|
6697
6788
|
*/
|
|
6698
6789
|
name: string;
|
|
6699
6790
|
/**
|
|
@@ -6720,6 +6811,10 @@ export interface GetSearchIndexesResult {
|
|
|
6720
6811
|
*/
|
|
6721
6812
|
synonyms: outputs.GetSearchIndexesResultSynonym[];
|
|
6722
6813
|
type: string;
|
|
6814
|
+
/**
|
|
6815
|
+
* Set of type set definitions (when present). Each item includes:
|
|
6816
|
+
*/
|
|
6817
|
+
typeSets: outputs.GetSearchIndexesResultTypeSet[];
|
|
6723
6818
|
}
|
|
6724
6819
|
export interface GetSearchIndexesResultSynonym {
|
|
6725
6820
|
/**
|
|
@@ -6727,11 +6822,21 @@ export interface GetSearchIndexesResultSynonym {
|
|
|
6727
6822
|
*/
|
|
6728
6823
|
analyzer: string;
|
|
6729
6824
|
/**
|
|
6730
|
-
*
|
|
6825
|
+
* Type set name.
|
|
6731
6826
|
*/
|
|
6732
6827
|
name: string;
|
|
6733
6828
|
sourceCollection: string;
|
|
6734
6829
|
}
|
|
6830
|
+
export interface GetSearchIndexesResultTypeSet {
|
|
6831
|
+
/**
|
|
6832
|
+
* Type set name.
|
|
6833
|
+
*/
|
|
6834
|
+
name: string;
|
|
6835
|
+
/**
|
|
6836
|
+
* JSON array string describing the types for the set.
|
|
6837
|
+
*/
|
|
6838
|
+
types: string;
|
|
6839
|
+
}
|
|
6735
6840
|
export interface GetServerlessInstanceLink {
|
|
6736
6841
|
href: string;
|
|
6737
6842
|
rel: string;
|
|
@@ -6845,13 +6950,37 @@ export interface GetSharedTierSnapshotsResult {
|
|
|
6845
6950
|
}
|
|
6846
6951
|
export interface GetStreamConnectionAuthentication {
|
|
6847
6952
|
/**
|
|
6848
|
-
*
|
|
6953
|
+
* Public identifier for the Kafka client.
|
|
6954
|
+
*/
|
|
6955
|
+
clientId: string;
|
|
6956
|
+
/**
|
|
6957
|
+
* Secret known only to the Kafka client and the authorization server.
|
|
6958
|
+
*/
|
|
6959
|
+
clientSecret: string;
|
|
6960
|
+
/**
|
|
6961
|
+
* Method of authentication. Value can be `PLAIN`, `SCRAM-256`, `SCRAM-512`, or `OAUTHBEARER`.
|
|
6849
6962
|
*/
|
|
6850
6963
|
mechanism: string;
|
|
6964
|
+
/**
|
|
6965
|
+
* SASL OAUTHBEARER authentication method. Value must be OIDC.
|
|
6966
|
+
*/
|
|
6967
|
+
method: string;
|
|
6851
6968
|
/**
|
|
6852
6969
|
* Password of the account to connect to the Kafka cluster.
|
|
6853
6970
|
*/
|
|
6854
6971
|
password: string;
|
|
6972
|
+
/**
|
|
6973
|
+
* Additional information to provide to the Kafka broker.
|
|
6974
|
+
*/
|
|
6975
|
+
saslOauthbearerExtensions: string;
|
|
6976
|
+
/**
|
|
6977
|
+
* Scope of the access request to the broker specified by the Kafka clients.
|
|
6978
|
+
*/
|
|
6979
|
+
scope: string;
|
|
6980
|
+
/**
|
|
6981
|
+
* OAUTH issuer (IdP provider) token endpoint HTTP(S) URI used to retrieve the token.
|
|
6982
|
+
*/
|
|
6983
|
+
tokenEndpointUrl: string;
|
|
6855
6984
|
/**
|
|
6856
6985
|
* Username of the account to connect to the Kafka cluster.
|
|
6857
6986
|
*/
|
|
@@ -6924,7 +7053,7 @@ export interface GetStreamConnectionsResult {
|
|
|
6924
7053
|
[key: string]: string;
|
|
6925
7054
|
};
|
|
6926
7055
|
/**
|
|
6927
|
-
*
|
|
7056
|
+
* Label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
|
|
6928
7057
|
*/
|
|
6929
7058
|
connectionName: string;
|
|
6930
7059
|
/**
|
|
@@ -6939,7 +7068,9 @@ export interface GetStreamConnectionsResult {
|
|
|
6939
7068
|
};
|
|
6940
7069
|
id: string;
|
|
6941
7070
|
/**
|
|
6942
|
-
*
|
|
7071
|
+
* Label that identifies the stream processing workspace. Attribute is deprecated and will be removed in following major versions in favor of `workspaceName`.
|
|
7072
|
+
*
|
|
7073
|
+
* @deprecated This parameter is deprecated. Please transition to workspace_name.
|
|
6943
7074
|
*/
|
|
6944
7075
|
instanceName: string;
|
|
6945
7076
|
/**
|
|
@@ -6962,16 +7093,46 @@ export interface GetStreamConnectionsResult {
|
|
|
6962
7093
|
* URL of the HTTPs endpoint that will be used for creating a connection.
|
|
6963
7094
|
*/
|
|
6964
7095
|
url: string;
|
|
7096
|
+
/**
|
|
7097
|
+
* Label that identifies the stream processing workspace. Conflicts with `instanceName`.
|
|
7098
|
+
*
|
|
7099
|
+
* > **NOTE:** Either `workspaceName` or `instanceName` must be provided, but not both. These fields are functionally identical and `workspaceName` is an alias for `instanceName`. `workspaceName` should be used instead of `instanceName`.
|
|
7100
|
+
*/
|
|
7101
|
+
workspaceName: string;
|
|
6965
7102
|
}
|
|
6966
7103
|
export interface GetStreamConnectionsResultAuthentication {
|
|
6967
7104
|
/**
|
|
6968
|
-
*
|
|
7105
|
+
* Public identifier for the Kafka client.
|
|
7106
|
+
*/
|
|
7107
|
+
clientId: string;
|
|
7108
|
+
/**
|
|
7109
|
+
* Secret known only to the Kafka client and the authorization server.
|
|
7110
|
+
*/
|
|
7111
|
+
clientSecret: string;
|
|
7112
|
+
/**
|
|
7113
|
+
* Method of authentication. Value can be `PLAIN`, `SCRAM-256`, `SCRAM-512`, or `OAUTHBEARER`.
|
|
6969
7114
|
*/
|
|
6970
7115
|
mechanism: string;
|
|
7116
|
+
/**
|
|
7117
|
+
* SASL OAUTHBEARER authentication method. Value must be OIDC.
|
|
7118
|
+
*/
|
|
7119
|
+
method: string;
|
|
6971
7120
|
/**
|
|
6972
7121
|
* Password of the account to connect to the Kafka cluster.
|
|
6973
7122
|
*/
|
|
6974
7123
|
password: string;
|
|
7124
|
+
/**
|
|
7125
|
+
* Additional information to provide to the Kafka broker.
|
|
7126
|
+
*/
|
|
7127
|
+
saslOauthbearerExtensions: string;
|
|
7128
|
+
/**
|
|
7129
|
+
* Scope of the access request to the broker specified by the Kafka clients.
|
|
7130
|
+
*/
|
|
7131
|
+
scope: string;
|
|
7132
|
+
/**
|
|
7133
|
+
* OAUTH issuer (IdP provider) token endpoint HTTP(S) URI used to retrieve the token.
|
|
7134
|
+
*/
|
|
7135
|
+
tokenEndpointUrl: string;
|
|
6975
7136
|
/**
|
|
6976
7137
|
* Username of the account to connect to the Kafka cluster.
|
|
6977
7138
|
*/
|
|
@@ -7030,6 +7191,7 @@ export interface GetStreamInstanceDataProcessRegion {
|
|
|
7030
7191
|
region: string;
|
|
7031
7192
|
}
|
|
7032
7193
|
export interface GetStreamInstanceStreamConfig {
|
|
7194
|
+
maxTierSize: string;
|
|
7033
7195
|
/**
|
|
7034
7196
|
* Selected tier for the Stream Instance. Configures Memory / VCPU allowances. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Streams/operation/createStreamInstance) describes the valid values.
|
|
7035
7197
|
*/
|
|
@@ -7069,6 +7231,7 @@ export interface GetStreamInstancesResultDataProcessRegion {
|
|
|
7069
7231
|
region: string;
|
|
7070
7232
|
}
|
|
7071
7233
|
export interface GetStreamInstancesResultStreamConfig {
|
|
7234
|
+
maxTierSize: string;
|
|
7072
7235
|
/**
|
|
7073
7236
|
* Selected tier for the Stream Instance. Configures Memory / VCPU allowances. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Streams/operation/createStreamInstance) describes the valid values.
|
|
7074
7237
|
*/
|
|
@@ -7116,13 +7279,17 @@ export interface GetStreamPrivatelinkEndpointsResult {
|
|
|
7116
7279
|
*/
|
|
7117
7280
|
providerAccountId: string;
|
|
7118
7281
|
/**
|
|
7119
|
-
* Provider where the endpoint is deployed. Valid values are AWS and
|
|
7282
|
+
* Provider where the endpoint is deployed. Valid values are AWS, AZURE, and GCP.
|
|
7120
7283
|
*/
|
|
7121
7284
|
providerName: string;
|
|
7122
7285
|
/**
|
|
7123
7286
|
* The region of the Provider’s cluster. See [AZURE](https://www.mongodb.com/docs/atlas/reference/microsoft-azure/#stream-processing-instances) and [AWS](https://www.mongodb.com/docs/atlas/reference/amazon-aws/#stream-processing-instances) supported regions. When the vendor is `CONFLUENT`, this is the domain name of Confluent cluster. When the vendor is `MSK`, this is computed by the API from the provided `arn`.
|
|
7124
7287
|
*/
|
|
7125
7288
|
region: string;
|
|
7289
|
+
/**
|
|
7290
|
+
* List of GCP service attachment URIs for Confluent vendor. Required for GCP provider with CONFLUENT vendor.
|
|
7291
|
+
*/
|
|
7292
|
+
serviceAttachmentUris: string[];
|
|
7126
7293
|
/**
|
|
7127
7294
|
* For AZURE EVENTHUB, this is the [namespace endpoint ID](https://learn.microsoft.com/en-us/rest/api/eventhub/namespaces/get). For AWS CONFLUENT cluster, this is the [VPC Endpoint service name](https://docs.confluent.io/cloud/current/networking/private-links/aws-privatelink.html).
|
|
7128
7295
|
*/
|
|
@@ -7137,6 +7304,8 @@ export interface GetStreamPrivatelinkEndpointsResult {
|
|
|
7137
7304
|
* * **AWS**: MSK, CONFLUENT, and S3
|
|
7138
7305
|
*
|
|
7139
7306
|
* * **Azure**: EVENTHUB and CONFLUENT
|
|
7307
|
+
*
|
|
7308
|
+
* * **GCP**: CONFLUENT
|
|
7140
7309
|
*/
|
|
7141
7310
|
vendor: string;
|
|
7142
7311
|
}
|
|
@@ -7166,7 +7335,9 @@ export interface GetStreamProcessorsResult {
|
|
|
7166
7335
|
*/
|
|
7167
7336
|
id: string;
|
|
7168
7337
|
/**
|
|
7169
|
-
*
|
|
7338
|
+
* Label that identifies the stream processing workspace.
|
|
7339
|
+
*
|
|
7340
|
+
* @deprecated This parameter is deprecated. Please transition to workspace_name.
|
|
7170
7341
|
*/
|
|
7171
7342
|
instanceName: string;
|
|
7172
7343
|
/**
|
|
@@ -7178,7 +7349,7 @@ export interface GetStreamProcessorsResult {
|
|
|
7178
7349
|
*/
|
|
7179
7350
|
pipeline: string;
|
|
7180
7351
|
/**
|
|
7181
|
-
*
|
|
7352
|
+
* Label that identifies the stream processor.
|
|
7182
7353
|
*/
|
|
7183
7354
|
processorName: string;
|
|
7184
7355
|
/**
|
|
@@ -7195,6 +7366,10 @@ export interface GetStreamProcessorsResult {
|
|
|
7195
7366
|
* The stats associated with the stream processor. Refer to the [MongoDB Atlas Docs](https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor) for more information.
|
|
7196
7367
|
*/
|
|
7197
7368
|
stats: string;
|
|
7369
|
+
/**
|
|
7370
|
+
* Label that identifies the stream processing workspace.
|
|
7371
|
+
*/
|
|
7372
|
+
workspaceName: string;
|
|
7198
7373
|
}
|
|
7199
7374
|
export interface GetStreamProcessorsResultOptions {
|
|
7200
7375
|
/**
|
|
@@ -7216,6 +7391,129 @@ export interface GetStreamProcessorsResultOptionsDlq {
|
|
|
7216
7391
|
*/
|
|
7217
7392
|
db: string;
|
|
7218
7393
|
}
|
|
7394
|
+
export interface GetStreamWorkspaceDataProcessRegion {
|
|
7395
|
+
/**
|
|
7396
|
+
* Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Streams/operation/creategroupstreamworkspace) describes the valid values.
|
|
7397
|
+
*/
|
|
7398
|
+
cloudProvider: string;
|
|
7399
|
+
/**
|
|
7400
|
+
* Name of the cloud provider region hosting Atlas Stream Processing. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Streams/operation/creategroupstreamworkspace) describes the valid values.
|
|
7401
|
+
*/
|
|
7402
|
+
region: string;
|
|
7403
|
+
}
|
|
7404
|
+
export interface GetStreamWorkspaceStreamConfig {
|
|
7405
|
+
maxTierSize: string;
|
|
7406
|
+
/**
|
|
7407
|
+
* Selected tier for the Stream Instance. Configures Memory / VCPU allowances. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Streams/operation/creategroupstreamworkspace) describes the valid values.
|
|
7408
|
+
*/
|
|
7409
|
+
tier: string;
|
|
7410
|
+
}
|
|
7411
|
+
export interface GetStreamWorkspacesResult {
|
|
7412
|
+
/**
|
|
7413
|
+
* Defines the cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
|
|
7414
|
+
*/
|
|
7415
|
+
dataProcessRegion: outputs.GetStreamWorkspacesResultDataProcessRegion;
|
|
7416
|
+
/**
|
|
7417
|
+
* List that contains the hostnames assigned to the stream workspace.
|
|
7418
|
+
*/
|
|
7419
|
+
hostnames: string[];
|
|
7420
|
+
id: string;
|
|
7421
|
+
/**
|
|
7422
|
+
* Unique 24-hexadecimal digit string that identifies your project.
|
|
7423
|
+
*/
|
|
7424
|
+
projectId: string;
|
|
7425
|
+
/**
|
|
7426
|
+
* Defines the configuration options for an Atlas Stream Processing Instance. See stream config
|
|
7427
|
+
*/
|
|
7428
|
+
streamConfig: outputs.GetStreamWorkspacesResultStreamConfig;
|
|
7429
|
+
/**
|
|
7430
|
+
* Label that identifies the stream workspace.
|
|
7431
|
+
*/
|
|
7432
|
+
workspaceName: string;
|
|
7433
|
+
}
|
|
7434
|
+
export interface GetStreamWorkspacesResultDataProcessRegion {
|
|
7435
|
+
/**
|
|
7436
|
+
* Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Streams/operation/creategroupstreamworkspace) describes the valid values.
|
|
7437
|
+
*/
|
|
7438
|
+
cloudProvider: string;
|
|
7439
|
+
/**
|
|
7440
|
+
* Name of the cloud provider region hosting Atlas Stream Processing. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Streams/operation/creategroupstreamworkspace) describes the valid values.
|
|
7441
|
+
*/
|
|
7442
|
+
region: string;
|
|
7443
|
+
}
|
|
7444
|
+
export interface GetStreamWorkspacesResultStreamConfig {
|
|
7445
|
+
maxTierSize: string;
|
|
7446
|
+
/**
|
|
7447
|
+
* Selected tier for the Stream Workspace. Configures Memory / VCPU allowances. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Streams/operation/creategroupstreamworkspace) describes the valid values.
|
|
7448
|
+
*/
|
|
7449
|
+
tier: string;
|
|
7450
|
+
}
|
|
7451
|
+
export interface GetTeamUser {
|
|
7452
|
+
/**
|
|
7453
|
+
* Two-character alphabetical string that identifies the MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.
|
|
7454
|
+
*/
|
|
7455
|
+
country: string;
|
|
7456
|
+
/**
|
|
7457
|
+
* Date and time when MongoDB Cloud created the current account. This value is in the ISO 8601 timestamp format in UTC.
|
|
7458
|
+
*/
|
|
7459
|
+
createdAt: string;
|
|
7460
|
+
/**
|
|
7461
|
+
* First or given name that belongs to the MongoDB Cloud user.
|
|
7462
|
+
*/
|
|
7463
|
+
firstName: string;
|
|
7464
|
+
/**
|
|
7465
|
+
* Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.
|
|
7466
|
+
*/
|
|
7467
|
+
id: string;
|
|
7468
|
+
/**
|
|
7469
|
+
* Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
|
|
7470
|
+
*/
|
|
7471
|
+
invitationCreatedAt: string;
|
|
7472
|
+
/**
|
|
7473
|
+
* Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
|
|
7474
|
+
*/
|
|
7475
|
+
invitationExpiresAt: string;
|
|
7476
|
+
/**
|
|
7477
|
+
* Username of the MongoDB Cloud user who sent the invitation to join the organization.
|
|
7478
|
+
*/
|
|
7479
|
+
inviterUsername: string;
|
|
7480
|
+
/**
|
|
7481
|
+
* Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.
|
|
7482
|
+
*/
|
|
7483
|
+
lastAuth: string;
|
|
7484
|
+
/**
|
|
7485
|
+
* Last name, family name, or surname that belongs to the MongoDB Cloud user.
|
|
7486
|
+
*/
|
|
7487
|
+
lastName: string;
|
|
7488
|
+
/**
|
|
7489
|
+
* Mobile phone number that belongs to the MongoDB Cloud user.
|
|
7490
|
+
*/
|
|
7491
|
+
mobileNumber: string;
|
|
7492
|
+
/**
|
|
7493
|
+
* String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or are already active in the organization.
|
|
7494
|
+
*/
|
|
7495
|
+
orgMembershipStatus: string;
|
|
7496
|
+
/**
|
|
7497
|
+
* Organization and project-level roles assigned to one MongoDB Cloud user within one organization.
|
|
7498
|
+
*/
|
|
7499
|
+
roles: outputs.GetTeamUserRole[];
|
|
7500
|
+
/**
|
|
7501
|
+
* List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.
|
|
7502
|
+
*/
|
|
7503
|
+
teamIds: string[];
|
|
7504
|
+
/**
|
|
7505
|
+
* Email address that represents the username of the MongoDB Cloud user.
|
|
7506
|
+
*/
|
|
7507
|
+
username: string;
|
|
7508
|
+
}
|
|
7509
|
+
export interface GetTeamUserRole {
|
|
7510
|
+
orgRoles: string[];
|
|
7511
|
+
projectRoleAssignments: outputs.GetTeamUserRoleProjectRoleAssignment[];
|
|
7512
|
+
}
|
|
7513
|
+
export interface GetTeamUserRoleProjectRoleAssignment {
|
|
7514
|
+
projectId: string;
|
|
7515
|
+
projectRoles: string[];
|
|
7516
|
+
}
|
|
7219
7517
|
export interface GetThirdPartyIntegrationsResult {
|
|
7220
7518
|
accountId: string;
|
|
7221
7519
|
/**
|
|
@@ -7596,6 +7894,16 @@ export interface SearchIndexSynonym {
|
|
|
7596
7894
|
*/
|
|
7597
7895
|
sourceCollection: string;
|
|
7598
7896
|
}
|
|
7897
|
+
export interface SearchIndexTypeSet {
|
|
7898
|
+
/**
|
|
7899
|
+
* Name of the type set.
|
|
7900
|
+
*/
|
|
7901
|
+
name: string;
|
|
7902
|
+
/**
|
|
7903
|
+
* JSON array describing the types.
|
|
7904
|
+
*/
|
|
7905
|
+
types?: string;
|
|
7906
|
+
}
|
|
7599
7907
|
export interface ServerlessInstanceLink {
|
|
7600
7908
|
href: string;
|
|
7601
7909
|
rel: string;
|
|
@@ -7614,13 +7922,37 @@ export interface ServerlessInstanceTag {
|
|
|
7614
7922
|
}
|
|
7615
7923
|
export interface StreamConnectionAuthentication {
|
|
7616
7924
|
/**
|
|
7617
|
-
*
|
|
7925
|
+
* Public identifier for the Kafka client.
|
|
7926
|
+
*/
|
|
7927
|
+
clientId?: string;
|
|
7928
|
+
/**
|
|
7929
|
+
* Secret known only to the Kafka client and the authorization server.
|
|
7930
|
+
*/
|
|
7931
|
+
clientSecret?: string;
|
|
7932
|
+
/**
|
|
7933
|
+
* Method of authentication. Value can be `PLAIN`, `SCRAM-256`, or `SCRAM-512`.
|
|
7618
7934
|
*/
|
|
7619
7935
|
mechanism?: string;
|
|
7936
|
+
/**
|
|
7937
|
+
* SASL OAUTHBEARER authentication method. Value must be OIDC.
|
|
7938
|
+
*/
|
|
7939
|
+
method?: string;
|
|
7620
7940
|
/**
|
|
7621
7941
|
* Password of the account to connect to the Kafka cluster.
|
|
7622
7942
|
*/
|
|
7623
7943
|
password?: string;
|
|
7944
|
+
/**
|
|
7945
|
+
* Additional information to provide to the Kafka broker.
|
|
7946
|
+
*/
|
|
7947
|
+
saslOauthbearerExtensions?: string;
|
|
7948
|
+
/**
|
|
7949
|
+
* Scope of the access request to the broker specified by the Kafka clients.
|
|
7950
|
+
*/
|
|
7951
|
+
scope?: string;
|
|
7952
|
+
/**
|
|
7953
|
+
* OAUTH issuer (IdP provider) token endpoint HTTP(S) URI used to retrieve the token.
|
|
7954
|
+
*/
|
|
7955
|
+
tokenEndpointUrl?: string;
|
|
7624
7956
|
/**
|
|
7625
7957
|
* Username of the account to connect to the Kafka cluster.
|
|
7626
7958
|
*/
|
|
@@ -7639,6 +7971,8 @@ export interface StreamConnectionDbRoleToExecute {
|
|
|
7639
7971
|
role: string;
|
|
7640
7972
|
/**
|
|
7641
7973
|
* Type of connection. Can be `AWSLambda`, `Cluster`, `Https`, `Kafka` or `Sample`.
|
|
7974
|
+
*
|
|
7975
|
+
* > **NOTE:** Either `workspaceName` or `instanceName` must be provided, but not both. These fields are functionally identical and `workspaceName` is an alias for `instanceName`. `workspaceName` should be used instead of `instanceName`.
|
|
7642
7976
|
*/
|
|
7643
7977
|
type: string;
|
|
7644
7978
|
}
|
|
@@ -7679,6 +8013,7 @@ export interface StreamInstanceDataProcessRegion {
|
|
|
7679
8013
|
region: string;
|
|
7680
8014
|
}
|
|
7681
8015
|
export interface StreamInstanceStreamConfig {
|
|
8016
|
+
maxTierSize: string;
|
|
7682
8017
|
/**
|
|
7683
8018
|
* Selected tier for the Stream Instance. Configures Memory / VCPU allowances. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Streams/operation/createStreamInstance) describes the valid values.
|
|
7684
8019
|
*/
|
|
@@ -7704,6 +8039,32 @@ export interface StreamProcessorOptionsDlq {
|
|
|
7704
8039
|
*/
|
|
7705
8040
|
db: string;
|
|
7706
8041
|
}
|
|
8042
|
+
export interface StreamProcessorTimeouts {
|
|
8043
|
+
/**
|
|
8044
|
+
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
|
|
8045
|
+
*/
|
|
8046
|
+
create?: string;
|
|
8047
|
+
}
|
|
8048
|
+
export interface StreamWorkspaceDataProcessRegion {
|
|
8049
|
+
/**
|
|
8050
|
+
* Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Streams/operation/creategroupstreamworkspace) describes the valid values.
|
|
8051
|
+
*/
|
|
8052
|
+
cloudProvider: string;
|
|
8053
|
+
/**
|
|
8054
|
+
* Name of the cloud provider region hosting Atlas Stream Processing. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Streams/operation/creategroupstreamworkspace) describes the valid values.
|
|
8055
|
+
*/
|
|
8056
|
+
region: string;
|
|
8057
|
+
}
|
|
8058
|
+
export interface StreamWorkspaceStreamConfig {
|
|
8059
|
+
/**
|
|
8060
|
+
* Max tier size for the Stream Workspace. Configures Memory / VCPU allowances.
|
|
8061
|
+
*/
|
|
8062
|
+
maxTierSize: string;
|
|
8063
|
+
/**
|
|
8064
|
+
* Selected tier for the Stream Workspace. Configures Memory / VCPU allowances. The [MongoDB Atlas API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Streams/operation/creategroupstreamworkspace) describes the valid values.
|
|
8065
|
+
*/
|
|
8066
|
+
tier: string;
|
|
8067
|
+
}
|
|
7707
8068
|
export interface X509AuthenticationDatabaseUserCertificate {
|
|
7708
8069
|
createdAt: string;
|
|
7709
8070
|
groupId: string;
|
|
@@ -7713,43 +8074,9 @@ export interface X509AuthenticationDatabaseUserCertificate {
|
|
|
7713
8074
|
}
|
|
7714
8075
|
export declare namespace config {
|
|
7715
8076
|
interface AssumeRole {
|
|
7716
|
-
/**
|
|
7717
|
-
* The duration, between 15 minutes and 12 hours, of the role session. Valid time units are ns, us (or µs), ms, s, h, or m.
|
|
7718
|
-
*/
|
|
7719
|
-
duration?: string;
|
|
7720
|
-
/**
|
|
7721
|
-
* A unique identifier that might be required when you assume a role in another account.
|
|
7722
|
-
*/
|
|
7723
|
-
externalId?: string;
|
|
7724
|
-
/**
|
|
7725
|
-
* IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.
|
|
7726
|
-
*/
|
|
7727
|
-
policy?: string;
|
|
7728
|
-
/**
|
|
7729
|
-
* Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed.
|
|
7730
|
-
*/
|
|
7731
|
-
policyArns?: string[];
|
|
7732
8077
|
/**
|
|
7733
8078
|
* Amazon Resource Name (ARN) of an IAM Role to assume prior to making API calls.
|
|
7734
8079
|
*/
|
|
7735
8080
|
roleArn?: string;
|
|
7736
|
-
/**
|
|
7737
|
-
* An identifier for the assumed role session.
|
|
7738
|
-
*/
|
|
7739
|
-
sessionName?: string;
|
|
7740
|
-
/**
|
|
7741
|
-
* Source identity specified by the principal assuming the role.
|
|
7742
|
-
*/
|
|
7743
|
-
sourceIdentity?: string;
|
|
7744
|
-
/**
|
|
7745
|
-
* Assume role session tags.
|
|
7746
|
-
*/
|
|
7747
|
-
tags?: {
|
|
7748
|
-
[key: string]: string;
|
|
7749
|
-
};
|
|
7750
|
-
/**
|
|
7751
|
-
* Assume role session tag keys to pass to any subsequent sessions.
|
|
7752
|
-
*/
|
|
7753
|
-
transitiveTagKeys?: string[];
|
|
7754
8081
|
}
|
|
7755
8082
|
}
|