Rootly

Community
Package contributed by a community member
v0.0.6 published on Friday, Aug 12, 2022 by Rootly

CustomField

Manages custom fields.

Create a CustomField Resource

new CustomField(name: string, args: CustomFieldArgs, opts?: CustomResourceOptions);
@overload
def CustomField(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                description: Optional[str] = None,
                enabled: Optional[bool] = None,
                kind: Optional[str] = None,
                label: Optional[str] = None,
                requireds: Optional[Sequence[str]] = None,
                showns: Optional[Sequence[str]] = None)
@overload
def CustomField(resource_name: str,
                args: CustomFieldArgs,
                opts: Optional[ResourceOptions] = 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.

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.

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:

Kind string

The kind of the custom field

Label string

The name of the custom field

Description string

The description of the custom field

Enabled bool

Whether the custom field is enabled or not

Requireds List<string>

Where the custom field is required.

Showns List<string>

Where the custom field is shown.

Kind string

The kind of the custom field

Label string

The name of the custom field

Description string

The description of the custom field

Enabled bool

Whether the custom field is enabled or not

Requireds []string

Where the custom field is required.

Showns []string

Where the custom field is shown.

kind String

The kind of the custom field

label String

The name of the custom field

description String

The description of the custom field

enabled Boolean

Whether the custom field is enabled or not

requireds List<String>

Where the custom field is required.

showns List<String>

Where the custom field is shown.

kind string

The kind of the custom field

label string

The name of the custom field

description string

The description of the custom field

enabled boolean

Whether the custom field is enabled or not

requireds string[]

Where the custom field is required.

showns string[]

Where the custom field is shown.

kind str

The kind of the custom field

label str

The name of the custom field

description str

The description of the custom field

enabled bool

Whether the custom field is enabled or not

requireds Sequence[str]

Where the custom field is required.

showns Sequence[str]

Where the custom field is shown.

kind String

The kind of the custom field

label String

The name of the custom field

description String

The description of the custom field

enabled Boolean

Whether the custom field is enabled or not

requireds List<String>

Where the custom field is required.

showns List<String>

Where the custom field is shown.

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 an 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,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        kind: Optional[str] = None,
        label: Optional[str] = None,
        requireds: Optional[Sequence[str]] = None,
        showns: Optional[Sequence[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:
Description string

The description of the custom field

Enabled bool

Whether the custom field is enabled or not

Kind string

The kind of the custom field

Label string

The name of the custom field

Requireds List<string>

Where the custom field is required.

Showns List<string>

Where the custom field is shown.

Description string

The description of the custom field

Enabled bool

Whether the custom field is enabled or not

Kind string

The kind of the custom field

Label string

The name of the custom field

Requireds []string

Where the custom field is required.

Showns []string

Where the custom field is shown.

description String

The description of the custom field

enabled Boolean

Whether the custom field is enabled or not

kind String

The kind of the custom field

label String

The name of the custom field

requireds List<String>

Where the custom field is required.

showns List<String>

Where the custom field is shown.

description string

The description of the custom field

enabled boolean

Whether the custom field is enabled or not

kind string

The kind of the custom field

label string

The name of the custom field

requireds string[]

Where the custom field is required.

showns string[]

Where the custom field is shown.

description str

The description of the custom field

enabled bool

Whether the custom field is enabled or not

kind str

The kind of the custom field

label str

The name of the custom field

requireds Sequence[str]

Where the custom field is required.

showns Sequence[str]

Where the custom field is shown.

description String

The description of the custom field

enabled Boolean

Whether the custom field is enabled or not

kind String

The kind of the custom field

label String

The name of the custom field

requireds List<String>

Where the custom field is required.

showns List<String>

Where the custom field is shown.

Package Details

Repository
https://github.com/rootlyhq/pulumi-rootly
License
Apache-2.0
Notes

This Pulumi package is based on the rootly Terraform Provider.