service.md

page_title	subcategory	description
firehydrant_service Resource - terraform-provider-firehydrant		Service Resource

firehydrant_service (Resource)

Service Resource

Example Usage

resource "firehydrant_service" "my_service" {
  alert_on_add             = true
  auto_add_responding_team = false
  description              = "...my_description..."
  external_resources = [
    {
      connection_type = "...my_connection_type..."
      remote_id       = "...my_remote_id..."
    }
  ]
  functionalities = [
    {
      id      = "...my_id..."
      summary = "...my_summary..."
    }
  ]
  labels = {
    "see" : "documentation",
  }
  links = [
    {
      href_url = "...my_href_url..."
      icon_url = "...my_icon_url..."
      name     = "...my_name..."
    }
  ]
  name = "...my_name..."
  owner = {
    id = "...my_id..."
  }
  service_tier = 4
  teams = [
    {
      id = "...my_id..."
    }
  ]
}

Schema

Required

• name (String)

Optional

• alert_on_add (Boolean)
• auto_add_responding_team (Boolean)
• description (String)
• external_resources (Attributes List) An array of external resources to attach to this service. (see below for nested schema)
• functionalities (Attributes List) An array of functionalities (see below for nested schema)
• labels (Map of String) A hash of label keys and values
• links (Attributes List) An array of links to associate with this service (see below for nested schema)
• owner (Attributes) An object representing a Team that owns the service (see below for nested schema)
• service_tier (Number) Integer representing service tier. Lower values represent higher criticality. If not specified the default value will be 5. must be one of ["0", "1", "2", "3", "4", "5"]
• teams (Attributes List) An array of teams to attach to this service. (see below for nested schema)

Read-Only

• active_incidents (List of String) List of active incident guids
• allowed_params (List of String)
• checklists (Attributes List) List of checklists associated with a service (see below for nested schema)
• completed_checks (Number)
• created_at (String)
• id (String) The ID of this resource.
• last_import (Attributes) (see below for nested schema)
• managed_by (String) If set, this field indicates that the service is managed by an integration and thus cannot be set manually
• managed_by_settings (Attributes) Indicates the settings of the catalog that manages this service (see below for nested schema)
• service_checklist_updated_at (String)
• slug (String)
• updated_at (String)
• updated_by (Attributes) (see below for nested schema)

Nested Schema for external_resources

Optional:

• connection_type (String) The integration slug for the external resource. Can be one of: github, opsgenie, pager_duty, victorops. Not required if the resource has already been imported.
• remote_id (String) Not Null

Read-Only:

• connection_id (String)
• connection_name (String)
• created_at (String)
• name (String)
• remote_url (String)
• updated_at (String)

Nested Schema for functionalities

Optional:

• id (String) If you are trying to reuse a functionality, you may set the ID to attach it to the service
• summary (String) If you are trying to create a new functionality and attach it to this service, set the summary key

Read-Only:

• active_incidents (List of String) List of active incident guids
• alert_on_add (Boolean)
• auto_add_responding_team (Boolean)
• created_at (String)
• description (String)
• external_resources (Attributes List) Information about known linkages to representations of services outside of FireHydrant. (see below for nested schema)
• labels (Map of String) An object of label key and values
• links (Attributes List) List of links attached to this functionality. (see below for nested schema)
• name (String)
• owner (Attributes) TeamEntity model (see below for nested schema)
• slug (String)
• updated_at (String)
• updated_by (Attributes) (see below for nested schema)

Nested Schema for functionalities.external_resources

Read-Only:

• connection_id (String)
• connection_name (String)
• connection_type (String)
• created_at (String)
• name (String)
• remote_id (String)
• remote_url (String)
• updated_at (String)

Nested Schema for functionalities.links

Read-Only:

• href_url (String)
• icon_url (String)
• id (String)
• name (String)

Nested Schema for functionalities.owner

Nested Schema for functionalities.updated_by

Read-Only:

• email (String)
• id (String)
• name (String)
• source (String)

Nested Schema for links

Optional:

• href_url (String) URL. Not Null
• icon_url (String) An optional URL to an icon representing this link
• name (String) Short name used to display and identify this link. Not Null

Read-Only:

• id (String)

Nested Schema for owner

Optional:

• id (String) Not Null

Read-Only:

• created_at (String)
• created_by (Attributes) (see below for nested schema)
• description (String)
• functionalities (Attributes List) (see below for nested schema)
• memberships (Attributes List) (see below for nested schema)
• ms_teams_channel (Attributes) (see below for nested schema)
• name (String)
• owned_functionalities (Attributes List) (see below for nested schema)
• owned_runbooks (Attributes List) (see below for nested schema)
• signals_ical_url (String)
• slack_channel (Attributes) (see below for nested schema)
• slug (String)
• updated_at (String)

Nested Schema for owner.created_by

Read-Only:

• email (String)
• id (String)
• name (String)
• source (String)

Nested Schema for owner.functionalities

Read-Only:

• active_incidents (List of String) List of active incident guids
• alert_on_add (Boolean)
• auto_add_responding_team (Boolean)
• created_at (String)
• description (String)
• external_resources (Attributes List) Information about known linkages to representations of services outside of FireHydrant. (see below for nested schema)
• id (String)
• labels (Map of String) An object of label key and values
• links (Attributes List) List of links attached to this functionality. (see below for nested schema)
• name (String)
• owner (Attributes) TeamEntity model (see below for nested schema)
• slug (String)
• updated_at (String)
• updated_by (Attributes) (see below for nested schema)

Nested Schema for owner.functionalities.external_resources

Read-Only:

• connection_id (String)
• connection_name (String)
• connection_type (String)
• created_at (String)
• name (String)
• remote_id (String)
• remote_url (String)
• updated_at (String)

Nested Schema for owner.functionalities.links

Read-Only:

• href_url (String)
• icon_url (String)
• id (String)
• name (String)

Nested Schema for owner.functionalities.owner

Nested Schema for owner.functionalities.updated_by

Read-Only:

• email (String)
• id (String)
• name (String)
• source (String)

Nested Schema for owner.memberships

Read-Only:

• default_incident_role (Attributes) IncidentRoleEntity model (see below for nested schema)
• schedule (Attributes) (see below for nested schema)
• user (Attributes) (see below for nested schema)

Nested Schema for owner.memberships.default_incident_role

Read-Only:

• created_at (String)
• description (String)
• discarded_at (String)
• id (String)
• name (String)
• summary (String)
• updated_at (String)

Nested Schema for owner.memberships.schedule

Read-Only:

• discarded (Boolean)
• id (String)
• integration (String)
• name (String)

Nested Schema for owner.memberships.user

Read-Only:

• created_at (String)
• email (String)
• id (String)
• name (String)
• signals_enabled_notification_types (List of String)
• slack_linked (Boolean)
• slack_user_id (String)
• updated_at (String)

Nested Schema for owner.ms_teams_channel

Read-Only:

• channel_id (String)
• channel_name (String)
• channel_url (String)
• id (String)
• ms_team_id (String)
• status (String)
• team_name (String)

Nested Schema for owner.owned_functionalities

Read-Only:

• active_incidents (List of String) List of active incident guids
• alert_on_add (Boolean)
• auto_add_responding_team (Boolean)
• created_at (String)
• description (String)
• external_resources (Attributes List) Information about known linkages to representations of services outside of FireHydrant. (see below for nested schema)
• id (String)
• labels (Map of String) An object of label key and values
• links (Attributes List) List of links attached to this functionality. (see below for nested schema)
• name (String)
• owner (Attributes) TeamEntity model (see below for nested schema)
• slug (String)
• updated_at (String)
• updated_by (Attributes) (see below for nested schema)

Nested Schema for owner.owned_functionalities.external_resources

Read-Only:

• connection_id (String)
• connection_name (String)
• connection_type (String)
• created_at (String)
• name (String)
• remote_id (String)
• remote_url (String)
• updated_at (String)

Nested Schema for owner.owned_functionalities.links

Read-Only:

• href_url (String)
• icon_url (String)
• id (String)
• name (String)

Nested Schema for owner.owned_functionalities.owner

Nested Schema for owner.owned_functionalities.updated_by

Read-Only:

• email (String)
• id (String)
• name (String)
• source (String)

Nested Schema for owner.owned_runbooks

Read-Only:

• attachment_rule (Attributes) (see below for nested schema)
• categories (String) categories the runbook applies to
• created_at (String)
• description (String)
• id (String)
• name (String)
• owner (Attributes) TeamEntity model (see below for nested schema)
• summary (String)
• type (String)
• updated_at (String)

Nested Schema for owner.owned_runbooks.attachment_rule

Read-Only:

• logic (Attributes) An unstructured object of key/value pairs describing the logic for applying the rule. (see below for nested schema)
• user_data (Attributes) (see below for nested schema)

Nested Schema for owner.owned_runbooks.attachment_rule.logic

Nested Schema for owner.owned_runbooks.attachment_rule.user_data

Read-Only:

• label (String)
• type (String)
• value (String)

Nested Schema for owner.owned_runbooks.owner

Nested Schema for owner.slack_channel

Read-Only:

• id (String)
• name (String)
• slack_channel_id (String)

Nested Schema for teams

Optional:

• id (String) Not Null

Read-Only:

• created_at (String)
• created_by (Attributes) (see below for nested schema)
• description (String)
• functionalities (Attributes List) (see below for nested schema)
• memberships (Attributes List) (see below for nested schema)
• ms_teams_channel (Attributes) (see below for nested schema)
• name (String)
• owned_functionalities (Attributes List) (see below for nested schema)
• owned_runbooks (Attributes List) (see below for nested schema)
• signals_ical_url (String)
• slack_channel (Attributes) (see below for nested schema)
• slug (String)
• updated_at (String)

Nested Schema for teams.created_by

Read-Only:

• email (String)
• id (String)
• name (String)
• source (String)

Nested Schema for teams.functionalities

Read-Only:

• active_incidents (List of String) List of active incident guids
• alert_on_add (Boolean)
• auto_add_responding_team (Boolean)
• created_at (String)
• description (String)
• external_resources (Attributes List) Information about known linkages to representations of services outside of FireHydrant. (see below for nested schema)
• id (String)
• labels (Map of String) An object of label key and values
• links (Attributes List) List of links attached to this functionality. (see below for nested schema)
• name (String)
• owner (Attributes) TeamEntity model (see below for nested schema)
• slug (String)
• updated_at (String)
• updated_by (Attributes) (see below for nested schema)

Nested Schema for teams.functionalities.external_resources

Read-Only:

• connection_id (String)
• connection_name (String)
• connection_type (String)
• created_at (String)
• name (String)
• remote_id (String)
• remote_url (String)
• updated_at (String)

Nested Schema for teams.functionalities.links

Read-Only:

• href_url (String)
• icon_url (String)
• id (String)
• name (String)

Nested Schema for teams.functionalities.owner

Nested Schema for teams.functionalities.updated_by

Read-Only:

• email (String)
• id (String)
• name (String)
• source (String)

Nested Schema for teams.memberships

Read-Only:

• default_incident_role (Attributes) IncidentRoleEntity model (see below for nested schema)
• schedule (Attributes) (see below for nested schema)
• user (Attributes) (see below for nested schema)

Nested Schema for teams.memberships.default_incident_role

Read-Only:

• created_at (String)
• description (String)
• discarded_at (String)
• id (String)
• name (String)
• summary (String)
• updated_at (String)

Nested Schema for teams.memberships.schedule

Read-Only:

• discarded (Boolean)
• id (String)
• integration (String)
• name (String)

Nested Schema for teams.memberships.user

Read-Only:

• created_at (String)
• email (String)
• id (String)
• name (String)
• signals_enabled_notification_types (List of String)
• slack_linked (Boolean)
• slack_user_id (String)
• updated_at (String)

Nested Schema for teams.ms_teams_channel

Read-Only:

• channel_id (String)
• channel_name (String)
• channel_url (String)
• id (String)
• ms_team_id (String)
• status (String)
• team_name (String)

Nested Schema for teams.owned_functionalities

Read-Only:

• active_incidents (List of String) List of active incident guids
• alert_on_add (Boolean)
• auto_add_responding_team (Boolean)
• created_at (String)
• description (String)
• external_resources (Attributes List) Information about known linkages to representations of services outside of FireHydrant. (see below for nested schema)
• id (String)
• labels (Map of String) An object of label key and values
• links (Attributes List) List of links attached to this functionality. (see below for nested schema)
• name (String)
• owner (Attributes) TeamEntity model (see below for nested schema)
• slug (String)
• updated_at (String)
• updated_by (Attributes) (see below for nested schema)

Nested Schema for teams.owned_functionalities.external_resources

Read-Only:

• connection_id (String)
• connection_name (String)
• connection_type (String)
• created_at (String)
• name (String)
• remote_id (String)
• remote_url (String)
• updated_at (String)

Nested Schema for teams.owned_functionalities.links

Read-Only:

• href_url (String)
• icon_url (String)
• id (String)
• name (String)

Nested Schema for teams.owned_functionalities.owner

Nested Schema for teams.owned_functionalities.updated_by

Read-Only:

• email (String)
• id (String)
• name (String)
• source (String)

Nested Schema for teams.owned_runbooks

Read-Only:

• attachment_rule (Attributes) (see below for nested schema)
• categories (String) categories the runbook applies to
• created_at (String)
• description (String)
• id (String)
• name (String)
• owner (Attributes) TeamEntity model (see below for nested schema)
• summary (String)
• type (String)
• updated_at (String)

Nested Schema for teams.owned_runbooks.attachment_rule

Read-Only:

• logic (Attributes) An unstructured object of key/value pairs describing the logic for applying the rule. (see below for nested schema)
• user_data (Attributes) (see below for nested schema)

Nested Schema for teams.owned_runbooks.attachment_rule.logic

Nested Schema for teams.owned_runbooks.attachment_rule.user_data

Read-Only:

• label (String)
• type (String)
• value (String)

Nested Schema for teams.owned_runbooks.owner

Nested Schema for teams.slack_channel

Read-Only:

• id (String)
• name (String)
• slack_channel_id (String)

Nested Schema for checklists

Read-Only:

• checks (Attributes List) (see below for nested schema)
• created_at (String)
• description (String)
• id (String)
• name (String)
• owner (Attributes) TeamEntity model (see below for nested schema)
• updated_at (String)

Nested Schema for checklists.checks

Read-Only:

• description (String)
• id (String)
• name (String)
• status (Boolean)

Nested Schema for checklists.owner

Read-Only:

• created_at (String)
• created_by (Attributes) (see below for nested schema)
• description (String)
• functionalities (Attributes List) (see below for nested schema)
• id (String)
• memberships (Attributes List) (see below for nested schema)
• ms_teams_channel (Attributes) (see below for nested schema)
• name (String)
• owned_functionalities (Attributes List) (see below for nested schema)
• owned_runbooks (Attributes List) (see below for nested schema)
• signals_ical_url (String)
• slack_channel (Attributes) (see below for nested schema)
• slug (String)
• updated_at (String)

Nested Schema for checklists.owner.created_by

Read-Only:

• email (String)
• id (String)
• name (String)
• source (String)

Nested Schema for checklists.owner.functionalities

Read-Only:

• active_incidents (List of String) List of active incident guids
• alert_on_add (Boolean)
• auto_add_responding_team (Boolean)
• created_at (String)
• description (String)
• external_resources (Attributes List) Information about known linkages to representations of services outside of FireHydrant. (see below for nested schema)
• id (String)
• labels (Map of String) An object of label key and values
• links (Attributes List) List of links attached to this functionality. (see below for nested schema)
• name (String)
• owner (Attributes) TeamEntity model (see below for nested schema)
• slug (String)
• updated_at (String)
• updated_by (Attributes) (see below for nested schema)

Nested Schema for checklists.owner.functionalities.external_resources

Read-Only:

• connection_id (String)
• connection_name (String)
• connection_type (String)
• created_at (String)
• name (String)
• remote_id (String)
• remote_url (String)
• updated_at (String)

Nested Schema for checklists.owner.functionalities.links

Read-Only:

• href_url (String)
• icon_url (String)
• id (String)
• name (String)

Nested Schema for checklists.owner.functionalities.owner

Nested Schema for checklists.owner.functionalities.updated_by

Read-Only:

• email (String)
• id (String)
• name (String)
• source (String)

Nested Schema for checklists.owner.memberships

