@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
240 lines (239 loc) • 8.38 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* ## Example Usage
*
* ### Database Route
*
* ```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 iot = new scaleway.databases.Instance("iot", {
* name: "iot",
* nodeType: "db-dev-s",
* engine: "PostgreSQL-12",
* userName: "root",
* password: "T3stP4ssw0rdD0N0tUs3!",
* });
* const main = new scaleway.iot.Route("main", {
* name: "default",
* hubId: mainHub.id,
* topic: "#",
* database: {
* query: `INSERT INTO measurements(
* \x09push_time,
* \x09report_time,
* \x09station_id,
* \x09temperature,
* \x09humidity
* ) VALUES (
* \x09NOW(),
* \x09TIMESTAMP 'epoch' + ((PAYLOAD::jsonb->'last_reported')::integer * INTERVAL '1 second'),
* \x09(PAYLOAD::jsonb->'station_id')::uuid,
* \x09(PAYLOAD::jsonb->'temperature')::decimal,
* \x09(PAYLOAD::jsonb->'humidity'):decimal:
* );
* `,
* host: iot.endpointIp,
* port: iot.endpointPort,
* dbname: "rdb",
* username: iot.userName,
* password: iot.password,
* },
* });
* ```
*
* ### S3 Route
*
* ```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 mainBucket = new scaleway.object.Bucket("main", {
* region: "fr-par",
* name: "my_awesome-bucket",
* });
* const main = new scaleway.iot.Route("main", {
* name: "main",
* hubId: mainHub.id,
* topic: "#",
* s3: {
* bucketRegion: mainBucket.region,
* bucketName: mainBucket.name,
* objectPrefix: "foo",
* strategy: "per_topic",
* },
* });
* ```
*
* ### Rest Route
*
* ```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.Route("main", {
* name: "main",
* hubId: mainHub.id,
* topic: "#",
* rest: {
* verb: "get",
* uri: "http://scaleway.com",
* headers: {
* "X-awesome-header": "my-awesome-value",
* },
* },
* });
* ```
*
* ## Import
*
* IoT Routes can be imported using the `{region}/{id}`, e.g.
*
* bash
*
* ```sh
* $ pulumi import scaleway:iot/route:Route route01 fr-par/11111111-1111-1111-1111-111111111111
* ```
*/
export declare class Route extends pulumi.CustomResource {
/**
* Get an existing Route 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?: RouteState, opts?: pulumi.CustomResourceOptions): Route;
/**
* Returns true if the given object is an instance of Route. 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 Route;
/**
* The date and time the Route was created.
*/
readonly createdAt: pulumi.Output<string>;
/**
* Configuration block for the database routes. See [product documentation](https://www.scaleway.com/en/docs/iot-hub/how-to/create-route/) for a better understanding of the parameters.
*/
readonly database: pulumi.Output<outputs.iot.RouteDatabase | undefined>;
/**
* The hub ID to which the Route will be attached to.
*/
readonly hubId: pulumi.Output<string>;
/**
* The name of the IoT Route you want to create (e.g. `my-route`).
*/
readonly name: pulumi.Output<string>;
/**
* (Defaults to provider `region`) The region in which the Route is attached to.
*/
readonly region: pulumi.Output<string>;
/**
* Configuration block for the rest routes. See [product documentation](https://www.scaleway.com/en/docs/iot-hub/how-to/create-route/) for a better understanding of the parameters.
*/
readonly rest: pulumi.Output<outputs.iot.RouteRest | undefined>;
/**
* Configuration block for the S3 routes. See [product documentation](https://www.scaleway.com/en/docs/iot-hub/how-to/create-route/) for a better understanding of the parameters.
*/
readonly s3: pulumi.Output<outputs.iot.RouteS3 | undefined>;
/**
* The topic the Route subscribes to, wildcards allowed (e.g. `thelab/+/temperature/#`).
*/
readonly topic: pulumi.Output<string>;
/**
* Create a Route 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: RouteArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Route resources.
*/
export interface RouteState {
/**
* The date and time the Route was created.
*/
createdAt?: pulumi.Input<string>;
/**
* Configuration block for the database routes. See [product documentation](https://www.scaleway.com/en/docs/iot-hub/how-to/create-route/) for a better understanding of the parameters.
*/
database?: pulumi.Input<inputs.iot.RouteDatabase>;
/**
* The hub ID to which the Route will be attached to.
*/
hubId?: pulumi.Input<string>;
/**
* The name of the IoT Route you want to create (e.g. `my-route`).
*/
name?: pulumi.Input<string>;
/**
* (Defaults to provider `region`) The region in which the Route is attached to.
*/
region?: pulumi.Input<string>;
/**
* Configuration block for the rest routes. See [product documentation](https://www.scaleway.com/en/docs/iot-hub/how-to/create-route/) for a better understanding of the parameters.
*/
rest?: pulumi.Input<inputs.iot.RouteRest>;
/**
* Configuration block for the S3 routes. See [product documentation](https://www.scaleway.com/en/docs/iot-hub/how-to/create-route/) for a better understanding of the parameters.
*/
s3?: pulumi.Input<inputs.iot.RouteS3>;
/**
* The topic the Route subscribes to, wildcards allowed (e.g. `thelab/+/temperature/#`).
*/
topic?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Route resource.
*/
export interface RouteArgs {
/**
* Configuration block for the database routes. See [product documentation](https://www.scaleway.com/en/docs/iot-hub/how-to/create-route/) for a better understanding of the parameters.
*/
database?: pulumi.Input<inputs.iot.RouteDatabase>;
/**
* The hub ID to which the Route will be attached to.
*/
hubId: pulumi.Input<string>;
/**
* The name of the IoT Route you want to create (e.g. `my-route`).
*/
name?: pulumi.Input<string>;
/**
* (Defaults to provider `region`) The region in which the Route is attached to.
*/
region?: pulumi.Input<string>;
/**
* Configuration block for the rest routes. See [product documentation](https://www.scaleway.com/en/docs/iot-hub/how-to/create-route/) for a better understanding of the parameters.
*/
rest?: pulumi.Input<inputs.iot.RouteRest>;
/**
* Configuration block for the S3 routes. See [product documentation](https://www.scaleway.com/en/docs/iot-hub/how-to/create-route/) for a better understanding of the parameters.
*/
s3?: pulumi.Input<inputs.iot.RouteS3>;
/**
* The topic the Route subscribes to, wildcards allowed (e.g. `thelab/+/temperature/#`).
*/
topic: pulumi.Input<string>;
}