1. Packages
  2. Cisco Meraki
  3. API Docs
  4. devices
  5. CameraCustomAnalytics
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

meraki.devices.CameraCustomAnalytics

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as meraki from "@pulumi/meraki";
    
    const example = new meraki.devices.CameraCustomAnalytics("example", {
        artifactId: "1",
        enabled: true,
        parameters: [{
            name: "detection_threshold",
            value: 0.5,
        }],
        serial: "string",
    });
    export const merakiDevicesCameraCustomAnalyticsExample = example;
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.devices.CameraCustomAnalytics("example",
        artifact_id="1",
        enabled=True,
        parameters=[meraki.devices.CameraCustomAnalyticsParameterArgs(
            name="detection_threshold",
            value=0.5,
        )],
        serial="string")
    pulumi.export("merakiDevicesCameraCustomAnalyticsExample", 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.NewCameraCustomAnalytics(ctx, "example", &devices.CameraCustomAnalyticsArgs{
    			ArtifactId: pulumi.String("1"),
    			Enabled:    pulumi.Bool(true),
    			Parameters: devices.CameraCustomAnalyticsParameterArray{
    				&devices.CameraCustomAnalyticsParameterArgs{
    					Name:  pulumi.String("detection_threshold"),
    					Value: pulumi.Float64(0.5),
    				},
    			},
    			Serial: pulumi.String("string"),
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiDevicesCameraCustomAnalyticsExample", 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.CameraCustomAnalytics("example", new()
        {
            ArtifactId = "1",
            Enabled = true,
            Parameters = new[]
            {
                new Meraki.Devices.Inputs.CameraCustomAnalyticsParameterArgs
                {
                    Name = "detection_threshold",
                    Value = 0.5,
                },
            },
            Serial = "string",
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiDevicesCameraCustomAnalyticsExample"] = example,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.meraki.devices.CameraCustomAnalytics;
    import com.pulumi.meraki.devices.CameraCustomAnalyticsArgs;
    import com.pulumi.meraki.devices.inputs.CameraCustomAnalyticsParameterArgs;
    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 CameraCustomAnalytics("example", CameraCustomAnalyticsArgs.builder()
                .artifactId("1")
                .enabled(true)
                .parameters(CameraCustomAnalyticsParameterArgs.builder()
                    .name("detection_threshold")
                    .value("0.5")
                    .build())
                .serial("string")
                .build());
    
            ctx.export("merakiDevicesCameraCustomAnalyticsExample", example);
        }
    }
    
    resources:
      example:
        type: meraki:devices:CameraCustomAnalytics
        properties:
          artifactId: '1'
          enabled: true
          parameters:
            - name: detection_threshold
              value: '0.5'
          serial: string
    outputs:
      merakiDevicesCameraCustomAnalyticsExample: ${example}
    

    Create CameraCustomAnalytics Resource

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

    Constructor syntax

    new CameraCustomAnalytics(name: string, args: CameraCustomAnalyticsArgs, opts?: CustomResourceOptions);
    @overload
    def CameraCustomAnalytics(resource_name: str,
                              args: CameraCustomAnalyticsArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def CameraCustomAnalytics(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              serial: Optional[str] = None,
                              artifact_id: Optional[str] = None,
                              enabled: Optional[bool] = None,
                              parameters: Optional[Sequence[CameraCustomAnalyticsParameterArgs]] = None)
    func NewCameraCustomAnalytics(ctx *Context, name string, args CameraCustomAnalyticsArgs, opts ...ResourceOption) (*CameraCustomAnalytics, error)
    public CameraCustomAnalytics(string name, CameraCustomAnalyticsArgs args, CustomResourceOptions? opts = null)
    public CameraCustomAnalytics(String name, CameraCustomAnalyticsArgs args)
    public CameraCustomAnalytics(String name, CameraCustomAnalyticsArgs args, CustomResourceOptions options)
    
    type: meraki:devices:CameraCustomAnalytics
    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 CameraCustomAnalyticsArgs
    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 CameraCustomAnalyticsArgs
    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 CameraCustomAnalyticsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CameraCustomAnalyticsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CameraCustomAnalyticsArgs
    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 cameraCustomAnalyticsResource = new Meraki.Devices.CameraCustomAnalytics("cameraCustomAnalyticsResource", new()
    {
        Serial = "string",
        ArtifactId = "string",
        Enabled = false,
        Parameters = new[]
        {
            new Meraki.Devices.Inputs.CameraCustomAnalyticsParameterArgs
            {
                Name = "string",
                Value = 0,
            },
        },
    });
    
    example, err := devices.NewCameraCustomAnalytics(ctx, "cameraCustomAnalyticsResource", &devices.CameraCustomAnalyticsArgs{
    	Serial:     pulumi.String("string"),
    	ArtifactId: pulumi.String("string"),
    	Enabled:    pulumi.Bool(false),
    	Parameters: devices.CameraCustomAnalyticsParameterArray{
    		&devices.CameraCustomAnalyticsParameterArgs{
    			Name:  pulumi.String("string"),
    			Value: pulumi.Float64(0),
    		},
    	},
    })
    
    var cameraCustomAnalyticsResource = new CameraCustomAnalytics("cameraCustomAnalyticsResource", CameraCustomAnalyticsArgs.builder()
        .serial("string")
        .artifactId("string")
        .enabled(false)
        .parameters(CameraCustomAnalyticsParameterArgs.builder()
            .name("string")
            .value(0)
            .build())
        .build());
    
    camera_custom_analytics_resource = meraki.devices.CameraCustomAnalytics("cameraCustomAnalyticsResource",
        serial="string",
        artifact_id="string",
        enabled=False,
        parameters=[meraki.devices.CameraCustomAnalyticsParameterArgs(
            name="string",
            value=0,
        )])
    
    const cameraCustomAnalyticsResource = new meraki.devices.CameraCustomAnalytics("cameraCustomAnalyticsResource", {
        serial: "string",
        artifactId: "string",
        enabled: false,
        parameters: [{
            name: "string",
            value: 0,
        }],
    });
    
    type: meraki:devices:CameraCustomAnalytics
    properties:
        artifactId: string
        enabled: false
        parameters:
            - name: string
              value: 0
        serial: string
    

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

    Serial string
    serial path parameter.
    ArtifactId string
    Custom analytics artifact ID
    Enabled bool
    Whether custom analytics is enabled
    Parameters List<CameraCustomAnalyticsParameter>
    Parameters for the custom analytics workload
    Serial string
    serial path parameter.
    ArtifactId string
    Custom analytics artifact ID
    Enabled bool
    Whether custom analytics is enabled
    Parameters []CameraCustomAnalyticsParameterArgs
    Parameters for the custom analytics workload
    serial String
    serial path parameter.
    artifactId String
    Custom analytics artifact ID
    enabled Boolean
    Whether custom analytics is enabled
    parameters List<CameraCustomAnalyticsParameter>
    Parameters for the custom analytics workload
    serial string
    serial path parameter.
    artifactId string
    Custom analytics artifact ID
    enabled boolean
    Whether custom analytics is enabled
    parameters CameraCustomAnalyticsParameter[]
    Parameters for the custom analytics workload
    serial str
    serial path parameter.
    artifact_id str
    Custom analytics artifact ID
    enabled bool
    Whether custom analytics is enabled
    parameters Sequence[CameraCustomAnalyticsParameterArgs]
    Parameters for the custom analytics workload
    serial String
    serial path parameter.
    artifactId String
    Custom analytics artifact ID
    enabled Boolean
    Whether custom analytics is enabled
    parameters List<Property Map>
    Parameters for the custom analytics workload

    Outputs

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

    Get an existing CameraCustomAnalytics 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?: CameraCustomAnalyticsState, opts?: CustomResourceOptions): CameraCustomAnalytics
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            artifact_id: Optional[str] = None,
            enabled: Optional[bool] = None,
            parameters: Optional[Sequence[CameraCustomAnalyticsParameterArgs]] = None,
            serial: Optional[str] = None) -> CameraCustomAnalytics
    func GetCameraCustomAnalytics(ctx *Context, name string, id IDInput, state *CameraCustomAnalyticsState, opts ...ResourceOption) (*CameraCustomAnalytics, error)
    public static CameraCustomAnalytics Get(string name, Input<string> id, CameraCustomAnalyticsState? state, CustomResourceOptions? opts = null)
    public static CameraCustomAnalytics get(String name, Output<String> id, CameraCustomAnalyticsState 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:
    ArtifactId string
    Custom analytics artifact ID
    Enabled bool
    Whether custom analytics is enabled
    Parameters List<CameraCustomAnalyticsParameter>
    Parameters for the custom analytics workload
    Serial string
    serial path parameter.
    ArtifactId string
    Custom analytics artifact ID
    Enabled bool
    Whether custom analytics is enabled
    Parameters []CameraCustomAnalyticsParameterArgs
    Parameters for the custom analytics workload
    Serial string
    serial path parameter.
    artifactId String
    Custom analytics artifact ID
    enabled Boolean
    Whether custom analytics is enabled
    parameters List<CameraCustomAnalyticsParameter>
    Parameters for the custom analytics workload
    serial String
    serial path parameter.
    artifactId string
    Custom analytics artifact ID
    enabled boolean
    Whether custom analytics is enabled
    parameters CameraCustomAnalyticsParameter[]
    Parameters for the custom analytics workload
    serial string
    serial path parameter.
    artifact_id str
    Custom analytics artifact ID
    enabled bool
    Whether custom analytics is enabled
    parameters Sequence[CameraCustomAnalyticsParameterArgs]
    Parameters for the custom analytics workload
    serial str
    serial path parameter.
    artifactId String
    Custom analytics artifact ID
    enabled Boolean
    Whether custom analytics is enabled
    parameters List<Property Map>
    Parameters for the custom analytics workload
    serial String
    serial path parameter.

    Supporting Types

    CameraCustomAnalyticsParameter, CameraCustomAnalyticsParameterArgs

    Name string
    Name of the parameter
    Value double
    Value of the parameter
    Name string
    Name of the parameter
    Value float64
    Value of the parameter
    name String
    Name of the parameter
    value Double
    Value of the parameter
    name string
    Name of the parameter
    value number
    Value of the parameter
    name str
    Name of the parameter
    value float
    Value of the parameter
    name String
    Name of the parameter
    value Number
    Value of the parameter

    Import

    $ pulumi import meraki:devices/cameraCustomAnalytics:CameraCustomAnalytics 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
    Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi