1. Registry
  2. Packages
  3. Rootly
  4. API Docs
  5. StatusPageAnnouncement
Viewing docs for Rootly v4.1.0
published on Sunday, Oct 11, 2026 by rootlyhq
rootly logo Rootly
Viewing docs for Rootly v4.1.0
published on Sunday, Oct 11, 2026 by rootlyhq

    Import

    rootly.StatusPageAnnouncement can be imported using the import command.

    $ pulumi import rootly:index/statusPageAnnouncement:StatusPageAnnouncement 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
    

    Create StatusPageAnnouncement Resource

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

    Constructor syntax

    new StatusPageAnnouncement(name: string, args: StatusPageAnnouncementArgs, opts?: CustomResourceOptions);
    @overload
    def StatusPageAnnouncement(resource_name: str,
                               args: StatusPageAnnouncementArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def StatusPageAnnouncement(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               body: Optional[str] = None,
                               status_page_id: Optional[str] = None,
                               title: Optional[str] = None,
                               notify_subscribers: Optional[bool] = None)
    func NewStatusPageAnnouncement(ctx *Context, name string, args StatusPageAnnouncementArgs, opts ...ResourceOption) (*StatusPageAnnouncement, error)
    public StatusPageAnnouncement(string name, StatusPageAnnouncementArgs args, CustomResourceOptions? opts = null)
    public StatusPageAnnouncement(String name, StatusPageAnnouncementArgs args)
    public StatusPageAnnouncement(String name, StatusPageAnnouncementArgs args, CustomResourceOptions options)
    
    type: rootly:StatusPageAnnouncement
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "rootly_status_page_announcement" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args StatusPageAnnouncementArgs
    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 StatusPageAnnouncementArgs
    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 StatusPageAnnouncementArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StatusPageAnnouncementArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StatusPageAnnouncementArgs
    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 statusPageAnnouncementResource = new Rootly.StatusPageAnnouncement("statusPageAnnouncementResource", new()
    {
        Body = "string",
        StatusPageId = "string",
        Title = "string",
        NotifySubscribers = false,
    });
    
    example, err := rootly.NewStatusPageAnnouncement(ctx, "statusPageAnnouncementResource", &rootly.StatusPageAnnouncementArgs{
    	Body:              pulumi.String("string"),
    	StatusPageId:      pulumi.String("string"),
    	Title:             pulumi.String("string"),
    	NotifySubscribers: pulumi.Bool(false),
    })
    
    resource "rootly_status_page_announcement" "statusPageAnnouncementResource" {
      lifecycle {
        create_before_destroy = true
      }
      body               = "string"
      status_page_id     = "string"
      title              = "string"
      notify_subscribers = false
    }
    
    var statusPageAnnouncementResource = new StatusPageAnnouncement("statusPageAnnouncementResource", StatusPageAnnouncementArgs.builder()
        .body("string")
        .statusPageId("string")
        .title("string")
        .notifySubscribers(false)
        .build());
    
    status_page_announcement_resource = rootly.StatusPageAnnouncement("statusPageAnnouncementResource",
        body="string",
        status_page_id="string",
        title="string",
        notify_subscribers=False)
    
    const statusPageAnnouncementResource = new rootly.StatusPageAnnouncement("statusPageAnnouncementResource", {
        body: "string",
        statusPageId: "string",
        title: "string",
        notifySubscribers: false,
    });
    
    type: rootly:StatusPageAnnouncement
    properties:
        body: string
        notifySubscribers: false
        statusPageId: string
        title: string
    

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

    Body string
    Body of the announcement
    StatusPageId string
    ID of the status page the announcement was posted to
    Title string
    Title of the announcement
    NotifySubscribers bool
    Controls if status page subscribers should be notified. Defaults to true. Value must be one of true or false
    Body string
    Body of the announcement
    StatusPageId string
    ID of the status page the announcement was posted to
    Title string
    Title of the announcement
    NotifySubscribers bool
    Controls if status page subscribers should be notified. Defaults to true. Value must be one of true or false
    body string
    Body of the announcement
    status_page_id string
    ID of the status page the announcement was posted to
    title string
    Title of the announcement
    notify_subscribers bool
    Controls if status page subscribers should be notified. Defaults to true. Value must be one of true or false
    body String
    Body of the announcement
    statusPageId String
    ID of the status page the announcement was posted to
    title String
    Title of the announcement
    notifySubscribers Boolean
    Controls if status page subscribers should be notified. Defaults to true. Value must be one of true or false
    body string
    Body of the announcement
    statusPageId string
    ID of the status page the announcement was posted to
    title string
    Title of the announcement
    notifySubscribers boolean
    Controls if status page subscribers should be notified. Defaults to true. Value must be one of true or false
    body str
    Body of the announcement
    status_page_id str
    ID of the status page the announcement was posted to
    title str
    Title of the announcement
    notify_subscribers bool
    Controls if status page subscribers should be notified. Defaults to true. Value must be one of true or false
    body String
    Body of the announcement
    statusPageId String
    ID of the status page the announcement was posted to
    title String
    Title of the announcement
    notifySubscribers Boolean
    Controls if status page subscribers should be notified. Defaults to true. Value must be one of true or false

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    PublishedAt string
    Date the announcement was published
    UserId int
    ID of the user who posted the announcement
    Id string
    The provider-assigned unique ID for this managed resource.
    PublishedAt string
    Date the announcement was published
    UserId int
    ID of the user who posted the announcement
    id string
    The provider-assigned unique ID for this managed resource.
    published_at string
    Date the announcement was published
    user_id number
    ID of the user who posted the announcement
    id String
    The provider-assigned unique ID for this managed resource.
    publishedAt String
    Date the announcement was published
    userId Integer
    ID of the user who posted the announcement
    id string
    The provider-assigned unique ID for this managed resource.
    publishedAt string
    Date the announcement was published
    userId number
    ID of the user who posted the announcement
    id str
    The provider-assigned unique ID for this managed resource.
    published_at str
    Date the announcement was published
    user_id int
    ID of the user who posted the announcement
    id String
    The provider-assigned unique ID for this managed resource.
    publishedAt String
    Date the announcement was published
    userId Number
    ID of the user who posted the announcement

    Look up Existing StatusPageAnnouncement Resource

    Get an existing StatusPageAnnouncement 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?: StatusPageAnnouncementState, opts?: CustomResourceOptions): StatusPageAnnouncement
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            body: Optional[str] = None,
            notify_subscribers: Optional[bool] = None,
            published_at: Optional[str] = None,
            status_page_id: Optional[str] = None,
            title: Optional[str] = None,
            user_id: Optional[int] = None) -> StatusPageAnnouncement
    func GetStatusPageAnnouncement(ctx *Context, name string, id IDInput, state *StatusPageAnnouncementState, opts ...ResourceOption) (*StatusPageAnnouncement, error)
    public static StatusPageAnnouncement Get(string name, Input<string> id, StatusPageAnnouncementState? state, CustomResourceOptions? opts = null)
    public static StatusPageAnnouncement get(String name, Output<String> id, StatusPageAnnouncementState state, CustomResourceOptions options)
    resources:  _:    type: rootly:StatusPageAnnouncement    get:      id: ${id}
    import {
      to = rootly_status_page_announcement.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:
    Body string
    Body of the announcement
    NotifySubscribers bool
    Controls if status page subscribers should be notified. Defaults to true. Value must be one of true or false
    PublishedAt string
    Date the announcement was published
    StatusPageId string
    ID of the status page the announcement was posted to
    Title string
    Title of the announcement
    UserId int
    ID of the user who posted the announcement
    Body string
    Body of the announcement
    NotifySubscribers bool
    Controls if status page subscribers should be notified. Defaults to true. Value must be one of true or false
    PublishedAt string
    Date the announcement was published
    StatusPageId string
    ID of the status page the announcement was posted to
    Title string
    Title of the announcement
    UserId int
    ID of the user who posted the announcement
    body string
    Body of the announcement
    notify_subscribers bool
    Controls if status page subscribers should be notified. Defaults to true. Value must be one of true or false
    published_at string
    Date the announcement was published
    status_page_id string
    ID of the status page the announcement was posted to
    title string
    Title of the announcement
    user_id number
    ID of the user who posted the announcement
    body String
    Body of the announcement
    notifySubscribers Boolean
    Controls if status page subscribers should be notified. Defaults to true. Value must be one of true or false
    publishedAt String
    Date the announcement was published
    statusPageId String
    ID of the status page the announcement was posted to
    title String
    Title of the announcement
    userId Integer
    ID of the user who posted the announcement
    body string
    Body of the announcement
    notifySubscribers boolean
    Controls if status page subscribers should be notified. Defaults to true. Value must be one of true or false
    publishedAt string
    Date the announcement was published
    statusPageId string
    ID of the status page the announcement was posted to
    title string
    Title of the announcement
    userId number
    ID of the user who posted the announcement
    body str
    Body of the announcement
    notify_subscribers bool
    Controls if status page subscribers should be notified. Defaults to true. Value must be one of true or false
    published_at str
    Date the announcement was published
    status_page_id str
    ID of the status page the announcement was posted to
    title str
    Title of the announcement
    user_id int
    ID of the user who posted the announcement
    body String
    Body of the announcement
    notifySubscribers Boolean
    Controls if status page subscribers should be notified. Defaults to true. Value must be one of true or false
    publishedAt String
    Date the announcement was published
    statusPageId String
    ID of the status page the announcement was posted to
    title String
    Title of the announcement
    userId Number
    ID of the user who posted the announcement

    Package Details

    Repository
    rootly rootlyhq/pulumi-rootly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rootly Terraform Provider.
    rootly logo Rootly
    Viewing docs for Rootly v4.1.0
    published on Sunday, Oct 11, 2026 by rootlyhq

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial