1. Packages
  2. Unifi
  3. API Docs
  4. setting
  5. LcdMonitor
Viewing docs for Unifi v0.2.0
published on Tuesday, Feb 17, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-unifi

unifi.setting.LcdMonitor

unifi logo
Viewing docs for Unifi v0.2.0
published on Tuesday, Feb 17, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-unifi

    Manages LCD Monitor (LCM) settings for UniFi devices with built-in displays, such as the UniFi Dream Machine Pro (UDM Pro) and UniFi Network Video Recorder (UNVR).

    Create LcdMonitor Resource

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

    Constructor syntax

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

@overload
def LcdMonitor(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               enabled: Optional[bool] = None,
               brightness: Optional[int] = None,
               idle_timeout: Optional[int] = None,
               site: Optional[str] = None,
               sync: Optional[bool] = None,
               touch_event: Optional[bool] = None)
    func NewLcdMonitor(ctx *Context, name string, args LcdMonitorArgs, opts ...ResourceOption) (*LcdMonitor, error)
    public LcdMonitor(string name, LcdMonitorArgs args, CustomResourceOptions? opts = null)
    public LcdMonitor(String name, LcdMonitorArgs args)
public LcdMonitor(String name, LcdMonitorArgs args, CustomResourceOptions options)

    type: unifi:setting:LcdMonitor
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 LcdMonitorArgs
    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 LcdMonitorArgs
    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 LcdMonitorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LcdMonitorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LcdMonitorArgs
    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 lcdMonitorResource = new Unifi.Setting.LcdMonitor("lcdMonitorResource", new()
{
    Enabled = false,
    Brightness = 0,
    IdleTimeout = 0,
    Site = "string",
    Sync = false,
    TouchEvent = false,
});

    example, err := setting.NewLcdMonitor(ctx, "lcdMonitorResource", &setting.LcdMonitorArgs{
	Enabled:     pulumi.Bool(false),
	Brightness:  pulumi.Int(0),
	IdleTimeout: pulumi.Int(0),
	Site:        pulumi.String("string"),
	Sync:        pulumi.Bool(false),
	TouchEvent:  pulumi.Bool(false),
})

    var lcdMonitorResource = new LcdMonitor("lcdMonitorResource", LcdMonitorArgs.builder()
    .enabled(false)
    .brightness(0)
    .idleTimeout(0)
    .site("string")
    .sync(false)
    .touchEvent(false)
    .build());

    lcd_monitor_resource = unifi.setting.LcdMonitor("lcdMonitorResource",
    enabled=False,
    brightness=0,
    idle_timeout=0,
    site="string",
    sync=False,
    touch_event=False)

    const lcdMonitorResource = new unifi.setting.LcdMonitor("lcdMonitorResource", {
    enabled: false,
    brightness: 0,
    idleTimeout: 0,
    site: "string",
    sync: false,
    touchEvent: false,
});

    type: unifi:setting:LcdMonitor
