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

rootly.FormFieldPlacement

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

    Import

    rootly.FormFieldPlacement can be imported using the import command.

    $ pulumi import rootly:index/formFieldPlacement:FormFieldPlacement 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

    Create FormFieldPlacement Resource

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

    Constructor syntax

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

@overload
def FormFieldPlacement(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       form: Optional[str] = None,
                       form_set_id: Optional[str] = None,
                       form_field_id: Optional[str] = None,
                       non_editable: Optional[bool] = None,
                       placement_operator: Optional[str] = None,
                       position: Optional[int] = None,
                       required: Optional[bool] = None,
                       required_operator: Optional[str] = None)
    func NewFormFieldPlacement(ctx *Context, name string, args FormFieldPlacementArgs, opts ...ResourceOption) (*FormFieldPlacement, error)
    public FormFieldPlacement(string name, FormFieldPlacementArgs args, CustomResourceOptions? opts = null)
    public FormFieldPlacement(String name, FormFieldPlacementArgs args)
public FormFieldPlacement(String name, FormFieldPlacementArgs args, CustomResourceOptions options)

    type: rootly:FormFieldPlacement
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 FormFieldPlacementArgs
    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 FormFieldPlacementArgs
    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 FormFieldPlacementArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FormFieldPlacementArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FormFieldPlacementArgs
    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 formFieldPlacementResource = new Rootly.FormFieldPlacement("formFieldPlacementResource", new()
{
    Form = "string",
    FormSetId = "string",
    FormFieldId = "string",
    NonEditable = false,
    PlacementOperator = "string",
    Position = 0,
    Required = false,
    RequiredOperator = "string",
});

    example, err := rootly.NewFormFieldPlacement(ctx, "formFieldPlacementResource", &rootly.FormFieldPlacementArgs{
	Form:              pulumi.String("string"),
	FormSetId:         pulumi.String("string"),
	FormFieldId:       pulumi.String("string"),
	NonEditable:       pulumi.Bool(false),
	PlacementOperator: pulumi.String("string"),
	Position:          pulumi.Int(0),
	Required:          pulumi.Bool(false),
	RequiredOperator:  pulumi.String("string"),
})

    var formFieldPlacementResource = new FormFieldPlacement("formFieldPlacementResource", FormFieldPlacementArgs.builder()
    .form("string")
    .formSetId("string")
    .formFieldId("string")
    .nonEditable(false)
    .placementOperator("string")
    .position(0)
    .required(false)
    .requiredOperator("string")
    .build());

    form_field_placement_resource = rootly.FormFieldPlacement("formFieldPlacementResource",
    form="string",
    form_set_id="string",
    form_field_id="string",
    non_editable=False,
    placement_operator="string",
    position=0,
    required=False,
    required_operator="string")

    const formFieldPlacementResource = new rootly.FormFieldPlacement("formFieldPlacementResource", {
    form: "string",
    formSetId: "string",
    formFieldId: "string",
    nonEditable: false,
    placementOperator: "string",
    position: 0,
    required: false,
    requiredOperator: "string",
});

    type: rootly:FormFieldPlacement
properties:
    form: string
    formFieldId: string
    formSetId: string
    nonEditable: false
    placementOperator: string
    position: 0
    required: false
    requiredOperator: string

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

    Form string
    The form this field is placed on.
    FormSetId string
    The form set this field is placed in.
    FormFieldId string
    The form field that is placed.
    NonEditable bool
    Whether the field is read-only and cannot be edited by users.. Value must be one of true or false
    PlacementOperator string
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=placement. Value must be one of and, or.
    Position int
    The position of the field placement.
    Required bool
    Whether the field is unconditionally required on this form.. Value must be one of true or false
    RequiredOperator string
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=required. Value must be one of and, or.
    Form string
    The form this field is placed on.
    FormSetId string
    The form set this field is placed in.
    FormFieldId string
    The form field that is placed.
    NonEditable bool
    Whether the field is read-only and cannot be edited by users.. Value must be one of true or false
    PlacementOperator string
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=placement. Value must be one of and, or.
    Position int
    The position of the field placement.
    Required bool
    Whether the field is unconditionally required on this form.. Value must be one of true or false
    RequiredOperator string
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=required. Value must be one of and, or.
    form String
    The form this field is placed on.
    formSetId String
    The form set this field is placed in.
    formFieldId String
    The form field that is placed.
    nonEditable Boolean
    Whether the field is read-only and cannot be edited by users.. Value must be one of true or false
    placementOperator String
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=placement. Value must be one of and, or.
    position Integer
    The position of the field placement.
    required Boolean
    Whether the field is unconditionally required on this form.. Value must be one of true or false
    requiredOperator String
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=required. Value must be one of and, or.
    form string
    The form this field is placed on.
    formSetId string
    The form set this field is placed in.
    formFieldId string
    The form field that is placed.
    nonEditable boolean
    Whether the field is read-only and cannot be edited by users.. Value must be one of true or false
    placementOperator string
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=placement. Value must be one of and, or.
    position number
    The position of the field placement.
    required boolean
    Whether the field is unconditionally required on this form.. Value must be one of true or false
    requiredOperator string
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=required. Value must be one of and, or.
    form str
    The form this field is placed on.
    form_set_id str
    The form set this field is placed in.
    form_field_id str
    The form field that is placed.
    non_editable bool
    Whether the field is read-only and cannot be edited by users.. Value must be one of true or false
    placement_operator str
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=placement. Value must be one of and, or.
    position int
    The position of the field placement.
    required bool
    Whether the field is unconditionally required on this form.. Value must be one of true or false
    required_operator str
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=required. Value must be one of and, or.
    form String
    The form this field is placed on.
    formSetId String
    The form set this field is placed in.
    formFieldId String
    The form field that is placed.
    nonEditable Boolean
    Whether the field is read-only and cannot be edited by users.. Value must be one of true or false
    placementOperator String
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=placement. Value must be one of and, or.
    position Number
    The position of the field placement.
    required Boolean
    Whether the field is unconditionally required on this form.. Value must be one of true or false
    requiredOperator String
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=required. Value must be one of and, or.

    Outputs

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

    Get an existing FormFieldPlacement 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?: FormFieldPlacementState, opts?: CustomResourceOptions): FormFieldPlacement
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        form: Optional[str] = None,
        form_field_id: Optional[str] = None,
        form_set_id: Optional[str] = None,
        non_editable: Optional[bool] = None,
        placement_operator: Optional[str] = None,
        position: Optional[int] = None,
        required: Optional[bool] = None,
        required_operator: Optional[str] = None) -> FormFieldPlacement
    func GetFormFieldPlacement(ctx *Context, name string, id IDInput, state *FormFieldPlacementState, opts ...ResourceOption) (*FormFieldPlacement, error)
    public static FormFieldPlacement Get(string name, Input<string> id, FormFieldPlacementState? state, CustomResourceOptions? opts = null)
    public static FormFieldPlacement get(String name, Output<String> id, FormFieldPlacementState state, CustomResourceOptions options)
    resources:  _:    type: rootly:FormFieldPlacement    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:
    Form string
    The form this field is placed on.
    FormFieldId string
    The form field that is placed.
    FormSetId string
    The form set this field is placed in.
    NonEditable bool
    Whether the field is read-only and cannot be edited by users.. Value must be one of true or false
    PlacementOperator string
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=placement. Value must be one of and, or.
    Position int
    The position of the field placement.
    Required bool
    Whether the field is unconditionally required on this form.. Value must be one of true or false
    RequiredOperator string
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=required. Value must be one of and, or.
    Form string
    The form this field is placed on.
    FormFieldId string
    The form field that is placed.
    FormSetId string
    The form set this field is placed in.
    NonEditable bool
    Whether the field is read-only and cannot be edited by users.. Value must be one of true or false
    PlacementOperator string
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=placement. Value must be one of and, or.
    Position int
    The position of the field placement.
    Required bool
    Whether the field is unconditionally required on this form.. Value must be one of true or false
    RequiredOperator string
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=required. Value must be one of and, or.
    form String
    The form this field is placed on.
    formFieldId String
    The form field that is placed.
    formSetId String
    The form set this field is placed in.
    nonEditable Boolean
    Whether the field is read-only and cannot be edited by users.. Value must be one of true or false
    placementOperator String
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=placement. Value must be one of and, or.
    position Integer
    The position of the field placement.
    required Boolean
    Whether the field is unconditionally required on this form.. Value must be one of true or false
    requiredOperator String
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=required. Value must be one of and, or.
    form string
    The form this field is placed on.
    formFieldId string
    The form field that is placed.
    formSetId string
    The form set this field is placed in.
    nonEditable boolean
    Whether the field is read-only and cannot be edited by users.. Value must be one of true or false
    placementOperator string
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=placement. Value must be one of and, or.
    position number
    The position of the field placement.
    required boolean
    Whether the field is unconditionally required on this form.. Value must be one of true or false
    requiredOperator string
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=required. Value must be one of and, or.
    form str
    The form this field is placed on.
    form_field_id str
    The form field that is placed.
    form_set_id str
    The form set this field is placed in.
    non_editable bool
    Whether the field is read-only and cannot be edited by users.. Value must be one of true or false
    placement_operator str
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=placement. Value must be one of and, or.
    position int
    The position of the field placement.
    required bool
    Whether the field is unconditionally required on this form.. Value must be one of true or false
    required_operator str
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=required. Value must be one of and, or.
    form String
    The form this field is placed on.
    formFieldId String
    The form field that is placed.
    formSetId String
    The form set this field is placed in.
    nonEditable Boolean
    Whether the field is read-only and cannot be edited by users.. Value must be one of true or false
    placementOperator String
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=placement. Value must be one of and, or.
    position Number
    The position of the field placement.
    required Boolean
    Whether the field is unconditionally required on this form.. Value must be one of true or false
    requiredOperator String
    Logical operator when evaluating multiple formfieldplacement_conditions with conditioned=required. Value must be one of and, or.

    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.