1. Registry
  2. Packages
  3. Rootly
  4. API Docs
  5. StatusPageComponentGroup
Viewing docs for Rootly v4.0.0
published on Tuesday, Sep 15, 2026 by rootlyhq
rootly logo
Viewing docs for Rootly v4.0.0
published on Tuesday, Sep 15, 2026 by rootlyhq

    Manages a Status Pages V3 component group.

    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

    resource "rootly_status_page_component_group" "infrastructure" {
      status_page_id       = rootly_status_page.public.id
      name                 = "Infrastructure"
      description          = "Core infrastructure services"
      collapsed_by_default = false
    }
    

    Create StatusPageComponentGroup Resource

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

    Constructor syntax

    new StatusPageComponentGroup(name: string, args: StatusPageComponentGroupArgs, opts?: CustomResourceOptions);
    @overload
    def StatusPageComponentGroup(resource_name: str,
                                 args: StatusPageComponentGroupArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def StatusPageComponentGroup(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 status_page_id: Optional[str] = None,
                                 collapsed_by_default: Optional[bool] = None,
                                 description: Optional[str] = None,
                                 name: Optional[str] = None,
                                 position: Optional[int] = None)
    func NewStatusPageComponentGroup(ctx *Context, name string, args StatusPageComponentGroupArgs, opts ...ResourceOption) (*StatusPageComponentGroup, error)
    public StatusPageComponentGroup(string name, StatusPageComponentGroupArgs args, CustomResourceOptions? opts = null)
    public StatusPageComponentGroup(String name, StatusPageComponentGroupArgs args)
    public StatusPageComponentGroup(String name, StatusPageComponentGroupArgs args, CustomResourceOptions options)
    
    type: rootly:StatusPageComponentGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "rootly_status_page_component_group" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args StatusPageComponentGroupArgs
    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 StatusPageComponentGroupArgs
    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 StatusPageComponentGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StatusPageComponentGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StatusPageComponentGroupArgs
    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 statusPageComponentGroupResource = new Rootly.StatusPageComponentGroup("statusPageComponentGroupResource", new()
    {
        StatusPageId = "string",
        CollapsedByDefault = false,
        Description = "string",
        Name = "string",
        Position = 0,
    });
    
    example, err := rootly.NewStatusPageComponentGroup(ctx, "statusPageComponentGroupResource", &rootly.StatusPageComponentGroupArgs{
    	StatusPageId:       pulumi.String("string"),
    	CollapsedByDefault: pulumi.Bool(false),
    	Description:        pulumi.String("string"),
    	Name:               pulumi.String("string"),
    	Position:           pulumi.Int(0),
    })
    
    resource "rootly_status_page_component_group" "statusPageComponentGroupResource" {
      lifecycle {
        create_before_destroy = true
      }
      status_page_id       = "string"
      collapsed_by_default = false
      description          = "string"
      name                 = "string"
      position             = 0
    }
    
    var statusPageComponentGroupResource = new StatusPageComponentGroup("statusPageComponentGroupResource", StatusPageComponentGroupArgs.builder()
        .statusPageId("string")
        .collapsedByDefault(false)
        .description("string")
        .name("string")
        .position(0)
        .build());
    
    status_page_component_group_resource = rootly.StatusPageComponentGroup("statusPageComponentGroupResource",
        status_page_id="string",
        collapsed_by_default=False,
        description="string",
        name="string",
        position=0)
    
    const statusPageComponentGroupResource = new rootly.StatusPageComponentGroup("statusPageComponentGroupResource", {
        statusPageId: "string",
        collapsedByDefault: false,
        description: "string",
        name: "string",
        position: 0,
    });
    
    type: rootly:StatusPageComponentGroup
    properties:
        collapsedByDefault: false
        description: string
        name: string
        position: 0
        statusPageId: string
    

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

    StatusPageId string
    CollapsedByDefault bool
    Whether the group renders collapsed on the public page. Value must be one of true or false
    Description string
    Description of the component group
    Name string
    Name of the component group
    Position int
    Position of the group on the status page's top-level list
    StatusPageId string
    CollapsedByDefault bool
    Whether the group renders collapsed on the public page. Value must be one of true or false
    Description string
    Description of the component group
    Name string
    Name of the component group
    Position int
    Position of the group on the status page's top-level list
    status_page_id string
    collapsed_by_default bool
    Whether the group renders collapsed on the public page. Value must be one of true or false
    description string
    Description of the component group
    name string
    Name of the component group
    position number
    Position of the group on the status page's top-level list
    statusPageId String
    collapsedByDefault Boolean
    Whether the group renders collapsed on the public page. Value must be one of true or false
    description String
    Description of the component group
    name String
    Name of the component group
    position Integer
    Position of the group on the status page's top-level list
    statusPageId string
    collapsedByDefault boolean
    Whether the group renders collapsed on the public page. Value must be one of true or false
    description string
    Description of the component group
    name string
    Name of the component group
    position number
    Position of the group on the status page's top-level list
    status_page_id str
    collapsed_by_default bool
    Whether the group renders collapsed on the public page. Value must be one of true or false
    description str
    Description of the component group
    name str
    Name of the component group
    position int
    Position of the group on the status page's top-level list
    statusPageId String
    collapsedByDefault Boolean
    Whether the group renders collapsed on the public page. Value must be one of true or false
    description String
    Description of the component group
    name String
    Name of the component group
    position Number
    Position of the group on the status page's top-level list

    Outputs

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

    Get an existing StatusPageComponentGroup 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?: StatusPageComponentGroupState, opts?: CustomResourceOptions): StatusPageComponentGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            collapsed_by_default: Optional[bool] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            position: Optional[int] = None,
            status_page_id: Optional[str] = None) -> StatusPageComponentGroup
    func GetStatusPageComponentGroup(ctx *Context, name string, id IDInput, state *StatusPageComponentGroupState, opts ...ResourceOption) (*StatusPageComponentGroup, error)
    public static StatusPageComponentGroup Get(string name, Input<string> id, StatusPageComponentGroupState? state, CustomResourceOptions? opts = null)
    public static StatusPageComponentGroup get(String name, Output<String> id, StatusPageComponentGroupState state, CustomResourceOptions options)
    resources:  _:    type: rootly:StatusPageComponentGroup    get:      id: ${id}
    import {
      to = rootly_status_page_component_group.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:
    CollapsedByDefault bool
    Whether the group renders collapsed on the public page. Value must be one of true or false
    Description string
    Description of the component group
    Name string
    Name of the component group
    Position int
    Position of the group on the status page's top-level list
    StatusPageId string
    CollapsedByDefault bool
    Whether the group renders collapsed on the public page. Value must be one of true or false
    Description string
    Description of the component group
    Name string
    Name of the component group
    Position int
    Position of the group on the status page's top-level list
    StatusPageId string
    collapsed_by_default bool
    Whether the group renders collapsed on the public page. Value must be one of true or false
    description string
    Description of the component group
    name string
    Name of the component group
    position number
    Position of the group on the status page's top-level list
    status_page_id string
    collapsedByDefault Boolean
    Whether the group renders collapsed on the public page. Value must be one of true or false
    description String
    Description of the component group
    name String
    Name of the component group
    position Integer
    Position of the group on the status page's top-level list
    statusPageId String
    collapsedByDefault boolean
    Whether the group renders collapsed on the public page. Value must be one of true or false
    description string
    Description of the component group
    name string
    Name of the component group
    position number
    Position of the group on the status page's top-level list
    statusPageId string
    collapsed_by_default bool
    Whether the group renders collapsed on the public page. Value must be one of true or false
    description str
    Description of the component group
    name str
    Name of the component group
    position int
    Position of the group on the status page's top-level list
    status_page_id str
    collapsedByDefault Boolean
    Whether the group renders collapsed on the public page. Value must be one of true or false
    description String
    Description of the component group
    name String
    Name of the component group
    position Number
    Position of the group on the status page's top-level list
    statusPageId String

    Import

    rootly.StatusPageComponentGroup can be imported using the import command.

    $ pulumi import rootly:index/statusPageComponentGroup:StatusPageComponentGroup 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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial