Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Opsgenie Provider
  3. API Docs
  4. EmailIntegration
Opsgenie v1.3.14 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-opsgenie

opsgenie.EmailIntegration

Explore with Pulumi AI

Opsgenie v1.3.14 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-opsgenie

Manages an Email Integration within Opsgenie.

Create EmailIntegration Resource

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

Constructor syntax

new EmailIntegration(name: string, args: EmailIntegrationArgs, opts?: CustomResourceOptions);
@overload
def EmailIntegration(resource_name: str,
                     args: EmailIntegrationArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def EmailIntegration(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     email_username: Optional[str] = None,
                     enabled: Optional[bool] = None,
                     ignore_responders_from_payload: Optional[bool] = None,
                     name: Optional[str] = None,
                     owner_team_id: Optional[str] = None,
                     responders: Optional[Sequence[EmailIntegrationResponderArgs]] = None,
                     suppress_notifications: Optional[bool] = None)
func NewEmailIntegration(ctx *Context, name string, args EmailIntegrationArgs, opts ...ResourceOption) (*EmailIntegration, error)
public EmailIntegration(string name, EmailIntegrationArgs args, CustomResourceOptions? opts = null)
public EmailIntegration(String name, EmailIntegrationArgs args)
public EmailIntegration(String name, EmailIntegrationArgs args, CustomResourceOptions options)

type: opsgenie:EmailIntegration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

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

var emailIntegrationResource = new Opsgenie.EmailIntegration("emailIntegrationResource", new()
{
    EmailUsername = "string",
    Enabled = false,
    IgnoreRespondersFromPayload = false,
    Name = "string",
    OwnerTeamId = "string",
    Responders = new[]
    {
        new Opsgenie.Inputs.EmailIntegrationResponderArgs
        {
            Id = "string",
            Type = "string",
        },
    },
    SuppressNotifications = false,
});
Copy
example, err := opsgenie.NewEmailIntegration(ctx, "emailIntegrationResource", &opsgenie.EmailIntegrationArgs{
	EmailUsername:               pulumi.String("string"),
	Enabled:                     pulumi.Bool(false),
	IgnoreRespondersFromPayload: pulumi.Bool(false),
	Name:                        pulumi.String("string"),
	OwnerTeamId:                 pulumi.String("string"),
	Responders: opsgenie.EmailIntegrationResponderArray{
		&opsgenie.EmailIntegrationResponderArgs{
			Id:   pulumi.String("string"),
			Type: pulumi.String("string"),
		},
	},
	SuppressNotifications: pulumi.Bool(false),
})
Copy
var emailIntegrationResource = new EmailIntegration("emailIntegrationResource", EmailIntegrationArgs.builder()
    .emailUsername("string")
    .enabled(false)
    .ignoreRespondersFromPayload(false)
    .name("string")
    .ownerTeamId("string")
    .responders(EmailIntegrationResponderArgs.builder()
        .id("string")
        .type("string")
        .build())
    .suppressNotifications(false)
    .build());
Copy
email_integration_resource = opsgenie.EmailIntegration("emailIntegrationResource",
    email_username="string",
    enabled=False,
    ignore_responders_from_payload=False,
    name="string",
    owner_team_id="string",
    responders=[{
        "id": "string",
        "type": "string",
    }],
    suppress_notifications=False)
Copy
const emailIntegrationResource = new opsgenie.EmailIntegration("emailIntegrationResource", {
    emailUsername: "string",
    enabled: false,
    ignoreRespondersFromPayload: false,
    name: "string",
    ownerTeamId: "string",
    responders: [{
        id: "string",
        type: "string",
    }],
    suppressNotifications: false,
});
Copy
type: opsgenie:EmailIntegration
properties:
    emailUsername: string
    enabled: false
    ignoreRespondersFromPayload: false
    name: string
    ownerTeamId: string
    responders:
        - id: string
          type: string
    suppressNotifications: false
Copy

EmailIntegration Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The EmailIntegration resource accepts the following input properties:

EmailUsername This property is required. string
The username part of the email address. It must be unique for each integration.
Enabled bool
A Member block as documented below.
IgnoreRespondersFromPayload bool
If enabled, the integration will ignore recipients sent in request payloads. Default: false.
Name string
Name of the integration. Name must be unique for each integration.
OwnerTeamId string
Owner team id of the integration.
Responders List<EmailIntegrationResponder>
SuppressNotifications bool
If enabled, notifications that come from alerts will be suppressed. Default: false.
EmailUsername This property is required. string
The username part of the email address. It must be unique for each integration.
Enabled bool
A Member block as documented below.
IgnoreRespondersFromPayload bool
If enabled, the integration will ignore recipients sent in request payloads. Default: false.
Name string
Name of the integration. Name must be unique for each integration.
OwnerTeamId string
Owner team id of the integration.
Responders []EmailIntegrationResponderArgs
SuppressNotifications bool
If enabled, notifications that come from alerts will be suppressed. Default: false.
emailUsername This property is required. String
The username part of the email address. It must be unique for each integration.
enabled Boolean
A Member block as documented below.
ignoreRespondersFromPayload Boolean
If enabled, the integration will ignore recipients sent in request payloads. Default: false.
name String
Name of the integration. Name must be unique for each integration.
ownerTeamId String
Owner team id of the integration.
responders List<EmailIntegrationResponder>
suppressNotifications Boolean
If enabled, notifications that come from alerts will be suppressed. Default: false.
emailUsername This property is required. string
The username part of the email address. It must be unique for each integration.
enabled boolean
A Member block as documented below.
ignoreRespondersFromPayload boolean
If enabled, the integration will ignore recipients sent in request payloads. Default: false.
name string
Name of the integration. Name must be unique for each integration.
ownerTeamId string
Owner team id of the integration.
responders EmailIntegrationResponder[]
suppressNotifications boolean
If enabled, notifications that come from alerts will be suppressed. Default: false.
email_username This property is required. str
The username part of the email address. It must be unique for each integration.
enabled bool
A Member block as documented below.
ignore_responders_from_payload bool
If enabled, the integration will ignore recipients sent in request payloads. Default: false.
name str
Name of the integration. Name must be unique for each integration.
owner_team_id str
Owner team id of the integration.
responders Sequence[EmailIntegrationResponderArgs]
suppress_notifications bool
If enabled, notifications that come from alerts will be suppressed. Default: false.
emailUsername This property is required. String
The username part of the email address. It must be unique for each integration.
enabled Boolean
A Member block as documented below.
ignoreRespondersFromPayload Boolean
If enabled, the integration will ignore recipients sent in request payloads. Default: false.
name String
Name of the integration. Name must be unique for each integration.
ownerTeamId String
Owner team id of the integration.
responders List<Property Map>
suppressNotifications Boolean
If enabled, notifications that come from alerts will be suppressed. Default: false.

Outputs

All input properties are implicitly available as output properties. Additionally, the EmailIntegration 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 EmailIntegration Resource

Get an existing EmailIntegration 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?: EmailIntegrationState, opts?: CustomResourceOptions): EmailIntegration
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        email_username: Optional[str] = None,
        enabled: Optional[bool] = None,
        ignore_responders_from_payload: Optional[bool] = None,
        name: Optional[str] = None,
        owner_team_id: Optional[str] = None,
        responders: Optional[Sequence[EmailIntegrationResponderArgs]] = None,
        suppress_notifications: Optional[bool] = None) -> EmailIntegration
