@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
152 lines (151 loc) • 4.93 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const mainHub = new scaleway.iot.Hub("main", {
* name: "main",
* productPlan: "plan_shared",
* });
* const main = new scaleway.iot.Network("main", {
* name: "main",
* hubId: mainHub.id,
* type: "sigfox",
* });
* ```
*
* ## Import
*
* IoT Networks can be imported using the `{region}/{id}`, e.g.
*
* bash
*
* ```sh
* $ pulumi import scaleway:index/iotNetwork:IotNetwork net01 fr-par/11111111-1111-1111-1111-111111111111
* ```
*
* @deprecated scaleway.index/iotnetwork.IotNetwork has been deprecated in favor of scaleway.iot/network.Network
*/
export declare class IotNetwork extends pulumi.CustomResource {
/**
* Get an existing IotNetwork 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?: IotNetworkState, opts?: pulumi.CustomResourceOptions): IotNetwork;
/**
* Returns true if the given object is an instance of IotNetwork. 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 IotNetwork;
/**
* The date and time the Network was created.
*/
readonly createdAt: pulumi.Output<string>;
/**
* The endpoint to use when interacting with the network.
*/
readonly endpoint: pulumi.Output<string>;
/**
* The hub ID to which the Network will be attached to.
*/
readonly hubId: pulumi.Output<string>;
/**
* The name of the IoT Network you want to create (e.g. `my-net`).
*/
readonly name: pulumi.Output<string>;
/**
* (Defaults to provider `region`) The region in which the Network is attached to.
*/
readonly region: pulumi.Output<string>;
/**
* The endpoint key to keep secret.
*/
readonly secret: pulumi.Output<string>;
/**
* The prefix that will be prepended to all topics for this Network.
*/
readonly topicPrefix: pulumi.Output<string | undefined>;
/**
* The network type to create (e.g. `sigfox`).
*/
readonly type: pulumi.Output<string>;
/**
* Create a IotNetwork 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/iotnetwork.IotNetwork has been deprecated in favor of scaleway.iot/network.Network */
constructor(name: string, args: IotNetworkArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering IotNetwork resources.
*/
export interface IotNetworkState {
/**
* The date and time the Network was created.
*/
createdAt?: pulumi.Input<string>;
/**
* The endpoint to use when interacting with the network.
*/
endpoint?: pulumi.Input<string>;
/**
* The hub ID to which the Network will be attached to.
*/
hubId?: pulumi.Input<string>;
/**
* The name of the IoT Network you want to create (e.g. `my-net`).
*/
name?: pulumi.Input<string>;
/**
* (Defaults to provider `region`) The region in which the Network is attached to.
*/
region?: pulumi.Input<string>;
/**
* The endpoint key to keep secret.
*/
secret?: pulumi.Input<string>;
/**
* The prefix that will be prepended to all topics for this Network.
*/
topicPrefix?: pulumi.Input<string>;
/**
* The network type to create (e.g. `sigfox`).
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a IotNetwork resource.
*/
export interface IotNetworkArgs {
/**
* The hub ID to which the Network will be attached to.
*/
hubId: pulumi.Input<string>;
/**
* The name of the IoT Network you want to create (e.g. `my-net`).
*/
name?: pulumi.Input<string>;
/**
* (Defaults to provider `region`) The region in which the Network is attached to.
*/
region?: pulumi.Input<string>;
/**
* The prefix that will be prepended to all topics for this Network.
*/
topicPrefix?: pulumi.Input<string>;
/**
* The network type to create (e.g. `sigfox`).
*/
type: pulumi.Input<string>;
}