Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Rootly
  4. API Docs
  5. StatusPageComponent
Viewing docs for Rootly v4.0.0
published on Tuesday, Sep 15, 2026 by rootlyhq
Schema (JSON)
rootlyhq/pulumi-rootly

rootly.StatusPageComponent

rootly logo
Viewing docs for Rootly v4.0.0
published on Tuesday, Sep 15, 2026 by rootlyhq
Schema (JSON)
rootlyhq/pulumi-rootly

    Manages a Status Pages V3 component.

    Early access: This resource is not generally available. It is available only to organizations participating in the Status Pages V3 Early Access program. Contact Rootly Support to request access.

    Example Usage

    # Ad-hoc component with its own name and description
resource "rootly_status_page_component" "website" {
  status_page_id                 = rootly_status_page.public.id
  status_page_component_group_id = rootly_status_page_component_group.infrastructure.id
  name                           = "Website"
  description                    = "Public marketing website"
}

# Catalog-backed component mirroring a service; name and description
# are derived from the backing service.
resource "rootly_status_page_component" "database" {
  status_page_id = rootly_status_page.public.id
  source_type    = "Service"
  source_id      = rootly_service.elasticsearch_prod.id
}

    Create StatusPageComponent Resource

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

    Constructor syntax

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

@overload
def StatusPageComponent(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        status_page_id: Optional[str] = None,
                        description: Optional[str] = None,
                        name: Optional[str] = None,
                        position: Optional[int] = None,
                        source_id: Optional[str] = None,
                        source_type: Optional[str] = None,
                        status: Optional[str] = None,
                        status_page_component_group_id: Optional[str] = None)
    func NewStatusPageComponent(ctx *Context, name string, args StatusPageComponentArgs, opts ...ResourceOption) (*StatusPageComponent, error)
    public StatusPageComponent(string name, StatusPageComponentArgs args, CustomResourceOptions? opts = null)
    public StatusPageComponent(String name, StatusPageComponentArgs args)
public StatusPageComponent(String name, StatusPageComponentArgs args, CustomResourceOptions options)

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


    resource "rootly_status_page_component" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args StatusPageComponentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args StatusPageComponentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args StatusPageComponentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StatusPageComponentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StatusPageComponentArgs
    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 statusPageComponentResource = new Rootly.StatusPageComponent("statusPageComponentResource", new()
{
    StatusPageId = "string",
    Description = "string",
    Name = "string",
    Position = 0,
    SourceId = "string",
    SourceType = "string",
    Status = "string",
    StatusPageComponentGroupId = "string",
});

    example, err := rootly.NewStatusPageComponent(ctx, "statusPageComponentResource", &rootly.StatusPageComponentArgs{
	StatusPageId:               pulumi.String("string"),
	Description:                pulumi.String("string"),
	Name:                       pulumi.String("string"),
	Position:                   pulumi.Int(0),
	SourceId:                   pulumi.String("string"),
	SourceType:                 pulumi.String("string"),
	Status:                     pulumi.String("string"),
	StatusPageComponentGroupId: pulumi.String("string"),
})

    resource "rootly_status_page_component" "statusPageComponentResource" {
  lifecycle {
    create_before_destroy = true
  }
  status_page_id                 = "string"
  description                    = "string"
  name                           = "string"
  position                       = 0
  source_id                      = "string"
  source_type                    = "string"
  status                         = "string"
  status_page_component_group_id = "string"
}

    var statusPageComponentResource = new StatusPageComponent("statusPageComponentResource", StatusPageComponentArgs.builder()
    .statusPageId("string")
    .description("string")
    .name("string")
    .position(0)
    .sourceId("string")
    .sourceType("string")
    .status("string")
    .statusPageComponentGroupId("string")
    .build());

    status_page_component_resource = rootly.StatusPageComponent("statusPageComponentResource",
    status_page_id="string",
    description="string",
    name="string",
    position=0,
    source_id="string",
    source_type="string",
    status="string",
    status_page_component_group_id="string")

    const statusPageComponentResource = new rootly.StatusPageComponent("statusPageComponentResource", {
    statusPageId: "string",
    description: "string",
    name: "string",
    position: 0,
    sourceId: "string",
    sourceType: "string",
    status: "string",
    statusPageComponentGroupId: "string",
});

    type: rootly:StatusPageComponent