func GetEmailIntegration(ctx *Context, name string, id IDInput, state *EmailIntegrationState, opts ...ResourceOption) (*EmailIntegration, error)
public static EmailIntegration Get(string name, Input<string> id, EmailIntegrationState? state, CustomResourceOptions? opts = null)
public static EmailIntegration get(String name, Output<String> id, EmailIntegrationState state, CustomResourceOptions options)
resources:  _:    type: opsgenie:EmailIntegration    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
EmailUsername string
The username part of the email address. It must be unique for each integration.
Enabled bool
A Member block as documented below.
IgnoreRespondersFromPayload bool
If enabled, the integration will ignore recipients sent in request payloads. Default: false.
Name string
Name of the integration. Name must be unique for each integration.
OwnerTeamId string
Owner team id of the integration.
Responders List<EmailIntegrationResponder>
SuppressNotifications bool
If enabled, notifications that come from alerts will be suppressed. Default: false.
EmailUsername string
The username part of the email address. It must be unique for each integration.
Enabled bool
A Member block as documented below.
IgnoreRespondersFromPayload bool
If enabled, the integration will ignore recipients sent in request payloads. Default: false.
Name string
Name of the integration. Name must be unique for each integration.
OwnerTeamId string
Owner team id of the integration.
Responders []EmailIntegrationResponderArgs
SuppressNotifications bool
If enabled, notifications that come from alerts will be suppressed. Default: false.
emailUsername String
The username part of the email address. It must be unique for each integration.
enabled Boolean
A Member block as documented below.
ignoreRespondersFromPayload Boolean
If enabled, the integration will ignore recipients sent in request payloads. Default: false.
name String
Name of the integration. Name must be unique for each integration.
ownerTeamId String
Owner team id of the integration.
responders List<EmailIntegrationResponder>
suppressNotifications Boolean
If enabled, notifications that come from alerts will be suppressed. Default: false.
emailUsername string
The username part of the email address. It must be unique for each integration.
enabled boolean
A Member block as documented below.
ignoreRespondersFromPayload boolean
If enabled, the integration will ignore recipients sent in request payloads. Default: false.
name string
Name of the integration. Name must be unique for each integration.
ownerTeamId string
Owner team id of the integration.
responders EmailIntegrationResponder[]
suppressNotifications boolean
If enabled, notifications that come from alerts will be suppressed. Default: false.
email_username str
The username part of the email address. It must be unique for each integration.
enabled bool
A Member block as documented below.
ignore_responders_from_payload bool
If enabled, the integration will ignore recipients sent in request payloads. Default: false.
name str
Name of the integration. Name must be unique for each integration.
owner_team_id str
Owner team id of the integration.
responders Sequence[EmailIntegrationResponderArgs]
suppress_notifications bool
If enabled, notifications that come from alerts will be suppressed. Default: false.
emailUsername String
The username part of the email address. It must be unique for each integration.
enabled Boolean
A Member block as documented below.
ignoreRespondersFromPayload Boolean
If enabled, the integration will ignore recipients sent in request payloads. Default: false.
name String
Name of the integration. Name must be unique for each integration.
ownerTeamId String
Owner team id of the integration.
responders List<Property Map>
suppressNotifications Boolean
If enabled, notifications that come from alerts will be suppressed. Default: false.

Supporting Types

EmailIntegrationResponder
, EmailIntegrationResponderArgs

Id string
The ID of the Opsgenie Email based Integration.
Type string
The responder type.
Id string
The ID of the Opsgenie Email based Integration.
Type string
The responder type.
id String
The ID of the Opsgenie Email based Integration.
type String
The responder type.
id string
The ID of the Opsgenie Email based Integration.
type string
The responder type.
id str
The ID of the Opsgenie Email based Integration.
type str
The responder type.
id String
The ID of the Opsgenie Email based Integration.
type String
The responder type.

Import

Email Integrations can be imported using the id, e.g.

$ pulumi import opsgenie:index/emailIntegration:EmailIntegration test id`
Copy

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

Package Details

Repository
Opsgenie pulumi/pulumi-opsgenie
License
Apache-2.0
Notes
This Pulumi package is based on the opsgenie Terraform Provider.
Opsgenie v1.3.14 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-opsgenie