Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Unifi
  4. API Docs
  5. setting
  6. EtherLighting
Viewing docs for Unifi v0.3.0
published on Wednesday, Jul 8, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-unifi

unifi.setting.EtherLighting

unifi logo
Viewing docs for Unifi v0.3.0
published on Wednesday, Jul 8, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-unifi

    Manages the site-level Etherlighting palette — the colors that switches with per-port LEDs (USW Pro Max line) use when a device’s etherLighting block selects a scheme. networkOverrides assigns a color per network/VLAN (used by mode = "network"); speedOverrides assigns a color per link-speed class (used by mode = "speed"). Overrides take precedence over the controller’s built-in default palette; networks or speeds without an override keep their default color. NOTE: the controller silently drops any override whose color equals that network’s built-in default — declare only colors that actually differ from the defaults, or the entry will not round-trip.

    Create EtherLighting Resource

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

    Constructor syntax

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

@overload
def EtherLighting(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  network_overrides: Optional[Sequence[EtherLightingNetworkOverrideArgs]] = None,
                  site: Optional[str] = None,
                  speed_overrides: Optional[Sequence[EtherLightingSpeedOverrideArgs]] = None)
    func NewEtherLighting(ctx *Context, name string, args *EtherLightingArgs, opts ...ResourceOption) (*EtherLighting, error)
    public EtherLighting(string name, EtherLightingArgs? args = null, CustomResourceOptions? opts = null)
    public EtherLighting(String name, EtherLightingArgs args)
public EtherLighting(String name, EtherLightingArgs args, CustomResourceOptions options)

    type: unifi:setting:EtherLighting
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "unifi_setting_ether_lighting" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args EtherLightingArgs
    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 EtherLightingArgs
    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 EtherLightingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EtherLightingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EtherLightingArgs
    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 etherLightingResource = new Unifi.Setting.EtherLighting("etherLightingResource", new()
{
    NetworkOverrides = new[]
    {
        new Unifi.Setting.Inputs.EtherLightingNetworkOverrideArgs
        {
            ColorHex = "string",
            NetworkId = "string",
        },
    },
    Site = "string",
    SpeedOverrides = new[]
    {
        new Unifi.Setting.Inputs.EtherLightingSpeedOverrideArgs
        {
            ColorHex = "string",
            Speed = "string",
        },
    },
});

    example, err := setting.NewEtherLighting(ctx, "etherLightingResource", &setting.EtherLightingArgs{
	NetworkOverrides: setting.EtherLightingNetworkOverrideArray{
		&setting.EtherLightingNetworkOverrideArgs{
			ColorHex:  pulumi.String("string"),
			NetworkId: pulumi.String("string"),
		},
	},
	Site: pulumi.String("string"),
	SpeedOverrides: setting.EtherLightingSpeedOverrideArray{
		&setting.EtherLightingSpeedOverrideArgs{
			ColorHex: pulumi.String("string"),
			Speed:    pulumi.String("string"),
		},
	},
})

    resource "unifi_setting_ether_lighting" "etherLightingResource" {
  lifecycle {
    create_before_destroy = true
  }
  network_overrides {
    color_hex  = "string"
    network_id = "string"
  }
  site = "string"
  speed_overrides {
    color_hex = "string"
    speed     = "string"
  }
}

    var etherLightingResource = new EtherLighting("etherLightingResource", EtherLightingArgs.builder()
    .networkOverrides(EtherLightingNetworkOverrideArgs.builder()
        .colorHex("string")
        .networkId("string")
        .build())
    .site("string")
    .speedOverrides(EtherLightingSpeedOverrideArgs.builder()
        .colorHex("string")
        .speed("string")
        .build())
    .build());

    ether_lighting_resource = unifi.setting.EtherLighting("etherLightingResource",
    network_overrides=[{
        "color_hex": "string",
        "network_id": "string",
    }],
    site="string",
    speed_overrides=[{
        "color_hex": "string",
        "speed": "string",
    }])

    const etherLightingResource = new unifi.setting.EtherLighting("etherLightingResource", {
    networkOverrides: [{
        colorHex: "string",
        networkId: "string",
    }],
    site: "string",
    speedOverrides: [{
        colorHex: "string",
        speed: "string",
    }],
});

    type: unifi:setting:EtherLighting
