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

rootly.FormFieldOption

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_form_field" "regions_affected" {
  name       = "Regions affected"
  kind       = "custom"
  input_kind = "multi_select"
  shown      = ["web_new_incident_form", "web_update_incident_form"]
  required   = ["web_new_incident_form", "web_update_incident_form"]
}

resource "rootly_form_field_option" "asia" {
  form_field_id = rootly_form_field.regions_affected.id
  value         = "Asia"
}

resource "rootly_form_field_option" "europe" {
  form_field_id = rootly_form_field.regions_affected.id
  value         = "Europe"
}

resource "rootly_form_field_option" "north_america" {
  form_field_id = rootly_form_field.regions_affected.id
  value         = "North America"
}

    Create FormFieldOption Resource

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

    Constructor syntax

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

@overload
def FormFieldOption(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    form_field_id: Optional[str] = None,
                    value: Optional[str] = None,
                    color: Optional[str] = None,
                    default: Optional[bool] = None,
                    form_field_option_id: Optional[str] = None,
                    position: Optional[int] = None)
    func NewFormFieldOption(ctx *Context, name string, args FormFieldOptionArgs, opts ...ResourceOption) (*FormFieldOption, error)
    public FormFieldOption(string name, FormFieldOptionArgs args, CustomResourceOptions? opts = null)
    public FormFieldOption(String name, FormFieldOptionArgs args)
public FormFieldOption(String name, FormFieldOptionArgs args, CustomResourceOptions options)

    type: rootly:FormFieldOption
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 FormFieldOptionArgs
    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 FormFieldOptionArgs
    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 FormFieldOptionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FormFieldOptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FormFieldOptionArgs
    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 formFieldOptionResource = new Rootly.FormFieldOption("formFieldOptionResource", new()
{
    FormFieldId = "string",
    Value = "string",
    Color = "string",
    Default = false,
    FormFieldOptionId = "string",
    Position = 0,
});

    example, err := rootly.NewFormFieldOption(ctx, "formFieldOptionResource", &rootly.FormFieldOptionArgs{
	FormFieldId:       pulumi.String("string"),
	Value:             pulumi.String("string"),
	Color:             pulumi.String("string"),
	Default:           pulumi.Bool(false),
	FormFieldOptionId: pulumi.String("string"),
	Position:          pulumi.Int(0),
})

    var formFieldOptionResource = new FormFieldOption("formFieldOptionResource", FormFieldOptionArgs.builder()
    .formFieldId("string")
    .value("string")
    .color("string")
    .default_(false)
    .formFieldOptionId("string")
    .position(0)
    .build());

    form_field_option_resource = rootly.FormFieldOption("formFieldOptionResource",
    form_field_id="string",
    value="string",
    color="string",
    default=False,
    form_field_option_id="string",
    position=0)

    const formFieldOptionResource = new rootly.FormFieldOption("formFieldOptionResource", {
    formFieldId: "string",
    value: "string",
    color: "string",
    "default": false,
    formFieldOptionId: "string",
    position: 0,
});

    type: rootly:FormFieldOption
properties:
    color: string
    default: false
    formFieldId: string
    formFieldOptionId: string
    position: 0
    value: string

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

    FormFieldId string
    The ID of the parent custom field
    Value string
    The value of the form field option
    Color string
    The hex color of the form field option
    Default bool
    Value must be one of true or false
    FormFieldOptionId string
    Unique ID of the form field option
    Position int
    The position of the form field option
    FormFieldId string
    The ID of the parent custom field
    Value string
    The value of the form field option
    Color string
    The hex color of the form field option
    Default bool
    Value must be one of true or false
    FormFieldOptionId string
    Unique ID of the form field option
    Position int
    The position of the form field option
    formFieldId String
    The ID of the parent custom field
    value String
    The value of the form field option
    color String
    The hex color of the form field option
    default_ Boolean
    Value must be one of true or false
    formFieldOptionId String
    Unique ID of the form field option
    position Integer
    The position of the form field option
    formFieldId string
    The ID of the parent custom field
    value string
    The value of the form field option
    color string
    The hex color of the form field option
    default boolean
    Value must be one of true or false
    formFieldOptionId string
    Unique ID of the form field option
    position number
    The position of the form field option
    form_field_id str
    The ID of the parent custom field
    value str
    The value of the form field option
    color str
    The hex color of the form field option
    default bool
    Value must be one of true or false
    form_field_option_id str
    Unique ID of the form field option
    position int
    The position of the form field option
    formFieldId String
    The ID of the parent custom field
    value String
    The value of the form field option
    color String
    The hex color of the form field option
    default Boolean
    Value must be one of true or false
    formFieldOptionId String
    Unique ID of the form field option
    position Number
    The position of the form field option

    Outputs

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

    Get an existing FormFieldOption 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?: FormFieldOptionState, opts?: CustomResourceOptions): FormFieldOption
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        color: Optional[str] = None,
        default: Optional[bool] = None,
        form_field_id: Optional[str] = None,
        form_field_option_id: Optional[str] = None,
        position: Optional[int] = None,
        value: Optional[str] = None) -> FormFieldOption
    func GetFormFieldOption(ctx *Context, name string, id IDInput, state *FormFieldOptionState, opts ...ResourceOption) (*FormFieldOption, error)
    public static FormFieldOption Get(string name, Input<string> id, FormFieldOptionState? state, CustomResourceOptions? opts = null)
    public static FormFieldOption get(String name, Output<String> id, FormFieldOptionState state, CustomResourceOptions options)
    resources:  _:    type: rootly:FormFieldOption    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 hex color of the form field option
    Default bool
    Value must be one of true or false
    FormFieldId string
    The ID of the parent custom field
    FormFieldOptionId string
    Unique ID of the form field option
    Position int
    The position of the form field option
    Value string
    The value of the form field option
    Color string
    The hex color of the form field option
    Default bool
    Value must be one of true or false
    FormFieldId string
    The ID of the parent custom field
    FormFieldOptionId string
    Unique ID of the form field option
    Position int
    The position of the form field option
    Value string
    The value of the form field option
    color String
    The hex color of the form field option
    default_ Boolean
    Value must be one of true or false
    formFieldId String
    The ID of the parent custom field
    formFieldOptionId String
    Unique ID of the form field option
    position Integer
    The position of the form field option
    value String
    The value of the form field option
    color string
    The hex color of the form field option
    default boolean
    Value must be one of true or false
    formFieldId string
    The ID of the parent custom field
    formFieldOptionId string
    Unique ID of the form field option
    position number
    The position of the form field option
    value string
    The value of the form field option
    color str
    The hex color of the form field option
    default bool
    Value must be one of true or false
    form_field_id str
    The ID of the parent custom field
    form_field_option_id str
    Unique ID of the form field option
    position int
    The position of the form field option
    value str
    The value of the form field option
    color String
    The hex color of the form field option
    default Boolean
    Value must be one of true or false
    formFieldId String
    The ID of the parent custom field
    formFieldOptionId String
    Unique ID of the form field option
    position Number
    The position of the form field option
    value String
    The value of the form field option

    Import

    rootly.FormFieldOption can be imported using the import command.

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