Skip to main content

EmailIntegration

Resource EmailIntegration in pulumi-better-uptime.
24 min read

Resource EmailIntegration in pulumi-better-uptime.

Pulumi type: better-uptime:index/emailIntegration:EmailIntegration.

name is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.

Example#

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

Arguments#

PropertyTypeRequiredDescription
acknowledgedAlertIdFieldEmailIntegrationAcknowledgedAlertIdField (input)noWhen acknowledging an incident, how to extract an alert id, a unique alert identifier which will be used to acknowledge and resolve incidents.
acknowledgedRuleTypestringyesShould an incident be acknowledged for all emails, those satisfying all acknowledged_rules, or those satisfying any of them. Valid values are unused, all, or any
acknowledgedRulesEmailIntegrationAcknowledgedRule (input)[]noAn array of rules to match to acknowledge an incident.
callbooleannoWhether to call when a new incident is created.
causeFieldEmailIntegrationCauseField (input)noA field describing how to extract an incident cause, used as a short description shared with the team member on-call.
criticalAlertbooleannoWhether to send a critical push notification that ignores the mute switch and Do not Disturb mode when a new incident is created.
emailbooleannoWhether to send an email when a new incident is created.
namestringnoThe name of this Email integration.
otherAcknowledgedFieldsEmailIntegrationOtherAcknowledgedField (input)[]noAn array of additional fields, which will be extracted when acknowledging an incident.
otherResolvedFieldsEmailIntegrationOtherResolvedField (input)[]noAn array of additional fields, which will be extracted when resolving an incident.
otherStartedFieldsEmailIntegrationOtherStartedField (input)[]noAn array of additional fields, which will be extracted when starting an incident.
pausedbooleannoSet to true to pause monitoring - we won't notify you about downtime. Set to false to resume monitoring.
policyIdstringnoID of the escalation policy associated with the email integration.
pushbooleannoWhether to send a push notification when a new incident is created.
recoveryPeriodnumbernoHow long the integration must be up to automatically mark an incident as resolved after being down.
resolvedAlertIdFieldEmailIntegrationResolvedAlertIdField (input)noWhen resolving an incident, how to extract an alert id, a unique alert identifier which will be used to acknowledge and resolve incidents.
resolvedRuleTypestringyesShould an incident be resolved for all emails, those satisfying all resolved_rules, or those satisfying any of them. Valid values are unused, all, or any
resolvedRulesEmailIntegrationResolvedRule (input)[]noAn array of rules to match to resolved an incident.
smsbooleannoWhether to send an SMS when a new incident is created.
startedAlertIdFieldEmailIntegrationStartedAlertIdField (input)noWhen starting an incident, how to extract an alert id, a unique alert identifier which will be used to acknowledge and resolve incidents.
startedRuleTypestringyesShould an incident be started for all emails, those satisfying all started_rules, or those satisfying any of them. Valid values are unused, all, or any
startedRulesEmailIntegrationStartedRule (input)[]noAn array of rules to match to start a new incident.
teamNamestringnoUsed to specify the team the resource should be created in when using global tokens. You can't update this value later.
teamWaitnumbernoHow long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team.
titleFieldEmailIntegrationTitleField (input)noAn optional field describing how to extract a customized incident title.

Outputs#

Computed outputs are produced by the provider. They are not constructor arguments.

PropertyTypeComputedDescription
acknowledgedAlertIdFieldEmailIntegrationAcknowledgedAlertIdField (output)noWhen acknowledging an incident, how to extract an alert id, a unique alert identifier which will be used to acknowledge and resolve incidents.
acknowledgedRuleTypestringnoShould an incident be acknowledged for all emails, those satisfying all acknowledged_rules, or those satisfying any of them. Valid values are unused, all, or any
acknowledgedRulesEmailIntegrationAcknowledgedRule (output)[]noAn array of rules to match to acknowledge an incident.
callbooleannoWhether to call when a new incident is created.
causeFieldEmailIntegrationCauseField (output)noA field describing how to extract an incident cause, used as a short description shared with the team member on-call.
createdAtstringyesThe time when this email integration was created.
criticalAlertbooleannoWhether to send a critical push notification that ignores the mute switch and Do not Disturb mode when a new incident is created.
emailbooleannoWhether to send an email when a new incident is created.
emailAddressstringyesThe email address we expect emails to receive at.
namestringnoThe name of this Email integration.
otherAcknowledgedFieldsEmailIntegrationOtherAcknowledgedField (output)[]noAn array of additional fields, which will be extracted when acknowledging an incident.
otherResolvedFieldsEmailIntegrationOtherResolvedField (output)[]noAn array of additional fields, which will be extracted when resolving an incident.
otherStartedFieldsEmailIntegrationOtherStartedField (output)[]noAn array of additional fields, which will be extracted when starting an incident.
pausedbooleannoSet to true to pause monitoring - we won't notify you about downtime. Set to false to resume monitoring.
policyIdstringnoID of the escalation policy associated with the email integration.
pushbooleannoWhether to send a push notification when a new incident is created.
recoveryPeriodnumbernoHow long the integration must be up to automatically mark an incident as resolved after being down.
resolvedAlertIdFieldEmailIntegrationResolvedAlertIdField (output)noWhen resolving an incident, how to extract an alert id, a unique alert identifier which will be used to acknowledge and resolve incidents.
resolvedRuleTypestringnoShould an incident be resolved for all emails, those satisfying all resolved_rules, or those satisfying any of them. Valid values are unused, all, or any
resolvedRulesEmailIntegrationResolvedRule (output)[]noAn array of rules to match to resolved an incident.
smsbooleannoWhether to send an SMS when a new incident is created.
startedAlertIdFieldEmailIntegrationStartedAlertIdField (output)noWhen starting an incident, how to extract an alert id, a unique alert identifier which will be used to acknowledge and resolve incidents.
startedRuleTypestringnoShould an incident be started for all emails, those satisfying all started_rules, or those satisfying any of them. Valid values are unused, all, or any
startedRulesEmailIntegrationStartedRule (output)[]noAn array of rules to match to start a new incident.
teamNamestringnoUsed to specify the team the resource should be created in when using global tokens. You can't update this value later.
teamWaitnumbernoHow long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team.
titleFieldEmailIntegrationTitleField (output)noAn optional field describing how to extract a customized incident title.
updatedAtstringyesThe time when this email integration was updated.

EmailIntegrationAcknowledgedAlertIdField (input)#

Input object EmailIntegrationAcknowledgedAlertIdField. Fields below belong to this object, not to the parent.

PropertyTypeRequiredDescription
contentstringnoThe content to match. Required when matchType is match_before, match_after, or match_regex. Should be a valid regular expression when matchType is match_regex.
contentAfterstringnoWhen should we start extracting content for the field. Required when matchType is match_between.
contentBeforestringnoWhen should we stop extracting content for the field. Required when matchType is match_between.
fieldTargetstringnoThe target of the field. Can be any of the following: from_email, subject, or body.
matchTypestringnoThe match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything.
namestringnoThe name of the field.
specialTypestringnoA special type of the field. Can be alertId or cause or otherwise null for a custom field.
targetFieldstringnoThe target field within the content of the field_target.

EmailIntegrationAcknowledgedRule (input)#

Input object EmailIntegrationAcknowledgedRule. Fields below belong to this object, not to the parent.

PropertyTypeRequiredDescription
contentstringnoThe content we should match to satisfy the rule. Should be a valid regular expression when matchType is matches_regex.
matchTypestringnoThe type of the rule. Can be any of the following: contains, contains_not, matches_regex, matches_regex_not, equals, or equals_not.
ruleTargetstringnoThe target of the rule. Can be any of the following: from_email, subject, or body.
targetFieldstringnoThe target field within the content of the rule_target.

EmailIntegrationCauseField (input)#

Input object EmailIntegrationCauseField. Fields below belong to this object, not to the parent.

PropertyTypeRequiredDescription
contentstringnoThe content to match. Required when matchType is match_before, match_after, or match_regex. Should be a valid regular expression when matchType is match_regex.
contentAfterstringnoWhen should we start extracting content for the field. Required when matchType is match_between.
contentBeforestringnoWhen should we stop extracting content for the field. Required when matchType is match_between.
fieldTargetstringnoThe target of the field. Can be any of the following: from_email, subject, or body.
matchTypestringnoThe match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything.
namestringnoThe name of the field.
specialTypestringnoA special type of the field. Can be alertId or cause or otherwise null for a custom field.
targetFieldstringnoThe target field within the content of the field_target.

EmailIntegrationOtherAcknowledgedField (input)#

Input object EmailIntegrationOtherAcknowledgedField. Fields below belong to this object, not to the parent.

PropertyTypeRequiredDescription
contentstringnoThe content to match. Required when matchType is match_before, match_after, or match_regex. Should be a valid regular expression when matchType is match_regex.
contentAfterstringnoWhen should we start extracting content for the field. Required when matchType is match_between.
contentBeforestringnoWhen should we stop extracting content for the field. Required when matchType is match_between.
fieldTargetstringnoThe target of the field. Can be any of the following: from_email, subject, or body.
matchTypestringnoThe match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything.
namestringnoThe name of the field.
specialTypestringnoA special type of the field. Can be alertId or cause or otherwise null for a custom field.
targetFieldstringnoThe target field within the content of the field_target.

EmailIntegrationOtherResolvedField (input)#

Input object EmailIntegrationOtherResolvedField. Fields below belong to this object, not to the parent.

PropertyTypeRequiredDescription
contentstringnoThe content to match. Required when matchType is match_before, match_after, or match_regex. Should be a valid regular expression when matchType is match_regex.
contentAfterstringnoWhen should we start extracting content for the field. Required when matchType is match_between.
contentBeforestringnoWhen should we stop extracting content for the field. Required when matchType is match_between.
fieldTargetstringnoThe target of the field. Can be any of the following: from_email, subject, or body.
matchTypestringnoThe match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything.
namestringnoThe name of the field.
specialTypestringnoA special type of the field. Can be alertId or cause or otherwise null for a custom field.
targetFieldstringnoThe target field within the content of the field_target.

EmailIntegrationOtherStartedField (input)#

Input object EmailIntegrationOtherStartedField. Fields below belong to this object, not to the parent.

PropertyTypeRequiredDescription
contentstringnoThe content to match. Required when matchType is match_before, match_after, or match_regex. Should be a valid regular expression when matchType is match_regex.
contentAfterstringnoWhen should we start extracting content for the field. Required when matchType is match_between.
contentBeforestringnoWhen should we stop extracting content for the field. Required when matchType is match_between.
fieldTargetstringnoThe target of the field. Can be any of the following: from_email, subject, or body.
matchTypestringnoThe match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything.
namestringnoThe name of the field.
specialTypestringnoA special type of the field. Can be alertId or cause or otherwise null for a custom field.
targetFieldstringnoThe target field within the content of the field_target.

EmailIntegrationResolvedAlertIdField (input)#

Input object EmailIntegrationResolvedAlertIdField. Fields below belong to this object, not to the parent.

PropertyTypeRequiredDescription
contentstringnoThe content to match. Required when matchType is match_before, match_after, or match_regex. Should be a valid regular expression when matchType is match_regex.
contentAfterstringnoWhen should we start extracting content for the field. Required when matchType is match_between.
contentBeforestringnoWhen should we stop extracting content for the field. Required when matchType is match_between.
fieldTargetstringnoThe target of the field. Can be any of the following: from_email, subject, or body.
matchTypestringnoThe match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything.
namestringnoThe name of the field.
specialTypestringnoA special type of the field. Can be alertId or cause or otherwise null for a custom field.
targetFieldstringnoThe target field within the content of the field_target.

EmailIntegrationResolvedRule (input)#

Input object EmailIntegrationResolvedRule. Fields below belong to this object, not to the parent.

PropertyTypeRequiredDescription
contentstringnoThe content we should match to satisfy the rule. Should be a valid regular expression when matchType is matches_regex.
matchTypestringnoThe type of the rule. Can be any of the following: contains, contains_not, matches_regex, matches_regex_not, equals, or equals_not.
ruleTargetstringnoThe target of the rule. Can be any of the following: from_email, subject, or body.
targetFieldstringnoThe target field within the content of the rule_target.

EmailIntegrationStartedAlertIdField (input)#

Input object EmailIntegrationStartedAlertIdField. Fields below belong to this object, not to the parent.

PropertyTypeRequiredDescription
contentstringnoThe content to match. Required when matchType is match_before, match_after, or match_regex. Should be a valid regular expression when matchType is match_regex.
contentAfterstringnoWhen should we start extracting content for the field. Required when matchType is match_between.
contentBeforestringnoWhen should we stop extracting content for the field. Required when matchType is match_between.
fieldTargetstringnoThe target of the field. Can be any of the following: from_email, subject, or body.
matchTypestringnoThe match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything.
namestringnoThe name of the field.
specialTypestringnoA special type of the field. Can be alertId or cause or otherwise null for a custom field.
targetFieldstringnoThe target field within the content of the field_target.

EmailIntegrationStartedRule (input)#

Input object EmailIntegrationStartedRule. Fields below belong to this object, not to the parent.

PropertyTypeRequiredDescription
contentstringnoThe content we should match to satisfy the rule. Should be a valid regular expression when matchType is matches_regex.
matchTypestringnoThe type of the rule. Can be any of the following: contains, contains_not, matches_regex, matches_regex_not, equals, or equals_not.
ruleTargetstringnoThe target of the rule. Can be any of the following: from_email, subject, or body.
targetFieldstringnoThe target field within the content of the rule_target.

EmailIntegrationTitleField (input)#

Input object EmailIntegrationTitleField. Fields below belong to this object, not to the parent.

PropertyTypeRequiredDescription
contentstringnoThe content to match. Required when matchType is match_before, match_after, or match_regex. Should be a valid regular expression when matchType is match_regex.
contentAfterstringnoWhen should we start extracting content for the field. Required when matchType is match_between.
contentBeforestringnoWhen should we stop extracting content for the field. Required when matchType is match_between.
fieldTargetstringnoThe target of the field. Can be any of the following: from_email, subject, or body.
matchTypestringnoThe match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything.
namestringnoThe name of the field.
specialTypestringnoA special type of the field. Can be alertId or cause or otherwise null for a custom field.
targetFieldstringnoThe target field within the content of the field_target.

EmailIntegrationAcknowledgedAlertIdField (output)#

Output object EmailIntegrationAcknowledgedAlertIdField. Fields below belong to this object.

PropertyTypeAlways presentDescription
contentstringyesThe content to match. Required when matchType is match_before, match_after, or match_regex. Should be a valid regular expression when matchType is match_regex.
contentAfterstringyesWhen should we start extracting content for the field. Required when matchType is match_between.
contentBeforestringyesWhen should we stop extracting content for the field. Required when matchType is match_between.
fieldTargetstringyesThe target of the field. Can be any of the following: from_email, subject, or body.
matchTypestringyesThe match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything.
namestringyesThe name of the field.
specialTypestringyesA special type of the field. Can be alertId or cause or otherwise null for a custom field.
targetFieldstringyesThe target field within the content of the field_target.

EmailIntegrationAcknowledgedRule (output)#

Output object EmailIntegrationAcknowledgedRule. Fields below belong to this object.

PropertyTypeAlways presentDescription
contentstringyesThe content we should match to satisfy the rule. Should be a valid regular expression when matchType is matches_regex.
matchTypestringyesThe type of the rule. Can be any of the following: contains, contains_not, matches_regex, matches_regex_not, equals, or equals_not.
ruleTargetstringyesThe target of the rule. Can be any of the following: from_email, subject, or body.
targetFieldstringyesThe target field within the content of the rule_target.

EmailIntegrationCauseField (output)#

Output object EmailIntegrationCauseField. Fields below belong to this object.

PropertyTypeAlways presentDescription
contentstringyesThe content to match. Required when matchType is match_before, match_after, or match_regex. Should be a valid regular expression when matchType is match_regex.
contentAfterstringyesWhen should we start extracting content for the field. Required when matchType is match_between.
contentBeforestringyesWhen should we stop extracting content for the field. Required when matchType is match_between.
fieldTargetstringyesThe target of the field. Can be any of the following: from_email, subject, or body.
matchTypestringyesThe match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything.
namestringyesThe name of the field.
specialTypestringyesA special type of the field. Can be alertId or cause or otherwise null for a custom field.
targetFieldstringyesThe target field within the content of the field_target.

EmailIntegrationOtherAcknowledgedField (output)#

Output object EmailIntegrationOtherAcknowledgedField. Fields below belong to this object.

PropertyTypeAlways presentDescription
contentstringyesThe content to match. Required when matchType is match_before, match_after, or match_regex. Should be a valid regular expression when matchType is match_regex.
contentAfterstringyesWhen should we start extracting content for the field. Required when matchType is match_between.
contentBeforestringyesWhen should we stop extracting content for the field. Required when matchType is match_between.
fieldTargetstringyesThe target of the field. Can be any of the following: from_email, subject, or body.
matchTypestringyesThe match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything.
namestringyesThe name of the field.
specialTypestringyesA special type of the field. Can be alertId or cause or otherwise null for a custom field.
targetFieldstringyesThe target field within the content of the field_target.

EmailIntegrationOtherResolvedField (output)#

Output object EmailIntegrationOtherResolvedField. Fields below belong to this object.

PropertyTypeAlways presentDescription
contentstringyesThe content to match. Required when matchType is match_before, match_after, or match_regex. Should be a valid regular expression when matchType is match_regex.
contentAfterstringyesWhen should we start extracting content for the field. Required when matchType is match_between.
contentBeforestringyesWhen should we stop extracting content for the field. Required when matchType is match_between.
fieldTargetstringyesThe target of the field. Can be any of the following: from_email, subject, or body.
matchTypestringyesThe match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything.
namestringyesThe name of the field.
specialTypestringyesA special type of the field. Can be alertId or cause or otherwise null for a custom field.
targetFieldstringyesThe target field within the content of the field_target.

