1. Packages
  2. Rootly
  3. API Docs
  4. CustomForm
Rootly v1.2.1 published on Tuesday, Apr 2, 2024 by Rootly

rootly.CustomForm

Explore with Pulumi AI

rootly logo
Rootly v1.2.1 published on Tuesday, Apr 2, 2024 by Rootly

    Create CustomForm Resource

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

    Constructor syntax

    new CustomForm(name: string, args: CustomFormArgs, opts?: CustomResourceOptions);
    @overload
    def CustomForm(resource_name: str,
                   args: CustomFormArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def CustomForm(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   command: Optional[str] = None,
                   description: Optional[str] = None,
                   enabled: Optional[bool] = None,
                   name: Optional[str] = None,
                   slug: Optional[str] = None)
    func NewCustomForm(ctx *Context, name string, args CustomFormArgs, opts ...ResourceOption) (*CustomForm, error)
    public CustomForm(string name, CustomFormArgs args, CustomResourceOptions? opts = null)
    public CustomForm(String name, CustomFormArgs args)
    public CustomForm(String name, CustomFormArgs args, CustomResourceOptions options)
    
    type: rootly:CustomForm
    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 CustomFormArgs
    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 CustomFormArgs
    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 CustomFormArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomFormArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomFormArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var customFormResource = new Rootly.CustomForm("customFormResource", new()
    {
        Command = "string",
        Description = "string",
        Enabled = false,
        Name = "string",
        Slug = "string",
    });
    
    example, err := rootly.NewCustomForm(ctx, "customFormResource", &rootly.CustomFormArgs{
    	Command:     pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Enabled:     pulumi.Bool(false),
    	Name:        pulumi.String("string"),
    	Slug:        pulumi.String("string"),
    })
    
    var customFormResource = new CustomForm("customFormResource", CustomFormArgs.builder()        
        .command("string")
        .description("string")
        .enabled(false)
        .name("string")
        .slug("string")
        .build());
    
    custom_form_resource = rootly.CustomForm("customFormResource",
        command="string",
        description="string",
        enabled=False,
        name="string",
        slug="string")
    
    const customFormResource = new rootly.CustomForm("customFormResource", {
        command: "string",
        description: "string",
        enabled: false,
        name: "string",
        slug: "string",
    });
    
    type: rootly:CustomForm
    properties:
        command: string
        description: string
        enabled: false
        name: string
        slug: string
    

    CustomForm Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The CustomForm resource accepts the following input properties:

    Command string
    The Slack command used to trigger this form.
    Description string
    Enabled bool
    Name string
    The name of the custom form.
    Slug string
    The custom form slug. Add this to formfield.shown or formfield.required to associate form fields with custom forms.
    Command string
    The Slack command used to trigger this form.
    Description string
    Enabled bool
    Name string
    The name of the custom form.
    Slug string
    The custom form slug. Add this to formfield.shown or formfield.required to associate form fields with custom forms.
    command String
    The Slack command used to trigger this form.
    description String
    enabled Boolean
    name String
    The name of the custom form.
    slug String
    The custom form slug. Add this to formfield.shown or formfield.required to associate form fields with custom forms.
    command string
    The Slack command used to trigger this form.
    description string
    enabled boolean
    name string
    The name of the custom form.
    slug string
    The custom form slug. Add this to formfield.shown or formfield.required to associate form fields with custom forms.
    command str
    The Slack command used to trigger this form.
    description str
    enabled bool
    name str
    The name of the custom form.
    slug str
    The custom form slug. Add this to formfield.shown or formfield.required to associate form fields with custom forms.
    command String
    The Slack command used to trigger this form.
    description String
    enabled Boolean
    name String
    The name of the custom form.
    slug String
    The custom form slug. Add this to formfield.shown or formfield.required to associate form fields with custom forms.

    Outputs

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

    Get an existing CustomForm 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?: CustomFormState, opts?: CustomResourceOptions): CustomForm
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            command: Optional[str] = None,
            description: Optional[str] = None,
            enabled: Optional[bool] = None,
            name: Optional[str] = None,
            slug: Optional[str] = None) -> CustomForm
    func GetCustomForm(ctx *Context, name string, id IDInput, state *CustomFormState, opts ...ResourceOption) (*CustomForm, error)
    public static CustomForm Get(string name, Input<string> id, CustomFormState? state, CustomResourceOptions? opts = null)
    public static CustomForm get(String name, Output<String> id, CustomFormState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Command string
    The Slack command used to trigger this form.
    Description string
    Enabled bool
    Name string
    The name of the custom form.
    Slug string
    The custom form slug. Add this to formfield.shown or formfield.required to associate form fields with custom forms.
    Command string
    The Slack command used to trigger this form.
    Description string
    Enabled bool
    Name string
    The name of the custom form.
    Slug string
    The custom form slug. Add this to formfield.shown or formfield.required to associate form fields with custom forms.
    command String
    The Slack command used to trigger this form.
    description String
    enabled Boolean
    name String
    The name of the custom form.
    slug String
    The custom form slug. Add this to formfield.shown or formfield.required to associate form fields with custom forms.
    command string
    The Slack command used to trigger this form.
    description string
    enabled boolean
    name string
    The name of the custom form.
    slug string
    The custom form slug. Add this to formfield.shown or formfield.required to associate form fields with custom forms.
    command str
    The Slack command used to trigger this form.
    description str
    enabled bool
    name str
    The name of the custom form.
    slug str
    The custom form slug. Add this to formfield.shown or formfield.required to associate form fields with custom forms.
    command String
    The Slack command used to trigger this form.
    description String
    enabled Boolean
    name String
    The name of the custom form.
    slug String
    The custom form slug. Add this to formfield.shown or formfield.required to associate form fields with custom forms.

    Package Details

    Repository
    rootly rootlyhq/pulumi-rootly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rootly Terraform Provider.
    rootly logo
    Rootly v1.2.1 published on Tuesday, Apr 2, 2024 by Rootly