Scaleway v1.10.0, Jul 1 23

Scaleway v1.10.0 published on Saturday, Jul 1, 2023 by lbrlabs

scaleway.IotHub

Explore with Pulumi AI

Scaleway v1.10.0 published on Saturday, Jul 1, 2023 by lbrlabs

lbrlabs/pulumi-scaleway

Import

IoT Hubs can be imported using the {region}/{id}, e.g. bash

 $ pulumi import scaleway:index/iotHub:IotHub hub01 fr-par/11111111-1111-1111-1111-111111111111

Create IotHub Resource

new IotHub(name: string, args: IotHubArgs, opts?: CustomResourceOptions);

@overload
def IotHub(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           device_auto_provisioning: Optional[bool] = None,
           disable_events: Optional[bool] = None,
           enabled: Optional[bool] = None,
           events_topic_prefix: Optional[str] = None,
           hub_ca: Optional[str] = None,
           hub_ca_challenge: Optional[str] = None,
           name: Optional[str] = None,
           product_plan: Optional[str] = None,
           project_id: Optional[str] = None,
           region: Optional[str] = None)
@overload
def IotHub(resource_name: str,
           args: IotHubArgs,
           opts: Optional[ResourceOptions] = None)

func NewIotHub(ctx *Context, name string, args IotHubArgs, opts ...ResourceOption) (*IotHub, error)

public IotHub(string name, IotHubArgs args, CustomResourceOptions? opts = null)

public IotHub(String name, IotHubArgs args)
public IotHub(String name, IotHubArgs args, CustomResourceOptions options)

type: scaleway:IotHub
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args IotHubArgs: 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 IotHubArgs: 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 IotHubArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args IotHubArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args IotHubArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

ProductPlan string: Product plan to create the hub, see documentation for available product plans (e.g. plan_shared)
Important: Updates to product_plan will recreate the IoT Hub Instance.
DeviceAutoProvisioning bool: Wether to enable the device auto provisioning or not
DisableEvents bool: Whether to enable the hub events or not
Enabled bool: Wether the IoT Hub instance should be enabled or not.
Important: Updates to enabled will disconnect eventually connected devices.
EventsTopicPrefix string: Topic prefix for the hub events
HubCa string: Custom user provided certificate authority
HubCaChallenge string: Challenge certificate for the user provided hub CA
Name string: The name of the IoT Hub instance you want to create (e.g. my-hub).
ProjectId string: project_id) The ID of the project the IoT Hub Instance is associated with.
Region string: region) The region in which the Database Instance should be created.

ProductPlan string: Product plan to create the hub, see documentation for available product plans (e.g. plan_shared)
Important: Updates to product_plan will recreate the IoT Hub Instance.
DeviceAutoProvisioning bool: Wether to enable the device auto provisioning or not
DisableEvents bool: Whether to enable the hub events or not
Enabled bool: Wether the IoT Hub instance should be enabled or not.
Important: Updates to enabled will disconnect eventually connected devices.
EventsTopicPrefix string: Topic prefix for the hub events
HubCa string: Custom user provided certificate authority
HubCaChallenge string: Challenge certificate for the user provided hub CA
Name string: The name of the IoT Hub instance you want to create (e.g. my-hub).
ProjectId string: project_id) The ID of the project the IoT Hub Instance is associated with.
Region string: region) The region in which the Database Instance should be created.

productPlan String: Product plan to create the hub, see documentation for available product plans (e.g. plan_shared)
Important: Updates to product_plan will recreate the IoT Hub Instance.
deviceAutoProvisioning Boolean: Wether to enable the device auto provisioning or not
disableEvents Boolean: Whether to enable the hub events or not
enabled Boolean: Wether the IoT Hub instance should be enabled or not.
Important: Updates to enabled will disconnect eventually connected devices.
eventsTopicPrefix String: Topic prefix for the hub events
hubCa String: Custom user provided certificate authority
hubCaChallenge String: Challenge certificate for the user provided hub CA
name String: The name of the IoT Hub instance you want to create (e.g. my-hub).
projectId String: project_id) The ID of the project the IoT Hub Instance is associated with.
region String: region) The region in which the Database Instance should be created.

productPlan string: Product plan to create the hub, see documentation for available product plans (e.g. plan_shared)
Important: Updates to product_plan will recreate the IoT Hub Instance.
deviceAutoProvisioning boolean: Wether to enable the device auto provisioning or not
disableEvents boolean: Whether to enable the hub events or not
enabled boolean: Wether the IoT Hub instance should be enabled or not.
Important: Updates to enabled will disconnect eventually connected devices.
eventsTopicPrefix string: Topic prefix for the hub events
hubCa string: Custom user provided certificate authority
hubCaChallenge string: Challenge certificate for the user provided hub CA
name string: The name of the IoT Hub instance you want to create (e.g. my-hub).
projectId string: project_id) The ID of the project the IoT Hub Instance is associated with.
region string: region) The region in which the Database Instance should be created.

product_plan str: Product plan to create the hub, see documentation for available product plans (e.g. plan_shared)
Important: Updates to product_plan will recreate the IoT Hub Instance.
device_auto_provisioning bool: Wether to enable the device auto provisioning or not
disable_events bool: Whether to enable the hub events or not
enabled bool: Wether the IoT Hub instance should be enabled or not.
Important: Updates to enabled will disconnect eventually connected devices.
events_topic_prefix str: Topic prefix for the hub events
hub_ca str: Custom user provided certificate authority
hub_ca_challenge str: Challenge certificate for the user provided hub CA
name str: The name of the IoT Hub instance you want to create (e.g. my-hub).
project_id str: project_id) The ID of the project the IoT Hub Instance is associated with.
region str: region) The region in which the Database Instance should be created.

productPlan String: Product plan to create the hub, see documentation for available product plans (e.g. plan_shared)
Important: Updates to product_plan will recreate the IoT Hub Instance.
deviceAutoProvisioning Boolean: Wether to enable the device auto provisioning or not
disableEvents Boolean: Whether to enable the hub events or not
enabled Boolean: Wether the IoT Hub instance should be enabled or not.
Important: Updates to enabled will disconnect eventually connected devices.
eventsTopicPrefix String: Topic prefix for the hub events
hubCa String: Custom user provided certificate authority
hubCaChallenge String: Challenge certificate for the user provided hub CA
name String: The name of the IoT Hub instance you want to create (e.g. my-hub).
projectId String: project_id) The ID of the project the IoT Hub Instance is associated with.
region String: region) The region in which the Database Instance should be created.

Outputs

All input properties are implicitly available as output properties. Additionally, the IotHub resource produces the following output properties:

ConnectedDeviceCount int: The current number of connected devices in the Hub.
CreatedAt string: The date and time the Hub was created.
DeviceCount int: The number of registered devices in the Hub.
Endpoint string: The MQTT network endpoint to connect MQTT devices to.
Id string: The provider-assigned unique ID for this managed resource.
OrganizationId string: The organization_id you want to attach the resource to
Status string: The current status of the Hub.
UpdatedAt string: The date and time the Hub resource was updated.

ConnectedDeviceCount int: The current number of connected devices in the Hub.
CreatedAt string: The date and time the Hub was created.
DeviceCount int: The number of registered devices in the Hub.
Endpoint string: The MQTT network endpoint to connect MQTT devices to.
Id string: The provider-assigned unique ID for this managed resource.
OrganizationId string: The organization_id you want to attach the resource to
Status string: The current status of the Hub.
UpdatedAt string: The date and time the Hub resource was updated.

connectedDeviceCount Integer: The current number of connected devices in the Hub.
createdAt String: The date and time the Hub was created.
deviceCount Integer: The number of registered devices in the Hub.
endpoint String: The MQTT network endpoint to connect MQTT devices to.
id String: The provider-assigned unique ID for this managed resource.
organizationId String: The organization_id you want to attach the resource to
status String: The current status of the Hub.
updatedAt String: The date and time the Hub resource was updated.

connectedDeviceCount number: The current number of connected devices in the Hub.
createdAt string: The date and time the Hub was created.
deviceCount number: The number of registered devices in the Hub.
endpoint string: The MQTT network endpoint to connect MQTT devices to.
id string: The provider-assigned unique ID for this managed resource.
organizationId string: The organization_id you want to attach the resource to
status string: The current status of the Hub.
updatedAt string: The date and time the Hub resource was updated.

connected_device_count int: The current number of connected devices in the Hub.
created_at str: The date and time the Hub was created.
device_count int: The number of registered devices in the Hub.
endpoint str: The MQTT network endpoint to connect MQTT devices to.
id str: The provider-assigned unique ID for this managed resource.
organization_id str: The organization_id you want to attach the resource to
status str: The current status of the Hub.
updated_at str: The date and time the Hub resource was updated.

connectedDeviceCount Number: The current number of connected devices in the Hub.
createdAt String: The date and time the Hub was created.
deviceCount Number: The number of registered devices in the Hub.
endpoint String: The MQTT network endpoint to connect MQTT devices to.
id String: The provider-assigned unique ID for this managed resource.
organizationId String: The organization_id you want to attach the resource to
status String: The current status of the Hub.
updatedAt String: The date and time the Hub resource was updated.

Look up Existing IotHub Resource

Get an existing IotHub 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?: IotHubState, opts?: CustomResourceOptions): IotHub

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connected_device_count: Optional[int] = None,
        created_at: Optional[str] = None,
        device_auto_provisioning: Optional[bool] = None,
        device_count: Optional[int] = None,
        disable_events: Optional[bool] = None,
        enabled: Optional[bool] = None,
        endpoint: Optional[str] = None,
        events_topic_prefix: Optional[str] = None,
        hub_ca: Optional[str] = None,
        hub_ca_challenge: Optional[str] = None,
        name: Optional[str] = None,
        organization_id: Optional[str] = None,
        product_plan: Optional[str] = None,
        project_id: Optional[str] = None,
        region: Optional[str] = None,
        status: Optional[str] = None,
        updated_at: Optional[str] = None) -> IotHub

func GetIotHub(ctx *Context, name string, id IDInput, state *IotHubState, opts ...ResourceOption) (*IotHub, error)

public static IotHub Get(string name, Input<string> id, IotHubState? state, CustomResourceOptions? opts = null)

public static IotHub get(String name, Output<String> id, IotHubState 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:

ConnectedDeviceCount int: The current number of connected devices in the Hub.
CreatedAt string: The date and time the Hub was created.
DeviceAutoProvisioning bool: Wether to enable the device auto provisioning or not
DeviceCount int: The number of registered devices in the Hub.
DisableEvents bool: Whether to enable the hub events or not
Enabled bool: Wether the IoT Hub instance should be enabled or not.
Important: Updates to enabled will disconnect eventually connected devices.
Endpoint string: The MQTT network endpoint to connect MQTT devices to.
EventsTopicPrefix string: Topic prefix for the hub events
HubCa string: Custom user provided certificate authority
HubCaChallenge string: Challenge certificate for the user provided hub CA
Name string: The name of the IoT Hub instance you want to create (e.g. my-hub).
OrganizationId string: The organization_id you want to attach the resource to
ProductPlan string: Product plan to create the hub, see documentation for available product plans (e.g. plan_shared)
Important: Updates to product_plan will recreate the IoT Hub Instance.
ProjectId string: project_id) The ID of the project the IoT Hub Instance is associated with.
Region string: region) The region in which the Database Instance should be created.
Status string: The current status of the Hub.
UpdatedAt string: The date and time the Hub resource was updated.

ConnectedDeviceCount int: The current number of connected devices in the Hub.
CreatedAt string: The date and time the Hub was created.
DeviceAutoProvisioning bool: Wether to enable the device auto provisioning or not
DeviceCount int: The number of registered devices in the Hub.
DisableEvents bool: Whether to enable the hub events or not
Enabled bool: Wether the IoT Hub instance should be enabled or not.
Important: Updates to enabled will disconnect eventually connected devices.
Endpoint string: The MQTT network endpoint to connect MQTT devices to.
EventsTopicPrefix string: Topic prefix for the hub events
HubCa string: Custom user provided certificate authority
HubCaChallenge string: Challenge certificate for the user provided hub CA
Name string: The name of the IoT Hub instance you want to create (e.g. my-hub).
OrganizationId string: The organization_id you want to attach the resource to
ProductPlan string: Product plan to create the hub, see documentation for available product plans (e.g. plan_shared)
Important: Updates to product_plan will recreate the IoT Hub Instance.
ProjectId string: project_id) The ID of the project the IoT Hub Instance is associated with.
Region string: region) The region in which the Database Instance should be created.
Status string: The current status of the Hub.
UpdatedAt string: The date and time the Hub resource was updated.

connectedDeviceCount Integer: The current number of connected devices in the Hub.
createdAt String: The date and time the Hub was created.
deviceAutoProvisioning Boolean: Wether to enable the device auto provisioning or not
deviceCount Integer: The number of registered devices in the Hub.
disableEvents Boolean: Whether to enable the hub events or not
enabled Boolean: Wether the IoT Hub instance should be enabled or not.
Important: Updates to enabled will disconnect eventually connected devices.
endpoint String: The MQTT network endpoint to connect MQTT devices to.
eventsTopicPrefix String: Topic prefix for the hub events
hubCa String: Custom user provided certificate authority
hubCaChallenge String: Challenge certificate for the user provided hub CA
name String: The name of the IoT Hub instance you want to create (e.g. my-hub).
organizationId String: The organization_id you want to attach the resource to
productPlan String: Product plan to create the hub, see documentation for available product plans (e.g. plan_shared)
Important: Updates to product_plan will recreate the IoT Hub Instance.
projectId String: project_id) The ID of the project the IoT Hub Instance is associated with.
region String: region) The region in which the Database Instance should be created.
status String: The current status of the Hub.
updatedAt String: The date and time the Hub resource was updated.

