@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
248 lines (247 loc) • 8.45 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* ## Example Usage
*
* ### Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.iot.Hub("main", {
* name: "test-iot",
* productPlan: "plan_shared",
* });
* const mainDevice = new scaleway.iot.Device("main", {
* hubId: main.id,
* name: "test-iot",
* });
* ```
*
* ### With custom certificate
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as local from "@pulumi/local";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.iot.Hub("main", {
* name: "test-iot",
* productPlan: "plan_shared",
* });
* const deviceCert = local.getFile({
* filename: "device-certificate.pem",
* });
* const mainDevice = new scaleway.iot.Device("main", {
* hubId: main.id,
* name: "test-iot",
* certificate: {
* crt: deviceCert.then(deviceCert => deviceCert.content),
* },
* });
* ```
*
* ## Import
*
* IoT devices can be imported using the `{region}/{id}`, e.g.
*
* bash
*
* ```sh
* $ pulumi import scaleway:index/iotDevice:IotDevice device01 fr-par/11111111-1111-1111-1111-111111111111
* ```
*
* @deprecated scaleway.index/iotdevice.IotDevice has been deprecated in favor of scaleway.iot/device.Device
*/
export declare class IotDevice extends pulumi.CustomResource {
/**
* Get an existing IotDevice resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: IotDeviceState, opts?: pulumi.CustomResourceOptions): IotDevice;
/**
* Returns true if the given object is an instance of IotDevice. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is IotDevice;
/**
* Allow plain and server-authenticated TLS connections in addition to mutually-authenticated ones.
*
* > **Important:** Updates to `allowInsecure` can disconnect eventually connected devices.
*/
readonly allowInsecure: pulumi.Output<boolean | undefined>;
/**
* Allow more than one simultaneous connection using the same device credentials.
*
* > **Important:** Updates to `allowMultipleConnections` can disconnect eventually connected devices.
*/
readonly allowMultipleConnections: pulumi.Output<boolean | undefined>;
/**
* The certificate bundle of the device.
*/
readonly certificate: pulumi.Output<outputs.IotDeviceCertificate>;
/**
* The date and time the device was created.
*/
readonly createdAt: pulumi.Output<string>;
/**
* The description of the IoT device (e.g. `living room`).
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The ID of the hub on which this device will be created.
*/
readonly hubId: pulumi.Output<string>;
/**
* The current connection status of the device.
*/
readonly isConnected: pulumi.Output<boolean>;
/**
* The last MQTT activity of the device.
*/
readonly lastActivityAt: pulumi.Output<string>;
/**
* Rules that define which messages are authorized or denied based on their topic.
*/
readonly messageFilters: pulumi.Output<outputs.IotDeviceMessageFilters | undefined>;
/**
* The name of the IoT device you want to create (e.g. `my-device`).
*
* > **Important:** Updates to `name` will destroy and recreate a new resource.
*/
readonly name: pulumi.Output<string>;
/**
* The region you want to attach the resource to
*/
readonly region: pulumi.Output<string>;
/**
* The current status of the device.
*/
readonly status: pulumi.Output<string>;
/**
* The date and time the device resource was updated.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Create a IotDevice resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
/** @deprecated scaleway.index/iotdevice.IotDevice has been deprecated in favor of scaleway.iot/device.Device */
constructor(name: string, args: IotDeviceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering IotDevice resources.
*/
export interface IotDeviceState {
/**
* Allow plain and server-authenticated TLS connections in addition to mutually-authenticated ones.
*
* > **Important:** Updates to `allowInsecure` can disconnect eventually connected devices.
*/
allowInsecure?: pulumi.Input<boolean>;
/**
* Allow more than one simultaneous connection using the same device credentials.
*
* > **Important:** Updates to `allowMultipleConnections` can disconnect eventually connected devices.
*/
allowMultipleConnections?: pulumi.Input<boolean>;
/**
* The certificate bundle of the device.
*/
certificate?: pulumi.Input<inputs.IotDeviceCertificate>;
/**
* The date and time the device was created.
*/
createdAt?: pulumi.Input<string>;
/**
* The description of the IoT device (e.g. `living room`).
*/
description?: pulumi.Input<string>;
/**
* The ID of the hub on which this device will be created.
*/
hubId?: pulumi.Input<string>;
/**
* The current connection status of the device.
*/
isConnected?: pulumi.Input<boolean>;
/**
* The last MQTT activity of the device.
*/
lastActivityAt?: pulumi.Input<string>;
/**
* Rules that define which messages are authorized or denied based on their topic.
*/
messageFilters?: pulumi.Input<inputs.IotDeviceMessageFilters>;
/**
* The name of the IoT device you want to create (e.g. `my-device`).
*
* > **Important:** Updates to `name` will destroy and recreate a new resource.
*/
name?: pulumi.Input<string>;
/**
* The region you want to attach the resource to
*/
region?: pulumi.Input<string>;
/**
* The current status of the device.
*/
status?: pulumi.Input<string>;
/**
* The date and time the device resource was updated.
*/
updatedAt?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a IotDevice resource.
*/
export interface IotDeviceArgs {
/**
* Allow plain and server-authenticated TLS connections in addition to mutually-authenticated ones.
*
* > **Important:** Updates to `allowInsecure` can disconnect eventually connected devices.
*/
allowInsecure?: pulumi.Input<boolean>;
/**
* Allow more than one simultaneous connection using the same device credentials.
*
* > **Important:** Updates to `allowMultipleConnections` can disconnect eventually connected devices.
*/
allowMultipleConnections?: pulumi.Input<boolean>;
/**
* The certificate bundle of the device.
*/
certificate?: pulumi.Input<inputs.IotDeviceCertificate>;
/**
* The description of the IoT device (e.g. `living room`).
*/
description?: pulumi.Input<string>;
/**
* The ID of the hub on which this device will be created.
*/
hubId: pulumi.Input<string>;
/**
* Rules that define which messages are authorized or denied based on their topic.
*/
messageFilters?: pulumi.Input<inputs.IotDeviceMessageFilters>;
/**
* The name of the IoT device you want to create (e.g. `my-device`).
*
* > **Important:** Updates to `name` will destroy and recreate a new resource.
*/
name?: pulumi.Input<string>;
/**
* The region you want to attach the resource to
*/
region?: pulumi.Input<string>;
}