Skip to content

Latest commit

 

History

History
 
 

PagerDuty-Users-User

README.md

PagerDuty::Users::User

This resource type manages a PagerDuty User

Documentation

Prerequisites

AWS Management Console

To get started:

  1. Sign in to the AWS Management Console with your account and navigate to CloudFormation.

  2. Select "Public extensions" from the left hand pane and filter Publisher by "Third Party".

  3. Use the search bar to filter by the "PagerDuty::Users::User" prefix.

Note: All official PagerDuty resources begin with PagerDuty:: and specify that they are Published by PagerDuty.

  1. Select the desired resource name to view more information about its schema, and click Activate.

  2. On the Extension details page, specify:

  • Extension name
  • Execution role ARN
  • Automatic updates for minor version releases
  • Configuration
  1. In your terminal, specify the configuration data for the registered PagerDuty CloudFormation resource type, in the given account and region by using the SetTypeConfiguration operation:

For example:

$ aws cloudformation set-type-configuration \
--region us-west-2 --type RESOURCE \
--type-name PagerDuty::Users::User \
--configuration-alias default \
--configuration "{ \"PagerDutyAccess\":{\"Token\":\"YOURAPIKEY\"}}"
  1. After you have your resource configured, create your AWS stack that includes any of the activated PagerDuty resources.

For more information about available commands and workflows, see the official AWS documentation.

Supported regions

The PagerDuty CloudFormation resources are available on the CloudFormation Public Registry in the following regions:

Code Name
us-east-1 US East (N. Virginia)
us-east-2 US East (Ohio)
us-west-1 US West (N. California)
us-west-2 US West (Oregon)
ap-south-1 Asia Pacific (Mumbai)
ap-northeast-1 Asia Pacific (Tokyo)
ap-northeast-2 Asia Pacific (Seoul)
ap-southeast-1 Asia Pacific (Singapore)
ap-southeast-2 Asia Pacific (Sydney)
ca-central-1 Canada (Central)
eu-central-1 Europe (Frankfurt)
eu-west-1 Europe (Ireland)
eu-west-2 Europe (London)
eu-west-3 Europe (Paris)
eu-north-1 Europe (Stockholm)
sa-east-1 South America (São Paulo)

Note: To privately register a resource in any other region, use the provided packages.

Examples

Shows how to set User in PagerDuty.

---
AWSTemplateFormatVersion: '2010-09-09'
Description: Shows how to create an EscalationPolicy in PagerDuty
Resources:
  SampleEscalationPolicy:
    Type: PagerDuty::EscalationPolicies::EscalationPolicy
    Properties:
      NumLoops: 5
      Name: TestEscalationPolicy
      Teams:
        - Id: 123456
          Type: team_reference
      EscalationRules:
        - EscalationDelayInMinutes: 30
        - Targets:
            - Id: 654321
              Type: user_reference