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

rootly.AlertField

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_alert_field" "cloud_region" {
  label = "Cloud Region"
  kind  = "select"
}

    Create AlertField Resource

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

    Constructor syntax

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

@overload
def AlertField(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               kind: Optional[str] = None,
               name: Optional[str] = None,
               slug: Optional[str] = None)
    func NewAlertField(ctx *Context, name string, args *AlertFieldArgs, opts ...ResourceOption) (*AlertField, error)
    public AlertField(string name, AlertFieldArgs? args = null, CustomResourceOptions? opts = null)
    public AlertField(String name, AlertFieldArgs args)
public AlertField(String name, AlertFieldArgs args, CustomResourceOptions options)

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

    example, err := rootly.NewAlertField(ctx, "alertFieldResource", &rootly.AlertFieldArgs{
	Kind: pulumi.String("string"),
	Name: pulumi.String("string"),
	Slug: pulumi.String("string"),
})

    var alertFieldResource = new AlertField("alertFieldResource", AlertFieldArgs.builder()
    .kind("string")
    .name("string")
    .slug("string")
    .build());

    alert_field_resource = rootly.AlertField("alertFieldResource",
    kind="string",
    name="string",
    slug="string")

    const alertFieldResource = new rootly.AlertField("alertFieldResource", {
    kind: "string",
    name: "string",
    slug: "string",
});

    type: rootly:AlertField
properties:
    kind: string
    name: string
    slug: string

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

    Kind string
    The kind of alert field
    Name string
    The name of the alert field
    Slug string
    The slug of the alert field
    Kind string
    The kind of alert field
    Name string
    The name of the alert field
    Slug string
    The slug of the alert field
    kind String
    The kind of alert field
    name String
    The name of the alert field
    slug String
    The slug of the alert field
    kind string
    The kind of alert field
    name string
    The name of the alert field
    slug string
    The slug of the alert field
    kind str
    The kind of alert field
    name str
    The name of the alert field
    slug str
    The slug of the alert field
    kind String
    The kind of alert field
    name String
    The name of the alert field
    slug String
    The slug of the alert field

    Outputs

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

    Get an existing AlertField 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?: AlertFieldState, opts?: CustomResourceOptions): AlertField
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        kind: Optional[str] = None,
        name: Optional[str] = None,
        slug: Optional[str] = None) -> AlertField
    func GetAlertField(ctx *Context, name string, id IDInput, state *AlertFieldState, opts ...ResourceOption) (*AlertField, error)
    public static AlertField Get(string name, Input<string> id, AlertFieldState? state, CustomResourceOptions? opts = null)
    public static AlertField get(String name, Output<String> id, AlertFieldState state, CustomResourceOptions options)
    resources:  _:    type: rootly:AlertField    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:
    Kind string
    The kind of alert field
    Name string
    The name of the alert field
    Slug string
    The slug of the alert field
    Kind string
    The kind of alert field
    Name string
    The name of the alert field
    Slug string
    The slug of the alert field
    kind String
    The kind of alert field
    name String
    The name of the alert field
    slug String
    The slug of the alert field
    kind string
    The kind of alert field
    name string
    The name of the alert field
    slug string
    The slug of the alert field
    kind str
    The kind of alert field
    name str
    The name of the alert field
    slug str
    The slug of the alert field
    kind String
    The kind of alert field
    name String
    The name of the alert field
    slug String
    The slug of the alert field

    Import

    rootly.AlertField can be imported using the import command.

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