1. Packages
  2. Meraki
  3. API Docs
  4. devices
  5. CameraSense
Meraki v0.1.1 published on Thursday, May 16, 2024 by Pulumi

meraki.devices.CameraSense

Explore with Pulumi AI

meraki logo
Meraki v0.1.1 published on Thursday, May 16, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as meraki from "@pulumi/meraki";
    
    const example = new meraki.devices.CameraSense("example", {
        audioDetection: {
            enabled: false,
        },
        mqttBrokerId: "1234",
        senseEnabled: true,
        serial: "string",
    });
    export const merakiDevicesCameraSenseExample = example;
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.devices.CameraSense("example",
        audio_detection=meraki.devices.CameraSenseAudioDetectionArgs(
            enabled=False,
        ),
        mqtt_broker_id="1234",
        sense_enabled=True,
        serial="string")
    pulumi.export("merakiDevicesCameraSenseExample", example)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/devices"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := devices.NewCameraSense(ctx, "example", &devices.CameraSenseArgs{
    			AudioDetection: &devices.CameraSenseAudioDetectionArgs{
    				Enabled: pulumi.Bool(false),
    			},
    			MqttBrokerId: pulumi.String("1234"),
    			SenseEnabled: pulumi.Bool(true),
    			Serial:       pulumi.String("string"),
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiDevicesCameraSenseExample", example)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Meraki = Pulumi.Meraki;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Meraki.Devices.CameraSense("example", new()
        {
            AudioDetection = new Meraki.Devices.Inputs.CameraSenseAudioDetectionArgs
            {
                Enabled = false,
            },
            MqttBrokerId = "1234",
            SenseEnabled = true,
            Serial = "string",
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiDevicesCameraSenseExample"] = example,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.meraki.devices.CameraSense;
    import com.pulumi.meraki.devices.CameraSenseArgs;
    import com.pulumi.meraki.devices.inputs.CameraSenseAudioDetectionArgs;
    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 CameraSense("example", CameraSenseArgs.builder()        
                .audioDetection(CameraSenseAudioDetectionArgs.builder()
                    .enabled(false)
                    .build())
                .mqttBrokerId("1234")
                .senseEnabled(true)
                .serial("string")
                .build());
    
            ctx.export("merakiDevicesCameraSenseExample", example);
        }
    }
    
    resources:
      example:
        type: meraki:devices:CameraSense
        properties:
          audioDetection:
            enabled: false
          mqttBrokerId: '1234'
          senseEnabled: true
          serial: string
    outputs:
      merakiDevicesCameraSenseExample: ${example}
    

    Create CameraSense Resource

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

    Constructor syntax

    new CameraSense(name: string, args: CameraSenseArgs, opts?: CustomResourceOptions);
    @overload
    def CameraSense(resource_name: str,
                    args: CameraSenseArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def CameraSense(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    serial: Optional[str] = None,
                    audio_detection: Optional[CameraSenseAudioDetectionArgs] = None,
                    detection_model_id: Optional[str] = None,
                    mqtt_broker_id: Optional[str] = None,
                    sense_enabled: Optional[bool] = None)
    func NewCameraSense(ctx *Context, name string, args CameraSenseArgs, opts ...ResourceOption) (*CameraSense, error)
    public CameraSense(string name, CameraSenseArgs args, CustomResourceOptions? opts = null)
    public CameraSense(String name, CameraSenseArgs args)
    public CameraSense(String name, CameraSenseArgs args, CustomResourceOptions options)
    
    type: meraki:devices:CameraSense
    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 CameraSenseArgs
    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 CameraSenseArgs
    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 CameraSenseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CameraSenseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CameraSenseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var cameraSenseResource = new Meraki.Devices.CameraSense("cameraSenseResource", new()
    {
        Serial = "string",
        AudioDetection = new Meraki.Devices.Inputs.CameraSenseAudioDetectionArgs
        {
            Enabled = false,
        },
        DetectionModelId = "string",
        MqttBrokerId = "string",
        SenseEnabled = false,
    });
    
    example, err := devices.NewCameraSense(ctx, "cameraSenseResource", &devices.CameraSenseArgs{
    	Serial: pulumi.String("string"),
    	AudioDetection: &devices.CameraSenseAudioDetectionArgs{
    		Enabled: pulumi.Bool(false),
    	},
    	DetectionModelId: pulumi.String("string"),
    	MqttBrokerId:     pulumi.String("string"),
    	SenseEnabled:     pulumi.Bool(false),
    })
    
    var cameraSenseResource = new CameraSense("cameraSenseResource", CameraSenseArgs.builder()        
        .serial("string")
        .audioDetection(CameraSenseAudioDetectionArgs.builder()
            .enabled(false)
            .build())
        .detectionModelId("string")
        .mqttBrokerId("string")
        .senseEnabled(false)
        .build());
    
    camera_sense_resource = meraki.devices.CameraSense("cameraSenseResource",
        serial="string",
        audio_detection=meraki.devices.CameraSenseAudioDetectionArgs(
            enabled=False,
        ),
        detection_model_id="string",
        mqtt_broker_id="string",
        sense_enabled=False)
    
    const cameraSenseResource = new meraki.devices.CameraSense("cameraSenseResource", {
        serial: "string",
        audioDetection: {
            enabled: false,
        },
        detectionModelId: "string",
        mqttBrokerId: "string",
        senseEnabled: false,
    });
    
    type: meraki:devices:CameraSense
    properties:
        audioDetection:
            enabled: false
        detectionModelId: string
        mqttBrokerId: string
        senseEnabled: false
        serial: string
    

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

    Serial string
    serial path parameter.
    AudioDetection CameraSenseAudioDetection
    The details of the audio detection config.
    DetectionModelId string
    The ID of the object detection model
    MqttBrokerId string
    The ID of the MQTT broker to be enabled on the camera. A value of null will disable MQTT on the camera
    SenseEnabled bool
    Boolean indicating if sense(license) is enabled(true) or disabled(false) on the camera
    Serial string
    serial path parameter.
    AudioDetection CameraSenseAudioDetectionArgs
    The details of the audio detection config.
    DetectionModelId string
    The ID of the object detection model
    MqttBrokerId string
    The ID of the MQTT broker to be enabled on the camera. A value of null will disable MQTT on the camera
    SenseEnabled bool
    Boolean indicating if sense(license) is enabled(true) or disabled(false) on the camera
    serial String
    serial path parameter.
    audioDetection CameraSenseAudioDetection
    The details of the audio detection config.
    detectionModelId String
    The ID of the object detection model
    mqttBrokerId String
    The ID of the MQTT broker to be enabled on the camera. A value of null will disable MQTT on the camera
    senseEnabled Boolean
    Boolean indicating if sense(license) is enabled(true) or disabled(false) on the camera
    serial string
    serial path parameter.
    audioDetection CameraSenseAudioDetection
    The details of the audio detection config.
    detectionModelId string
    The ID of the object detection model
    mqttBrokerId string
    The ID of the MQTT broker to be enabled on the camera. A value of null will disable MQTT on the camera
    senseEnabled boolean
    Boolean indicating if sense(license) is enabled(true) or disabled(false) on the camera
    serial str
    serial path parameter.
    audio_detection CameraSenseAudioDetectionArgs
    The details of the audio detection config.
    detection_model_id str
    The ID of the object detection model
    mqtt_broker_id str
    The ID of the MQTT broker to be enabled on the camera. A value of null will disable MQTT on the camera
    sense_enabled bool
    Boolean indicating if sense(license) is enabled(true) or disabled(false) on the camera
    serial String
    serial path parameter.
    audioDetection Property Map
    The details of the audio detection config.
    detectionModelId String
    The ID of the object detection model
    mqttBrokerId String
    The ID of the MQTT broker to be enabled on the camera. A value of null will disable MQTT on the camera
    senseEnabled Boolean
    Boolean indicating if sense(license) is enabled(true) or disabled(false) on the camera

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CameraSense resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    MqttTopics List<string>
    Id string
    The provider-assigned unique ID for this managed resource.
    MqttTopics []string
    id String
    The provider-assigned unique ID for this managed resource.
    mqttTopics List<String>
    id string
    The provider-assigned unique ID for this managed resource.
    mqttTopics string[]
    id str
    The provider-assigned unique ID for this managed resource.
    mqtt_topics Sequence[str]
    id String
    The provider-assigned unique ID for this managed resource.
    mqttTopics List<String>

    Look up Existing CameraSense Resource

    Get an existing CameraSense 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?: CameraSenseState, opts?: CustomResourceOptions): CameraSense
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            audio_detection: Optional[CameraSenseAudioDetectionArgs] = None,
            detection_model_id: Optional[str] = None,
            mqtt_broker_id: Optional[str] = None,
            mqtt_topics: Optional[Sequence[str]] = None,
            sense_enabled: Optional[bool] = None,
            serial: Optional[str] = None) -> CameraSense
    func GetCameraSense(ctx *Context, name string, id IDInput, state *CameraSenseState, opts ...ResourceOption) (*CameraSense, error)
    public static CameraSense Get(string name, Input<string> id, CameraSenseState? state, CustomResourceOptions? opts = null)
    public static CameraSense get(String name, Output<String> id, CameraSenseState 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:
    AudioDetection CameraSenseAudioDetection
    The details of the audio detection config.
    DetectionModelId string
    The ID of the object detection model
    MqttBrokerId string
    The ID of the MQTT broker to be enabled on the camera. A value of null will disable MQTT on the camera
    MqttTopics List<string>
    SenseEnabled bool
    Boolean indicating if sense(license) is enabled(true) or disabled(false) on the camera
    Serial string
    serial path parameter.
    AudioDetection CameraSenseAudioDetectionArgs
    The details of the audio detection config.
    DetectionModelId string
    The ID of the object detection model
    MqttBrokerId string
    The ID of the MQTT broker to be enabled on the camera. A value of null will disable MQTT on the camera
    MqttTopics []string
    SenseEnabled bool
    Boolean indicating if sense(license) is enabled(true) or disabled(false) on the camera
    Serial string
    serial path parameter.
    audioDetection CameraSenseAudioDetection
    The details of the audio detection config.
    detectionModelId String
    The ID of the object detection model
    mqttBrokerId String
    The ID of the MQTT broker to be enabled on the camera. A value of null will disable MQTT on the camera
    mqttTopics List<String>
    senseEnabled Boolean
    Boolean indicating if sense(license) is enabled(true) or disabled(false) on the camera
    serial String
    serial path parameter.
    audioDetection CameraSenseAudioDetection
    The details of the audio detection config.
    detectionModelId string
    The ID of the object detection model
    mqttBrokerId string
    The ID of the MQTT broker to be enabled on the camera. A value of null will disable MQTT on the camera
    mqttTopics string[]
    senseEnabled boolean
    Boolean indicating if sense(license) is enabled(true) or disabled(false) on the camera
    serial string
    serial path parameter.
    audio_detection CameraSenseAudioDetectionArgs
    The details of the audio detection config.
    detection_model_id str
    The ID of the object detection model
    mqtt_broker_id str
    The ID of the MQTT broker to be enabled on the camera. A value of null will disable MQTT on the camera
    mqtt_topics Sequence[str]
    sense_enabled bool
    Boolean indicating if sense(license) is enabled(true) or disabled(false) on the camera
    serial str
    serial path parameter.
    audioDetection Property Map
    The details of the audio detection config.
    detectionModelId String
    The ID of the object detection model
    mqttBrokerId String
    The ID of the MQTT broker to be enabled on the camera. A value of null will disable MQTT on the camera
    mqttTopics List<String>
    senseEnabled Boolean
    Boolean indicating if sense(license) is enabled(true) or disabled(false) on the camera
    serial String
    serial path parameter.

    Supporting Types

    CameraSenseAudioDetection, CameraSenseAudioDetectionArgs

    Enabled bool
    Boolean indicating if audio detection is enabled(true) or disabled(false) on the camera
    Enabled bool
    Boolean indicating if audio detection is enabled(true) or disabled(false) on the camera
    enabled Boolean
    Boolean indicating if audio detection is enabled(true) or disabled(false) on the camera
    enabled boolean
    Boolean indicating if audio detection is enabled(true) or disabled(false) on the camera
    enabled bool
    Boolean indicating if audio detection is enabled(true) or disabled(false) on the camera
    enabled Boolean
    Boolean indicating if audio detection is enabled(true) or disabled(false) on the camera

    Import

    $ pulumi import meraki:devices/cameraSense:CameraSense example "serial"
    

    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
    Meraki v0.1.1 published on Thursday, May 16, 2024 by Pulumi