connectedDeviceCount number: The current number of connected devices in the Hub.
createdAt string: The date and time the Hub was created.
deviceAutoProvisioning boolean: Wether to enable the device auto provisioning or not
deviceCount number: The number of registered devices in the Hub.
disableEvents boolean: Whether to enable the hub events or not
enabled boolean: Wether the IoT Hub instance should be enabled or not.
Important: Updates to enabled will disconnect eventually connected devices.
endpoint string: The MQTT network endpoint to connect MQTT devices to.
eventsTopicPrefix string: Topic prefix for the hub events
hubCa string: Custom user provided certificate authority
hubCaChallenge string: Challenge certificate for the user provided hub CA
name string: The name of the IoT Hub instance you want to create (e.g. my-hub).
organizationId string: The organization_id you want to attach the resource to
productPlan string: Product plan to create the hub, see documentation for available product plans (e.g. plan_shared)
Important: Updates to product_plan will recreate the IoT Hub Instance.
projectId string: project_id) The ID of the project the IoT Hub Instance is associated with.
region string: region) The region in which the Database Instance should be created.
status string: The current status of the Hub.
updatedAt string: The date and time the Hub resource was updated.

connected_device_count int: The current number of connected devices in the Hub.
created_at str: The date and time the Hub was created.
device_auto_provisioning bool: Wether to enable the device auto provisioning or not
device_count int: The number of registered devices in the Hub.
disable_events bool: Whether to enable the hub events or not
enabled bool: Wether the IoT Hub instance should be enabled or not.
Important: Updates to enabled will disconnect eventually connected devices.
endpoint str: The MQTT network endpoint to connect MQTT devices to.
events_topic_prefix str: Topic prefix for the hub events
hub_ca str: Custom user provided certificate authority
hub_ca_challenge str: Challenge certificate for the user provided hub CA
name str: The name of the IoT Hub instance you want to create (e.g. my-hub).
organization_id str: The organization_id you want to attach the resource to
product_plan str: Product plan to create the hub, see documentation for available product plans (e.g. plan_shared)
Important: Updates to product_plan will recreate the IoT Hub Instance.
project_id str: project_id) The ID of the project the IoT Hub Instance is associated with.
region str: region) The region in which the Database Instance should be created.
status str: The current status of the Hub.
updated_at str: The date and time the Hub resource was updated.

connectedDeviceCount Number: The current number of connected devices in the Hub.
createdAt String: The date and time the Hub was created.
deviceAutoProvisioning Boolean: Wether to enable the device auto provisioning or not
deviceCount Number: The number of registered devices in the Hub.
disableEvents Boolean: Whether to enable the hub events or not
enabled Boolean: Wether the IoT Hub instance should be enabled or not.
Important: Updates to enabled will disconnect eventually connected devices.
endpoint String: The MQTT network endpoint to connect MQTT devices to.
eventsTopicPrefix String: Topic prefix for the hub events
hubCa String: Custom user provided certificate authority
hubCaChallenge String: Challenge certificate for the user provided hub CA
name String: The name of the IoT Hub instance you want to create (e.g. my-hub).
organizationId String: The organization_id you want to attach the resource to
productPlan String: Product plan to create the hub, see documentation for available product plans (e.g. plan_shared)
Important: Updates to product_plan will recreate the IoT Hub Instance.
projectId String: project_id) The ID of the project the IoT Hub Instance is associated with.
region String: region) The region in which the Database Instance should be created.
status String: The current status of the Hub.
updatedAt String: The date and time the Hub resource was updated.

Package Details

Repository: scaleway lbrlabs/pulumi-scaleway
License: Apache-2.0
Notes: This Pulumi package is based on the scaleway Terraform Provider.

Scaleway v1.10.0 published on Saturday, Jul 1, 2023 by lbrlabs

lbrlabs/pulumi-scaleway

scaleway.IotHub

On this page

On this page

Import

Create IotHub Resource

IotHub Resource Properties

Inputs

Outputs

Look up Existing IotHub Resource

Package Details

On this page

On this page