Docs Packages
  1. Packages
  2. Rootly
  3. API Docs
  4. CustomField
Rootly v1.2.1 published on Tuesday, Apr 2, 2024 by Rootly
rootlyhq/pulumi-rootly

rootly.CustomField

Explore with Pulumi AI

rootly logo
Rootly v1.2.1 published on Tuesday, Apr 2, 2024 by Rootly
rootlyhq/pulumi-rootly

    DEPRECATED: Please use rootly.FormField resource instead.

    Create CustomField Resource

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

    Constructor syntax

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

@overload
def CustomField(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                label: Optional[str] = None,
                default: Optional[str] = None,
                description: Optional[str] = None,
                enabled: Optional[bool] = None,
                kind: Optional[str] = None,
                position: Optional[int] = None,
                requireds: Optional[Sequence[str]] = None,
                showns: Optional[Sequence[str]] = None,
                slug: Optional[str] = None)
    func NewCustomField(ctx *Context, name string, args CustomFieldArgs, opts ...ResourceOption) (*CustomField, error)
    public CustomField(string name, CustomFieldArgs args, CustomResourceOptions? opts = null)
    public CustomField(String name, CustomFieldArgs args)
public CustomField(String name, CustomFieldArgs args, CustomResourceOptions options)

    type: rootly:CustomField
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 CustomFieldArgs
    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 CustomFieldArgs
    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 CustomFieldArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomFieldArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomFieldArgs
    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 customFieldResource = new Rootly.CustomField("customFieldResource", new()
{
    Label = "string",
    Default = "string",
    Description = "string",
    Enabled = false,
    Kind = "string",
    Position = 0,
    Requireds = new[]
    {
        "string",
    },
    Showns = new[]
    {
        "string",
    },
    Slug = "string",
});

    example, err := rootly.NewCustomField(ctx, "customFieldResource", &rootly.CustomFieldArgs{
	Label:       pulumi.String("string"),
	Default:     pulumi.String("string"),
	Description: pulumi.String("string"),
	Enabled:     pulumi.Bool(false),
	Kind:        pulumi.String("string"),
	Position:    pulumi.Int(0),
	Requireds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Showns: pulumi.StringArray{
		pulumi.String("string"),
	},
	Slug: pulumi.String("string"),
})

    var customFieldResource = new CustomField("customFieldResource", CustomFieldArgs.builder()        
    .label("string")
    .default_("string")
    .description("string")
    .enabled(false)
    .kind("string")
    .position(0)
    .requireds("string")
    .showns("string")
    .slug("string")
    .build());

    custom_field_resource = rootly.CustomField("customFieldResource",
    label="string",
    default="string",
    description="string",
    enabled=False,
    kind="string",
    position=0,
    requireds=["string"],
    showns=["string"],
    slug="string")

    const customFieldResource = new rootly.CustomField("customFieldResource", {
    label: "string",
    "default": "string",
    description: "string",
    enabled: false,
    kind: "string",
    position: 0,
    requireds: ["string"],
    showns: ["string"],
    slug: "string",
});

    type: rootly:CustomField
properties:
    default: string
    description: string
    enabled: false
    kind: string
    label: string
    position: 0
    requireds:
        - string
    showns:
        - string
    slug: string

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

    Label string
    The name of the custom_field
    Default string
    The default value for text field kinds.
    Description string
    The description of the custom_field
    Enabled bool
    Kind string
    The kind of the custom_field
    Position int
    The position of the custom_field
    Requireds List<string>
    Showns List<string>
    Slug string
    The slug of the custom_field
    Label string
    The name of the custom_field
    Default string
    The default value for text field kinds.
    Description string
    The description of the custom_field
    Enabled bool
    Kind string
    The kind of the custom_field
    Position int
    The position of the custom_field
    Requireds []string
    Showns []string
    Slug string
    The slug of the custom_field
    label String
    The name of the custom_field
    default_ String
    The default value for text field kinds.
    description String
    The description of the custom_field
    enabled Boolean
    kind String
    The kind of the custom_field
    position Integer
    The position of the custom_field
    requireds List<String>
    showns List<String>
    slug String
    The slug of the custom_field
    label string
    The name of the custom_field
    default string
    The default value for text field kinds.
    description string
    The description of the custom_field
    enabled boolean
    kind string
    The kind of the custom_field
    position number
    The position of the custom_field
    requireds string[]
    showns string[]
    slug string
    The slug of the custom_field
    label str
    The name of the custom_field
    default str
    The default value for text field kinds.
    description str
    The description of the custom_field
    enabled bool
    kind str
    The kind of the custom_field
    position int
    The position of the custom_field
    requireds Sequence[str]
    showns Sequence[str]
    slug str
    The slug of the custom_field
    label String
    The name of the custom_field
    default String
    The default value for text field kinds.
    description String
    The description of the custom_field
    enabled Boolean
    kind String
    The kind of the custom_field
    position Number
    The position of the custom_field
    requireds List<String>
    showns List<String>
    slug String
    The slug of the custom_field

    Outputs

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

    Get an existing CustomField 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?: CustomFieldState, opts?: CustomResourceOptions): CustomField
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        default: Optional[str] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        kind: Optional[str] = None,
        label: Optional[str] = None,
        position: Optional[int] = None,
        requireds: Optional[Sequence[str]] = None,
        showns: Optional[Sequence[str]] = None,
        slug: Optional[str] = None) -> CustomField
    func GetCustomField(ctx *Context, name string, id IDInput, state *CustomFieldState, opts ...ResourceOption) (*CustomField, error)
    public static CustomField Get(string name, Input<string> id, CustomFieldState? state, CustomResourceOptions? opts = null)
    public static CustomField get(String name, Output<String> id, CustomFieldState 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:
    Default string
    The default value for text field kinds.
    Description string
    The description of the custom_field
    Enabled bool
    Kind string
    The kind of the custom_field
    Label string
    The name of the custom_field
    Position int
    The position of the custom_field
    Requireds List<string>
    Showns List<string>
    Slug string
    The slug of the custom_field
    Default string
    The default value for text field kinds.
    Description string
    The description of the custom_field
    Enabled bool
    Kind string
    The kind of the custom_field
    Label string
    The name of the custom_field
    Position int
    The position of the custom_field
    Requireds []string
    Showns []string
    Slug string
    The slug of the custom_field
    default_ String
    The default value for text field kinds.
    description String
    The description of the custom_field
    enabled Boolean
    kind String
    The kind of the custom_field
    label String
    The name of the custom_field
    position Integer
    The position of the custom_field
    requireds List<String>
    showns List<String>
    slug String
    The slug of the custom_field
    default string
    The default value for text field kinds.
    description string
    The description of the custom_field
    enabled boolean
    kind string
    The kind of the custom_field
    label string
    The name of the custom_field
    position number
    The position of the custom_field
    requireds string[]
    showns string[]
    slug string
    The slug of the custom_field
    default str
    The default value for text field kinds.
    description str
    The description of the custom_field
    enabled bool
    kind str
    The kind of the custom_field
    label str
    The name of the custom_field
    position int
    The position of the custom_field
    requireds Sequence[str]
    showns Sequence[str]
    slug str
    The slug of the custom_field
    default String
    The default value for text field kinds.
    description String
    The description of the custom_field
    enabled Boolean
    kind String
    The kind of the custom_field
    label String
    The name of the custom_field
    position Number
    The position of the custom_field
    requireds List<String>
    showns List<String>
    slug String
    The slug of the custom_field

    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
    rootlyhq/pulumi-rootly