1. Packages
  2. Rootly
  3. API Docs
  4. StatusPageTemplate
Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly

rootly.StatusPageTemplate

Explore with Pulumi AI

Create StatusPageTemplate Resource

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

Constructor syntax

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

@overload
def StatusPageTemplate(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       body: Optional[str] = None,
                       title: Optional[str] = None,
                       enabled: Optional[bool] = None,
                       kind: Optional[str] = None,
                       position: Optional[int] = None,
                       should_notify_subscribers: Optional[bool] = None,
                       status_page_id: Optional[str] = None,
                       update_status: Optional[str] = None)
func NewStatusPageTemplate(ctx *Context, name string, args StatusPageTemplateArgs, opts ...ResourceOption) (*StatusPageTemplate, error)
public StatusPageTemplate(string name, StatusPageTemplateArgs args, CustomResourceOptions? opts = null)
public StatusPageTemplate(String name, StatusPageTemplateArgs args)
public StatusPageTemplate(String name, StatusPageTemplateArgs args, CustomResourceOptions options)
type: rootly:StatusPageTemplate
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. StatusPageTemplateArgs
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. StatusPageTemplateArgs
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. StatusPageTemplateArgs
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. StatusPageTemplateArgs
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. StatusPageTemplateArgs
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 statusPageTemplateResource = new Rootly.StatusPageTemplate("statusPageTemplateResource", new()
{
    Body = "string",
    Title = "string",
    Enabled = false,
    Kind = "string",
    Position = 0,
    ShouldNotifySubscribers = false,
    StatusPageId = "string",
    UpdateStatus = "string",
});
Copy
example, err := rootly.NewStatusPageTemplate(ctx, "statusPageTemplateResource", &rootly.StatusPageTemplateArgs{
	Body:                    pulumi.String("string"),
	Title:                   pulumi.String("string"),
	Enabled:                 pulumi.Bool(false),
	Kind:                    pulumi.String("string"),
	Position:                pulumi.Int(0),
	ShouldNotifySubscribers: pulumi.Bool(false),
	StatusPageId:            pulumi.String("string"),
	UpdateStatus:            pulumi.String("string"),
})
Copy
var statusPageTemplateResource = new StatusPageTemplate("statusPageTemplateResource", StatusPageTemplateArgs.builder()
    .body("string")
    .title("string")
    .enabled(false)
    .kind("string")
    .position(0)
    .shouldNotifySubscribers(false)
    .statusPageId("string")
    .updateStatus("string")
    .build());
Copy
status_page_template_resource = rootly.StatusPageTemplate("statusPageTemplateResource",
    body="string",
    title="string",
    enabled=False,
    kind="string",
    position=0,
    should_notify_subscribers=False,
    status_page_id="string",
    update_status="string")
Copy
const statusPageTemplateResource = new rootly.StatusPageTemplate("statusPageTemplateResource", {
    body: "string",
    title: "string",
    enabled: false,
    kind: "string",
    position: 0,
    shouldNotifySubscribers: false,
    statusPageId: "string",
    updateStatus: "string",
});
Copy
type: rootly:StatusPageTemplate
properties:
    body: string
    enabled: false
    kind: string
    position: 0
    shouldNotifySubscribers: false
    statusPageId: string
    title: string
    updateStatus: string
Copy

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

Body This property is required. string
Description of the event the template will populate
Title This property is required. string
Title of the template
Enabled bool
Kind string
The kind of the status page template. Value must be one of normal, scheduled.
Position int
Position of the workflow task
ShouldNotifySubscribers bool
Controls if incident subscribers should be notified. Value must be one of true or false
StatusPageId Changes to this property will trigger replacement. string
UpdateStatus string
Status of the event the template will populate
Body This property is required. string
Description of the event the template will populate
Title This property is required. string
Title of the template
Enabled bool
Kind string
The kind of the status page template. Value must be one of normal, scheduled.
Position int
Position of the workflow task
ShouldNotifySubscribers bool
Controls if incident subscribers should be notified. Value must be one of true or false
StatusPageId Changes to this property will trigger replacement. string
UpdateStatus string
Status of the event the template will populate
body This property is required. String
Description of the event the template will populate
title This property is required. String
Title of the template
enabled Boolean
kind String
The kind of the status page template. Value must be one of normal, scheduled.
position Integer
Position of the workflow task
shouldNotifySubscribers Boolean
Controls if incident subscribers should be notified. Value must be one of true or false
statusPageId Changes to this property will trigger replacement. String
updateStatus String
Status of the event the template will populate
body This property is required. string
Description of the event the template will populate
title This property is required. string
Title of the template
enabled boolean
kind string
The kind of the status page template. Value must be one of normal, scheduled.
position number
Position of the workflow task
shouldNotifySubscribers boolean
Controls if incident subscribers should be notified. Value must be one of true or false
statusPageId Changes to this property will trigger replacement. string
updateStatus string
Status of the event the template will populate
body This property is required. str
Description of the event the template will populate
title This property is required. str
Title of the template
enabled bool
kind str
The kind of the status page template. Value must be one of normal, scheduled.
position int
Position of the workflow task
should_notify_subscribers bool
Controls if incident subscribers should be notified. Value must be one of true or false
status_page_id Changes to this property will trigger replacement. str
update_status str
Status of the event the template will populate
body This property is required. String
Description of the event the template will populate
title This property is required. String
Title of the template
enabled Boolean
kind String
The kind of the status page template. Value must be one of normal, scheduled.
position Number
Position of the workflow task
shouldNotifySubscribers Boolean
Controls if incident subscribers should be notified. Value must be one of true or false
statusPageId Changes to this property will trigger replacement. String
updateStatus String
Status of the event the template will populate

Outputs

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

Get an existing StatusPageTemplate 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?: StatusPageTemplateState, opts?: CustomResourceOptions): StatusPageTemplate
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        body: Optional[str] = None,
        enabled: Optional[bool] = None,
        kind: Optional[str] = None,
        position: Optional[int] = None,
        should_notify_subscribers: Optional[bool] = None,
        status_page_id: Optional[str] = None,
        title: Optional[str] = None,
        update_status: Optional[str] = None) -> StatusPageTemplate
func GetStatusPageTemplate(ctx *Context, name string, id IDInput, state *StatusPageTemplateState, opts ...ResourceOption) (*StatusPageTemplate, error)
public static StatusPageTemplate Get(string name, Input<string> id, StatusPageTemplateState? state, CustomResourceOptions? opts = null)
public static StatusPageTemplate get(String name, Output<String> id, StatusPageTemplateState state, CustomResourceOptions options)
resources:  _:    type: rootly:StatusPageTemplate    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:
Body string
Description of the event the template will populate
Enabled bool
Kind string
The kind of the status page template. Value must be one of normal, scheduled.
Position int
Position of the workflow task
ShouldNotifySubscribers bool
Controls if incident subscribers should be notified. Value must be one of true or false
StatusPageId Changes to this property will trigger replacement. string
Title string
Title of the template
UpdateStatus string
Status of the event the template will populate
Body string
Description of the event the template will populate
Enabled bool
Kind string
The kind of the status page template. Value must be one of normal, scheduled.
Position int
Position of the workflow task
ShouldNotifySubscribers bool
Controls if incident subscribers should be notified. Value must be one of true or false
StatusPageId Changes to this property will trigger replacement. string
Title string
Title of the template
UpdateStatus string
Status of the event the template will populate
body String
Description of the event the template will populate
enabled Boolean
kind String
The kind of the status page template. Value must be one of normal, scheduled.
position Integer
Position of the workflow task
shouldNotifySubscribers Boolean
Controls if incident subscribers should be notified. Value must be one of true or false
statusPageId Changes to this property will trigger replacement. String
title String
Title of the template
updateStatus String
Status of the event the template will populate
body string
Description of the event the template will populate
enabled boolean
kind string
The kind of the status page template. Value must be one of normal, scheduled.
position number
Position of the workflow task
shouldNotifySubscribers boolean
Controls if incident subscribers should be notified. Value must be one of true or false
statusPageId Changes to this property will trigger replacement. string
title string
Title of the template
updateStatus string
Status of the event the template will populate
body str
Description of the event the template will populate
enabled bool
kind str
The kind of the status page template. Value must be one of normal, scheduled.
position int
Position of the workflow task
should_notify_subscribers bool
Controls if incident subscribers should be notified. Value must be one of true or false
status_page_id Changes to this property will trigger replacement. str
title str
Title of the template
update_status str
Status of the event the template will populate
body String
Description of the event the template will populate
enabled Boolean
kind String
The kind of the status page template. Value must be one of normal, scheduled.
position Number
Position of the workflow task
shouldNotifySubscribers Boolean
Controls if incident subscribers should be notified. Value must be one of true or false
statusPageId Changes to this property will trigger replacement. String
title String
Title of the template
updateStatus String
Status of the event the template will populate

Package Details

Repository
rootly rootlyhq/pulumi-rootly
License
Apache-2.0
Notes
This Pulumi package is based on the rootly Terraform Provider.