Read-Only:

• default_incident_role (Attributes) IncidentRoleEntity model (see below for nested schema)
• schedule (Attributes) (see below for nested schema)
• user (Attributes) (see below for nested schema)

Nested Schema for checklists.owner.memberships.default_incident_role

Read-Only:

• created_at (String)
• description (String)
• discarded_at (String)
• id (String)
• name (String)
• summary (String)
• updated_at (String)

Nested Schema for checklists.owner.memberships.schedule

Read-Only:

• discarded (Boolean)
• id (String)
• integration (String)
• name (String)

Nested Schema for checklists.owner.memberships.user

Read-Only:

• created_at (String)
• email (String)
• id (String)
• name (String)
• signals_enabled_notification_types (List of String)
• slack_linked (Boolean)
• slack_user_id (String)
• updated_at (String)

Nested Schema for checklists.owner.ms_teams_channel

Read-Only:

• channel_id (String)
• channel_name (String)
• channel_url (String)
• id (String)
• ms_team_id (String)
• status (String)
• team_name (String)

Nested Schema for checklists.owner.owned_functionalities

Read-Only:

• active_incidents (List of String) List of active incident guids
• alert_on_add (Boolean)
• auto_add_responding_team (Boolean)
• created_at (String)
• description (String)
• external_resources (Attributes List) Information about known linkages to representations of services outside of FireHydrant. (see below for nested schema)
• id (String)
• labels (Map of String) An object of label key and values
• links (Attributes List) List of links attached to this functionality. (see below for nested schema)
• name (String)
• owner (Attributes) TeamEntity model (see below for nested schema)
• slug (String)
• updated_at (String)
• updated_by (Attributes) (see below for nested schema)

Nested Schema for checklists.owner.owned_functionalities.external_resources

Read-Only:

• connection_id (String)
• connection_name (String)
• connection_type (String)
• created_at (String)
• name (String)
• remote_id (String)
• remote_url (String)
• updated_at (String)

Nested Schema for checklists.owner.owned_functionalities.links

Read-Only:

• href_url (String)
• icon_url (String)
• id (String)
• name (String)

Nested Schema for checklists.owner.owned_functionalities.owner

Nested Schema for checklists.owner.owned_functionalities.updated_by

Read-Only:

• email (String)
• id (String)
• name (String)
• source (String)

Nested Schema for checklists.owner.owned_runbooks

Read-Only:

• attachment_rule (Attributes) (see below for nested schema)
• categories (String) categories the runbook applies to
• created_at (String)
• description (String)
• id (String)
• name (String)
• owner (Attributes) TeamEntity model (see below for nested schema)
• summary (String)
• type (String)
• updated_at (String)

Nested Schema for checklists.owner.owned_runbooks.attachment_rule

Read-Only:

• logic (Attributes) An unstructured object of key/value pairs describing the logic for applying the rule. (see below for nested schema)
• user_data (Attributes) (see below for nested schema)

Nested Schema for checklists.owner.owned_runbooks.attachment_rule.logic

Nested Schema for checklists.owner.owned_runbooks.attachment_rule.user_data

Read-Only:

• label (String)
• type (String)
• value (String)

Nested Schema for checklists.owner.owned_runbooks.owner

Nested Schema for checklists.owner.slack_channel

Read-Only:

• id (String)
• name (String)
• slack_channel_id (String)

Nested Schema for last_import

Read-Only:

• import_errors (Attributes List) (see below for nested schema)
• imported_at (String)
• remote_id (String)
• state (String) must be one of ["selected", "skipped", "imported", "errored"]

Nested Schema for last_import.import_errors

Read-Only:

• created_at (String)
• data (Attributes) Additional error data (see below for nested schema)
• id (String)
• message (String)
• resource (Attributes) (see below for nested schema)

Nested Schema for last_import.import_errors.data

Nested Schema for last_import.import_errors.resource

Read-Only:

• name (String)
• resource_id (String)
• resource_type (String)

Nested Schema for managed_by_settings

Nested Schema for updated_by

Read-Only:

• email (String)
• id (String)
• name (String)
• source (String)

Import

Import is supported using the following syntax:

terraform import firehydrant_service.my_firehydrant_service ""