properties:
    description: string
    name: string
    position: 0
    sourceId: string
    sourceType: string
    status: string
    statusPageComponentGroupId: string
    statusPageId: string

    StatusPageComponent 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 StatusPageComponent resource accepts the following input properties:

    StatusPageId string
    Description string
    Description of the component (derived from the source for catalog-backed components)
    Name string
    Name of the component (derived from the source for catalog-backed components)
    Position int
    Position of the component
    SourceId string
    ID of the catalog source backing the component (null for ad-hoc components)
    SourceType string
    Catalog source type backing the component (null for ad-hoc components)
    Status string
    Latest recorded status of the component. Value must be one of operational, degradedPerformance, partialOutage, majorOutage, maintenance, impacted.
    StatusPageComponentGroupId string
    ID of the component group the component belongs to
    StatusPageId string
    Description string
    Description of the component (derived from the source for catalog-backed components)
    Name string
    Name of the component (derived from the source for catalog-backed components)
    Position int
    Position of the component
    SourceId string
    ID of the catalog source backing the component (null for ad-hoc components)
    SourceType string
    Catalog source type backing the component (null for ad-hoc components)
    Status string
    Latest recorded status of the component. Value must be one of operational, degradedPerformance, partialOutage, majorOutage, maintenance, impacted.
    StatusPageComponentGroupId string
    ID of the component group the component belongs to
    status_page_id string
    description string
    Description of the component (derived from the source for catalog-backed components)
    name string
    Name of the component (derived from the source for catalog-backed components)
    position number
    Position of the component
    source_id string
    ID of the catalog source backing the component (null for ad-hoc components)
    source_type string
    Catalog source type backing the component (null for ad-hoc components)
    status string
    Latest recorded status of the component. Value must be one of operational, degradedPerformance, partialOutage, majorOutage, maintenance, impacted.
    status_page_component_group_id string
    ID of the component group the component belongs to
    statusPageId String
    description String
    Description of the component (derived from the source for catalog-backed components)
    name String
    Name of the component (derived from the source for catalog-backed components)
    position Integer
    Position of the component
    sourceId String
    ID of the catalog source backing the component (null for ad-hoc components)
    sourceType String
    Catalog source type backing the component (null for ad-hoc components)
    status String
    Latest recorded status of the component. Value must be one of operational, degradedPerformance, partialOutage, majorOutage, maintenance, impacted.
    statusPageComponentGroupId String
    ID of the component group the component belongs to
    statusPageId string
    description string
    Description of the component (derived from the source for catalog-backed components)
    name string
    Name of the component (derived from the source for catalog-backed components)
    position number
    Position of the component
    sourceId string
    ID of the catalog source backing the component (null for ad-hoc components)
    sourceType string
    Catalog source type backing the component (null for ad-hoc components)
    status string
    Latest recorded status of the component. Value must be one of operational, degradedPerformance, partialOutage, majorOutage, maintenance, impacted.
    statusPageComponentGroupId string
    ID of the component group the component belongs to
    status_page_id str
    description str
    Description of the component (derived from the source for catalog-backed components)
    name str
    Name of the component (derived from the source for catalog-backed components)
    position int
    Position of the component
    source_id str
    ID of the catalog source backing the component (null for ad-hoc components)
    source_type str
    Catalog source type backing the component (null for ad-hoc components)
    status str
    Latest recorded status of the component. Value must be one of operational, degradedPerformance, partialOutage, majorOutage, maintenance, impacted.
    status_page_component_group_id str
    ID of the component group the component belongs to
    statusPageId String
    description String
    Description of the component (derived from the source for catalog-backed components)
    name String
    Name of the component (derived from the source for catalog-backed components)
    position Number
    Position of the component
    sourceId String
    ID of the catalog source backing the component (null for ad-hoc components)
    sourceType String
    Catalog source type backing the component (null for ad-hoc components)
    status String
    Latest recorded status of the component. Value must be one of operational, degradedPerformance, partialOutage, majorOutage, maintenance, impacted.
    statusPageComponentGroupId String
    ID of the component group the component belongs to

    Outputs

    All input properties are implicitly available as output properties. Additionally, the StatusPageComponent 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 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 StatusPageComponent Resource

    Get an existing StatusPageComponent 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?: StatusPageComponentState, opts?: CustomResourceOptions): StatusPageComponent
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        position: Optional[int] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        status: Optional[str] = None,
        status_page_component_group_id: Optional[str] = None,
        status_page_id: Optional[str] = None) -> StatusPageComponent
    func GetStatusPageComponent(ctx *Context, name string, id IDInput, state *StatusPageComponentState, opts ...ResourceOption) (*StatusPageComponent, error)
    public static StatusPageComponent Get(string name, Input<string> id, StatusPageComponentState? state, CustomResourceOptions? opts = null)
    public static StatusPageComponent get(String name, Output<String> id, StatusPageComponentState state, CustomResourceOptions options)
    resources:  _:    type: rootly:StatusPageComponent    get:      id: ${id}
    import {
  to = rootly_status_page_component.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Description string
    Description of the component (derived from the source for catalog-backed components)
    Name string
    Name of the component (derived from the source for catalog-backed components)
    Position int
    Position of the component
    SourceId string
    ID of the catalog source backing the component (null for ad-hoc components)
    SourceType string
    Catalog source type backing the component (null for ad-hoc components)
    Status string
    Latest recorded status of the component. Value must be one of operational, degradedPerformance, partialOutage, majorOutage, maintenance, impacted.
    StatusPageComponentGroupId string
    ID of the component group the component belongs to
    StatusPageId string
    Description string
    Description of the component (derived from the source for catalog-backed components)
    Name string
    Name of the component (derived from the source for catalog-backed components)
    Position int
    Position of the component
    SourceId string
    ID of the catalog source backing the component (null for ad-hoc components)
    SourceType string
    Catalog source type backing the component (null for ad-hoc components)
    Status string
    Latest recorded status of the component. Value must be one of operational, degradedPerformance, partialOutage, majorOutage, maintenance, impacted.
    StatusPageComponentGroupId string
    ID of the component group the component belongs to
    StatusPageId string
    description string
    Description of the component (derived from the source for catalog-backed components)
    name string
    Name of the component (derived from the source for catalog-backed components)
    position number
    Position of the component
    source_id string
    ID of the catalog source backing the component (null for ad-hoc components)
    source_type string
    Catalog source type backing the component (null for ad-hoc components)
    status string
    Latest recorded status of the component. Value must be one of operational, degradedPerformance, partialOutage, majorOutage, maintenance, impacted.
    status_page_component_group_id string
    ID of the component group the component belongs to
    status_page_id string
    description String
    Description of the component (derived from the source for catalog-backed components)
    name String
    Name of the component (derived from the source for catalog-backed components)
    position Integer
    Position of the component
    sourceId String
    ID of the catalog source backing the component (null for ad-hoc components)
    sourceType String
    Catalog source type backing the component (null for ad-hoc components)
    status String
    Latest recorded status of the component. Value must be one of operational, degradedPerformance, partialOutage, majorOutage, maintenance, impacted.
    statusPageComponentGroupId String
    ID of the component group the component belongs to
    statusPageId String
    description string
    Description of the component (derived from the source for catalog-backed components)
    name string
    Name of the component (derived from the source for catalog-backed components)
    position number
    Position of the component
    sourceId string
    ID of the catalog source backing the component (null for ad-hoc components)
    sourceType string
    Catalog source type backing the component (null for ad-hoc components)
    status string
    Latest recorded status of the component. Value must be one of operational, degradedPerformance, partialOutage, majorOutage, maintenance, impacted.
    statusPageComponentGroupId string
    ID of the component group the component belongs to
    statusPageId string
    description str
    Description of the component (derived from the source for catalog-backed components)
    name str
    Name of the component (derived from the source for catalog-backed components)
    position int
    Position of the component
    source_id str
    ID of the catalog source backing the component (null for ad-hoc components)
    source_type str
    Catalog source type backing the component (null for ad-hoc components)
    status str
    Latest recorded status of the component. Value must be one of operational, degradedPerformance, partialOutage, majorOutage, maintenance, impacted.
    status_page_component_group_id str
    ID of the component group the component belongs to
    status_page_id str
    description String
    Description of the component (derived from the source for catalog-backed components)
    name String
    Name of the component (derived from the source for catalog-backed components)
    position Number
    Position of the component
    sourceId String
    ID of the catalog source backing the component (null for ad-hoc components)
    sourceType String
    Catalog source type backing the component (null for ad-hoc components)
    status String
    Latest recorded status of the component. Value must be one of operational, degradedPerformance, partialOutage, majorOutage, maintenance, impacted.
    statusPageComponentGroupId String
    ID of the component group the component belongs to
    statusPageId String

    Import

    rootly.StatusPageComponent can be imported using the import command.

    $ pulumi import rootly:index/statusPageComponent:StatusPageComponent primary a816421c-6ceb-481a-87c4-585e47451f24

    Or using an import block.

    Locate the resource id in the web app, or retrieve it by listing resources through the API if it’s not visible in the web app.

    HCL can be generated from the import block using the -generate-config-out flag.

    pulumi preview -generate-config-out=generated.tf

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    rootly rootlyhq/pulumi-rootly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rootly Terraform Provider.
    rootly logo
    Viewing docs for Rootly v4.0.0
    published on Tuesday, Sep 15, 2026 by rootlyhq
    Schema (JSON)
    rootlyhq/pulumi-rootly

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial