Home > Modules > Component: opsgenie

Component: opsgenie

No description available.

Component: opsgenie

Terraform component to provision Opsgenie resources.

Usage

Stack Level: Global

Here’s an example snippet for how to use this component. For more information use these resources:

  1. See the detailed usage documentation for the full breakdown in usage.
  2. View the Cloud Posse opsgenie module’s example configuration for a more complete example.
components:
  terraform:
    opsgenie:
      vars:
        teams:
        - name: acme
          description: Global Team for Acme Co.
          members:
            username: opsgenie-test@cloudposse.com
            role: admin
        - name: acme.dev
          description: Acme Dev Team
          delete_default_resources: true
          members:
            username: opsgenie-test@cloudposse.com
            role: admin
        - name: acme.dev.some-service
          description: "repo: https://github.com/acme/some-service;owner:David Lightman @David Lightman"
          ignore_members: true
          delete_default_resources: true
          members:
            username: opsgenie-test@cloudposse.com
            role: admin

        alert_policies:
        - name: "prioritize-env-prod-critical-alerts"
          owner_team_name: acme.dev
          tags:
            - "ManagedBy:terraform"
          filter:
            type: match-all-conditions
            conditions:
              - field: source
                operation: matches
                expected_value: ".*prod.acme.*"
              - field: tags
                operation: contains
                expected_value: "severity:critical"
          priority: P1

        escalations:
        - name: acme.dev.some-service-escalation
          description: "repo: https://github.com/acme/some-service;owner:David Lightman @David Lightman"
          owner_team_name: acme.dev
          rule:
            condition: if-not-acked
            notify_type: default
            delay: 0
            recipients:
            - type: team
              team_name: acme.dev.some-service

        api_integrations:
        - name: acme-dev-opsgenie-sns-integration
          type: AmazonSns
          owner_team_name: acme.dev

Requirements

Name Version
terraform >= 0.12
aws >= 2.0
local >= 1.3
opsgenie >= 0.5.0
template >= 2.0

Providers

Name Version
aws >= 2.0

Inputs

Name Description Type Default Required
additional_tag_map Additional tags for appending to tags_as_list_of_maps. Not added to tags. map(string) {} no
attributes Additional attributes (e.g. 1) list(string) [] no
context Single object for setting entire context at once.See description of individual variables for details.Leave string and numeric variables as null to use default value.Individual variable settings (non-null) override settings in context object,except for attributes, tags, and additional_tag_map, which are merged. object({ enabled = bool namespace = string environment = string stage = string name = string delimiter = string attributes = list(string) tags = map(string) additional_tag_map = map(string) regex_replace_chars = string label_order = list(string) id_length_limit = number }) { “additional_tag_map”: {}, “attributes”: [], “delimiter”: null, “enabled”: true, “environment”: null, “id_length_limit”: null, “label_order”: [], “name”: null, “namespace”: null, “regex_replace_chars”: null, “stage”: null, “tags”: {}} no
delimiter Delimiter to be used between namespace, environment, stage, name and attributes.Defaults to - (hyphen). Set to "" to use no delimiter at all. string null no
enabled Set to false to prevent the module from creating any resources bool null no
environment Environment, e.g. ‘uw2’, ‘us-west-2’, OR ‘prod’, ‘staging’, ‘dev’, ‘UAT’ string null no
id_length_limit Limit id to this many characters.Set to 0 for unlimited length.Set to null for default, which is 0.Does not affect id_full. number null no
import_role_arn IAM Role ARN to use when importing a resource string null no
kms_key_arn AWS KMS key used for writing to SSM string "alias/aws/ssm" no
label_order The naming order of the id output and Name tag.Defaults to [“namespace”, “environment”, “stage”, “name”, “attributes”].You can omit any of the 5 elements, but at least one must be present. list(string) null no
name Solution name, e.g. ‘app’ or ‘jenkins’ string null no
namespace Namespace, which could be your organization name or abbreviation, e.g. ‘eg’ or ‘cp’ string null no
regex_replace_chars Regex to replace chars with empty string in namespace, environment, stage and name.If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits. string null no
region AWS Region string n/a yes
ssm_parameter_name_format SSM parameter name format string "/%s/%s" no
ssm_path SSM path string "opsgenie" no
stage Stage, e.g. ‘prod’, ‘staging’, ‘dev’, OR ‘source’, ‘build’, ‘test’, ‘deploy’, ‘release’ string null no
tags Additional tags (e.g. map('BusinessUnit','XYZ') map(string) {} no
tfstate_account_id The ID of the account where the Terraform remote state backend is provisioned string "" no
tfstate_assume_role Set to false to use the caller’s role to access the Terraform remote state bool true no
tfstate_bucket_environment_name The name of the environment for Terraform state bucket string "" no
tfstate_bucket_stage_name The name of the stage for Terraform state bucket string "root" no
tfstate_existing_role_arn The ARN of the existing IAM Role to access the Terraform remote state. If not provided and remote_state_assume_role is true, a role will be constructed from remote_state_role_arn_template string "" no
tfstate_role_arn_template IAM Role ARN template for accessing the Terraform remote state string "arn:aws:iam::%s:role/%s-%s-%s-%s" no
tfstate_role_environment_name The name of the environment for Terraform state IAM role string "gbl" no
tfstate_role_name IAM Role name for accessing the Terraform remote state string "terraform" no
tfstate_role_stage_name The name of the stage for Terraform state IAM role string "root" no

Outputs

Name Description
alert_policies Alert policies
api_integrations API integrations
escalations Escalations
existing_users Existing Users
notification_policies Notification policies
service_incident_rule_ids Service Incident Rule IDs
services Services
team_routing_rules Team routing rules
teams Teams
users Users

References