properties:
    networkOverrides:
        - colorHex: string
          networkId: string
    site: string
    speedOverrides:
        - colorHex: string
          speed: string

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

    NetworkOverrides List<Pulumiverse.Unifi.Setting.Inputs.EtherLightingNetworkOverride>
    Per-network LED colors, used when a device's Etherlighting mode is network.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    SpeedOverrides List<Pulumiverse.Unifi.Setting.Inputs.EtherLightingSpeedOverride>
    Per-link-speed LED colors, used when a device's Etherlighting mode is speed.
    NetworkOverrides []EtherLightingNetworkOverrideArgs
    Per-network LED colors, used when a device's Etherlighting mode is network.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    SpeedOverrides []EtherLightingSpeedOverrideArgs
    Per-link-speed LED colors, used when a device's Etherlighting mode is speed.
    network_overrides list(object)
    Per-network LED colors, used when a device's Etherlighting mode is network.
    site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    speed_overrides list(object)
    Per-link-speed LED colors, used when a device's Etherlighting mode is speed.
    networkOverrides List<EtherLightingNetworkOverride>
    Per-network LED colors, used when a device's Etherlighting mode is network.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    speedOverrides List<EtherLightingSpeedOverride>
    Per-link-speed LED colors, used when a device's Etherlighting mode is speed.
    networkOverrides EtherLightingNetworkOverride[]
    Per-network LED colors, used when a device's Etherlighting mode is network.
    site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    speedOverrides EtherLightingSpeedOverride[]
    Per-link-speed LED colors, used when a device's Etherlighting mode is speed.
    network_overrides Sequence[EtherLightingNetworkOverrideArgs]
    Per-network LED colors, used when a device's Etherlighting mode is network.
    site str
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    speed_overrides Sequence[EtherLightingSpeedOverrideArgs]
    Per-link-speed LED colors, used when a device's Etherlighting mode is speed.
    networkOverrides List<Property Map>
    Per-network LED colors, used when a device's Etherlighting mode is network.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    speedOverrides List<Property Map>
    Per-link-speed LED colors, used when a device's Etherlighting mode is speed.

    Outputs

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

    Get an existing EtherLighting 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?: EtherLightingState, opts?: CustomResourceOptions): EtherLighting
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        network_overrides: Optional[Sequence[EtherLightingNetworkOverrideArgs]] = None,
        site: Optional[str] = None,
        speed_overrides: Optional[Sequence[EtherLightingSpeedOverrideArgs]] = None) -> EtherLighting
    func GetEtherLighting(ctx *Context, name string, id IDInput, state *EtherLightingState, opts ...ResourceOption) (*EtherLighting, error)
    public static EtherLighting Get(string name, Input<string> id, EtherLightingState? state, CustomResourceOptions? opts = null)
    public static EtherLighting get(String name, Output<String> id, EtherLightingState state, CustomResourceOptions options)
    resources:  _:    type: unifi:setting:EtherLighting    get:      id: ${id}
    import {
  to = unifi_setting_ether_lighting.example
  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:
    NetworkOverrides List<Pulumiverse.Unifi.Setting.Inputs.EtherLightingNetworkOverride>
    Per-network LED colors, used when a device's Etherlighting mode is network.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    SpeedOverrides List<Pulumiverse.Unifi.Setting.Inputs.EtherLightingSpeedOverride>
    Per-link-speed LED colors, used when a device's Etherlighting mode is speed.
    NetworkOverrides []EtherLightingNetworkOverrideArgs
    Per-network LED colors, used when a device's Etherlighting mode is network.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    SpeedOverrides []EtherLightingSpeedOverrideArgs
    Per-link-speed LED colors, used when a device's Etherlighting mode is speed.
    network_overrides list(object)
    Per-network LED colors, used when a device's Etherlighting mode is network.
    site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    speed_overrides list(object)
    Per-link-speed LED colors, used when a device's Etherlighting mode is speed.
    networkOverrides List<EtherLightingNetworkOverride>
    Per-network LED colors, used when a device's Etherlighting mode is network.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    speedOverrides List<EtherLightingSpeedOverride>
    Per-link-speed LED colors, used when a device's Etherlighting mode is speed.
    networkOverrides EtherLightingNetworkOverride[]
    Per-network LED colors, used when a device's Etherlighting mode is network.
    site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    speedOverrides EtherLightingSpeedOverride[]
    Per-link-speed LED colors, used when a device's Etherlighting mode is speed.
    network_overrides Sequence[EtherLightingNetworkOverrideArgs]
    Per-network LED colors, used when a device's Etherlighting mode is network.
    site str
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    speed_overrides Sequence[EtherLightingSpeedOverrideArgs]
    Per-link-speed LED colors, used when a device's Etherlighting mode is speed.
    networkOverrides List<Property Map>
    Per-network LED colors, used when a device's Etherlighting mode is network.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    speedOverrides List<Property Map>
    Per-link-speed LED colors, used when a device's Etherlighting mode is speed.

    Supporting Types

    EtherLightingNetworkOverride, EtherLightingNetworkOverrideArgs

    ColorHex string
    LED color as a 6-digit RGB hex string without # (e.g. ff6c14).
    NetworkId string
    ID of the network/VLAN this color applies to (e.g. unifi_network.iot.id).
    ColorHex string
    LED color as a 6-digit RGB hex string without # (e.g. ff6c14).
    NetworkId string
    ID of the network/VLAN this color applies to (e.g. unifi_network.iot.id).
    color_hex string
    LED color as a 6-digit RGB hex string without # (e.g. ff6c14).
    network_id string
    ID of the network/VLAN this color applies to (e.g. unifi_network.iot.id).
    colorHex String
    LED color as a 6-digit RGB hex string without # (e.g. ff6c14).
    networkId String
    ID of the network/VLAN this color applies to (e.g. unifi_network.iot.id).
    colorHex string
    LED color as a 6-digit RGB hex string without # (e.g. ff6c14).
    networkId string
    ID of the network/VLAN this color applies to (e.g. unifi_network.iot.id).
    color_hex str
    LED color as a 6-digit RGB hex string without # (e.g. ff6c14).
    network_id str
    ID of the network/VLAN this color applies to (e.g. unifi_network.iot.id).
    colorHex String
    LED color as a 6-digit RGB hex string without # (e.g. ff6c14).
    networkId String
    ID of the network/VLAN this color applies to (e.g. unifi_network.iot.id).

    EtherLightingSpeedOverride, EtherLightingSpeedOverrideArgs

    ColorHex string
    LED color as a 6-digit RGB hex string without # (e.g. ffc107).
    Speed string
    Link-speed class this color applies to.
    ColorHex string
    LED color as a 6-digit RGB hex string without # (e.g. ffc107).
    Speed string
    Link-speed class this color applies to.
    color_hex string
    LED color as a 6-digit RGB hex string without # (e.g. ffc107).
    speed string
    Link-speed class this color applies to.
    colorHex String
    LED color as a 6-digit RGB hex string without # (e.g. ffc107).
    speed String
    Link-speed class this color applies to.
    colorHex string
    LED color as a 6-digit RGB hex string without # (e.g. ffc107).
    speed string
    Link-speed class this color applies to.
    color_hex str
    LED color as a 6-digit RGB hex string without # (e.g. ffc107).
    speed str
    Link-speed class this color applies to.
    colorHex String
    LED color as a 6-digit RGB hex string without # (e.g. ffc107).
    speed String
    Link-speed class this color applies to.

    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.3.0
    published on Wednesday, Jul 8, 2026 by Pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-unifi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial