This collection of AWS CloudFormation resource types allow Rollbar to be controlled using AWS CloudFormation.
Resource | Description | Documentation |
---|---|---|
Rollbar::Notifications::Rule | This resource type manages a Rollbar notification rule | /Rollbar-Notifications-Rule |
Rollbar::Projects::AccessToken | This resource type manages a Rollbar project access token | /Rollbar-Projects-AccessToken |
Rollbar::Projects::Project | This resource type manages a Rollbar project | /Rollbar-Projects-Project |
Rollbar::Teams::Membership | This resource type manages a membership between a Rollbar team and project | /Rollbar-Teams-Membership |
Rollbar::Teams::Team | This resource type manages a Rollbar team | /Rollbar-Teams-Team |
To get started:
-
Sign in to the AWS Management Console with your account and navigate to CloudFormation.
-
Select "Public extensions" from the left hand pane and filter Publisher by "Third Party".
-
Use the search bar to filter by the "Rollbar" prefix.
Note: All official Rollbar resources begin with Rollbar::
and specify that they are Published by Rollbar
.
-
Select the desired resource name to view more information about its schema, and click Activate.
-
On the Extension details page, specify:
- Extension name
- Execution role ARN
- Automatic updates for minor version releases
- Configuration
- In your terminal, specify the configuration data for the registered Rollbar 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 Rollbar::Projects::Project \
--configuration-alias default \
--configuration "{ \"RollbarAccess\":{\"Token\":\"YOURACCOUNTTOKEN\"}}"
Note: All Rollbar resources requires a type configuration to be set, except Rollbar::Notifications::Rule
.
- After you have your resource configured, create your AWS stack that includes any of the activated Rollbar resources.
For more information about available commands and workflows, see the official AWS documentation.
The Rollbar 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.
---
AWSTemplateFormatVersion: '2010-09-09'
Description: Shows how to create a Rollbar project.
Resources:
RollbarProductionApp:
Type: Rollbar::Projects::Project
Properties:
Name: MySampleProject
Email:
Enabled: true
IncludeRequestParams: true
PagerDuty:
Enabled: true
ServiceKey: MzUwNDE0M3xBUE18QVBQTElDQVRJT058NDE5OTY3OTEw
---
AWSTemplateFormatVersion: '2010-09-09'
Description: Shows how to create a Rollbar access token.
Resources:
MySampleProjectAccessToken:
Type: Rollbar::Projects::AccessToken
Properties:
ProjectId: 123456
Name: Sample Access token
Scopes:
- write
- read
RateLimitWindowSize: 60
RateLimitWindowCount: 10
---
AWSTemplateFormatVersion: '2010-09-09'
Description: Shows how to set a Rollbar notification rule.
Resources:
MySampleNotificationRule:
Type: Rollbar::Notifications::Rule
Properties:
ProjectAccessToken: !Ref RollbarProductionAppAccessToken
Email:
Trigger: exp_repeat_item
Filters:
- Type: level
Operation: gte
Value: error
Config:
Teams:
- Day Team
- Night Team
---
AWSTemplateFormatVersion: '2010-09-09'
Description: Shows how to create a Rollbar team and assign it to a project.
Resources:
MySampleTeam:
Type: Rollbar::Teams::Team
Properties:
Name: Sample Team
AccessLevel: standard
MySampleTeamMembership:
Type: Rollbar::Teams::Membership
Properties:
TeamId: !GetAtt MySampleTeam.Id
MemberId: 123456
MemberType: project