@lbrlabs/pulumi-scaleway/iotHub.d.ts

A Pulumi package for creating and managing scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * ## Import
 *
 * IoT Hubs can be imported using the `{region}/{id}`, e.g. bash
 *
 * ```sh
 *  $ pulumi import scaleway:index/iotHub:IotHub hub01 fr-par/11111111-1111-1111-1111-111111111111
 * ```
 */
export declare class IotHub extends pulumi.CustomResource {
    /**
     * Get an existing IotHub 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?: IotHubState, opts?: pulumi.CustomResourceOptions): IotHub;
    /**
     * Returns true if the given object is an instance of IotHub.  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 IotHub;
    /**
     * The current number of connected devices in the Hub.
     */
    readonly connectedDeviceCount: pulumi.Output<number>;
    /**
     * The date and time the Hub was created.
     */
    readonly createdAt: pulumi.Output<string>;
    /**
     * Wether to enable the device auto provisioning or not
     */
    readonly deviceAutoProvisioning: pulumi.Output<boolean | undefined>;
    /**
     * The number of registered devices in the Hub.
     */
    readonly deviceCount: pulumi.Output<number>;
    /**
     * Whether to enable the hub events or not
     */
    readonly disableEvents: pulumi.Output<boolean | undefined>;
    /**
     * Wether the IoT Hub instance should be enabled or not.
     *
     * > **Important:** Updates to `enabled` will disconnect eventually connected devices.
     */
    readonly enabled: pulumi.Output<boolean | undefined>;
    /**
     * The MQTT network endpoint to connect MQTT devices to.
     */
    readonly endpoint: pulumi.Output<string>;
    /**
     * Topic prefix for the hub events
     */
    readonly eventsTopicPrefix: pulumi.Output<string | undefined>;
    /**
     * Custom user provided certificate authority
     */
    readonly hubCa: pulumi.Output<string | undefined>;
    /**
     * Challenge certificate for the user provided hub CA
     */
    readonly hubCaChallenge: pulumi.Output<string | undefined>;
    /**
     * The name of the IoT Hub instance you want to create (e.g. `my-hub`).
     */
    readonly name: pulumi.Output<string>;
    /**
     * The organization_id you want to attach the resource to
     */
    readonly organizationId: pulumi.Output<string>;
    /**
     * Product plan to create the hub, see documentation for available product plans (e.g. `planShared`)
     *
     * > **Important:** Updates to `productPlan` will recreate the IoT Hub Instance.
     */
    readonly productPlan: pulumi.Output<string>;
    /**
     * `projectId`) The ID of the project the IoT Hub Instance is associated with.
     */
    readonly projectId: pulumi.Output<string>;
    /**
     * `region`) The region in which the Database Instance should be created.
     */
    readonly region: pulumi.Output<string>;
    /**
     * The current status of the Hub.
     */
    readonly status: pulumi.Output<string>;
    /**
     * The date and time the Hub resource was updated.
     */
    readonly updatedAt: pulumi.Output<string>;
    /**
     * Create a IotHub 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.
     */
    constructor(name: string, args: IotHubArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering IotHub resources.
 */
export interface IotHubState {
    /**
     * The current number of connected devices in the Hub.
     */
    connectedDeviceCount?: pulumi.Input<number>;
    /**
     * The date and time the Hub was created.
     */
    createdAt?: pulumi.Input<string>;
    /**
     * Wether to enable the device auto provisioning or not
     */
    deviceAutoProvisioning?: pulumi.Input<boolean>;
    /**
     * The number of registered devices in the Hub.
     */
    deviceCount?: pulumi.Input<number>;
    /**
     * Whether to enable the hub events or not
     */
    disableEvents?: pulumi.Input<boolean>;
    /**
     * Wether the IoT Hub instance should be enabled or not.
     *
     * > **Important:** Updates to `enabled` will disconnect eventually connected devices.
     */
    enabled?: pulumi.Input<boolean>;
    /**
     * The MQTT network endpoint to connect MQTT devices to.
     */
    endpoint?: pulumi.Input<string>;
    /**
     * Topic prefix for the hub events
     */
    eventsTopicPrefix?: pulumi.Input<string>;
    /**
     * Custom user provided certificate authority
     */
    hubCa?: pulumi.Input<string>;
    /**
     * Challenge certificate for the user provided hub CA
     */
    hubCaChallenge?: pulumi.Input<string>;
    /**
     * The name of the IoT Hub instance you want to create (e.g. `my-hub`).
     */
    name?: pulumi.Input<string>;
    /**
     * The organization_id you want to attach the resource to
     */
    organizationId?: pulumi.Input<string>;
    /**
     * Product plan to create the hub, see documentation for available product plans (e.g. `planShared`)
     *
     * > **Important:** Updates to `productPlan` will recreate the IoT Hub Instance.
     */
    productPlan?: pulumi.Input<string>;
    /**
     * `projectId`) The ID of the project the IoT Hub Instance is associated with.
     */
    projectId?: pulumi.Input<string>;
    /**
     * `region`) The region in which the Database Instance should be created.
     */
    region?: pulumi.Input<string>;
    /**
     * The current status of the Hub.
     */
    status?: pulumi.Input<string>;
    /**
     * The date and time the Hub resource was updated.
     */
    updatedAt?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a IotHub resource.
 */
export interface IotHubArgs {
    /**
     * Wether to enable the device auto provisioning or not
     */
    deviceAutoProvisioning?: pulumi.Input<boolean>;
    /**
     * Whether to enable the hub events or not
     */
    disableEvents?: pulumi.Input<boolean>;
    /**
     * Wether the IoT Hub instance should be enabled or not.
     *
     * > **Important:** Updates to `enabled` will disconnect eventually connected devices.
     */
    enabled?: pulumi.Input<boolean>;
    /**
     * Topic prefix for the hub events
     */
    eventsTopicPrefix?: pulumi.Input<string>;
    /**
     * Custom user provided certificate authority
     */
    hubCa?: pulumi.Input<string>;
    /**
     * Challenge certificate for the user provided hub CA
     */
    hubCaChallenge?: pulumi.Input<string>;
    /**
     * The name of the IoT Hub instance you want to create (e.g. `my-hub`).
     */
    name?: pulumi.Input<string>;
    /**
     * Product plan to create the hub, see documentation for available product plans (e.g. `planShared`)
     *
     * > **Important:** Updates to `productPlan` will recreate the IoT Hub Instance.
     */
    productPlan: pulumi.Input<string>;
    /**
     * `projectId`) The ID of the project the IoT Hub Instance is associated with.
     */
    projectId?: pulumi.Input<string>;
    /**
     * `region`) The region in which the Database Instance should be created.
     */
    region?: pulumi.Input<string>;
}