1. Packages
  2. Rootly
  3. API Docs
  4. CustomFieldOption
Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly

rootly.CustomFieldOption

Explore with Pulumi AI

DEPRECATED: Please use rootly.FormField and rootly.FormFieldOption resources instead.

Create CustomFieldOption Resource

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

Constructor syntax

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

@overload
def CustomFieldOption(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      value: Optional[str] = None,
                      color: Optional[str] = None,
                      custom_field_id: Optional[int] = None,
                      default: Optional[bool] = None,
                      position: Optional[int] = None)
func NewCustomFieldOption(ctx *Context, name string, args CustomFieldOptionArgs, opts ...ResourceOption) (*CustomFieldOption, error)
public CustomFieldOption(string name, CustomFieldOptionArgs args, CustomResourceOptions? opts = null)
public CustomFieldOption(String name, CustomFieldOptionArgs args)
public CustomFieldOption(String name, CustomFieldOptionArgs args, CustomResourceOptions options)
type: rootly:CustomFieldOption
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CustomFieldOptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CustomFieldOptionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CustomFieldOptionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CustomFieldOptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CustomFieldOptionArgs
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 customFieldOptionResource = new Rootly.CustomFieldOption("customFieldOptionResource", new()
{
    Value = "string",
    Color = "string",
    CustomFieldId = 0,
    Default = false,
    Position = 0,
});
Copy
example, err := rootly.NewCustomFieldOption(ctx, "customFieldOptionResource", &rootly.CustomFieldOptionArgs{
	Value:         pulumi.String("string"),
	Color:         pulumi.String("string"),
	CustomFieldId: pulumi.Int(0),
	Default:       pulumi.Bool(false),
	Position:      pulumi.Int(0),
})
Copy
var customFieldOptionResource = new CustomFieldOption("customFieldOptionResource", CustomFieldOptionArgs.builder()
    .value("string")
    .color("string")
    .customFieldId(0)
    .default_(false)
    .position(0)
    .build());
Copy
custom_field_option_resource = rootly.CustomFieldOption("customFieldOptionResource",
    value="string",
    color="string",
    custom_field_id=0,
    default=False,
    position=0)
Copy
const customFieldOptionResource = new rootly.CustomFieldOption("customFieldOptionResource", {
    value: "string",
    color: "string",
    customFieldId: 0,
    "default": false,
    position: 0,
});
Copy
type: rootly:CustomFieldOption
properties:
    color: string
    customFieldId: 0
    default: false
    position: 0
    value: string
Copy

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

Value This property is required. string
The value of the customfieldoption
Color string
The hex color of the customfieldoption
CustomFieldId Changes to this property will trigger replacement. int
The ID of the parent custom field
Default bool
Position int
The position of the customfieldoption
Value This property is required. string
The value of the customfieldoption
Color string
The hex color of the customfieldoption
CustomFieldId Changes to this property will trigger replacement. int
The ID of the parent custom field
Default bool
Position int
The position of the customfieldoption
value This property is required. String
The value of the customfieldoption
color String
The hex color of the customfieldoption
customFieldId Changes to this property will trigger replacement. Integer
The ID of the parent custom field
default_ Boolean
position Integer
The position of the customfieldoption
value This property is required. string
The value of the customfieldoption
color string
The hex color of the customfieldoption
customFieldId Changes to this property will trigger replacement. number
The ID of the parent custom field
default boolean
position number
The position of the customfieldoption
value This property is required. str
The value of the customfieldoption
color str
The hex color of the customfieldoption
custom_field_id Changes to this property will trigger replacement. int
The ID of the parent custom field
default bool
position int
The position of the customfieldoption
value This property is required. String
The value of the customfieldoption
color String
The hex color of the customfieldoption
customFieldId Changes to this property will trigger replacement. Number
The ID of the parent custom field
default Boolean
position Number
The position of the customfieldoption

Outputs

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

Get an existing CustomFieldOption 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?: CustomFieldOptionState, opts?: CustomResourceOptions): CustomFieldOption
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        color: Optional[str] = None,
        custom_field_id: Optional[int] = None,
        default: Optional[bool] = None,
        position: Optional[int] = None,
        value: Optional[str] = None) -> CustomFieldOption
func GetCustomFieldOption(ctx *Context, name string, id IDInput, state *CustomFieldOptionState, opts ...ResourceOption) (*CustomFieldOption, error)
public static CustomFieldOption Get(string name, Input<string> id, CustomFieldOptionState? state, CustomResourceOptions? opts = null)
public static CustomFieldOption get(String name, Output<String> id, CustomFieldOptionState state, CustomResourceOptions options)
resources:  _:    type: rootly:CustomFieldOption    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 customfieldoption
CustomFieldId Changes to this property will trigger replacement. int
The ID of the parent custom field
Default bool
Position int
The position of the customfieldoption
Value string
The value of the customfieldoption
Color string
The hex color of the customfieldoption
CustomFieldId Changes to this property will trigger replacement. int
The ID of the parent custom field
Default bool
Position int
The position of the customfieldoption
Value string
The value of the customfieldoption
color String
The hex color of the customfieldoption
customFieldId Changes to this property will trigger replacement. Integer
The ID of the parent custom field
default_ Boolean
position Integer
The position of the customfieldoption
value String
The value of the customfieldoption
color string
The hex color of the customfieldoption
customFieldId Changes to this property will trigger replacement. number
The ID of the parent custom field
default boolean
position number
The position of the customfieldoption
value string
The value of the customfieldoption
color str
The hex color of the customfieldoption
custom_field_id Changes to this property will trigger replacement. int
The ID of the parent custom field
default bool
position int
The position of the customfieldoption
value str
The value of the customfieldoption
color String
The hex color of the customfieldoption
customFieldId Changes to this property will trigger replacement. Number
The ID of the parent custom field
default Boolean
position Number
The position of the customfieldoption
value String
The value of the customfieldoption

Package Details

Repository
rootly rootlyhq/pulumi-rootly
License
Apache-2.0
Notes
This Pulumi package is based on the rootly Terraform Provider.