1. Packages
  2. Cisco Meraki
  3. API Docs
  4. devices
  5. CameraGenerateSnapshot
Meraki v0.1.2 published on Tuesday, May 21, 2024 by Pulumi

meraki.devices.CameraGenerateSnapshot

Explore with Pulumi AI

meraki logo
Meraki v0.1.2 published on Tuesday, May 21, 2024 by Pulumi

    ~>Warning: This resource does not represent a real-world entity in Meraki Dashboard, therefore changing or deleting this resource on its own has no immediate effect. Instead, it is a task part of a Meraki Dashboard workflow. It is executed in Meraki without any additional verification. It does not check if it was executed before or if a similar configuration or action already existed previously.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as meraki from "@pulumi/meraki";
    
    const example = new meraki.devices.CameraGenerateSnapshot("example", {
        serial: "string",
        parameters: {
            fullframe: false,
            timestamp: "2021-04-30T15:18:08Z",
        },
    });
    export const merakiDevicesCameraGenerateSnapshotExample = example;
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.devices.CameraGenerateSnapshot("example",
        serial="string",
        parameters=meraki.devices.CameraGenerateSnapshotParametersArgs(
            fullframe=False,
            timestamp="2021-04-30T15:18:08Z",
        ))
    pulumi.export("merakiDevicesCameraGenerateSnapshotExample", 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.NewCameraGenerateSnapshot(ctx, "example", &devices.CameraGenerateSnapshotArgs{
    			Serial: pulumi.String("string"),
    			Parameters: &devices.CameraGenerateSnapshotParametersArgs{
    				Fullframe: pulumi.Bool(false),
    				Timestamp: pulumi.String("2021-04-30T15:18:08Z"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiDevicesCameraGenerateSnapshotExample", 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.CameraGenerateSnapshot("example", new()
        {
            Serial = "string",
            Parameters = new Meraki.Devices.Inputs.CameraGenerateSnapshotParametersArgs
            {
                Fullframe = false,
                Timestamp = "2021-04-30T15:18:08Z",
            },
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiDevicesCameraGenerateSnapshotExample"] = example,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.meraki.devices.CameraGenerateSnapshot;
    import com.pulumi.meraki.devices.CameraGenerateSnapshotArgs;
    import com.pulumi.meraki.devices.inputs.CameraGenerateSnapshotParametersArgs;
    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 CameraGenerateSnapshot("example", CameraGenerateSnapshotArgs.builder()        
                .serial("string")
                .parameters(CameraGenerateSnapshotParametersArgs.builder()
                    .fullframe(false)
                    .timestamp("2021-04-30T15:18:08Z")
                    .build())
                .build());
    
            ctx.export("merakiDevicesCameraGenerateSnapshotExample", example);
        }
    }
    
    resources:
      example:
        type: meraki:devices:CameraGenerateSnapshot
        properties:
          serial: string
          parameters:
            fullframe: false
            timestamp: 2021-04-30T15:18:08Z
    outputs:
      merakiDevicesCameraGenerateSnapshotExample: ${example}
    

    Create CameraGenerateSnapshot Resource

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

    Constructor syntax

    new CameraGenerateSnapshot(name: string, args: CameraGenerateSnapshotArgs, opts?: CustomResourceOptions);
    @overload
    def CameraGenerateSnapshot(resource_name: str,
                               args: CameraGenerateSnapshotArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def CameraGenerateSnapshot(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               parameters: Optional[CameraGenerateSnapshotParametersArgs] = None,
                               serial: Optional[str] = None)
    func NewCameraGenerateSnapshot(ctx *Context, name string, args CameraGenerateSnapshotArgs, opts ...ResourceOption) (*CameraGenerateSnapshot, error)
    public CameraGenerateSnapshot(string name, CameraGenerateSnapshotArgs args, CustomResourceOptions? opts = null)
    public CameraGenerateSnapshot(String name, CameraGenerateSnapshotArgs args)
    public CameraGenerateSnapshot(String name, CameraGenerateSnapshotArgs args, CustomResourceOptions options)
    
    type: meraki:devices:CameraGenerateSnapshot
    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 CameraGenerateSnapshotArgs
    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 CameraGenerateSnapshotArgs
    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 CameraGenerateSnapshotArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CameraGenerateSnapshotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CameraGenerateSnapshotArgs
    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 cameraGenerateSnapshotResource = new Meraki.Devices.CameraGenerateSnapshot("cameraGenerateSnapshotResource", new()
    {
        Parameters = new Meraki.Devices.Inputs.CameraGenerateSnapshotParametersArgs
        {
            Fullframe = false,
            Timestamp = "string",
        },
        Serial = "string",
    });
    
    example, err := devices.NewCameraGenerateSnapshot(ctx, "cameraGenerateSnapshotResource", &devices.CameraGenerateSnapshotArgs{
    	Parameters: &devices.CameraGenerateSnapshotParametersArgs{
    		Fullframe: pulumi.Bool(false),
    		Timestamp: pulumi.String("string"),
    	},
    	Serial: pulumi.String("string"),
    })
    
    var cameraGenerateSnapshotResource = new CameraGenerateSnapshot("cameraGenerateSnapshotResource", CameraGenerateSnapshotArgs.builder()        
        .parameters(CameraGenerateSnapshotParametersArgs.builder()
            .fullframe(false)
            .timestamp("string")
            .build())
        .serial("string")
        .build());
    
    camera_generate_snapshot_resource = meraki.devices.CameraGenerateSnapshot("cameraGenerateSnapshotResource",
        parameters=meraki.devices.CameraGenerateSnapshotParametersArgs(
            fullframe=False,
            timestamp="string",
        ),
        serial="string")
    
    const cameraGenerateSnapshotResource = new meraki.devices.CameraGenerateSnapshot("cameraGenerateSnapshotResource", {
        parameters: {
            fullframe: false,
            timestamp: "string",
        },
        serial: "string",
    });
    
    type: meraki:devices:CameraGenerateSnapshot
    properties:
        parameters:
            fullframe: false
            timestamp: string
        serial: string
    

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

    parameters Property Map
    serial String
    serial path parameter.

    Outputs

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

    Get an existing CameraGenerateSnapshot 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?: CameraGenerateSnapshotState, opts?: CustomResourceOptions): CameraGenerateSnapshot
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            parameters: Optional[CameraGenerateSnapshotParametersArgs] = None,
            serial: Optional[str] = None) -> CameraGenerateSnapshot
    func GetCameraGenerateSnapshot(ctx *Context, name string, id IDInput, state *CameraGenerateSnapshotState, opts ...ResourceOption) (*CameraGenerateSnapshot, error)
    public static CameraGenerateSnapshot Get(string name, Input<string> id, CameraGenerateSnapshotState? state, CustomResourceOptions? opts = null)
    public static CameraGenerateSnapshot get(String name, Output<String> id, CameraGenerateSnapshotState 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:
    parameters Property Map
    serial String
    serial path parameter.

    Supporting Types

    CameraGenerateSnapshotParameters, CameraGenerateSnapshotParametersArgs

    Fullframe bool
    [optional] If set to "true" the snapshot will be taken at full sensor resolution. This will error if used with timestamp.
    Timestamp string
    [optional] The snapshot will be taken from this time on the camera. The timestamp is expected to be in ISO 8601 format. If no timestamp is specified, we will assume current time.
    Fullframe bool
    [optional] If set to "true" the snapshot will be taken at full sensor resolution. This will error if used with timestamp.
    Timestamp string
    [optional] The snapshot will be taken from this time on the camera. The timestamp is expected to be in ISO 8601 format. If no timestamp is specified, we will assume current time.
    fullframe Boolean
    [optional] If set to "true" the snapshot will be taken at full sensor resolution. This will error if used with timestamp.
    timestamp String
    [optional] The snapshot will be taken from this time on the camera. The timestamp is expected to be in ISO 8601 format. If no timestamp is specified, we will assume current time.
    fullframe boolean
    [optional] If set to "true" the snapshot will be taken at full sensor resolution. This will error if used with timestamp.
    timestamp string
    [optional] The snapshot will be taken from this time on the camera. The timestamp is expected to be in ISO 8601 format. If no timestamp is specified, we will assume current time.
    fullframe bool
    [optional] If set to "true" the snapshot will be taken at full sensor resolution. This will error if used with timestamp.
    timestamp str
    [optional] The snapshot will be taken from this time on the camera. The timestamp is expected to be in ISO 8601 format. If no timestamp is specified, we will assume current time.
    fullframe Boolean
    [optional] If set to "true" the snapshot will be taken at full sensor resolution. This will error if used with timestamp.
    timestamp String
    [optional] The snapshot will be taken from this time on the camera. The timestamp is expected to be in ISO 8601 format. If no timestamp is specified, we will assume current time.

    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.2 published on Tuesday, May 21, 2024 by Pulumi