1. Packages
  2. Scaleway
  3. API Docs
  4. IotDevice
Scaleway v1.10.0 published on Saturday, Jul 1, 2023 by lbrlabs

scaleway.IotDevice

Explore with Pulumi AI

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

    Import

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

     $ pulumi import scaleway:index/iotDevice:IotDevice device01 fr-par/11111111-1111-1111-1111-111111111111
    

    Create IotDevice Resource

    new IotDevice(name: string, args: IotDeviceArgs, opts?: CustomResourceOptions);
    @overload
    def IotDevice(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  allow_insecure: Optional[bool] = None,
                  allow_multiple_connections: Optional[bool] = None,
                  certificate: Optional[IotDeviceCertificateArgs] = None,
                  description: Optional[str] = None,
                  hub_id: Optional[str] = None,
                  message_filters: Optional[IotDeviceMessageFiltersArgs] = None,
                  name: Optional[str] = None,
                  region: Optional[str] = None)
    @overload
    def IotDevice(resource_name: str,
                  args: IotDeviceArgs,
                  opts: Optional[ResourceOptions] = None)
    func NewIotDevice(ctx *Context, name string, args IotDeviceArgs, opts ...ResourceOption) (*IotDevice, error)
    public IotDevice(string name, IotDeviceArgs args, CustomResourceOptions? opts = null)
    public IotDevice(String name, IotDeviceArgs args)
    public IotDevice(String name, IotDeviceArgs args, CustomResourceOptions options)
    
    type: scaleway:IotDevice
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args IotDeviceArgs
    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 IotDeviceArgs
    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 IotDeviceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IotDeviceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IotDeviceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    HubId string

    The ID of the hub on which this device will be created.

    AllowInsecure bool

    Allow plain and server-authenticated TLS connections in addition to mutually-authenticated ones.

    Important: Updates to allow_insecure can disconnect eventually connected devices.

    AllowMultipleConnections bool

    Allow more than one simultaneous connection using the same device credentials.

    Important: Updates to allow_multiple_connections can disconnect eventually connected devices.

    Certificate Lbrlabs.PulumiPackage.Scaleway.Inputs.IotDeviceCertificate

    The certificate bundle of the device.

    Description string

    The description of the IoT device (e.g. living room).

    MessageFilters Lbrlabs.PulumiPackage.Scaleway.Inputs.IotDeviceMessageFilters

    Rules that define which messages are authorized or denied based on their topic.

    Name string

    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.

    Region string

    The region you want to attach the resource to

    HubId string

    The ID of the hub on which this device will be created.

    AllowInsecure bool

    Allow plain and server-authenticated TLS connections in addition to mutually-authenticated ones.

    Important: Updates to allow_insecure can disconnect eventually connected devices.

    AllowMultipleConnections bool

    Allow more than one simultaneous connection using the same device credentials.

    Important: Updates to allow_multiple_connections can disconnect eventually connected devices.

    Certificate IotDeviceCertificateArgs

    The certificate bundle of the device.

    Description string

    The description of the IoT device (e.g. living room).

    MessageFilters IotDeviceMessageFiltersArgs

    Rules that define which messages are authorized or denied based on their topic.

    Name string

    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.

    Region string

    The region you want to attach the resource to

    hubId String

    The ID of the hub on which this device will be created.

    allowInsecure Boolean

    Allow plain and server-authenticated TLS connections in addition to mutually-authenticated ones.

    Important: Updates to allow_insecure can disconnect eventually connected devices.

    allowMultipleConnections Boolean

    Allow more than one simultaneous connection using the same device credentials.

    Important: Updates to allow_multiple_connections can disconnect eventually connected devices.

    certificate IotDeviceCertificate

    The certificate bundle of the device.

    description String

    The description of the IoT device (e.g. living room).

    messageFilters IotDeviceMessageFilters

    Rules that define which messages are authorized or denied based on their topic.

    name String

    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.

    region String

    The region you want to attach the resource to

    hubId string

    The ID of the hub on which this device will be created.

    allowInsecure boolean

    Allow plain and server-authenticated TLS connections in addition to mutually-authenticated ones.

    Important: Updates to allow_insecure can disconnect eventually connected devices.

    allowMultipleConnections boolean

    Allow more than one simultaneous connection using the same device credentials.

    Important: Updates to allow_multiple_connections can disconnect eventually connected devices.

    certificate IotDeviceCertificate

    The certificate bundle of the device.

    description string

    The description of the IoT device (e.g. living room).

    messageFilters IotDeviceMessageFilters

    Rules that define which messages are authorized or denied based on their topic.

    name string

    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.

    region string

    The region you want to attach the resource to

    hub_id str

    The ID of the hub on which this device will be created.

    allow_insecure bool

    Allow plain and server-authenticated TLS connections in addition to mutually-authenticated ones.

    Important: Updates to allow_insecure can disconnect eventually connected devices.

    allow_multiple_connections bool

    Allow more than one simultaneous connection using the same device credentials.

    Important: Updates to allow_multiple_connections can disconnect eventually connected devices.

    certificate IotDeviceCertificateArgs

    The certificate bundle of the device.

    description str

    The description of the IoT device (e.g. living room).

    message_filters IotDeviceMessageFiltersArgs

    Rules that define which messages are authorized or denied based on their topic.

    name str

    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.

    region str

    The region you want to attach the resource to

    hubId String

    The ID of the hub on which this device will be created.

    allowInsecure Boolean

    Allow plain and server-authenticated TLS connections in addition to mutually-authenticated ones.

    Important: Updates to allow_insecure can disconnect eventually connected devices.

    allowMultipleConnections Boolean

    Allow more than one simultaneous connection using the same device credentials.

    Important: Updates to allow_multiple_connections can disconnect eventually connected devices.

    certificate Property Map

    The certificate bundle of the device.

    description String

    The description of the IoT device (e.g. living room).

    messageFilters Property Map

    Rules that define which messages are authorized or denied based on their topic.

    name String

    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.

    region String

    The region you want to attach the resource to

    Outputs

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

    CreatedAt string

    The date and time the device was created.

    Id string

    The provider-assigned unique ID for this managed resource.

    IsConnected bool

    The current connection status of the device.

    LastActivityAt string

    The last MQTT activity of the device.

    Status string

    The current status of the device.

    UpdatedAt string

    The date and time the device resource was updated.

    CreatedAt string

    The date and time the device was created.

    Id string

    The provider-assigned unique ID for this managed resource.

    IsConnected bool

    The current connection status of the device.

    LastActivityAt string

    The last MQTT activity of the device.

    Status string

    The current status of the device.

    UpdatedAt string

    The date and time the device resource was updated.

    createdAt String

    The date and time the device was created.

    id String

    The provider-assigned unique ID for this managed resource.

    isConnected Boolean

    The current connection status of the device.

    lastActivityAt String

    The last MQTT activity of the device.

    status String

    The current status of the device.

    updatedAt String

    The date and time the device resource was updated.

    createdAt string

    The date and time the device was created.

    id string

    The provider-assigned unique ID for this managed resource.

    isConnected boolean

    The current connection status of the device.

    lastActivityAt string

    The last MQTT activity of the device.

    status string

    The current status of the device.

    updatedAt string

    The date and time the device resource was updated.

    created_at str

    The date and time the device was created.

    id str

    The provider-assigned unique ID for this managed resource.

    is_connected bool

    The current connection status of the device.

    last_activity_at str

    The last MQTT activity of the device.

    status str

    The current status of the device.

    updated_at str

    The date and time the device resource was updated.

    createdAt String

    The date and time the device was created.

    id String

    The provider-assigned unique ID for this managed resource.

    isConnected Boolean

    The current connection status of the device.

    lastActivityAt String

    The last MQTT activity of the device.

    status String

    The current status of the device.

    updatedAt String

    The date and time the device resource was updated.

    Look up Existing IotDevice Resource

    Get an existing IotDevice 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?: IotDeviceState, opts?: CustomResourceOptions): IotDevice
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allow_insecure: Optional[bool] = None,
            allow_multiple_connections: Optional[bool] = None,
            certificate: Optional[IotDeviceCertificateArgs] = None,
            created_at: Optional[str] = None,
            description: Optional[str] = None,
            hub_id: Optional[str] = None,
            is_connected: Optional[bool] = None,
            last_activity_at: Optional[str] = None,
            message_filters: Optional[IotDeviceMessageFiltersArgs] = None,
            name: Optional[str] = None,
            region: Optional[str] = None,
            status: Optional[str] = None,
            updated_at: Optional[str] = None) -> IotDevice
    func GetIotDevice(ctx *Context, name string, id IDInput, state *IotDeviceState, opts ...ResourceOption) (*IotDevice, error)
    public static IotDevice Get(string name, Input<string> id, IotDeviceState? state, CustomResourceOptions? opts = null)
    public static IotDevice get(String name, Output<String> id, IotDeviceState 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:
    AllowInsecure bool

    Allow plain and server-authenticated TLS connections in addition to mutually-authenticated ones.

    Important: Updates to allow_insecure can disconnect eventually connected devices.

    AllowMultipleConnections bool

    Allow more than one simultaneous connection using the same device credentials.

    Important: Updates to allow_multiple_connections can disconnect eventually connected devices.

    Certificate Lbrlabs.PulumiPackage.Scaleway.Inputs.IotDeviceCertificate

    The certificate bundle of the device.

    CreatedAt string

    The date and time the device was created.

    Description string

    The description of the IoT device (e.g. living room).

    HubId string

    The ID of the hub on which this device will be created.

    IsConnected bool

    The current connection status of the device.

    LastActivityAt string

    The last MQTT activity of the device.

    MessageFilters Lbrlabs.PulumiPackage.Scaleway.Inputs.IotDeviceMessageFilters

    Rules that define which messages are authorized or denied based on their topic.

    Name string

    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.

    Region string

    The region you want to attach the resource to

    Status string

    The current status of the device.

    UpdatedAt string

    The date and time the device resource was updated.

    AllowInsecure bool

    Allow plain and server-authenticated TLS connections in addition to mutually-authenticated ones.

    Important: Updates to allow_insecure can disconnect eventually connected devices.

    AllowMultipleConnections bool

    Allow more than one simultaneous connection using the same device credentials.

    Important: Updates to allow_multiple_connections can disconnect eventually connected devices.

    Certificate IotDeviceCertificateArgs

    The certificate bundle of the device.

    CreatedAt string

    The date and time the device was created.

    Description string

    The description of the IoT device (e.g. living room).

    HubId string

    The ID of the hub on which this device will be created.

    IsConnected bool

    The current connection status of the device.

    LastActivityAt string

    The last MQTT activity of the device.

    MessageFilters IotDeviceMessageFiltersArgs

    Rules that define which messages are authorized or denied based on their topic.

    Name string

    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.

    Region string

    The region you want to attach the resource to

    Status string

    The current status of the device.

    UpdatedAt string

    The date and time the device resource was updated.

    allowInsecure Boolean

    Allow plain and server-authenticated TLS connections in addition to mutually-authenticated ones.

    Important: Updates to allow_insecure can disconnect eventually connected devices.

    allowMultipleConnections Boolean

    Allow more than one simultaneous connection using the same device credentials.

    Important: Updates to allow_multiple_connections can disconnect eventually connected devices.

    certificate IotDeviceCertificate

    The certificate bundle of the device.

    createdAt String

    The date and time the device was created.

    description String

    The description of the IoT device (e.g. living room).

    hubId String

    The ID of the hub on which this device will be created.

    isConnected Boolean

    The current connection status of the device.

    lastActivityAt String

    The last MQTT activity of the device.

    messageFilters IotDeviceMessageFilters

    Rules that define which messages are authorized or denied based on their topic.

    name String

    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.

    region String

    The region you want to attach the resource to

    status String

    The current status of the device.

    updatedAt String

    The date and time the device resource was updated.

    allowInsecure boolean

    Allow plain and server-authenticated TLS connections in addition to mutually-authenticated ones.

    Important: Updates to allow_insecure can disconnect eventually connected devices.

    allowMultipleConnections boolean

    Allow more than one simultaneous connection using the same device credentials.

    Important: Updates to allow_multiple_connections can disconnect eventually connected devices.

    certificate IotDeviceCertificate

    The certificate bundle of the device.

    createdAt string

    The date and time the device was created.

    description string

    The description of the IoT device (e.g. living room).

    hubId string

    The ID of the hub on which this device will be created.

    isConnected boolean

    The current connection status of the device.

    lastActivityAt string

    The last MQTT activity of the device.

    messageFilters IotDeviceMessageFilters

    Rules that define which messages are authorized or denied based on their topic.

    name string

    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.

    region string

    The region you want to attach the resource to

    status string

    The current status of the device.

    updatedAt string

    The date and time the device resource was updated.

    allow_insecure bool

    Allow plain and server-authenticated TLS connections in addition to mutually-authenticated ones.

    Important: Updates to allow_insecure can disconnect eventually connected devices.

    allow_multiple_connections bool

    Allow more than one simultaneous connection using the same device credentials.

    Important: Updates to allow_multiple_connections can disconnect eventually connected devices.

    certificate IotDeviceCertificateArgs

    The certificate bundle of the device.

    created_at str

    The date and time the device was created.

    description str

    The description of the IoT device (e.g. living room).

    hub_id str

    The ID of the hub on which this device will be created.

    is_connected bool

    The current connection status of the device.

    last_activity_at str

    The last MQTT activity of the device.

    message_filters IotDeviceMessageFiltersArgs

    Rules that define which messages are authorized or denied based on their topic.

    name str

    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.

    region str

    The region you want to attach the resource to

    status str

    The current status of the device.

    updated_at str

    The date and time the device resource was updated.

    allowInsecure Boolean

    Allow plain and server-authenticated TLS connections in addition to mutually-authenticated ones.

    Important: Updates to allow_insecure can disconnect eventually connected devices.

    allowMultipleConnections Boolean

    Allow more than one simultaneous connection using the same device credentials.

    Important: Updates to allow_multiple_connections can disconnect eventually connected devices.

    certificate Property Map

    The certificate bundle of the device.

    createdAt String

    The date and time the device was created.

    description String

    The description of the IoT device (e.g. living room).

    hubId String

    The ID of the hub on which this device will be created.

    isConnected Boolean

    The current connection status of the device.

    lastActivityAt String

    The last MQTT activity of the device.

    messageFilters Property Map

    Rules that define which messages are authorized or denied based on their topic.

    name String

    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.

    region String

    The region you want to attach the resource to

    status String

    The current status of the device.

    updatedAt String

    The date and time the device resource was updated.

    Supporting Types

    IotDeviceCertificate, IotDeviceCertificateArgs

    Crt string
    Key string

    The private key of the device, in case it is generated by Scaleway.

    Crt string
    Key string

    The private key of the device, in case it is generated by Scaleway.

    crt String
    key String

    The private key of the device, in case it is generated by Scaleway.

    crt string
    key string

    The private key of the device, in case it is generated by Scaleway.

    crt str
    key str

    The private key of the device, in case it is generated by Scaleway.

    crt String
    key String

    The private key of the device, in case it is generated by Scaleway.

    IotDeviceMessageFilters, IotDeviceMessageFiltersArgs

    Publish Lbrlabs.PulumiPackage.Scaleway.Inputs.IotDeviceMessageFiltersPublish

    Rules used to restrict topics the device can publish to.

    Subscribe Lbrlabs.PulumiPackage.Scaleway.Inputs.IotDeviceMessageFiltersSubscribe

    Rules used to restrict topics the device can subscribe to.

    Publish IotDeviceMessageFiltersPublish

    Rules used to restrict topics the device can publish to.

    Subscribe IotDeviceMessageFiltersSubscribe

    Rules used to restrict topics the device can subscribe to.

    publish IotDeviceMessageFiltersPublish

    Rules used to restrict topics the device can publish to.

    subscribe IotDeviceMessageFiltersSubscribe

    Rules used to restrict topics the device can subscribe to.

    publish IotDeviceMessageFiltersPublish

    Rules used to restrict topics the device can publish to.

    subscribe IotDeviceMessageFiltersSubscribe

    Rules used to restrict topics the device can subscribe to.

    publish IotDeviceMessageFiltersPublish

    Rules used to restrict topics the device can publish to.

    subscribe IotDeviceMessageFiltersSubscribe

    Rules used to restrict topics the device can subscribe to.

    publish Property Map

    Rules used to restrict topics the device can publish to.

    subscribe Property Map

    Rules used to restrict topics the device can subscribe to.

    IotDeviceMessageFiltersPublish, IotDeviceMessageFiltersPublishArgs

    Policy string

    Same as publish rules.

    Topics List<string>

    Same as publish rules.

    • certificate.crt - (Optional) The certificate of the device, either generated by Scaleway or provided.

    Important: Updates to certificate.crt will disconnect connected devices and the previous certificate will be deleted and won't be recoverable.

    Policy string

    Same as publish rules.

    Topics []string

    Same as publish rules.

    • certificate.crt - (Optional) The certificate of the device, either generated by Scaleway or provided.

    Important: Updates to certificate.crt will disconnect connected devices and the previous certificate will be deleted and won't be recoverable.

    policy String

    Same as publish rules.

    topics List<String>

    Same as publish rules.

    • certificate.crt - (Optional) The certificate of the device, either generated by Scaleway or provided.

    Important: Updates to certificate.crt will disconnect connected devices and the previous certificate will be deleted and won't be recoverable.

    policy string

    Same as publish rules.

    topics string[]

    Same as publish rules.

    • certificate.crt - (Optional) The certificate of the device, either generated by Scaleway or provided.

    Important: Updates to certificate.crt will disconnect connected devices and the previous certificate will be deleted and won't be recoverable.

    policy str

    Same as publish rules.

    topics Sequence[str]

    Same as publish rules.

    • certificate.crt - (Optional) The certificate of the device, either generated by Scaleway or provided.

    Important: Updates to certificate.crt will disconnect connected devices and the previous certificate will be deleted and won't be recoverable.

    policy String

    Same as publish rules.

    topics List<String>

    Same as publish rules.

    • certificate.crt - (Optional) The certificate of the device, either generated by Scaleway or provided.

    Important: Updates to certificate.crt will disconnect connected devices and the previous certificate will be deleted and won't be recoverable.

    IotDeviceMessageFiltersSubscribe, IotDeviceMessageFiltersSubscribeArgs

    Policy string

    Same as publish rules.

    Topics List<string>

    Same as publish rules.

    • certificate.crt - (Optional) The certificate of the device, either generated by Scaleway or provided.

    Important: Updates to certificate.crt will disconnect connected devices and the previous certificate will be deleted and won't be recoverable.

    Policy string

    Same as publish rules.

    Topics []string

    Same as publish rules.

    • certificate.crt - (Optional) The certificate of the device, either generated by Scaleway or provided.

    Important: Updates to certificate.crt will disconnect connected devices and the previous certificate will be deleted and won't be recoverable.

    policy String

    Same as publish rules.

    topics List<String>

    Same as publish rules.

    • certificate.crt - (Optional) The certificate of the device, either generated by Scaleway or provided.

    Important: Updates to certificate.crt will disconnect connected devices and the previous certificate will be deleted and won't be recoverable.

    policy string

    Same as publish rules.

    topics string[]

    Same as publish rules.

    • certificate.crt - (Optional) The certificate of the device, either generated by Scaleway or provided.

    Important: Updates to certificate.crt will disconnect connected devices and the previous certificate will be deleted and won't be recoverable.

    policy str

    Same as publish rules.

    topics Sequence[str]

    Same as publish rules.

    • certificate.crt - (Optional) The certificate of the device, either generated by Scaleway or provided.

    Important: Updates to certificate.crt will disconnect connected devices and the previous certificate will be deleted and won't be recoverable.

    policy String

    Same as publish rules.

    topics List<String>

    Same as publish rules.

    • certificate.crt - (Optional) The certificate of the device, either generated by Scaleway or provided.

    Important: Updates to certificate.crt will disconnect connected devices and the previous certificate will be deleted and won't be recoverable.

    Package Details

    Repository
    scaleway lbrlabs/pulumi-scaleway
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the scaleway Terraform Provider.

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