1. Packages
  2. Packages
  3. Rootly
  4. API Docs
  5. CommunicationsStage
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq
Schema (JSON)
rootlyhq/pulumi-rootly

rootly.CommunicationsStage

rootly logo
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq
Schema (JSON)
rootlyhq/pulumi-rootly

    Example Usage

    resource "rootly_communications_stage" "initial_notification" {
  name     = "Initial Notification"
  position = 1
}

    Create CommunicationsStage Resource

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

    Constructor syntax

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

@overload
def CommunicationsStage(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        description: Optional[str] = None,
                        name: Optional[str] = None,
                        position: Optional[int] = None,
                        slug: Optional[str] = None)
    func NewCommunicationsStage(ctx *Context, name string, args *CommunicationsStageArgs, opts ...ResourceOption) (*CommunicationsStage, error)
    public CommunicationsStage(string name, CommunicationsStageArgs? args = null, CustomResourceOptions? opts = null)
    public CommunicationsStage(String name, CommunicationsStageArgs args)
public CommunicationsStage(String name, CommunicationsStageArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args CommunicationsStageArgs
    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 CommunicationsStageArgs
    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 CommunicationsStageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CommunicationsStageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CommunicationsStageArgs
    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 communicationsStageResource = new Rootly.CommunicationsStage("communicationsStageResource", new()
{
    Description = "string",
    Name = "string",
    Position = 0,
    Slug = "string",
});

    example, err := rootly.NewCommunicationsStage(ctx, "communicationsStageResource", &rootly.CommunicationsStageArgs{
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Position:    pulumi.Int(0),
	Slug:        pulumi.String("string"),
})

    var communicationsStageResource = new CommunicationsStage("communicationsStageResource", CommunicationsStageArgs.builder()
    .description("string")
    .name("string")
    .position(0)
    .slug("string")
    .build());

    communications_stage_resource = rootly.CommunicationsStage("communicationsStageResource",
    description="string",
    name="string",
    position=0,
    slug="string")

    const communicationsStageResource = new rootly.CommunicationsStage("communicationsStageResource", {
    description: "string",
    name: "string",
    position: 0,
    slug: "string",
});

    type: rootly:CommunicationsStage
properties:
    description: string
    name: string
    position: 0
    slug: string

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

    Description string
    The description of the communications stage
    Name string
    The name of the communications stage
    Position int
    Position of the communications stage
    Slug string
    The slug of the communications stage
    Description string
    The description of the communications stage
    Name string
    The name of the communications stage
    Position int
    Position of the communications stage
    Slug string
    The slug of the communications stage
    description String
    The description of the communications stage
    name String
    The name of the communications stage
    position Integer
    Position of the communications stage
    slug String
    The slug of the communications stage
    description string
    The description of the communications stage
    name string
    The name of the communications stage
    position number
    Position of the communications stage
    slug string
    The slug of the communications stage
    description str
    The description of the communications stage
    name str
    The name of the communications stage
    position int
    Position of the communications stage
    slug str
    The slug of the communications stage
    description String
    The description of the communications stage
    name String
    The name of the communications stage
    position Number
    Position of the communications stage
    slug String
    The slug of the communications stage

    Outputs

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

    Get an existing CommunicationsStage 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?: CommunicationsStageState, opts?: CustomResourceOptions): CommunicationsStage
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        position: Optional[int] = None,
        slug: Optional[str] = None) -> CommunicationsStage
    func GetCommunicationsStage(ctx *Context, name string, id IDInput, state *CommunicationsStageState, opts ...ResourceOption) (*CommunicationsStage, error)
    public static CommunicationsStage Get(string name, Input<string> id, CommunicationsStageState? state, CustomResourceOptions? opts = null)
    public static CommunicationsStage get(String name, Output<String> id, CommunicationsStageState state, CustomResourceOptions options)
    resources:  _:    type: rootly:CommunicationsStage    get:      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
    The description of the communications stage
    Name string
    The name of the communications stage
    Position int
    Position of the communications stage
    Slug string
    The slug of the communications stage
    Description string
    The description of the communications stage
    Name string
    The name of the communications stage
    Position int
    Position of the communications stage
    Slug string
    The slug of the communications stage
    description String
    The description of the communications stage
    name String
    The name of the communications stage
    position Integer
    Position of the communications stage
    slug String
    The slug of the communications stage
    description string
    The description of the communications stage
    name string
    The name of the communications stage
    position number
    Position of the communications stage
    slug string
    The slug of the communications stage
    description str
    The description of the communications stage
    name str
    The name of the communications stage
    position int
    Position of the communications stage
    slug str
    The slug of the communications stage
    description String
    The description of the communications stage
    name String
    The name of the communications stage
    position Number
    Position of the communications stage
    slug String
    The slug of the communications stage

    Import

    rootly.CommunicationsStage can be imported using the import command.

    $ pulumi import rootly:index/communicationsStage:CommunicationsStage 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 v3.3.0
    published on Thursday, May 7, 2026 by rootlyhq
    Schema (JSON)
    rootlyhq/pulumi-rootly
      Try Pulumi Cloud free. Your team will thank you.