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

rootly.CommunicationsType

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_type" "slack_notification" {
  name = "Slack Notification"
}

    Create CommunicationsType Resource

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

    Constructor syntax

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

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

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

    example, err := rootly.NewCommunicationsType(ctx, "communicationsTypeResource", &rootly.CommunicationsTypeArgs{
	Color:       pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Position:    pulumi.Int(0),
	Slug:        pulumi.String("string"),
})

    var communicationsTypeResource = new CommunicationsType("communicationsTypeResource", CommunicationsTypeArgs.builder()
    .color("string")
    .description("string")
    .name("string")
    .position(0)
    .slug("string")
    .build());

    communications_type_resource = rootly.CommunicationsType("communicationsTypeResource",
    color="string",
    description="string",
    name="string",
    position=0,
    slug="string")

    const communicationsTypeResource = new rootly.CommunicationsType("communicationsTypeResource", {
    color: "string",
    description: "string",
    name: "string",
    position: 0,
    slug: "string",
});

    type: rootly:CommunicationsType
properties:
    color: string
    description: string
    name: string
    position: 0
    slug: string

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

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

    Outputs

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

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

    Import

    rootly.CommunicationsType can be imported using the import command.

    $ pulumi import rootly:index/communicationsType:CommunicationsType 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.