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#
| Property | Type | Required | Description |
|---|---|---|---|
acknowledgedAlertIdField | EmailIntegrationAcknowledgedAlertIdField (input) | no | When acknowledging an incident, how to extract an alert id, a unique alert identifier which will be used to acknowledge and resolve incidents. |
acknowledgedRuleType | string | yes | Should 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 |
acknowledgedRules | EmailIntegrationAcknowledgedRule (input)[] | no | An array of rules to match to acknowledge an incident. |
call | boolean | no | Whether to call when a new incident is created. |
causeField | EmailIntegrationCauseField (input) | no | A field describing how to extract an incident cause, used as a short description shared with the team member on-call. |
criticalAlert | boolean | no | Whether to send a critical push notification that ignores the mute switch and Do not Disturb mode when a new incident is created. |
email | boolean | no | Whether to send an email when a new incident is created. |
name | string | no | The name of this Email integration. |
otherAcknowledgedFields | EmailIntegrationOtherAcknowledgedField (input)[] | no | An array of additional fields, which will be extracted when acknowledging an incident. |
otherResolvedFields | EmailIntegrationOtherResolvedField (input)[] | no | An array of additional fields, which will be extracted when resolving an incident. |
otherStartedFields | EmailIntegrationOtherStartedField (input)[] | no | An array of additional fields, which will be extracted when starting an incident. |
paused | boolean | no | Set to true to pause monitoring - we won't notify you about downtime. Set to false to resume monitoring. |
policyId | string | no | ID of the escalation policy associated with the email integration. |
push | boolean | no | Whether to send a push notification when a new incident is created. |
recoveryPeriod | number | no | How long the integration must be up to automatically mark an incident as resolved after being down. |
resolvedAlertIdField | EmailIntegrationResolvedAlertIdField (input) | no | When resolving an incident, how to extract an alert id, a unique alert identifier which will be used to acknowledge and resolve incidents. |
resolvedRuleType | string | yes | Should 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 |
resolvedRules | EmailIntegrationResolvedRule (input)[] | no | An array of rules to match to resolved an incident. |
sms | boolean | no | Whether to send an SMS when a new incident is created. |
startedAlertIdField | EmailIntegrationStartedAlertIdField (input) | no | When starting an incident, how to extract an alert id, a unique alert identifier which will be used to acknowledge and resolve incidents. |
startedRuleType | string | yes | Should 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 |
startedRules | EmailIntegrationStartedRule (input)[] | no | An array of rules to match to start a new incident. |
teamName | string | no | Used to specify the team the resource should be created in when using global tokens. You can't update this value later. |
teamWait | number | no | How long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team. |
titleField | EmailIntegrationTitleField (input) | no | An optional field describing how to extract a customized incident title. |
Outputs#
Computed outputs are produced by the provider. They are not constructor arguments.
| Property | Type | Computed | Description |
|---|---|---|---|
acknowledgedAlertIdField | EmailIntegrationAcknowledgedAlertIdField (output) | no | When acknowledging an incident, how to extract an alert id, a unique alert identifier which will be used to acknowledge and resolve incidents. |
acknowledgedRuleType | string | no | Should 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 |
acknowledgedRules | EmailIntegrationAcknowledgedRule (output)[] | no | An array of rules to match to acknowledge an incident. |
call | boolean | no | Whether to call when a new incident is created. |
causeField | EmailIntegrationCauseField (output) | no | A field describing how to extract an incident cause, used as a short description shared with the team member on-call. |
createdAt | string | yes | The time when this email integration was created. |
criticalAlert | boolean | no | Whether to send a critical push notification that ignores the mute switch and Do not Disturb mode when a new incident is created. |
email | boolean | no | Whether to send an email when a new incident is created. |
emailAddress | string | yes | The email address we expect emails to receive at. |
name | string | no | The name of this Email integration. |
otherAcknowledgedFields | EmailIntegrationOtherAcknowledgedField (output)[] | no | An array of additional fields, which will be extracted when acknowledging an incident. |
otherResolvedFields | EmailIntegrationOtherResolvedField (output)[] | no | An array of additional fields, which will be extracted when resolving an incident. |
otherStartedFields | EmailIntegrationOtherStartedField (output)[] | no | An array of additional fields, which will be extracted when starting an incident. |
paused | boolean | no | Set to true to pause monitoring - we won't notify you about downtime. Set to false to resume monitoring. |
policyId | string | no | ID of the escalation policy associated with the email integration. |
push | boolean | no | Whether to send a push notification when a new incident is created. |
recoveryPeriod | number | no | How long the integration must be up to automatically mark an incident as resolved after being down. |
resolvedAlertIdField | EmailIntegrationResolvedAlertIdField (output) | no | When resolving an incident, how to extract an alert id, a unique alert identifier which will be used to acknowledge and resolve incidents. |
resolvedRuleType | string | no | Should 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 |
resolvedRules | EmailIntegrationResolvedRule (output)[] | no | An array of rules to match to resolved an incident. |
sms | boolean | no | Whether to send an SMS when a new incident is created. |
startedAlertIdField | EmailIntegrationStartedAlertIdField (output) | no | When starting an incident, how to extract an alert id, a unique alert identifier which will be used to acknowledge and resolve incidents. |
startedRuleType | string | no | Should 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 |
startedRules | EmailIntegrationStartedRule (output)[] | no | An array of rules to match to start a new incident. |
teamName | string | no | Used to specify the team the resource should be created in when using global tokens. You can't update this value later. |
teamWait | number | no | How long to wait before escalating the incident alert to the team. Leave blank to disable escalating to the entire team. |
titleField | EmailIntegrationTitleField (output) | no | An optional field describing how to extract a customized incident title. |
updatedAt | string | yes | The time when this email integration was updated. |
EmailIntegrationAcknowledgedAlertIdField (input)#
Input object EmailIntegrationAcknowledgedAlertIdField. Fields below belong to this object, not to the parent.
| Property | Type | Required | Description |
|---|---|---|---|
content | string | no | The 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. |
contentAfter | string | no | When should we start extracting content for the field. Required when matchType is match_between. |
contentBefore | string | no | When should we stop extracting content for the field. Required when matchType is match_between. |
fieldTarget | string | no | The target of the field. Can be any of the following: from_email, subject, or body. |
matchType | string | no | The match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything. |
name | string | no | The name of the field. |
specialType | string | no | A special type of the field. Can be alertId or cause or otherwise null for a custom field. |
targetField | string | no | The target field within the content of the field_target. |
EmailIntegrationAcknowledgedRule (input)#
Input object EmailIntegrationAcknowledgedRule. Fields below belong to this object, not to the parent.
| Property | Type | Required | Description |
|---|---|---|---|
content | string | no | The content we should match to satisfy the rule. Should be a valid regular expression when matchType is matches_regex. |
matchType | string | no | The type of the rule. Can be any of the following: contains, contains_not, matches_regex, matches_regex_not, equals, or equals_not. |
ruleTarget | string | no | The target of the rule. Can be any of the following: from_email, subject, or body. |
targetField | string | no | The target field within the content of the rule_target. |
EmailIntegrationCauseField (input)#
Input object EmailIntegrationCauseField. Fields below belong to this object, not to the parent.
| Property | Type | Required | Description |
|---|---|---|---|
content | string | no | The 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. |
contentAfter | string | no | When should we start extracting content for the field. Required when matchType is match_between. |
contentBefore | string | no | When should we stop extracting content for the field. Required when matchType is match_between. |
fieldTarget | string | no | The target of the field. Can be any of the following: from_email, subject, or body. |
matchType | string | no | The match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything. |
name | string | no | The name of the field. |
specialType | string | no | A special type of the field. Can be alertId or cause or otherwise null for a custom field. |
targetField | string | no | The target field within the content of the field_target. |
EmailIntegrationOtherAcknowledgedField (input)#
Input object EmailIntegrationOtherAcknowledgedField. Fields below belong to this object, not to the parent.
| Property | Type | Required | Description |
|---|---|---|---|
content | string | no | The 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. |
contentAfter | string | no | When should we start extracting content for the field. Required when matchType is match_between. |
contentBefore | string | no | When should we stop extracting content for the field. Required when matchType is match_between. |
fieldTarget | string | no | The target of the field. Can be any of the following: from_email, subject, or body. |
matchType | string | no | The match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything. |
name | string | no | The name of the field. |
specialType | string | no | A special type of the field. Can be alertId or cause or otherwise null for a custom field. |
targetField | string | no | The target field within the content of the field_target. |
EmailIntegrationOtherResolvedField (input)#
Input object EmailIntegrationOtherResolvedField. Fields below belong to this object, not to the parent.
| Property | Type | Required | Description |
|---|---|---|---|
content | string | no | The 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. |
contentAfter | string | no | When should we start extracting content for the field. Required when matchType is match_between. |
contentBefore | string | no | When should we stop extracting content for the field. Required when matchType is match_between. |
fieldTarget | string | no | The target of the field. Can be any of the following: from_email, subject, or body. |
matchType | string | no | The match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything. |
name | string | no | The name of the field. |
specialType | string | no | A special type of the field. Can be alertId or cause or otherwise null for a custom field. |
targetField | string | no | The target field within the content of the field_target. |
EmailIntegrationOtherStartedField (input)#
Input object EmailIntegrationOtherStartedField. Fields below belong to this object, not to the parent.
| Property | Type | Required | Description |
|---|---|---|---|
content | string | no | The 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. |
contentAfter | string | no | When should we start extracting content for the field. Required when matchType is match_between. |
contentBefore | string | no | When should we stop extracting content for the field. Required when matchType is match_between. |
fieldTarget | string | no | The target of the field. Can be any of the following: from_email, subject, or body. |
matchType | string | no | The match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything. |
name | string | no | The name of the field. |
specialType | string | no | A special type of the field. Can be alertId or cause or otherwise null for a custom field. |
targetField | string | no | The target field within the content of the field_target. |
EmailIntegrationResolvedAlertIdField (input)#
Input object EmailIntegrationResolvedAlertIdField. Fields below belong to this object, not to the parent.
| Property | Type | Required | Description |
|---|---|---|---|
content | string | no | The 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. |
contentAfter | string | no | When should we start extracting content for the field. Required when matchType is match_between. |
contentBefore | string | no | When should we stop extracting content for the field. Required when matchType is match_between. |
fieldTarget | string | no | The target of the field. Can be any of the following: from_email, subject, or body. |
matchType | string | no | The match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything. |
name | string | no | The name of the field. |
specialType | string | no | A special type of the field. Can be alertId or cause or otherwise null for a custom field. |
targetField | string | no | The target field within the content of the field_target. |
EmailIntegrationResolvedRule (input)#
Input object EmailIntegrationResolvedRule. Fields below belong to this object, not to the parent.
| Property | Type | Required | Description |
|---|---|---|---|
content | string | no | The content we should match to satisfy the rule. Should be a valid regular expression when matchType is matches_regex. |
matchType | string | no | The type of the rule. Can be any of the following: contains, contains_not, matches_regex, matches_regex_not, equals, or equals_not. |
ruleTarget | string | no | The target of the rule. Can be any of the following: from_email, subject, or body. |
targetField | string | no | The target field within the content of the rule_target. |
EmailIntegrationStartedAlertIdField (input)#
Input object EmailIntegrationStartedAlertIdField. Fields below belong to this object, not to the parent.
| Property | Type | Required | Description |
|---|---|---|---|
content | string | no | The 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. |
contentAfter | string | no | When should we start extracting content for the field. Required when matchType is match_between. |
contentBefore | string | no | When should we stop extracting content for the field. Required when matchType is match_between. |
fieldTarget | string | no | The target of the field. Can be any of the following: from_email, subject, or body. |
matchType | string | no | The match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything. |
name | string | no | The name of the field. |
specialType | string | no | A special type of the field. Can be alertId or cause or otherwise null for a custom field. |
targetField | string | no | The target field within the content of the field_target. |
EmailIntegrationStartedRule (input)#
Input object EmailIntegrationStartedRule. Fields below belong to this object, not to the parent.
| Property | Type | Required | Description |
|---|---|---|---|
content | string | no | The content we should match to satisfy the rule. Should be a valid regular expression when matchType is matches_regex. |
matchType | string | no | The type of the rule. Can be any of the following: contains, contains_not, matches_regex, matches_regex_not, equals, or equals_not. |
ruleTarget | string | no | The target of the rule. Can be any of the following: from_email, subject, or body. |
targetField | string | no | The target field within the content of the rule_target. |
EmailIntegrationTitleField (input)#
Input object EmailIntegrationTitleField. Fields below belong to this object, not to the parent.
| Property | Type | Required | Description |
|---|---|---|---|
content | string | no | The 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. |
contentAfter | string | no | When should we start extracting content for the field. Required when matchType is match_between. |
contentBefore | string | no | When should we stop extracting content for the field. Required when matchType is match_between. |
fieldTarget | string | no | The target of the field. Can be any of the following: from_email, subject, or body. |
matchType | string | no | The match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything. |
name | string | no | The name of the field. |
specialType | string | no | A special type of the field. Can be alertId or cause or otherwise null for a custom field. |
targetField | string | no | The target field within the content of the field_target. |
EmailIntegrationAcknowledgedAlertIdField (output)#
Output object EmailIntegrationAcknowledgedAlertIdField. Fields below belong to this object.
| Property | Type | Always present | Description |
|---|---|---|---|
content | string | yes | The 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. |
contentAfter | string | yes | When should we start extracting content for the field. Required when matchType is match_between. |
contentBefore | string | yes | When should we stop extracting content for the field. Required when matchType is match_between. |
fieldTarget | string | yes | The target of the field. Can be any of the following: from_email, subject, or body. |
matchType | string | yes | The match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything. |
name | string | yes | The name of the field. |
specialType | string | yes | A special type of the field. Can be alertId or cause or otherwise null for a custom field. |
targetField | string | yes | The target field within the content of the field_target. |
EmailIntegrationAcknowledgedRule (output)#
Output object EmailIntegrationAcknowledgedRule. Fields below belong to this object.
| Property | Type | Always present | Description |
|---|---|---|---|
content | string | yes | The content we should match to satisfy the rule. Should be a valid regular expression when matchType is matches_regex. |
matchType | string | yes | The type of the rule. Can be any of the following: contains, contains_not, matches_regex, matches_regex_not, equals, or equals_not. |
ruleTarget | string | yes | The target of the rule. Can be any of the following: from_email, subject, or body. |
targetField | string | yes | The target field within the content of the rule_target. |
EmailIntegrationCauseField (output)#
Output object EmailIntegrationCauseField. Fields below belong to this object.
| Property | Type | Always present | Description |
|---|---|---|---|
content | string | yes | The 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. |
contentAfter | string | yes | When should we start extracting content for the field. Required when matchType is match_between. |
contentBefore | string | yes | When should we stop extracting content for the field. Required when matchType is match_between. |
fieldTarget | string | yes | The target of the field. Can be any of the following: from_email, subject, or body. |
matchType | string | yes | The match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything. |
name | string | yes | The name of the field. |
specialType | string | yes | A special type of the field. Can be alertId or cause or otherwise null for a custom field. |
targetField | string | yes | The target field within the content of the field_target. |
EmailIntegrationOtherAcknowledgedField (output)#
Output object EmailIntegrationOtherAcknowledgedField. Fields below belong to this object.
| Property | Type | Always present | Description |
|---|---|---|---|
content | string | yes | The 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. |
contentAfter | string | yes | When should we start extracting content for the field. Required when matchType is match_between. |
contentBefore | string | yes | When should we stop extracting content for the field. Required when matchType is match_between. |
fieldTarget | string | yes | The target of the field. Can be any of the following: from_email, subject, or body. |
matchType | string | yes | The match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything. |
name | string | yes | The name of the field. |
specialType | string | yes | A special type of the field. Can be alertId or cause or otherwise null for a custom field. |
targetField | string | yes | The target field within the content of the field_target. |
EmailIntegrationOtherResolvedField (output)#
Output object EmailIntegrationOtherResolvedField. Fields below belong to this object.
| Property | Type | Always present | Description |
|---|---|---|---|
content | string | yes | The 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. |
contentAfter | string | yes | When should we start extracting content for the field. Required when matchType is match_between. |
contentBefore | string | yes | When should we stop extracting content for the field. Required when matchType is match_between. |
fieldTarget | string | yes | The target of the field. Can be any of the following: from_email, subject, or body. |
matchType | string | yes | The match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything. |
name | string | yes | The name of the field. |
specialType | string | yes | A special type of the field. Can be alertId or cause or otherwise null for a custom field. |
targetField | string | yes | The target field within the content of the field_target. |
EmailIntegrationOtherStartedField (output)#
Output object EmailIntegrationOtherStartedField. Fields below belong to this object.
| Property | Type | Always present | Description |
|---|---|---|---|
content | string | yes | The 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. |
contentAfter | string | yes | When should we start extracting content for the field. Required when matchType is match_between. |
contentBefore | string | yes | When should we stop extracting content for the field. Required when matchType is match_between. |
fieldTarget | string | yes | The target of the field. Can be any of the following: from_email, subject, or body. |
matchType | string | yes | The match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything. |
name | string | yes | The name of the field. |
specialType | string | yes | A special type of the field. Can be alertId or cause or otherwise null for a custom field. |
targetField | string | yes | The target field within the content of the field_target. |
EmailIntegrationResolvedAlertIdField (output)#
Output object EmailIntegrationResolvedAlertIdField. Fields below belong to this object.
| Property | Type | Always present | Description |
|---|---|---|---|
content | string | yes | The 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. |
contentAfter | string | yes | When should we start extracting content for the field. Required when matchType is match_between. |
contentBefore | string | yes | When should we stop extracting content for the field. Required when matchType is match_between. |
fieldTarget | string | yes | The target of the field. Can be any of the following: from_email, subject, or body. |
matchType | string | yes | The match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything. |
name | string | yes | The name of the field. |
specialType | string | yes | A special type of the field. Can be alertId or cause or otherwise null for a custom field. |
targetField | string | yes | The target field within the content of the field_target. |
EmailIntegrationResolvedRule (output)#
Output object EmailIntegrationResolvedRule. Fields below belong to this object.
| Property | Type | Always present | Description |
|---|---|---|---|
content | string | yes | The content we should match to satisfy the rule. Should be a valid regular expression when matchType is matches_regex. |
matchType | string | yes | The type of the rule. Can be any of the following: contains, contains_not, matches_regex, matches_regex_not, equals, or equals_not. |
ruleTarget | string | yes | The target of the rule. Can be any of the following: from_email, subject, or body. |
targetField | string | yes | The target field within the content of the rule_target. |
EmailIntegrationStartedAlertIdField (output)#
Output object EmailIntegrationStartedAlertIdField. Fields below belong to this object.
| Property | Type | Always present | Description |
|---|---|---|---|
content | string | yes | The 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. |
contentAfter | string | yes | When should we start extracting content for the field. Required when matchType is match_between. |
contentBefore | string | yes | When should we stop extracting content for the field. Required when matchType is match_between. |
fieldTarget | string | yes | The target of the field. Can be any of the following: from_email, subject, or body. |
matchType | string | yes | The match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything. |
name | string | yes | The name of the field. |
specialType | string | yes | A special type of the field. Can be alertId or cause or otherwise null for a custom field. |
targetField | string | yes | The target field within the content of the field_target. |
EmailIntegrationStartedRule (output)#
Output object EmailIntegrationStartedRule. Fields below belong to this object.
| Property | Type | Always present | Description |
|---|---|---|---|
content | string | yes | The content we should match to satisfy the rule. Should be a valid regular expression when matchType is matches_regex. |
matchType | string | yes | The type of the rule. Can be any of the following: contains, contains_not, matches_regex, matches_regex_not, equals, or equals_not. |
ruleTarget | string | yes | The target of the rule. Can be any of the following: from_email, subject, or body. |
targetField | string | yes | The target field within the content of the rule_target. |
EmailIntegrationTitleField (output)#
Output object EmailIntegrationTitleField. Fields below belong to this object.
| Property | Type | Always present | Description |
|---|---|---|---|
content | string | yes | The 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. |
contentAfter | string | yes | When should we start extracting content for the field. Required when matchType is match_between. |
contentBefore | string | yes | When should we stop extracting content for the field. Required when matchType is match_between. |
fieldTarget | string | yes | The target of the field. Can be any of the following: from_email, subject, or body. |
matchType | string | yes | The match type of the field. Can be any of the following: match_before, match_after, match_between, match_regex, or match_everything. |
name | string | yes | The name of the field. |
specialType | string | yes | A special type of the field. Can be alertId or cause or otherwise null for a custom field. |
targetField | string | yes | The target field within the content of the field_target. |