Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Checkly
  3. API Docs
  4. StatusPage
Checkly v2.2.0 published on Wednesday, Apr 9, 2025 by Checkly
checkly/pulumi-checkly

checkly.StatusPage

Explore with Pulumi AI

Checkly v2.2.0 published on Wednesday, Apr 9, 2025 by Checkly
checkly/pulumi-checkly

Checkly status pages allow you to easily communicate the uptime and health of your applications and services to your customers.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as checkly from "@checkly/pulumi";

const api = new checkly.StatusPageService("api", {name: "API"});
const database = new checkly.StatusPageService("database", {name: "Database"});
const example = new checkly.StatusPage("example", {
    name: "Example Application",
    url: "my-example-status-page",
    defaultTheme: "DARK",
    cards: [{
        name: "Services",
        serviceAttachments: [
            {
                serviceId: api.id,
            },
            {
                serviceId: database.id,
            },
        ],
    }],
});
Copy
import pulumi
import pulumi_checkly as checkly

api = checkly.StatusPageService("api", name="API")
database = checkly.StatusPageService("database", name="Database")
example = checkly.StatusPage("example",
    name="Example Application",
    url="my-example-status-page",
    default_theme="DARK",
    cards=[{
        "name": "Services",
        "service_attachments": [
            {
                "service_id": api.id,
            },
            {
                "service_id": database.id,
            },
        ],
    }])
Copy
package main

