Docs Packages
  1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. getThirdPartyIntegration
MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.getThirdPartyIntegration

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

    mongodbatlas.ThirdPartyIntegration describe a Third-Party Integration Settings for the given type.

    NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const testDatadog = new mongodbatlas.ThirdPartyIntegration("test_datadog", {
    projectId: "<PROJECT-ID>",
    type: "DATADOG",
    apiKey: "<API-KEY>",
    region: "<REGION>",
});
const test = mongodbatlas.getThirdPartyIntegrationOutput({
    projectId: testDatadog.projectId,
    type: "DATADOG",
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_datadog = mongodbatlas.ThirdPartyIntegration("test_datadog",
    project_id="<PROJECT-ID>",
    type="DATADOG",
    api_key="<API-KEY>",
    region="<REGION>")
test = mongodbatlas.get_third_party_integration_output(project_id=test_datadog.project_id,
    type="DATADOG")

    package main

import (
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		testDatadog, err := mongodbatlas.NewThirdPartyIntegration(ctx, "test_datadog", &mongodbatlas.ThirdPartyIntegrationArgs{
			ProjectId: pulumi.String("<PROJECT-ID>"),
			Type:      pulumi.String("DATADOG"),
			ApiKey:    pulumi.String("<API-KEY>"),
			Region:    pulumi.String("<REGION>"),
		})
		if err != nil {
			return err
		}
		_ = mongodbatlas.LookupThirdPartyIntegrationOutput(ctx, mongodbatlas.GetThirdPartyIntegrationOutputArgs{
			ProjectId: testDatadog.ProjectId,
			Type:      pulumi.String("DATADOG"),
		}, nil)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var testDatadog = new Mongodbatlas.ThirdPartyIntegration("test_datadog", new()
    {
        ProjectId = "<PROJECT-ID>",
        Type = "DATADOG",
        ApiKey = "<API-KEY>",
        Region = "<REGION>",
    });

    var test = Mongodbatlas.GetThirdPartyIntegration.Invoke(new()
    {
        ProjectId = testDatadog.ProjectId,
        Type = "DATADOG",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.ThirdPartyIntegration;
import com.pulumi.mongodbatlas.ThirdPartyIntegrationArgs;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetThirdPartyIntegrationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testDatadog = new ThirdPartyIntegration("testDatadog", ThirdPartyIntegrationArgs.builder()
            .projectId("<PROJECT-ID>")
            .type("DATADOG")
            .apiKey("<API-KEY>")
            .region("<REGION>")
            .build());

        final var test = MongodbatlasFunctions.getThirdPartyIntegration(GetThirdPartyIntegrationArgs.builder()
            .projectId(testDatadog.projectId())
            .type("DATADOG")
            .build());

    }
}

    resources:
  testDatadog:
    type: mongodbatlas:ThirdPartyIntegration
    name: test_datadog
    properties:
      projectId: <PROJECT-ID>
      type: DATADOG
      apiKey: <API-KEY>
      region: <REGION>
variables:
  test:
    fn::invoke:
      Function: mongodbatlas:getThirdPartyIntegration
      Arguments:
        projectId: ${testDatadog.projectId}
        type: DATADOG

    Using getThirdPartyIntegration

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getThirdPartyIntegration(args: GetThirdPartyIntegrationArgs, opts?: InvokeOptions): Promise<GetThirdPartyIntegrationResult>
function getThirdPartyIntegrationOutput(args: GetThirdPartyIntegrationOutputArgs, opts?: InvokeOptions): Output<GetThirdPartyIntegrationResult>
    def get_third_party_integration(enabled: Optional[bool] = None,
                                microsoft_teams_webhook_url: Optional[str] = None,
                                project_id: Optional[str] = None,
                                scheme: Optional[str] = None,
                                service_discovery: Optional[str] = None,
                                type: Optional[str] = None,
                                user_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetThirdPartyIntegrationResult
def get_third_party_integration_output(enabled: Optional[pulumi.Input[bool]] = None,
                                microsoft_teams_webhook_url: Optional[pulumi.Input[str]] = None,
                                project_id: Optional[pulumi.Input[str]] = None,
                                scheme: Optional[pulumi.Input[str]] = None,
                                service_discovery: Optional[pulumi.Input[str]] = None,
                                type: Optional[pulumi.Input[str]] = None,
                                user_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetThirdPartyIntegrationResult]
    func LookupThirdPartyIntegration(ctx *Context, args *LookupThirdPartyIntegrationArgs, opts ...InvokeOption) (*LookupThirdPartyIntegrationResult, error)
func LookupThirdPartyIntegrationOutput(ctx *Context, args *LookupThirdPartyIntegrationOutputArgs, opts ...InvokeOption) LookupThirdPartyIntegrationResultOutput

    > Note: This function is named LookupThirdPartyIntegration in the Go SDK.

    public static class GetThirdPartyIntegration 
{
    public static Task<GetThirdPartyIntegrationResult> InvokeAsync(GetThirdPartyIntegrationArgs args, InvokeOptions? opts = null)
    public static Output<GetThirdPartyIntegrationResult> Invoke(GetThirdPartyIntegrationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetThirdPartyIntegrationResult> getThirdPartyIntegration(GetThirdPartyIntegrationArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: mongodbatlas:index/getThirdPartyIntegration:getThirdPartyIntegration
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ProjectId string
    The unique ID for the project to get all Third-Party service integrations
    Type string
    Third-Party service integration type

    • PAGER_DUTY
    • DATADOG
    • OPS_GENIE
    • VICTOR_OPS
    • WEBHOOK
    • MICROSOFT_TEAMS
    • PROMETHEUS
    Enabled bool
    Whether your cluster has Prometheus enabled.
    MicrosoftTeamsWebhookUrl string
    Your Microsoft Teams incoming webhook URL.

    • PROMETHEUS
    Scheme string
    Your Prometheus protocol scheme configured for requests. Note This attribute is deprecated as it is not being used.

    Deprecated: This parameter is deprecated and will be removed in version 1.18.0.

    ServiceDiscovery string
    Indicates which service discovery method is used, either file or http.
    UserName string
    Your Prometheus username.
    ProjectId string
    The unique ID for the project to get all Third-Party service integrations
    Type string
    Third-Party service integration type

    • PAGER_DUTY
    • DATADOG
    • OPS_GENIE
    • VICTOR_OPS
    • WEBHOOK
    • MICROSOFT_TEAMS
    • PROMETHEUS
    Enabled bool
    Whether your cluster has Prometheus enabled.
    MicrosoftTeamsWebhookUrl string
    Your Microsoft Teams incoming webhook URL.

    • PROMETHEUS
    Scheme string
    Your Prometheus protocol scheme configured for requests. Note This attribute is deprecated as it is not being used.

    Deprecated: This parameter is deprecated and will be removed in version 1.18.0.

    ServiceDiscovery string
    Indicates which service discovery method is used, either file or http.
    UserName string
    Your Prometheus username.
    projectId String
    The unique ID for the project to get all Third-Party service integrations
    type String
    Third-Party service integration type

    • PAGER_DUTY
    • DATADOG
    • OPS_GENIE
    • VICTOR_OPS
    • WEBHOOK
    • MICROSOFT_TEAMS
    • PROMETHEUS
    enabled Boolean
    Whether your cluster has Prometheus enabled.
    microsoftTeamsWebhookUrl String
    Your Microsoft Teams incoming webhook URL.

    • PROMETHEUS
    scheme String
    Your Prometheus protocol scheme configured for requests. Note This attribute is deprecated as it is not being used.

    Deprecated: This parameter is deprecated and will be removed in version 1.18.0.

    serviceDiscovery String
    Indicates which service discovery method is used, either file or http.
    userName String
    Your Prometheus username.
    projectId string
    The unique ID for the project to get all Third-Party service integrations
    type string
    Third-Party service integration type

    • PAGER_DUTY
    • DATADOG
    • OPS_GENIE
    • VICTOR_OPS
    • WEBHOOK
    • MICROSOFT_TEAMS
    • PROMETHEUS
    enabled boolean
    Whether your cluster has Prometheus enabled.
    microsoftTeamsWebhookUrl string
    Your Microsoft Teams incoming webhook URL.

    • PROMETHEUS
    scheme string
    Your Prometheus protocol scheme configured for requests. Note This attribute is deprecated as it is not being used.

    Deprecated: This parameter is deprecated and will be removed in version 1.18.0.

    serviceDiscovery string
    Indicates which service discovery method is used, either file or http.
    userName string
    Your Prometheus username.
    project_id str
    The unique ID for the project to get all Third-Party service integrations
    type str
    Third-Party service integration type

    • PAGER_DUTY
    • DATADOG
    • OPS_GENIE
    • VICTOR_OPS
    • WEBHOOK
    • MICROSOFT_TEAMS
    • PROMETHEUS
    enabled bool
    Whether your cluster has Prometheus enabled.
    microsoft_teams_webhook_url str
    Your Microsoft Teams incoming webhook URL.

    • PROMETHEUS
    scheme str
    Your Prometheus protocol scheme configured for requests. Note This attribute is deprecated as it is not being used.

    Deprecated: This parameter is deprecated and will be removed in version 1.18.0.

    service_discovery str
    Indicates which service discovery method is used, either file or http.
    user_name str
    Your Prometheus username.
    projectId String
    The unique ID for the project to get all Third-Party service integrations
    type String
    Third-Party service integration type

    • PAGER_DUTY
    • DATADOG
    • OPS_GENIE
    • VICTOR_OPS
    • WEBHOOK
    • MICROSOFT_TEAMS
    • PROMETHEUS
    enabled Boolean
    Whether your cluster has Prometheus enabled.
    microsoftTeamsWebhookUrl String
    Your Microsoft Teams incoming webhook URL.

    • PROMETHEUS
    scheme String
    Your Prometheus protocol scheme configured for requests. Note This attribute is deprecated as it is not being used.

    Deprecated: This parameter is deprecated and will be removed in version 1.18.0.

    serviceDiscovery String
    Indicates which service discovery method is used, either file or http.
    userName String
    Your Prometheus username.

    getThirdPartyIntegration Result

    The following output properties are available:

    AccountId string
    ApiKey string
    Your API Key.
    ChannelName string
    Id string
    Unique identifier of the integration.
    ProjectId string
    Region string
    Two-letter code that indicates which API URL to use. See the region response field of MongoDB API Third-Party Service Integration documentation for more details. Opsgenie will use US by default.

    • VICTOR_OPS
    RoutingKey string
    An optional field for your Routing Key.

    • WEBHOOK
    Secret string
    An optional field for your webhook secret.

    • MICROSOFT_TEAMS
    ServiceKey string
    Your Service Key.

    • DATADOG
    TeamName string
    Type string
    Url string
    Your webhook URL.
    Enabled bool
    Whether your cluster has Prometheus enabled.
    MicrosoftTeamsWebhookUrl string
    Your Microsoft Teams incoming webhook URL.

    • PROMETHEUS
    Scheme string
    Your Prometheus protocol scheme configured for requests. Note This attribute is deprecated as it is not being used.

    Deprecated: This parameter is deprecated and will be removed in version 1.18.0.

    ServiceDiscovery string
    Indicates which service discovery method is used, either file or http.
    UserName string
    Your Prometheus username.
    AccountId string
    ApiKey string
    Your API Key.
    ChannelName string
    Id string
    Unique identifier of the integration.
    ProjectId string
    Region string
    Two-letter code that indicates which API URL to use. See the region response field of MongoDB API Third-Party Service Integration documentation for more details. Opsgenie will use US by default.

    • VICTOR_OPS
    RoutingKey string
    An optional field for your Routing Key.

    • WEBHOOK
    Secret string
    An optional field for your webhook secret.

    • MICROSOFT_TEAMS
    ServiceKey string
    Your Service Key.

    • DATADOG
    TeamName string
    Type string
    Url string
    Your webhook URL.
    Enabled bool
    Whether your cluster has Prometheus enabled.
    MicrosoftTeamsWebhookUrl string
    Your Microsoft Teams incoming webhook URL.

    • PROMETHEUS
    Scheme string
    Your Prometheus protocol scheme configured for requests. Note This attribute is deprecated as it is not being used.

    Deprecated: This parameter is deprecated and will be removed in version 1.18.0.

    ServiceDiscovery string
    Indicates which service discovery method is used, either file or http.
    UserName string
    Your Prometheus username.
    accountId String
    apiKey String
    Your API Key.
    channelName String
    id String
    Unique identifier of the integration.
    projectId String
    region String
    Two-letter code that indicates which API URL to use. See the region response field of MongoDB API Third-Party Service Integration documentation for more details. Opsgenie will use US by default.

    • VICTOR_OPS
    routingKey String
    An optional field for your Routing Key.

    • WEBHOOK
    secret String
    An optional field for your webhook secret.

    • MICROSOFT_TEAMS
    serviceKey String
    Your Service Key.

    • DATADOG
    teamName String
    type String
    url String
    Your webhook URL.
    enabled Boolean
    Whether your cluster has Prometheus enabled.
    microsoftTeamsWebhookUrl String
    Your Microsoft Teams incoming webhook URL.

    • PROMETHEUS
    scheme String
    Your Prometheus protocol scheme configured for requests. Note This attribute is deprecated as it is not being used.

    Deprecated: This parameter is deprecated and will be removed in version 1.18.0.

    serviceDiscovery String
    Indicates which service discovery method is used, either file or http.
    userName String
    Your Prometheus username.
    accountId string
    apiKey string
    Your API Key.
    channelName string
    id string
    Unique identifier of the integration.
    projectId string
    region string
    Two-letter code that indicates which API URL to use. See the region response field of MongoDB API Third-Party Service Integration documentation for more details. Opsgenie will use US by default.

    • VICTOR_OPS
    routingKey string
    An optional field for your Routing Key.

    • WEBHOOK
    secret string
    An optional field for your webhook secret.

    • MICROSOFT_TEAMS
    serviceKey string
    Your Service Key.

    • DATADOG
    teamName string
    type string
    url string
    Your webhook URL.
    enabled boolean
    Whether your cluster has Prometheus enabled.
    microsoftTeamsWebhookUrl string
    Your Microsoft Teams incoming webhook URL.

    • PROMETHEUS
    scheme string
    Your Prometheus protocol scheme configured for requests. Note This attribute is deprecated as it is not being used.

    Deprecated: This parameter is deprecated and will be removed in version 1.18.0.

    serviceDiscovery string
    Indicates which service discovery method is used, either file or http.
    userName string
    Your Prometheus username.
    account_id str
    api_key str
    Your API Key.
    channel_name str
    id str
    Unique identifier of the integration.
    project_id str
    region str
    Two-letter code that indicates which API URL to use. See the region response field of MongoDB API Third-Party Service Integration documentation for more details. Opsgenie will use US by default.

    • VICTOR_OPS
    routing_key str
    An optional field for your Routing Key.

    • WEBHOOK
    secret str
    An optional field for your webhook secret.

    • MICROSOFT_TEAMS
    service_key str
    Your Service Key.

    • DATADOG
    team_name str
    type str
    url str
    Your webhook URL.
    enabled bool
    Whether your cluster has Prometheus enabled.
    microsoft_teams_webhook_url str
    Your Microsoft Teams incoming webhook URL.

    • PROMETHEUS
    scheme str
    Your Prometheus protocol scheme configured for requests. Note This attribute is deprecated as it is not being used.

    Deprecated: This parameter is deprecated and will be removed in version 1.18.0.

    service_discovery str
    Indicates which service discovery method is used, either file or http.
    user_name str
    Your Prometheus username.
    accountId String
    apiKey String
    Your API Key.
    channelName String
    id String
    Unique identifier of the integration.
    projectId String
    region String
    Two-letter code that indicates which API URL to use. See the region response field of MongoDB API Third-Party Service Integration documentation for more details. Opsgenie will use US by default.

    • VICTOR_OPS
    routingKey String
    An optional field for your Routing Key.

    • WEBHOOK
    secret String
    An optional field for your webhook secret.

    • MICROSOFT_TEAMS
    serviceKey String
    Your Service Key.

    • DATADOG
    teamName String
    type String
    url String
    Your webhook URL.
    enabled Boolean
    Whether your cluster has Prometheus enabled.
    microsoftTeamsWebhookUrl String
    Your Microsoft Teams incoming webhook URL.

    • PROMETHEUS
    scheme String
    Your Prometheus protocol scheme configured for requests. Note This attribute is deprecated as it is not being used.

    Deprecated: This parameter is deprecated and will be removed in version 1.18.0.

    serviceDiscovery String
    Indicates which service discovery method is used, either file or http.
    userName String
    Your Prometheus username.

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi
    pulumi/pulumi-mongodbatlas