EmailIntegrationOtherStartedField (output)#

Output object EmailIntegrationOtherStartedField. Fields below belong to this object.

PropertyTypeAlways presentDescription
contentstringyesThe content to match. Required when matchType is match_before, match_after, or match_regex. Should be a valid regular expression when matchType is match_regex.
contentAfterstringyesWhen should we start extracting content for the field. Required when matchType is match_between.
contentBeforestringyesWhen should we stop extracting content for the field. Required when matchType is match_between.
fieldTargetstringyesThe target of the field. Can be any of the following: from_email, subject, or body.
matchTypestringyesThe match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything.
namestringyesThe name of the field.
specialTypestringyesA special type of the field. Can be alertId or cause or otherwise null for a custom field.
targetFieldstringyesThe target field within the content of the field_target.

EmailIntegrationResolvedAlertIdField (output)#

Output object EmailIntegrationResolvedAlertIdField. Fields below belong to this object.

PropertyTypeAlways presentDescription
contentstringyesThe content to match. Required when matchType is match_before, match_after, or match_regex. Should be a valid regular expression when matchType is match_regex.
contentAfterstringyesWhen should we start extracting content for the field. Required when matchType is match_between.
contentBeforestringyesWhen should we stop extracting content for the field. Required when matchType is match_between.
fieldTargetstringyesThe target of the field. Can be any of the following: from_email, subject, or body.
matchTypestringyesThe match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything.
namestringyesThe name of the field.
specialTypestringyesA special type of the field. Can be alertId or cause or otherwise null for a custom field.
targetFieldstringyesThe target field within the content of the field_target.

EmailIntegrationResolvedRule (output)#

Output object EmailIntegrationResolvedRule. Fields below belong to this object.

PropertyTypeAlways presentDescription
contentstringyesThe content we should match to satisfy the rule. Should be a valid regular expression when matchType is matches_regex.
matchTypestringyesThe type of the rule. Can be any of the following: contains, contains_not, matches_regex, matches_regex_not, equals, or equals_not.
ruleTargetstringyesThe target of the rule. Can be any of the following: from_email, subject, or body.
targetFieldstringyesThe target field within the content of the rule_target.

EmailIntegrationStartedAlertIdField (output)#

Output object EmailIntegrationStartedAlertIdField. Fields below belong to this object.

PropertyTypeAlways presentDescription
contentstringyesThe content to match. Required when matchType is match_before, match_after, or match_regex. Should be a valid regular expression when matchType is match_regex.
contentAfterstringyesWhen should we start extracting content for the field. Required when matchType is match_between.
contentBeforestringyesWhen should we stop extracting content for the field. Required when matchType is match_between.
fieldTargetstringyesThe target of the field. Can be any of the following: from_email, subject, or body.
matchTypestringyesThe match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything.
namestringyesThe name of the field.
specialTypestringyesA special type of the field. Can be alertId or cause or otherwise null for a custom field.
targetFieldstringyesThe target field within the content of the field_target.

EmailIntegrationStartedRule (output)#

Output object EmailIntegrationStartedRule. Fields below belong to this object.

PropertyTypeAlways presentDescription
contentstringyesThe content we should match to satisfy the rule. Should be a valid regular expression when matchType is matches_regex.
matchTypestringyesThe type of the rule. Can be any of the following: contains, contains_not, matches_regex, matches_regex_not, equals, or equals_not.
ruleTargetstringyesThe target of the rule. Can be any of the following: from_email, subject, or body.
targetFieldstringyesThe target field within the content of the rule_target.

EmailIntegrationTitleField (output)#

Output object EmailIntegrationTitleField. Fields below belong to this object.

PropertyTypeAlways presentDescription
contentstringyesThe content to match. Required when matchType is match_before, match_after, or match_regex. Should be a valid regular expression when matchType is match_regex.
contentAfterstringyesWhen should we start extracting content for the field. Required when matchType is match_between.
contentBeforestringyesWhen should we stop extracting content for the field. Required when matchType is match_between.
fieldTargetstringyesThe target of the field. Can be any of the following: from_email, subject, or body.
matchTypestringyesThe match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything.
namestringyesThe name of the field.
specialTypestringyesA special type of the field. Can be alertId or cause or otherwise null for a custom field.
targetFieldstringyesThe target field within the content of the field_target.