mongodbatlas.ThirdPartyIntegration
Explore with Pulumi AI
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
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;
return await Deployment.RunAsync(() =>
{
var testDatadog = new Mongodbatlas.ThirdPartyIntegration("testDatadog", new()
{
ApiKey = "<API-KEY>",
ProjectId = "<PROJECT-ID>",
Region = "<REGION>",
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 {
_, err := mongodbatlas.NewThirdPartyIntegration(ctx, "testDatadog", &mongodbatlas.ThirdPartyIntegrationArgs{
ApiKey: pulumi.String("<API-KEY>"),
ProjectId: pulumi.String("<PROJECT-ID>"),
Region: pulumi.String("<REGION>"),
Type: pulumi.String("DATADOG"),
})
if err != nil {
return err
}
return nil
})
}
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()
.apiKey("<API-KEY>")
.projectId("<PROJECT-ID>")
.region("<REGION>")
.type("DATADOG")
.build());
}
}
import pulumi
import pulumi_mongodbatlas as mongodbatlas
test_datadog = mongodbatlas.ThirdPartyIntegration("testDatadog",
api_key="<API-KEY>",
project_id="<PROJECT-ID>",
region="<REGION>",
type="DATADOG")
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const testDatadog = new mongodbatlas.ThirdPartyIntegration("testDatadog", {
apiKey: "<API-KEY>",
projectId: "<PROJECT-ID>",
region: "<REGION>",
type: "DATADOG",
});
resources:
testDatadog:
type: mongodbatlas:ThirdPartyIntegration
properties:
apiKey: <API-KEY>
projectId: <PROJECT-ID>
region: <REGION>
type: DATADOG
Create ThirdPartyIntegration Resource
new ThirdPartyIntegration(name: string, args: ThirdPartyIntegrationArgs, opts?: CustomResourceOptions);
@overload
def ThirdPartyIntegration(resource_name: 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)
@overload
def ThirdPartyIntegration(resource_name: str,
args: ThirdPartyIntegrationArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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:
- Project
Id 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
- Api
Key string Your API Key.
- Channel
Name string - Enabled bool
Whether your cluster has Prometheus enabled.
- Microsoft
Teams stringWebhook Url Your Microsoft Teams incoming webhook URL.
- Password string
Your Prometheus password.
- Region string
Indicates which API URL to use, either "US" or "EU". OpsGenie will use "US" by default.
- Routing
Key string An optional field for your Routing Key.
- Scheme string
Your Prometheus protocol scheme configured for requests.
- Secret string
An optional field for your webhook secret.
- Service
Discovery string Indicates which service discovery method is used, either file or http.
- Service
Key string Your Service Key.
- Team
Name string - Url string
Your webhook URL.
- User
Name string Your Prometheus username.
- Project
Id 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
- Api
Key string Your API Key.
- Channel
Name string - Enabled bool
Whether your cluster has Prometheus enabled.
- Microsoft
Teams stringWebhook Url Your Microsoft Teams incoming webhook URL.
- Password string
Your Prometheus password.
- Region string
Indicates which API URL to use, either "US" or "EU". OpsGenie will use "US" by default.
- Routing
Key string An optional field for your Routing Key.
- Scheme string
Your Prometheus protocol scheme configured for requests.
- Secret string
An optional field for your webhook secret.
- Service
Discovery string Indicates which service discovery method is used, either file or http.
- Service
Key string Your Service Key.
- Team
Name string - Url string
Your webhook URL.
- User
Name string Your Prometheus username.
- project
Id 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
- api
Key String Your API Key.
- channel
Name String - enabled Boolean
Whether your cluster has Prometheus enabled.
- microsoft
Teams StringWebhook Url Your Microsoft Teams incoming webhook URL.
- password String
Your Prometheus password.
- region String
Indicates which API URL to use, either "US" or "EU". OpsGenie will use "US" by default.
- routing
Key String An optional field for your Routing Key.
- scheme String
Your Prometheus protocol scheme configured for requests.
- secret String
An optional field for your webhook secret.
- service
Discovery String Indicates which service discovery method is used, either file or http.
- service
Key String Your Service Key.
- team
Name String - url String
Your webhook URL.
- user
Name String Your Prometheus username.
- project
Id 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
- api
Key string Your API Key.
- channel
Name string - enabled boolean
Whether your cluster has Prometheus enabled.
- microsoft
Teams stringWebhook Url Your Microsoft Teams incoming webhook URL.
- password string
Your Prometheus password.
- region string
Indicates which API URL to use, either "US" or "EU". OpsGenie will use "US" by default.
- routing
Key string An optional field for your Routing Key.
- scheme string
Your Prometheus protocol scheme configured for requests.
- secret string
An optional field for your webhook secret.
- service
Discovery string Indicates which service discovery method is used, either file or http.
- service
Key string Your Service Key.
- team
Name string - url string
Your webhook URL.
- user
Name string Your Prometheus username.
- 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
- api_
key str Your API Key.
- channel_
name str - enabled bool
Whether your cluster has Prometheus enabled.
- microsoft_
teams_ strwebhook_ url Your Microsoft Teams incoming webhook URL.
- password str
Your Prometheus password.
- region str
Indicates which API URL to use, either "US" or "EU". OpsGenie will use "US" by default.
- routing_
key str An optional field for your Routing Key.
- scheme str
Your Prometheus protocol scheme configured for requests.
- secret str
An optional field for your webhook secret.
- service_
discovery str Indicates which service discovery method is used, either file or http.
- service_
key str Your Service Key.
- team_
name str - url str
Your webhook URL.
- user_
name str Your Prometheus username.
- project
Id 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
- api
Key String Your API Key.
- channel
Name String - enabled Boolean
Whether your cluster has Prometheus enabled.
- microsoft
Teams StringWebhook Url Your Microsoft Teams incoming webhook URL.
- password String
Your Prometheus password.
- region String
Indicates which API URL to use, either "US" or "EU". OpsGenie will use "US" by default.
- routing
Key String An optional field for your Routing Key.
- scheme String
Your Prometheus protocol scheme configured for requests.
- secret String
An optional field for your webhook secret.
- service
Discovery String Indicates which service discovery method is used, either file or http.
- service
Key String Your Service Key.
- team
Name String - url String
Your webhook URL.
- user
Name String Your Prometheus username.
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.
- Api
Key string Your API Key.
- Channel
Name string - Enabled bool
Whether your cluster has Prometheus enabled.
- Microsoft
Teams stringWebhook Url Your Microsoft Teams incoming webhook URL.
- Password string
Your Prometheus password.
- Project
Id string The unique ID for the project to get all Third-Party service integrations
- Region string
Indicates which API URL to use, either "US" or "EU". OpsGenie will use "US" by default.
- Routing
Key string An optional field for your Routing Key.
- Scheme string
Your Prometheus protocol scheme configured for requests.
- Secret string
An optional field for your webhook secret.
- Service
Discovery string Indicates which service discovery method is used, either file or http.
- Service
Key string Your Service Key.
- Team
Name string - Type string
Third-Party Integration Settings type
- PAGER_DUTY
- DATADOG
- OPS_GENIE
- VICTOR_OPS
- WEBHOOK
- MICROSOFT_TEAMS
- PROMETHEUS
- Url string
Your webhook URL.
- User
Name string Your Prometheus username.
- Api
Key string Your API Key.
- Channel
Name string - Enabled bool
Whether your cluster has Prometheus enabled.
- Microsoft
Teams stringWebhook Url Your Microsoft Teams incoming webhook URL.
- Password string
Your Prometheus password.
- Project
Id string The unique ID for the project to get all Third-Party service integrations
- Region string
Indicates which API URL to use, either "US" or "EU". OpsGenie will use "US" by default.
- Routing
Key string An optional field for your Routing Key.
- Scheme string
Your Prometheus protocol scheme configured for requests.
- Secret string
An optional field for your webhook secret.
- Service
Discovery string Indicates which service discovery method is used, either file or http.
- Service
Key string Your Service Key.
- Team
Name string - Type string
Third-Party Integration Settings type
- PAGER_DUTY
- DATADOG
- OPS_GENIE
- VICTOR_OPS
- WEBHOOK
- MICROSOFT_TEAMS
- PROMETHEUS
- Url string
Your webhook URL.
- User
Name string Your Prometheus username.
- api
Key String Your API Key.
- channel
Name String - enabled Boolean
Whether your cluster has Prometheus enabled.
- microsoft
Teams StringWebhook Url Your Microsoft Teams incoming webhook URL.
- password String
Your Prometheus password.
- project
Id String The unique ID for the project to get all Third-Party service integrations
- region String
Indicates which API URL to use, either "US" or "EU". OpsGenie will use "US" by default.
- routing
Key String An optional field for your Routing Key.
- scheme String
Your Prometheus protocol scheme configured for requests.
- secret String
An optional field for your webhook secret.
- service
Discovery String Indicates which service discovery method is used, either file or http.
- service
Key String Your Service Key.
- team
Name String - type String
Third-Party Integration Settings type
- PAGER_DUTY
- DATADOG
- OPS_GENIE
- VICTOR_OPS
- WEBHOOK
- MICROSOFT_TEAMS
- PROMETHEUS
- url String
Your webhook URL.
- user
Name String Your Prometheus username.
- api
Key string Your API Key.
- channel
Name string - enabled boolean
Whether your cluster has Prometheus enabled.
- microsoft
Teams stringWebhook Url Your Microsoft Teams incoming webhook URL.
- password string
Your Prometheus password.
- project
Id string The unique ID for the project to get all Third-Party service integrations
- region string
Indicates which API URL to use, either "US" or "EU". OpsGenie will use "US" by default.
- routing
Key string An optional field for your Routing Key.
- scheme string
Your Prometheus protocol scheme configured for requests.
- secret string
An optional field for your webhook secret.
- service
Discovery string Indicates which service discovery method is used, either file or http.
- service
Key string Your Service Key.
- team
Name string - type string
Third-Party Integration Settings type
- PAGER_DUTY
- DATADOG
- OPS_GENIE
- VICTOR_OPS
- WEBHOOK
- MICROSOFT_TEAMS
- PROMETHEUS
- url string
Your webhook URL.
- user
Name string Your Prometheus username.
- api_
key str Your API Key.
- channel_
name str - enabled bool
Whether your cluster has Prometheus enabled.
- microsoft_
teams_ strwebhook_ url Your Microsoft Teams incoming webhook URL.
- password str
Your Prometheus password.
- project_
id str The unique ID for the project to get all Third-Party service integrations
- region str
Indicates which API URL to use, either "US" or "EU". OpsGenie will use "US" by default.
- routing_
key str An optional field for your Routing Key.
- scheme str
Your Prometheus protocol scheme configured for requests.
- secret str
An optional field for your webhook secret.
- service_
discovery str Indicates which service discovery method is used, either file or http.
- service_
key str Your Service Key.
- team_
name str - type str
Third-Party Integration Settings type
- PAGER_DUTY
- DATADOG
- OPS_GENIE
- VICTOR_OPS
- WEBHOOK
- MICROSOFT_TEAMS
- PROMETHEUS
- url str
Your webhook URL.
- user_
name str Your Prometheus username.
- api
Key String Your API Key.
- channel
Name String - enabled Boolean
Whether your cluster has Prometheus enabled.
- microsoft
Teams StringWebhook Url Your Microsoft Teams incoming webhook URL.
- password String
Your Prometheus password.
- project
Id String The unique ID for the project to get all Third-Party service integrations
- region String
Indicates which API URL to use, either "US" or "EU". OpsGenie will use "US" by default.
- routing
Key String An optional field for your Routing Key.
- scheme String
Your Prometheus protocol scheme configured for requests.
- secret String
An optional field for your webhook secret.
- service
Discovery String Indicates which service discovery method is used, either file or http.
- service
Key String Your Service Key.
- team
Name String - type String
Third-Party Integration Settings type
- PAGER_DUTY
- DATADOG
- OPS_GENIE
- VICTOR_OPS
- WEBHOOK
- MICROSOFT_TEAMS
- PROMETHEUS
- url String
Your webhook URL.
- user
Name String Your Prometheus username.
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 my_user 1112222b3bf99403840e8934-OPS_GENIE
See MongoDB Atlas API Documentation for more information.
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
mongodbatlas
Terraform Provider.