StatusPage - Khanh Docs

Resource StatusPage in pulumi-better-uptime.

Pulumi type: better-uptime:index/statusPage:StatusPage.

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.

import * as betteruptime from "pulumi-better-uptime"const resource = new betteruptime.StatusPage("statusPage", {  companyName: "<companyName>",  companyUrl: "<companyUrl>",  subdomain: "<subdomain>",  timezone: "<timezone>",})

Arguments#

Property	Type	Required	Description
`announcement`	`string`	no	Add an announcement to your status page.
`announcementEmbedCss`	`string`	no	Modify the design of the announcement embed.
`announcementEmbedLink`	`string`	no	Point your embedded announcement to a specified URL.
`announcementEmbedVisible`	`boolean`	no	Toggle this field if you want to show an announcement in your embed. You can embed the announcement using this snippet: `<script src="https://uptime.betterstack.com/widgets/announcement.js" data-id="<SET STATUS_PAGE_ID>" async="async" type="text/javascript"></script>`
`automaticReports`	`boolean`	no	Generate automatic reports when your services go down
`companyName`	`string`	yes	Name of your company.
`companyUrl`	`string`	yes	URL of your company's website.
`contactUrl`	`string`	no	URL that should be used for contacting you in case of an emergency.
`customCss`	`string`	no	Unleash your inner designer and tweak our status page design to fit your branding.
`customDomain`	`string`	no	Do you want a custom domain on your status page? Add a CNAME record that points your domain to status.betteruptime.com. Example: `CNAME status.walmine.com statuspage.betteruptime.com` To remove the custom domain, set the value to an empty string `""`.
`customJavascript`	`string`	no	Add custom behavior to your status page. It is only allowed for status pages with a custom domain name.
`darkLogoUrl`	`string`	no	A direct link to a dark version of your company's logo. The image should be under 20MB in size.
`design`	`string`	no	Choose between classic and modern status page design. Possible values: 'v1', 'v2'.
`googleAnalyticsId`	`string`	no	Specify your own Google Analytics ID if you want to receive hits on your status page.
`hideFromSearchEngines`	`boolean`	no	Hide your status page from search engines.
`history`	`number`	no	Number of days to display on the status page. Between 7 and 365 days.
`ipAllowlists`	`string[]`	no	List of IP addresses or CIDR ranges that are allowed to access the status page. Accepts IPv4, IPv6, CIDR ranges, and comments starting with `#`. To remove all IP restrictions, set to an empty list `[]`. This is a billable feature.
`layout`	`string`	no	Choose usual vertical layout or space-saving horizontal layout. Only applicable when design: v2. Possible values: 'vertical', 'horizontal'.
`logoUrl`	`string`	no	A direct link to your company's logo. The image should be under 20MB in size.
`minIncidentLength`	`number`	no	If you don't want to display short incidents on your status page, this attribute is for you.
`navigationLinks`	`StatusPageNavigationLink (input)[]`	no	Adjust the navigation links on your status page. Only applicable when design: v2. Only first 4 links considered.
`password`	`string`	no	Set a password of your status page (we won't store it as plaintext, promise). Required when password_enabled: true. We will set password_enabled: false automatically when you send us an empty password.
`passwordEnabled`	`boolean`	no	Do you want to enable password protection on your status page?
`published`	`boolean`	no	Is your status page currently accessible?
`requireSso`	`boolean`	no	Require SSO sign-in to access your status page. Requires SSO to be configured for your organization and is mutually exclusive with password protection.
`statusPageGroupId`	`number`	no	Set this attribute if you want to add this status page to a status page group.
`subdomain`	`string`	yes	What subdomain should we use for your status page? This needs to be unique across our entire application, so choose carefully
`subscribable`	`boolean`	no	Do you want to allow users to subscribe to your status page changes?
`theme`	`string`	no	Choose theme of your status page. Only applicable when design: v2. Possible values: 'light', 'dark'.
`timezone`	`string`	yes	What timezone should we display your status page in? The accepted values can be found in the Rails TimeZone documentation. https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html
`whitelabeled`	`boolean`	no	Whether the 'Powered by Better Stack' footer should be removed.

Outputs#

Computed outputs are produced by the provider. They are not constructor arguments.

Property	Type	Computed	Description
`aggregateState`	`string`	yes	The overall status of this status page.
`announcement`	`string`	no	Add an announcement to your status page.
`announcementEmbedCss`	`string`	no	Modify the design of the announcement embed.
`announcementEmbedLink`	`string`	no	Point your embedded announcement to a specified URL.
`announcementEmbedVisible`	`boolean`	no	Toggle this field if you want to show an announcement in your embed. You can embed the announcement using this snippet: `<script src="https://uptime.betterstack.com/widgets/announcement.js" data-id="<SET STATUS_PAGE_ID>" async="async" type="text/javascript"></script>`
`automaticReports`	`boolean`	no	Generate automatic reports when your services go down
`companyName`	`string`	no	Name of your company.
`companyUrl`	`string`	no	URL of your company's website.
`contactUrl`	`string`	no	URL that should be used for contacting you in case of an emergency.
`createdAt`	`string`	yes	The time when this status page was created.
`customCss`	`string`	no	Unleash your inner designer and tweak our status page design to fit your branding.
`customDomain`	`string`	no	Do you want a custom domain on your status page? Add a CNAME record that points your domain to status.betteruptime.com. Example: `CNAME status.walmine.com statuspage.betteruptime.com` To remove the custom domain, set the value to an empty string `""`.
`customJavascript`	`string`	no	Add custom behavior to your status page. It is only allowed for status pages with a custom domain name.
`darkLogoUrl`	`string`	no	A direct link to a dark version of your company's logo. The image should be under 20MB in size.
`design`	`string`	no	Choose between classic and modern status page design. Possible values: 'v1', 'v2'.
`googleAnalyticsId`	`string`	no	Specify your own Google Analytics ID if you want to receive hits on your status page.
`hideFromSearchEngines`	`boolean`	no	Hide your status page from search engines.
`history`	`number`	no	Number of days to display on the status page. Between 7 and 365 days.
`ipAllowlists`	`string[]`	no	List of IP addresses or CIDR ranges that are allowed to access the status page. Accepts IPv4, IPv6, CIDR ranges, and comments starting with `#`. To remove all IP restrictions, set to an empty list `[]`. This is a billable feature.
`layout`	`string`	no	Choose usual vertical layout or space-saving horizontal layout. Only applicable when design: v2. Possible values: 'vertical', 'horizontal'.
`logoUrl`	`string`	no	A direct link to your company's logo. The image should be under 20MB in size.
`minIncidentLength`	`number`	no	If you don't want to display short incidents on your status page, this attribute is for you.
`navigationLinks`	`StatusPageNavigationLink (output)[]`	no	Adjust the navigation links on your status page. Only applicable when design: v2. Only first 4 links considered.
`password`	`string`	no	Set a password of your status page (we won't store it as plaintext, promise). Required when password_enabled: true. We will set password_enabled: false automatically when you send us an empty password.
`passwordEnabled`	`boolean`	no	Do you want to enable password protection on your status page?
`published`	`boolean`	no	Is your status page currently accessible?
`requireSso`	`boolean`	no	Require SSO sign-in to access your status page. Requires SSO to be configured for your organization and is mutually exclusive with password protection.
`statusPageGroupId`	`number`	no	Set this attribute if you want to add this status page to a status page group.
`subdomain`	`string`	no	What subdomain should we use for your status page? This needs to be unique across our entire application, so choose carefully
`subscribable`	`boolean`	no	Do you want to allow users to subscribe to your status page changes?
`theme`	`string`	no	Choose theme of your status page. Only applicable when design: v2. Possible values: 'light', 'dark'.
`timezone`	`string`	no	What timezone should we display your status page in? The accepted values can be found in the Rails TimeZone documentation. https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html
`updatedAt`	`string`	yes	The time when this status page was updated.
`whitelabeled`	`boolean`	no	Whether the 'Powered by Better Stack' footer should be removed.

`StatusPageNavigationLink (input)`#

Input object StatusPageNavigationLink. Fields below belong to this object, not to the parent.

Property	Type	Required	Description
`href`	`string`	yes	Href of the link. Use full URL for external links. Use `/`, `/maintenance` and `/incidents` for built-in links.
`text`	`string`	yes	Label of the link.

`StatusPageNavigationLink (output)`#

Output object StatusPageNavigationLink. Fields below belong to this object.

Property	Type	Always present	Description
`href`	`string`	yes	Href of the link. Use full URL for external links. Use `/`, `/maintenance` and `/incidents` for built-in links.
`text`	`string`	yes	Label of the link.

Example#

Arguments#

Outputs#

StatusPageNavigationLink (input)#

StatusPageNavigationLink (output)#

`StatusPageNavigationLink (input)`#

`StatusPageNavigationLink (output)`#