1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. ThirdPartyIntegration
MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi

mongodbatlas.ThirdPartyIntegration

Explore with Pulumi AI

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

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

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

    NOTE: Slack integrations now use the OAuth2 verification method and must be initially configured, or updated from a legacy integration, through the Atlas third-party service integrations page. Legacy tokens will soon no longer be supported.Read more about slack setup

    IMPORTANT Each project can only have one configuration per {INTEGRATION-TYPE}.

    IMPORTANT: All arguments including the secrets will be stored in the raw state as plain-text. Read more about sensitive data in state.

    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>",
    });
    
    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>")
    
    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 {
    		_, 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
    		}
    		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>",
        });
    
    });
    
    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 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());
    
        }
    }
    
    resources:
      testDatadog:
        type: mongodbatlas:ThirdPartyIntegration
        name: test_datadog
        properties:
          projectId: <PROJECT-ID>
          type: DATADOG
          apiKey: <API-KEY>
          region: <REGION>
    

    Create ThirdPartyIntegration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ThirdPartyIntegration(name: string, args: ThirdPartyIntegrationArgs, opts?: CustomResourceOptions);
    @overload
    def ThirdPartyIntegration(resource_name: str,
                              args: ThirdPartyIntegrationArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def ThirdPartyIntegration(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              project_id: Optional[str] = None,
                              type: Optional[str] = None,
                              scheme: Optional[str] = None,
                              secret: Optional[str] = None,
                              password: Optional[str] = None,
                              enabled: Optional[bool] = None,
                              region: Optional[str] = None,
                              routing_key: Optional[str] = None,
                              api_key: Optional[str] = None,
                              microsoft_teams_webhook_url: Optional[str] = None,
                              service_discovery: Optional[str] = None,
                              service_key: Optional[str] = None,
                              team_name: Optional[str] = None,
                              channel_name: Optional[str] = None,
                              url: Optional[str] = None,
                              user_name: Optional[str] = None)
    func NewThirdPartyIntegration(ctx *Context, name string, args ThirdPartyIntegrationArgs, opts ...ResourceOption) (*ThirdPartyIntegration, error)
    public ThirdPartyIntegration(string name, ThirdPartyIntegrationArgs args, CustomResourceOptions? opts = null)
    public ThirdPartyIntegration(String name, ThirdPartyIntegrationArgs args)
    public ThirdPartyIntegration(String name, ThirdPartyIntegrationArgs args, CustomResourceOptions options)
    
    type: mongodbatlas:ThirdPartyIntegration
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ThirdPartyIntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ThirdPartyIntegrationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ThirdPartyIntegrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ThirdPartyIntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ThirdPartyIntegrationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var thirdPartyIntegrationResource = new Mongodbatlas.ThirdPartyIntegration("thirdPartyIntegrationResource", new()
    {
        ProjectId = "string",
        Type = "string",
        Secret = "string",
        Password = "string",
        Enabled = false,
        Region = "string",
        RoutingKey = "string",
        ApiKey = "string",
        MicrosoftTeamsWebhookUrl = "string",
        ServiceDiscovery = "string",
        ServiceKey = "string",
        TeamName = "string",
        ChannelName = "string",
        Url = "string",
        UserName = "string",
    });
    
    example, err := mongodbatlas.NewThirdPartyIntegration(ctx, "thirdPartyIntegrationResource", &mongodbatlas.ThirdPartyIntegrationArgs{
    	ProjectId:                pulumi.String("string"),
    	Type:                     pulumi.String("string"),
    	Secret:                   pulumi.String("string"),
    	Password:                 pulumi.String("string"),
    	Enabled:                  pulumi.Bool(false),
    	Region:                   pulumi.String("string"),
    	RoutingKey:               pulumi.String("string"),
    	ApiKey:                   pulumi.String("string"),
    	MicrosoftTeamsWebhookUrl: pulumi.String("string"),
    	ServiceDiscovery:         pulumi.String("string"),
    	ServiceKey:               pulumi.String("string"),
    	TeamName:                 pulumi.String("string"),
    	ChannelName:              pulumi.String("string"),
    	Url:                      pulumi.String("string"),
    	UserName:                 pulumi.String("string"),
    })
    
    var thirdPartyIntegrationResource = new ThirdPartyIntegration("thirdPartyIntegrationResource", ThirdPartyIntegrationArgs.builder()
        .projectId("string")
        .type("string")
        .secret("string")
        .password("string")
        .enabled(false)
        .region("string")
        .routingKey("string")
        .apiKey("string")
        .microsoftTeamsWebhookUrl("string")
        .serviceDiscovery("string")
        .serviceKey("string")
        .teamName("string")
        .channelName("string")
        .url("string")
        .userName("string")
        .build());
    
    third_party_integration_resource = mongodbatlas.ThirdPartyIntegration("thirdPartyIntegrationResource",
        project_id="string",
        type="string",
        secret="string",
        password="string",
        enabled=False,
        region="string",
        routing_key="string",
        api_key="string",
        microsoft_teams_webhook_url="string",
        service_discovery="string",
        service_key="string",
        team_name="string",
        channel_name="string",
        url="string",
        user_name="string")
    
    const thirdPartyIntegrationResource = new mongodbatlas.ThirdPartyIntegration("thirdPartyIntegrationResource", {
        projectId: "string",
        type: "string",
        secret: "string",
        password: "string",
        enabled: false,
        region: "string",
        routingKey: "string",
        apiKey: "string",
        microsoftTeamsWebhookUrl: "string",
        serviceDiscovery: "string",
        serviceKey: "string",
        teamName: "string",
        channelName: "string",
        url: "string",
        userName: "string",
    });
    
    type: mongodbatlas:ThirdPartyIntegration
    properties:
        apiKey: string
        channelName: string
        enabled: false
        microsoftTeamsWebhookUrl: string
        password: string
        projectId: string
        region: string
        routingKey: string
        secret: string
        serviceDiscovery: string
        serviceKey: string
        teamName: string
        type: string
        url: string
        userName: string
    

    ThirdPartyIntegration Resource Properties

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

    Inputs

    The ThirdPartyIntegration resource accepts the following input properties:

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

    Third-Party Integration Settings type

    • PAGER_DUTY

    • DATADOG

    • OPS_GENIE

    • VICTOR_OPS

    • WEBHOOK

    • MICROSOFT_TEAMS

    • PROMETHEUS

    • PAGER_DUTY

    ApiKey string
    ChannelName string
    Enabled bool
    MicrosoftTeamsWebhookUrl string
    Password string
    Region string
    RoutingKey string
    Scheme string

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

    Secret string
    ServiceDiscovery string
    ServiceKey string
    TeamName string
    Url string
    UserName string
    ProjectId string
    The unique ID for the project to get all Third-Party service integrations
    Type string

    Third-Party Integration Settings type

    • PAGER_DUTY

    • DATADOG

    • OPS_GENIE

    • VICTOR_OPS

    • WEBHOOK

    • MICROSOFT_TEAMS

    • PROMETHEUS

    • PAGER_DUTY

    ApiKey string
    ChannelName string
    Enabled bool
    MicrosoftTeamsWebhookUrl string
    Password string
    Region string
    RoutingKey string
    Scheme string

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

    Secret string
    ServiceDiscovery string
    ServiceKey string
    TeamName string
    Url string
    UserName string
    projectId String
    The unique ID for the project to get all Third-Party service integrations
    type String

    Third-Party Integration Settings type

    • PAGER_DUTY

    • DATADOG

    • OPS_GENIE

    • VICTOR_OPS

    • WEBHOOK

    • MICROSOFT_TEAMS

    • PROMETHEUS

    • PAGER_DUTY

    apiKey String
    channelName String
    enabled Boolean
    microsoftTeamsWebhookUrl String
    password String
    region String
    routingKey String
    scheme String

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

    secret String
    serviceDiscovery String
    serviceKey String
    teamName String
    url String
    userName String
    projectId string
    The unique ID for the project to get all Third-Party service integrations
    type string

    Third-Party Integration Settings type

    • PAGER_DUTY

    • DATADOG

    • OPS_GENIE

    • VICTOR_OPS

    • WEBHOOK

    • MICROSOFT_TEAMS

    • PROMETHEUS

    • PAGER_DUTY

    apiKey string
    channelName string
    enabled boolean
    microsoftTeamsWebhookUrl string
    password string
    region string
    routingKey string
    scheme string

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

    secret string
    serviceDiscovery string
    serviceKey string
    teamName string
    url string
    userName string
    project_id str
    The unique ID for the project to get all Third-Party service integrations
    type str

    Third-Party Integration Settings type

    • PAGER_DUTY

    • DATADOG

    • OPS_GENIE

    • VICTOR_OPS

    • WEBHOOK

    • MICROSOFT_TEAMS

    • PROMETHEUS

    • PAGER_DUTY

    api_key str
    channel_name str
    enabled bool
    microsoft_teams_webhook_url str
    password str
    region str
    routing_key str
    scheme str

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

    secret str
    service_discovery str
    service_key str
    team_name str
    url str
    user_name str
    projectId String
    The unique ID for the project to get all Third-Party service integrations
    type String

    Third-Party Integration Settings type

    • PAGER_DUTY

    • DATADOG

    • OPS_GENIE

    • VICTOR_OPS

    • WEBHOOK

    • MICROSOFT_TEAMS

    • PROMETHEUS

    • PAGER_DUTY

    apiKey String
    channelName String
    enabled Boolean
    microsoftTeamsWebhookUrl String
    password String
    region String
    routingKey String
    scheme String

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

    secret String
    serviceDiscovery String
    serviceKey String
    teamName String
    url String
    userName String

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ThirdPartyIntegration Resource

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

    public static get(name: string, id: Input<ID>, state?: ThirdPartyIntegrationState, opts?: CustomResourceOptions): ThirdPartyIntegration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_key: Optional[str] = None,
            channel_name: Optional[str] = None,
            enabled: Optional[bool] = None,
            microsoft_teams_webhook_url: Optional[str] = None,
            password: Optional[str] = None,
            project_id: Optional[str] = None,
            region: Optional[str] = None,
            routing_key: Optional[str] = None,
            scheme: Optional[str] = None,
            secret: Optional[str] = None,
            service_discovery: Optional[str] = None,
            service_key: Optional[str] = None,
            team_name: Optional[str] = None,
            type: Optional[str] = None,
            url: Optional[str] = None,
            user_name: Optional[str] = None) -> ThirdPartyIntegration
    func GetThirdPartyIntegration(ctx *Context, name string, id IDInput, state *ThirdPartyIntegrationState, opts ...ResourceOption) (*ThirdPartyIntegration, error)
    public static ThirdPartyIntegration Get(string name, Input<string> id, ThirdPartyIntegrationState? state, CustomResourceOptions? opts = null)
    public static ThirdPartyIntegration get(String name, Output<String> id, ThirdPartyIntegrationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiKey string
    ChannelName string
    Enabled bool
    MicrosoftTeamsWebhookUrl string
    Password string
    ProjectId string
    The unique ID for the project to get all Third-Party service integrations
    Region string
    RoutingKey string
    Scheme string

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

    Secret string
    ServiceDiscovery string
    ServiceKey string
    TeamName string
    Type string

    Third-Party Integration Settings type

    • PAGER_DUTY

    • DATADOG

    • OPS_GENIE

    • VICTOR_OPS

    • WEBHOOK

    • MICROSOFT_TEAMS

    • PROMETHEUS

    • PAGER_DUTY

    Url string
    UserName string
    ApiKey string
    ChannelName string
    Enabled bool
    MicrosoftTeamsWebhookUrl string
    Password string
    ProjectId string
    The unique ID for the project to get all Third-Party service integrations
    Region string
    RoutingKey string
    Scheme string

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

    Secret string
    ServiceDiscovery string
    ServiceKey string
    TeamName string
    Type string

    Third-Party Integration Settings type

    • PAGER_DUTY

    • DATADOG

    • OPS_GENIE

    • VICTOR_OPS

    • WEBHOOK

    • MICROSOFT_TEAMS

    • PROMETHEUS

    • PAGER_DUTY

    Url string
    UserName string
    apiKey String
    channelName String
    enabled Boolean
    microsoftTeamsWebhookUrl String
    password String
    projectId String
    The unique ID for the project to get all Third-Party service integrations
    region String
    routingKey String
    scheme String

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

    secret String
    serviceDiscovery String
    serviceKey String
    teamName String
    type String

    Third-Party Integration Settings type

    • PAGER_DUTY

    • DATADOG

    • OPS_GENIE

    • VICTOR_OPS

    • WEBHOOK

    • MICROSOFT_TEAMS

    • PROMETHEUS

    • PAGER_DUTY

    url String
    userName String
    apiKey string
    channelName string
    enabled boolean
    microsoftTeamsWebhookUrl string
    password string
    projectId string
    The unique ID for the project to get all Third-Party service integrations
    region string
    routingKey string
    scheme string

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

    secret string
    serviceDiscovery string
    serviceKey string
    teamName string
    type string

    Third-Party Integration Settings type

    • PAGER_DUTY

    • DATADOG

    • OPS_GENIE

    • VICTOR_OPS

    • WEBHOOK

    • MICROSOFT_TEAMS

    • PROMETHEUS

    • PAGER_DUTY

    url string
    userName string
    api_key str
    channel_name str
    enabled bool
    microsoft_teams_webhook_url str
    password str
    project_id str
    The unique ID for the project to get all Third-Party service integrations
    region str
    routing_key str
    scheme str

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

    secret str
    service_discovery str
    service_key str
    team_name str
    type str

    Third-Party Integration Settings type

    • PAGER_DUTY

    • DATADOG

    • OPS_GENIE

    • VICTOR_OPS

    • WEBHOOK

    • MICROSOFT_TEAMS

    • PROMETHEUS

    • PAGER_DUTY

    url str
    user_name str
    apiKey String
    channelName String
    enabled Boolean
    microsoftTeamsWebhookUrl String
    password String
    projectId String
    The unique ID for the project to get all Third-Party service integrations
    region String
    routingKey String
    scheme String

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

    secret String
    serviceDiscovery String
    serviceKey String
    teamName String
    type String

    Third-Party Integration Settings type

    • PAGER_DUTY

    • DATADOG

    • OPS_GENIE

    • VICTOR_OPS

    • WEBHOOK

    • MICROSOFT_TEAMS

    • PROMETHEUS

    • PAGER_DUTY

    url String
    userName String

    Import

    Third-Party Integration Settings can be imported using project ID and the integration type, in the format project_id-type, e.g.

    $ pulumi import mongodbatlas:index/thirdPartyIntegration:ThirdPartyIntegration test_datadog 1112222b3bf99403840e8934-DATADOG
    

    See MongoDB Atlas API Documentation for more information.

    To learn more about importing existing cloud resources, see Importing resources.

    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