import (
	"github.com/checkly/pulumi-checkly/sdk/v2/go/checkly"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		api, err := checkly.NewStatusPageService(ctx, "api", &checkly.StatusPageServiceArgs{
			Name: pulumi.String("API"),
		})
		if err != nil {
			return err
		}
		database, err := checkly.NewStatusPageService(ctx, "database", &checkly.StatusPageServiceArgs{
			Name: pulumi.String("Database"),
		})
		if err != nil {
			return err
		}
		_, err = checkly.NewStatusPage(ctx, "example", &checkly.StatusPageArgs{
			Name:         pulumi.String("Example Application"),
			Url:          pulumi.String("my-example-status-page"),
			DefaultTheme: pulumi.String("DARK"),
			Cards: checkly.StatusPageCardArray{
				&checkly.StatusPageCardArgs{
					Name: pulumi.String("Services"),
					ServiceAttachments: checkly.StatusPageCardServiceAttachmentArray{
						&checkly.StatusPageCardServiceAttachmentArgs{
							ServiceId: api.ID(),
						},
						&checkly.StatusPageCardServiceAttachmentArgs{
							ServiceId: database.ID(),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Checkly = Pulumi.Checkly;

return await Deployment.RunAsync(() => 
{
    var api = new Checkly.StatusPageService("api", new()
    {
        Name = "API",
    });

    var database = new Checkly.StatusPageService("database", new()
    {
        Name = "Database",
    });

    var example = new Checkly.StatusPage("example", new()
    {
        Name = "Example Application",
        Url = "my-example-status-page",
        DefaultTheme = "DARK",
        Cards = new[]
        {
            new Checkly.Inputs.StatusPageCardArgs
            {
                Name = "Services",
                ServiceAttachments = new[]
                {
                    new Checkly.Inputs.StatusPageCardServiceAttachmentArgs
                    {
                        ServiceId = api.Id,
                    },
                    new Checkly.Inputs.StatusPageCardServiceAttachmentArgs
                    {
                        ServiceId = database.Id,
                    },
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkly.StatusPageService;
import com.pulumi.checkly.StatusPageServiceArgs;
import com.pulumi.checkly.StatusPage;
import com.pulumi.checkly.StatusPageArgs;
import com.pulumi.checkly.inputs.StatusPageCardArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var api = new StatusPageService("api", StatusPageServiceArgs.builder()
            .name("API")
            .build());

        var database = new StatusPageService("database", StatusPageServiceArgs.builder()
            .name("Database")
            .build());

        var example = new StatusPage("example", StatusPageArgs.builder()
            .name("Example Application")
            .url("my-example-status-page")
            .defaultTheme("DARK")
            .cards(StatusPageCardArgs.builder()
                .name("Services")
                .serviceAttachments(                
                    StatusPageCardServiceAttachmentArgs.builder()
                        .serviceId(api.id())
                        .build(),
                    StatusPageCardServiceAttachmentArgs.builder()
                        .serviceId(database.id())
                        .build())
                .build())
            .build());

    }
}
Copy
resources:
  api:
    type: checkly:StatusPageService
    properties:
      name: API
  database:
    type: checkly:StatusPageService
    properties:
      name: Database
  example:
    type: checkly:StatusPage
    properties:
      name: Example Application
      url: my-example-status-page
      defaultTheme: DARK
      cards:
        - name: Services
          serviceAttachments:
            - serviceId: ${api.id}
            - serviceId: ${database.id}
Copy

Create StatusPage Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new StatusPage(name: string, args: StatusPageArgs, opts?: CustomResourceOptions);
@overload
def StatusPage(resource_name: str,
               args: StatusPageArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def StatusPage(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               cards: Optional[Sequence[StatusPageCardArgs]] = None,
               url: Optional[str] = None,
               custom_domain: Optional[str] = None,
               default_theme: Optional[str] = None,
               favicon: Optional[str] = None,
               logo: Optional[str] = None,
               name: Optional[str] = None,
               redirect_to: Optional[str] = None)
func NewStatusPage(ctx *Context, name string, args StatusPageArgs, opts ...ResourceOption) (*StatusPage, error)
public StatusPage(string name, StatusPageArgs args, CustomResourceOptions? opts = null)
public StatusPage(String name, StatusPageArgs args)
public StatusPage(String name, StatusPageArgs args, CustomResourceOptions options)

type: checkly:StatusPage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. StatusPageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. StatusPageArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. StatusPageArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. StatusPageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. StatusPageArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var statusPageResource = new Checkly.StatusPage("statusPageResource", new()
{
    Cards = new[]
    {
        new Checkly.Inputs.StatusPageCardArgs
        {
            Name = "string",
            ServiceAttachments = new[]
            {
                new Checkly.Inputs.StatusPageCardServiceAttachmentArgs
                {
                    ServiceId = "string",
                },
            },
        },
    },
    Url = "string",
    CustomDomain = "string",
    DefaultTheme = "string",
    Favicon = "string",
    Logo = "string",
    Name = "string",
    RedirectTo = "string",
});
Copy
example, err := checkly.NewStatusPage(ctx, "statusPageResource", &checkly.StatusPageArgs{
	Cards: checkly.StatusPageCardArray{
		&checkly.StatusPageCardArgs{
			Name: pulumi.String("string"),
			ServiceAttachments: checkly.StatusPageCardServiceAttachmentArray{
				&checkly.StatusPageCardServiceAttachmentArgs{
					ServiceId: pulumi.String("string"),
				},
			},
		},
	},
	Url:          pulumi.String("string"),
	CustomDomain: pulumi.String("string"),
	DefaultTheme: pulumi.String("string"),
	Favicon:      pulumi.String("string"),
	Logo:         pulumi.String("string"),
	Name:         pulumi.String("string"),
	RedirectTo:   pulumi.String("string"),
})
Copy
var statusPageResource = new StatusPage("statusPageResource", StatusPageArgs.builder()
    .cards(StatusPageCardArgs.builder()
        .name("string")
        .serviceAttachments(StatusPageCardServiceAttachmentArgs.builder()
            .serviceId("string")
            .build())
        .build())
    .url("string")
    .customDomain("string")
    .defaultTheme("string")
    .favicon("string")
    .logo("string")
    .name("string")
    .redirectTo("string")
    .build());
Copy
status_page_resource = checkly.StatusPage("statusPageResource",
    cards=[{
        "name": "string",
        "service_attachments": [{
            "service_id": "string",
        }],
    }],
    url="string",
    custom_domain="string",
    default_theme="string",
    favicon="string",
    logo="string",
    name="string",
    redirect_to="string")
Copy
const statusPageResource = new checkly.StatusPage("statusPageResource", {
    cards: [{
        name: "string",
        serviceAttachments: [{
            serviceId: "string",
        }],
    }],
    url: "string",
    customDomain: "string",
    defaultTheme: "string",
    favicon: "string",
    logo: "string",
    name: "string",
    redirectTo: "string",
});
Copy
type: checkly:StatusPage
properties:
    cards:
        - name: string
          serviceAttachments:
            - serviceId: string
    customDomain: string
    defaultTheme: string
    favicon: string
    logo: string
    name: string
    redirectTo: string
    url: string
Copy

StatusPage Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The StatusPage resource accepts the following input properties:

Cards This property is required. List<StatusPageCard>
A list of cards to include on the status page.
Url This property is required. string
The URL of the status page.
CustomDomain string
A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
DefaultTheme string
Possible values are AUTO, DARK, and LIGHT. (Default AUTO).
Favicon string
A URL to an image file to use as the favicon of the status page.
Logo string
A URL to an image file to use as the logo for the status page.
Name string
The name of the status page.
RedirectTo string
The URL the user should be redirected to when clicking the logo.
Cards This property is required. []StatusPageCardArgs
A list of cards to include on the status page.
Url This property is required. string
The URL of the status page.
CustomDomain string
A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
DefaultTheme string
Possible values are AUTO, DARK, and LIGHT. (Default AUTO).
Favicon string
A URL to an image file to use as the favicon of the status page.
Logo string
A URL to an image file to use as the logo for the status page.
Name string
The name of the status page.
RedirectTo string
The URL the user should be redirected to when clicking the logo.
cards This property is required. List<StatusPageCard>
A list of cards to include on the status page.
url This property is required. String
The URL of the status page.
customDomain String
A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
defaultTheme String
Possible values are AUTO, DARK, and LIGHT. (Default AUTO).
favicon String
A URL to an image file to use as the favicon of the status page.
logo String
A URL to an image file to use as the logo for the status page.
name String
The name of the status page.
redirectTo String
The URL the user should be redirected to when clicking the logo.
cards This property is required. StatusPageCard[]
A list of cards to include on the status page.
url This property is required. string
The URL of the status page.
customDomain string
A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
defaultTheme string
Possible values are AUTO, DARK, and LIGHT. (Default AUTO).
favicon string
A URL to an image file to use as the favicon of the status page.
logo string
A URL to an image file to use as the logo for the status page.
name string
The name of the status page.
redirectTo string
The URL the user should be redirected to when clicking the logo.
cards This property is required. Sequence[StatusPageCardArgs]
A list of cards to include on the status page.
url This property is required. str
The URL of the status page.
custom_domain str
A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
default_theme str
Possible values are AUTO, DARK, and LIGHT. (Default AUTO).
favicon str
A URL to an image file to use as the favicon of the status page.
logo str
A URL to an image file to use as the logo for the status page.
name str
The name of the status page.
redirect_to str
The URL the user should be redirected to when clicking the logo.
cards This property is required. List<Property Map>
A list of cards to include on the status page.
url This property is required. String
The URL of the status page.
customDomain String
A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
defaultTheme String
Possible values are AUTO, DARK, and LIGHT. (Default AUTO).
favicon String
A URL to an image file to use as the favicon of the status page.
logo String
A URL to an image file to use as the logo for the status page.
name String
The name of the status page.
redirectTo String
The URL the user should be redirected to when clicking the logo.

Outputs

All input properties are implicitly available as output properties. Additionally, the StatusPage resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing StatusPage Resource

Get an existing StatusPage resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: StatusPageState, opts?: CustomResourceOptions): StatusPage
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cards: Optional[Sequence[StatusPageCardArgs]] = None,
        custom_domain: Optional[str] = None,
        default_theme: Optional[str] = None,
        favicon: Optional[str] = None,
        logo: Optional[str] = None,
        name: Optional[str] = None,
        redirect_to: Optional[str] = None,
        url: Optional[str] = None) -> StatusPage
func GetStatusPage(ctx *Context, name string, id IDInput, state *StatusPageState, opts ...ResourceOption) (*StatusPage, error)
public static StatusPage Get(string name, Input<string> id, StatusPageState? state, CustomResourceOptions? opts = null)
public static StatusPage get(String name, Output<String> id, StatusPageState state, CustomResourceOptions options)
resources:  _:    type: checkly:StatusPage    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Cards List<StatusPageCard>
A list of cards to include on the status page.
CustomDomain string
A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
DefaultTheme string
Possible values are AUTO, DARK, and LIGHT. (Default AUTO).
Favicon string
A URL to an image file to use as the favicon of the status page.
Logo string
A URL to an image file to use as the logo for the status page.
Name string
The name of the status page.
RedirectTo string
The URL the user should be redirected to when clicking the logo.
Url string
The URL of the status page.
Cards []StatusPageCardArgs
A list of cards to include on the status page.
CustomDomain string
A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
DefaultTheme string
Possible values are AUTO, DARK, and LIGHT. (Default AUTO).
Favicon string
A URL to an image file to use as the favicon of the status page.
Logo string
A URL to an image file to use as the logo for the status page.
Name string
The name of the status page.
RedirectTo string
The URL the user should be redirected to when clicking the logo.
Url string
The URL of the status page.
cards List<StatusPageCard>
A list of cards to include on the status page.
customDomain String
A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
defaultTheme String
Possible values are AUTO, DARK, and LIGHT. (Default AUTO).
favicon String
A URL to an image file to use as the favicon of the status page.
logo String
A URL to an image file to use as the logo for the status page.
name String
The name of the status page.
redirectTo String
The URL the user should be redirected to when clicking the logo.
url String
The URL of the status page.
cards StatusPageCard[]
A list of cards to include on the status page.
customDomain string
A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
defaultTheme string
Possible values are AUTO, DARK, and LIGHT. (Default AUTO).
favicon string
A URL to an image file to use as the favicon of the status page.
logo string
A URL to an image file to use as the logo for the status page.
name string
The name of the status page.
redirectTo string
The URL the user should be redirected to when clicking the logo.
url string
The URL of the status page.
cards Sequence[StatusPageCardArgs]
A list of cards to include on the status page.
custom_domain str
A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
default_theme str
Possible values are AUTO, DARK, and LIGHT. (Default AUTO).
favicon str
A URL to an image file to use as the favicon of the status page.
logo str
A URL to an image file to use as the logo for the status page.
name str
The name of the status page.
redirect_to str
The URL the user should be redirected to when clicking the logo.
url str
The URL of the status page.
cards List<Property Map>
A list of cards to include on the status page.
customDomain String
A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
defaultTheme String
Possible values are AUTO, DARK, and LIGHT. (Default AUTO).
favicon String
A URL to an image file to use as the favicon of the status page.
logo String
A URL to an image file to use as the logo for the status page.
name String
The name of the status page.
redirectTo String
The URL the user should be redirected to when clicking the logo.
url String
The URL of the status page.

Supporting Types

StatusPageCard
, StatusPageCardArgs

Name This property is required. string
The name of the card.
ServiceAttachments This property is required. List<StatusPageCardServiceAttachment>
A list of services to attach to the card.
Name This property is required. string
The name of the card.
ServiceAttachments This property is required. []StatusPageCardServiceAttachment
A list of services to attach to the card.
name This property is required. String
The name of the card.
serviceAttachments This property is required. List<StatusPageCardServiceAttachment>
A list of services to attach to the card.
name This property is required. string
The name of the card.
serviceAttachments This property is required. StatusPageCardServiceAttachment[]
A list of services to attach to the card.
name This property is required. str
The name of the card.
service_attachments This property is required. Sequence[StatusPageCardServiceAttachment]
A list of services to attach to the card.
name This property is required. String
The name of the card.
serviceAttachments This property is required. List<Property Map>
A list of services to attach to the card.

StatusPageCardServiceAttachment
, StatusPageCardServiceAttachmentArgs

ServiceId This property is required. string
The ID of the service.
ServiceId This property is required. string
The ID of the service.
serviceId This property is required. String
The ID of the service.
serviceId This property is required. string
The ID of the service.
service_id This property is required. str
The ID of the service.
serviceId This property is required. String
The ID of the service.

Package Details

Repository
checkly checkly/pulumi-checkly
License
Apache-2.0
Notes
This Pulumi package is based on the checkly Terraform Provider.
Checkly v2.2.0 published on Wednesday, Apr 9, 2025 by Checkly
checkly/pulumi-checkly