1. Packages
  2. Scaleway
  3. API Docs
  4. getIotDevice
Scaleway v1.14.0 published on Thursday, Jun 6, 2024 by pulumiverse

scaleway.getIotDevice

Explore with Pulumi AI

scaleway logo
Scaleway v1.14.0 published on Thursday, Jun 6, 2024 by pulumiverse

    Gets information about an IOT Device.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumi/scaleway";
    
    const myDevice = scaleway.getIotDevice({
        deviceId: "11111111-1111-1111-1111-111111111111",
    });
    
    import pulumi
    import pulumi_scaleway as scaleway
    
    my_device = scaleway.get_iot_device(device_id="11111111-1111-1111-1111-111111111111")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := scaleway.LookupIotDevice(ctx, &scaleway.LookupIotDeviceArgs{
    			DeviceId: pulumi.StringRef("11111111-1111-1111-1111-111111111111"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scaleway = Pulumi.Scaleway;
    
    return await Deployment.RunAsync(() => 
    {
        var myDevice = Scaleway.GetIotDevice.Invoke(new()
        {
            DeviceId = "11111111-1111-1111-1111-111111111111",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scaleway.ScalewayFunctions;
    import com.pulumi.scaleway.inputs.GetIotDeviceArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var myDevice = ScalewayFunctions.getIotDevice(GetIotDeviceArgs.builder()
                .deviceId("11111111-1111-1111-1111-111111111111")
                .build());
    
        }
    }
    
    variables:
      myDevice:
        fn::invoke:
          Function: scaleway:getIotDevice
          Arguments:
            deviceId: 11111111-1111-1111-1111-111111111111
    

    Using getIotDevice

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getIotDevice(args: GetIotDeviceArgs, opts?: InvokeOptions): Promise<GetIotDeviceResult>
    function getIotDeviceOutput(args: GetIotDeviceOutputArgs, opts?: InvokeOptions): Output<GetIotDeviceResult>
    def get_iot_device(device_id: Optional[str] = None,
                       hub_id: Optional[str] = None,
                       name: Optional[str] = None,
                       region: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetIotDeviceResult
    def get_iot_device_output(device_id: Optional[pulumi.Input[str]] = None,
                       hub_id: Optional[pulumi.Input[str]] = None,
                       name: Optional[pulumi.Input[str]] = None,
                       region: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetIotDeviceResult]
    func LookupIotDevice(ctx *Context, args *LookupIotDeviceArgs, opts ...InvokeOption) (*LookupIotDeviceResult, error)
    func LookupIotDeviceOutput(ctx *Context, args *LookupIotDeviceOutputArgs, opts ...InvokeOption) LookupIotDeviceResultOutput

    > Note: This function is named LookupIotDevice in the Go SDK.

    public static class GetIotDevice 
    {
        public static Task<GetIotDeviceResult> InvokeAsync(GetIotDeviceArgs args, InvokeOptions? opts = null)
        public static Output<GetIotDeviceResult> Invoke(GetIotDeviceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIotDeviceResult> getIotDevice(GetIotDeviceArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: scaleway:index/getIotDevice:getIotDevice
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DeviceId string
    The device ID. Only one of the name and device_id should be specified.
    HubId string
    The hub ID.
    Name string
    The name of the Hub. Only one of the name and device_id should be specified.
    Region string
    region) The region in which the hub exists.
    DeviceId string
    The device ID. Only one of the name and device_id should be specified.
    HubId string
    The hub ID.
    Name string
    The name of the Hub. Only one of the name and device_id should be specified.
    Region string
    region) The region in which the hub exists.
    deviceId String
    The device ID. Only one of the name and device_id should be specified.
    hubId String
    The hub ID.
    name String
    The name of the Hub. Only one of the name and device_id should be specified.
    region String
    region) The region in which the hub exists.
    deviceId string
    The device ID. Only one of the name and device_id should be specified.
    hubId string
    The hub ID.
    name string
    The name of the Hub. Only one of the name and device_id should be specified.
    region string
    region) The region in which the hub exists.
    device_id str
    The device ID. Only one of the name and device_id should be specified.
    hub_id str
    The hub ID.
    name str
    The name of the Hub. Only one of the name and device_id should be specified.
    region str
    region) The region in which the hub exists.
    deviceId String
    The device ID. Only one of the name and device_id should be specified.
    hubId String
    The hub ID.
    name String
    The name of the Hub. Only one of the name and device_id should be specified.
    region String
    region) The region in which the hub exists.

    getIotDevice Result

    The following output properties are available:

    AllowInsecure bool
    AllowMultipleConnections bool
    Certificates []GetIotDeviceCertificate
    CreatedAt string
    Description string
    HubId string
    Id string
    The provider-assigned unique ID for this managed resource.
    IsConnected bool
    LastActivityAt string
    MessageFilters []GetIotDeviceMessageFilter
    Status string
    UpdatedAt string
    DeviceId string
    Name string
    Region string
    allowInsecure Boolean
    allowMultipleConnections Boolean
    certificates List<GetIotDeviceCertificate>
    createdAt String
    description String
    hubId String
    id String
    The provider-assigned unique ID for this managed resource.
    isConnected Boolean
    lastActivityAt String
    messageFilters List<GetIotDeviceMessageFilter>
    status String
    updatedAt String
    deviceId String
    name String
    region String
    allowInsecure boolean
    allowMultipleConnections boolean
    certificates GetIotDeviceCertificate[]
    createdAt string
    description string
    hubId string
    id string
    The provider-assigned unique ID for this managed resource.
    isConnected boolean
    lastActivityAt string
    messageFilters GetIotDeviceMessageFilter[]
    status string
    updatedAt string
    deviceId string
    name string
    region string
    allowInsecure Boolean
    allowMultipleConnections Boolean
    certificates List<Property Map>
    createdAt String
    description String
    hubId String
    id String
    The provider-assigned unique ID for this managed resource.
    isConnected Boolean
    lastActivityAt String
    messageFilters List<Property Map>
    status String
    updatedAt String
    deviceId String
    name String
    region String

    Supporting Types

    GetIotDeviceCertificate

    Crt string
    X509 PEM encoded certificate of the device
    Key string
    X509 PEM encoded key of the device
    Crt string
    X509 PEM encoded certificate of the device
    Key string
    X509 PEM encoded key of the device
    crt String
    X509 PEM encoded certificate of the device
    key String
    X509 PEM encoded key of the device
    crt string
    X509 PEM encoded certificate of the device
    key string
    X509 PEM encoded key of the device
    crt str
    X509 PEM encoded certificate of the device
    key str
    X509 PEM encoded key of the device
    crt String
    X509 PEM encoded certificate of the device
    key String
    X509 PEM encoded key of the device

    GetIotDeviceMessageFilter

    Publishes List<Pulumiverse.Scaleway.Inputs.GetIotDeviceMessageFilterPublish>
    Rule to restrict topics the device can publish to
    Subscribes List<Pulumiverse.Scaleway.Inputs.GetIotDeviceMessageFilterSubscribe>
    Rule to restrict topics the device can subscribe to
    Publishes []GetIotDeviceMessageFilterPublish
    Rule to restrict topics the device can publish to
    Subscribes []GetIotDeviceMessageFilterSubscribe
    Rule to restrict topics the device can subscribe to
    publishes List<GetIotDeviceMessageFilterPublish>
    Rule to restrict topics the device can publish to
    subscribes List<GetIotDeviceMessageFilterSubscribe>
    Rule to restrict topics the device can subscribe to
    publishes GetIotDeviceMessageFilterPublish[]
    Rule to restrict topics the device can publish to
    subscribes GetIotDeviceMessageFilterSubscribe[]
    Rule to restrict topics the device can subscribe to
    publishes Sequence[GetIotDeviceMessageFilterPublish]
    Rule to restrict topics the device can publish to
    subscribes Sequence[GetIotDeviceMessageFilterSubscribe]
    Rule to restrict topics the device can subscribe to
    publishes List<Property Map>
    Rule to restrict topics the device can publish to
    subscribes List<Property Map>
    Rule to restrict topics the device can subscribe to

    GetIotDeviceMessageFilterPublish

    Policy string
    Publish message filter policy
    Topics List<string>
    List of topics in the set
    Policy string
    Publish message filter policy
    Topics []string
    List of topics in the set
    policy String
    Publish message filter policy
    topics List<String>
    List of topics in the set
    policy string
    Publish message filter policy
    topics string[]
    List of topics in the set
    policy str
    Publish message filter policy
    topics Sequence[str]
    List of topics in the set
    policy String
    Publish message filter policy
    topics List<String>
    List of topics in the set

    GetIotDeviceMessageFilterSubscribe

    Policy string
    Subscribe message filter policy
    Topics List<string>
    List of topics in the set
    Policy string
    Subscribe message filter policy
    Topics []string
    List of topics in the set
    policy String
    Subscribe message filter policy
    topics List<String>
    List of topics in the set
    policy string
    Subscribe message filter policy
    topics string[]
    List of topics in the set
    policy str
    Subscribe message filter policy
    topics Sequence[str]
    List of topics in the set
    policy String
    Subscribe message filter policy
    topics List<String>
    List of topics in the set

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Scaleway v1.14.0 published on Thursday, Jun 6, 2024 by pulumiverse