properties:
    brightness: 0
    enabled: false
    idleTimeout: 0
    site: string
    sync: false
    touchEvent: false

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

    Enabled bool
    Whether the LCD display is enabled.
    Brightness int
    The brightness level of the LCD display. Valid values are 1-100.
    IdleTimeout int
    The time in seconds after which the display turns off when idle. Valid values are 10-3600.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    Sync bool
    Whether to synchronize display settings across multiple devices.
    TouchEvent bool
    Whether touch interactions with the display are enabled.
    Enabled bool
    Whether the LCD display is enabled.
    Brightness int
    The brightness level of the LCD display. Valid values are 1-100.
    IdleTimeout int
    The time in seconds after which the display turns off when idle. Valid values are 10-3600.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    Sync bool
    Whether to synchronize display settings across multiple devices.
    TouchEvent bool
    Whether touch interactions with the display are enabled.
    enabled Boolean
    Whether the LCD display is enabled.
    brightness Integer
    The brightness level of the LCD display. Valid values are 1-100.
    idleTimeout Integer
    The time in seconds after which the display turns off when idle. Valid values are 10-3600.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    sync Boolean
    Whether to synchronize display settings across multiple devices.
    touchEvent Boolean
    Whether touch interactions with the display are enabled.
    enabled boolean
    Whether the LCD display is enabled.
    brightness number
    The brightness level of the LCD display. Valid values are 1-100.
    idleTimeout number
    The time in seconds after which the display turns off when idle. Valid values are 10-3600.
    site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    sync boolean
    Whether to synchronize display settings across multiple devices.
    touchEvent boolean
    Whether touch interactions with the display are enabled.
    enabled bool
    Whether the LCD display is enabled.
    brightness int
    The brightness level of the LCD display. Valid values are 1-100.
    idle_timeout int
    The time in seconds after which the display turns off when idle. Valid values are 10-3600.
    site str
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    sync bool
    Whether to synchronize display settings across multiple devices.
    touch_event bool
    Whether touch interactions with the display are enabled.
    enabled Boolean
    Whether the LCD display is enabled.
    brightness Number
    The brightness level of the LCD display. Valid values are 1-100.
    idleTimeout Number
    The time in seconds after which the display turns off when idle. Valid values are 10-3600.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    sync Boolean
    Whether to synchronize display settings across multiple devices.
    touchEvent Boolean
    Whether touch interactions with the display are enabled.

    Outputs

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

    Get an existing LcdMonitor 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?: LcdMonitorState, opts?: CustomResourceOptions): LcdMonitor
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        brightness: Optional[int] = None,
        enabled: Optional[bool] = None,
        idle_timeout: Optional[int] = None,
        site: Optional[str] = None,
        sync: Optional[bool] = None,
        touch_event: Optional[bool] = None) -> LcdMonitor
    func GetLcdMonitor(ctx *Context, name string, id IDInput, state *LcdMonitorState, opts ...ResourceOption) (*LcdMonitor, error)
    public static LcdMonitor Get(string name, Input<string> id, LcdMonitorState? state, CustomResourceOptions? opts = null)
    public static LcdMonitor get(String name, Output<String> id, LcdMonitorState state, CustomResourceOptions options)
    resources:  _:    type: unifi:setting:LcdMonitor    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:
    Brightness int
    The brightness level of the LCD display. Valid values are 1-100.
    Enabled bool
    Whether the LCD display is enabled.
    IdleTimeout int
    The time in seconds after which the display turns off when idle. Valid values are 10-3600.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    Sync bool
    Whether to synchronize display settings across multiple devices.
    TouchEvent bool
    Whether touch interactions with the display are enabled.
    Brightness int
    The brightness level of the LCD display. Valid values are 1-100.
    Enabled bool
    Whether the LCD display is enabled.
    IdleTimeout int
    The time in seconds after which the display turns off when idle. Valid values are 10-3600.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    Sync bool
    Whether to synchronize display settings across multiple devices.
    TouchEvent bool
    Whether touch interactions with the display are enabled.
    brightness Integer
    The brightness level of the LCD display. Valid values are 1-100.
    enabled Boolean
    Whether the LCD display is enabled.
    idleTimeout Integer
    The time in seconds after which the display turns off when idle. Valid values are 10-3600.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    sync Boolean
    Whether to synchronize display settings across multiple devices.
    touchEvent Boolean
    Whether touch interactions with the display are enabled.
    brightness number
    The brightness level of the LCD display. Valid values are 1-100.
    enabled boolean
    Whether the LCD display is enabled.
    idleTimeout number
    The time in seconds after which the display turns off when idle. Valid values are 10-3600.
    site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    sync boolean
    Whether to synchronize display settings across multiple devices.
    touchEvent boolean
    Whether touch interactions with the display are enabled.
    brightness int
    The brightness level of the LCD display. Valid values are 1-100.
    enabled bool
    Whether the LCD display is enabled.
    idle_timeout int
    The time in seconds after which the display turns off when idle. Valid values are 10-3600.
    site str
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    sync bool
    Whether to synchronize display settings across multiple devices.
    touch_event bool
    Whether touch interactions with the display are enabled.
    brightness Number
    The brightness level of the LCD display. Valid values are 1-100.
    enabled Boolean
    Whether the LCD display is enabled.
    idleTimeout Number
    The time in seconds after which the display turns off when idle. Valid values are 10-3600.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    sync Boolean
    Whether to synchronize display settings across multiple devices.
    touchEvent Boolean
    Whether touch interactions with the display are enabled.

    Package Details

    Repository
    unifi pulumiverse/pulumi-unifi
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the unifi Terraform Provider.
    unifi logo
    Viewing docs for Unifi v0.2.0
    published on Tuesday, Feb 17, 2026 by Pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-unifi
      Try Pulumi Cloud free. Your team will thank you.