1. Packages
  2. Meraki Provider
  3. API Docs
  4. networks
  5. SensorMqttBrokers
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

meraki.networks.SensorMqttBrokers

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as meraki from "@pulumi/meraki";
    
    const example = new meraki.networks.SensorMqttBrokers("example", {
        enabled: true,
        mqttBrokerId: "string",
        networkId: "string",
    });
    export const merakiNetworksSensorMqttBrokersExample = example;
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.networks.SensorMqttBrokers("example",
        enabled=True,
        mqtt_broker_id="string",
        network_id="string")
    pulumi.export("merakiNetworksSensorMqttBrokersExample", example)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/networks"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := networks.NewSensorMqttBrokers(ctx, "example", &networks.SensorMqttBrokersArgs{
    			Enabled:      pulumi.Bool(true),
    			MqttBrokerId: pulumi.String("string"),
    			NetworkId:    pulumi.String("string"),
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiNetworksSensorMqttBrokersExample", example)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Meraki = Pulumi.Meraki;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Meraki.Networks.SensorMqttBrokers("example", new()
        {
            Enabled = true,
            MqttBrokerId = "string",
            NetworkId = "string",
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiNetworksSensorMqttBrokersExample"] = example,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.meraki.networks.SensorMqttBrokers;
    import com.pulumi.meraki.networks.SensorMqttBrokersArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new SensorMqttBrokers("example", SensorMqttBrokersArgs.builder()
                .enabled(true)
                .mqttBrokerId("string")
                .networkId("string")
                .build());
    
            ctx.export("merakiNetworksSensorMqttBrokersExample", example);
        }
    }
    
    resources:
      example:
        type: meraki:networks:SensorMqttBrokers
        properties:
          enabled: true
          mqttBrokerId: string
          networkId: string
    outputs:
      merakiNetworksSensorMqttBrokersExample: ${example}
    

    Create SensorMqttBrokers Resource

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

    Constructor syntax

    new SensorMqttBrokers(name: string, args: SensorMqttBrokersArgs, opts?: CustomResourceOptions);
    @overload
    def SensorMqttBrokers(resource_name: str,
                          args: SensorMqttBrokersArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def SensorMqttBrokers(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          mqtt_broker_id: Optional[str] = None,
                          network_id: Optional[str] = None,
                          enabled: Optional[bool] = None)
    func NewSensorMqttBrokers(ctx *Context, name string, args SensorMqttBrokersArgs, opts ...ResourceOption) (*SensorMqttBrokers, error)
    public SensorMqttBrokers(string name, SensorMqttBrokersArgs args, CustomResourceOptions? opts = null)
    public SensorMqttBrokers(String name, SensorMqttBrokersArgs args)
    public SensorMqttBrokers(String name, SensorMqttBrokersArgs args, CustomResourceOptions options)
    
    type: meraki:networks:SensorMqttBrokers
    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 SensorMqttBrokersArgs
    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 SensorMqttBrokersArgs
    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 SensorMqttBrokersArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SensorMqttBrokersArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SensorMqttBrokersArgs
    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 sensorMqttBrokersResource = new Meraki.Networks.SensorMqttBrokers("sensorMqttBrokersResource", new()
    {
        MqttBrokerId = "string",
        NetworkId = "string",
        Enabled = false,
    });
    
    example, err := networks.NewSensorMqttBrokers(ctx, "sensorMqttBrokersResource", &networks.SensorMqttBrokersArgs{
    	MqttBrokerId: pulumi.String("string"),
    	NetworkId:    pulumi.String("string"),
    	Enabled:      pulumi.Bool(false),
    })
    
    var sensorMqttBrokersResource = new SensorMqttBrokers("sensorMqttBrokersResource", SensorMqttBrokersArgs.builder()
        .mqttBrokerId("string")
        .networkId("string")
        .enabled(false)
        .build());
    
    sensor_mqtt_brokers_resource = meraki.networks.SensorMqttBrokers("sensorMqttBrokersResource",
        mqtt_broker_id="string",
        network_id="string",
        enabled=False)
    
    const sensorMqttBrokersResource = new meraki.networks.SensorMqttBrokers("sensorMqttBrokersResource", {
        mqttBrokerId: "string",
        networkId: "string",
        enabled: false,
    });
    
    type: meraki:networks:SensorMqttBrokers
    properties:
        enabled: false
        mqttBrokerId: string
        networkId: string
    

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

    MqttBrokerId string
    ID of the MQTT Broker.
    NetworkId string
    networkId path parameter. Network ID
    Enabled bool
    Specifies whether the broker is enabled for sensor data. Currently, only a single broker may be enabled for sensor data.
    MqttBrokerId string
    ID of the MQTT Broker.
    NetworkId string
    networkId path parameter. Network ID
    Enabled bool
    Specifies whether the broker is enabled for sensor data. Currently, only a single broker may be enabled for sensor data.
    mqttBrokerId String
    ID of the MQTT Broker.
    networkId String
    networkId path parameter. Network ID
    enabled Boolean
    Specifies whether the broker is enabled for sensor data. Currently, only a single broker may be enabled for sensor data.
    mqttBrokerId string
    ID of the MQTT Broker.
    networkId string
    networkId path parameter. Network ID
    enabled boolean
    Specifies whether the broker is enabled for sensor data. Currently, only a single broker may be enabled for sensor data.
    mqtt_broker_id str
    ID of the MQTT Broker.
    network_id str
    networkId path parameter. Network ID
    enabled bool
    Specifies whether the broker is enabled for sensor data. Currently, only a single broker may be enabled for sensor data.
    mqttBrokerId String
    ID of the MQTT Broker.
    networkId String
    networkId path parameter. Network ID
    enabled Boolean
    Specifies whether the broker is enabled for sensor data. Currently, only a single broker may be enabled for sensor data.

    Outputs

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

    Get an existing SensorMqttBrokers 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?: SensorMqttBrokersState, opts?: CustomResourceOptions): SensorMqttBrokers
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            enabled: Optional[bool] = None,
            mqtt_broker_id: Optional[str] = None,
            network_id: Optional[str] = None) -> SensorMqttBrokers
    func GetSensorMqttBrokers(ctx *Context, name string, id IDInput, state *SensorMqttBrokersState, opts ...ResourceOption) (*SensorMqttBrokers, error)
    public static SensorMqttBrokers Get(string name, Input<string> id, SensorMqttBrokersState? state, CustomResourceOptions? opts = null)
    public static SensorMqttBrokers get(String name, Output<String> id, SensorMqttBrokersState 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:
    Enabled bool
    Specifies whether the broker is enabled for sensor data. Currently, only a single broker may be enabled for sensor data.
    MqttBrokerId string
    ID of the MQTT Broker.
    NetworkId string
    networkId path parameter. Network ID
    Enabled bool
    Specifies whether the broker is enabled for sensor data. Currently, only a single broker may be enabled for sensor data.
    MqttBrokerId string
    ID of the MQTT Broker.
    NetworkId string
    networkId path parameter. Network ID
    enabled Boolean
    Specifies whether the broker is enabled for sensor data. Currently, only a single broker may be enabled for sensor data.
    mqttBrokerId String
    ID of the MQTT Broker.
    networkId String
    networkId path parameter. Network ID
    enabled boolean
    Specifies whether the broker is enabled for sensor data. Currently, only a single broker may be enabled for sensor data.
    mqttBrokerId string
    ID of the MQTT Broker.
    networkId string
    networkId path parameter. Network ID
    enabled bool
    Specifies whether the broker is enabled for sensor data. Currently, only a single broker may be enabled for sensor data.
    mqtt_broker_id str
    ID of the MQTT Broker.
    network_id str
    networkId path parameter. Network ID
    enabled Boolean
    Specifies whether the broker is enabled for sensor data. Currently, only a single broker may be enabled for sensor data.
    mqttBrokerId String
    ID of the MQTT Broker.
    networkId String
    networkId path parameter. Network ID

    Import

    $ pulumi import meraki:networks/sensorMqttBrokers:SensorMqttBrokers example "mqtt_broker_id,network_id"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    meraki pulumi/pulumi-meraki
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the meraki Terraform Provider.
    meraki logo
    Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi