1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. kms
  5. Packages
Google Cloud Classic v6.58.0 published on Tuesday, Jun 6, 2023 by Pulumi

gcp.kms.Registry

Explore with Pulumi AI

gcp logo
Google Cloud Classic v6.58.0 published on Tuesday, Jun 6, 2023 by Pulumi

    Deprecated:

    gcp.kms.Registry has been deprecated in favor of gcp.iot.Registry

    A Google Cloud IoT Core device registry.

    To get more information about DeviceRegistry, see:

    Example Usage

    Cloudiot Device Registry Basic

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var test_registry = new Gcp.Iot.Registry("test-registry");
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/iot"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := iot.NewRegistry(ctx, "test-registry", nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.iot.Registry;
    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) {
            var test_registry = new Registry("test-registry");
    
        }
    }
    
    import pulumi
    import pulumi_gcp as gcp
    
    test_registry = gcp.iot.Registry("test-registry")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const test_registry = new gcp.iot.Registry("test-registry", {});
    
    resources:
      test-registry:
        type: gcp:iot:Registry
    

    Cloudiot Device Registry Single Event Notification Configs

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var default_telemetry = new Gcp.PubSub.Topic("default-telemetry");
    
        var test_registry = new Gcp.Iot.Registry("test-registry", new()
        {
            EventNotificationConfigs = new[]
            {
                new Gcp.Iot.Inputs.RegistryEventNotificationConfigItemArgs
                {
                    PubsubTopicName = default_telemetry.Id,
                    SubfolderMatches = "",
                },
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/iot"
    	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/pubsub"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := pubsub.NewTopic(ctx, "default-telemetry", nil)
    		if err != nil {
    			return err
    		}
    		_, err = iot.NewRegistry(ctx, "test-registry", &iot.RegistryArgs{
    			EventNotificationConfigs: iot.RegistryEventNotificationConfigItemArray{
    				&iot.RegistryEventNotificationConfigItemArgs{
    					PubsubTopicName:  default_telemetry.ID(),
    					SubfolderMatches: pulumi.String(""),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.pubsub.Topic;
    import com.pulumi.gcp.iot.Registry;
    import com.pulumi.gcp.iot.RegistryArgs;
    import com.pulumi.gcp.iot.inputs.RegistryEventNotificationConfigItemArgs;
    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) {
            var default_telemetry = new Topic("default-telemetry");
    
            var test_registry = new Registry("test-registry", RegistryArgs.builder()        
                .eventNotificationConfigs(RegistryEventNotificationConfigItemArgs.builder()
                    .pubsubTopicName(default_telemetry.id())
                    .subfolderMatches("")
                    .build())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_gcp as gcp
    
    default_telemetry = gcp.pubsub.Topic("default-telemetry")
    test_registry = gcp.iot.Registry("test-registry", event_notification_configs=[gcp.iot.RegistryEventNotificationConfigItemArgs(
        pubsub_topic_name=default_telemetry.id,
        subfolder_matches="",
    )])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const default_telemetry = new gcp.pubsub.Topic("default-telemetry", {});
    const test_registry = new gcp.iot.Registry("test-registry", {eventNotificationConfigs: [{
        pubsubTopicName: default_telemetry.id,
        subfolderMatches: "",
    }]});
    
    resources:
      default-telemetry:
        type: gcp:pubsub:Topic
      test-registry:
        type: gcp:iot:Registry
        properties:
          eventNotificationConfigs:
            - pubsubTopicName: ${["default-telemetry"].id}
              subfolderMatches:
    

    Cloudiot Device Registry Full

    using System.Collections.Generic;
    using System.IO;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var default_devicestatus = new Gcp.PubSub.Topic("default-devicestatus");
    
        var default_telemetry = new Gcp.PubSub.Topic("default-telemetry");
    
        var additional_telemetry = new Gcp.PubSub.Topic("additional-telemetry");
    
        var test_registry = new Gcp.Iot.Registry("test-registry", new()
        {
            EventNotificationConfigs = new[]
            {
                new Gcp.Iot.Inputs.RegistryEventNotificationConfigItemArgs
                {
                    PubsubTopicName = additional_telemetry.Id,
                    SubfolderMatches = "test/path",
                },
                new Gcp.Iot.Inputs.RegistryEventNotificationConfigItemArgs
                {
                    PubsubTopicName = default_telemetry.Id,
                    SubfolderMatches = "",
                },
            },
            StateNotificationConfig = 
            {
                { "pubsub_topic_name", default_devicestatus.Id },
            },
            MqttConfig = 
            {
                { "mqtt_enabled_state", "MQTT_ENABLED" },
            },
            HttpConfig = 
            {
                { "http_enabled_state", "HTTP_ENABLED" },
            },
            LogLevel = "INFO",
            Credentials = new[]
            {
                new Gcp.Iot.Inputs.RegistryCredentialArgs
                {
                    PublicKeyCertificate = 
                    {
                        { "format", "X509_CERTIFICATE_PEM" },
                        { "certificate", File.ReadAllText("test-fixtures/rsa_cert.pem") },
                    },
                },
            },
        });
    
    });
    
    package main
    
    import (
    	"os"
    
    	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/iot"
    	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/pubsub"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func readFileOrPanic(path string) pulumi.StringPtrInput {
    	data, err := os.ReadFile(path)
    	if err != nil {
    		panic(err.Error())
    	}
    	return pulumi.String(string(data))
    }
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := pubsub.NewTopic(ctx, "default-devicestatus", nil)
    		if err != nil {
    			return err
    		}
    		_, err = pubsub.NewTopic(ctx, "default-telemetry", nil)
    		if err != nil {
    			return err
    		}
    		_, err = pubsub.NewTopic(ctx, "additional-telemetry", nil)
    		if err != nil {
    			return err
    		}
    		_, err = iot.NewRegistry(ctx, "test-registry", &iot.RegistryArgs{
    			EventNotificationConfigs: iot.RegistryEventNotificationConfigItemArray{
    				&iot.RegistryEventNotificationConfigItemArgs{
    					PubsubTopicName:  additional_telemetry.ID(),
    					SubfolderMatches: pulumi.String("test/path"),
    				},
    				&iot.RegistryEventNotificationConfigItemArgs{
    					PubsubTopicName:  default_telemetry.ID(),
    					SubfolderMatches: pulumi.String(""),
    				},
    			},
    			StateNotificationConfig: pulumi.AnyMap{
    				"pubsub_topic_name": default_devicestatus.ID(),
    			},
    			MqttConfig: pulumi.AnyMap{
    				"mqtt_enabled_state": pulumi.Any("MQTT_ENABLED"),
    			},
    			HttpConfig: pulumi.AnyMap{
    				"http_enabled_state": pulumi.Any("HTTP_ENABLED"),
    			},
    			LogLevel: pulumi.String("INFO"),
    			Credentials: iot.RegistryCredentialArray{
    				&iot.RegistryCredentialArgs{
    					PublicKeyCertificate: pulumi.AnyMap{
    						"format":      pulumi.Any("X509_CERTIFICATE_PEM"),
    						"certificate": readFileOrPanic("test-fixtures/rsa_cert.pem"),
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.pubsub.Topic;
    import com.pulumi.gcp.iot.Registry;
    import com.pulumi.gcp.iot.RegistryArgs;
    import com.pulumi.gcp.iot.inputs.RegistryEventNotificationConfigItemArgs;
    import com.pulumi.gcp.iot.inputs.RegistryCredentialArgs;
    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) {
            var default_devicestatus = new Topic("default-devicestatus");
    
            var default_telemetry = new Topic("default-telemetry");
    
            var additional_telemetry = new Topic("additional-telemetry");
    
            var test_registry = new Registry("test-registry", RegistryArgs.builder()        
                .eventNotificationConfigs(            
                    RegistryEventNotificationConfigItemArgs.builder()
                        .pubsubTopicName(additional_telemetry.id())
                        .subfolderMatches("test/path")
                        .build(),
                    RegistryEventNotificationConfigItemArgs.builder()
                        .pubsubTopicName(default_telemetry.id())
                        .subfolderMatches("")
                        .build())
                .stateNotificationConfig(Map.of("pubsub_topic_name", default_devicestatus.id()))
                .mqttConfig(Map.of("mqtt_enabled_state", "MQTT_ENABLED"))
                .httpConfig(Map.of("http_enabled_state", "HTTP_ENABLED"))
                .logLevel("INFO")
                .credentials(RegistryCredentialArgs.builder()
                    .publicKeyCertificate(Map.ofEntries(
                        Map.entry("format", "X509_CERTIFICATE_PEM"),
                        Map.entry("certificate", Files.readString(Paths.get("test-fixtures/rsa_cert.pem")))
                    ))
                    .build())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_gcp as gcp
    
    default_devicestatus = gcp.pubsub.Topic("default-devicestatus")
    default_telemetry = gcp.pubsub.Topic("default-telemetry")
    additional_telemetry = gcp.pubsub.Topic("additional-telemetry")
    test_registry = gcp.iot.Registry("test-registry",
        event_notification_configs=[
            gcp.iot.RegistryEventNotificationConfigItemArgs(
                pubsub_topic_name=additional_telemetry.id,
                subfolder_matches="test/path",
            ),
            gcp.iot.RegistryEventNotificationConfigItemArgs(
                pubsub_topic_name=default_telemetry.id,
                subfolder_matches="",
            ),
        ],
        state_notification_config={
            "pubsub_topic_name": default_devicestatus.id,
        },
        mqtt_config={
            "mqtt_enabled_state": "MQTT_ENABLED",
        },
        http_config={
            "http_enabled_state": "HTTP_ENABLED",
        },
        log_level="INFO",
        credentials=[gcp.iot.RegistryCredentialArgs(
            public_key_certificate={
                "format": "X509_CERTIFICATE_PEM",
                "certificate": (lambda path: open(path).read())("test-fixtures/rsa_cert.pem"),
            },
        )])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as fs from "fs";
    import * as gcp from "@pulumi/gcp";
    
    const default_devicestatus = new gcp.pubsub.Topic("default-devicestatus", {});
    const default_telemetry = new gcp.pubsub.Topic("default-telemetry", {});
    const additional_telemetry = new gcp.pubsub.Topic("additional-telemetry", {});
    const test_registry = new gcp.iot.Registry("test-registry", {
        eventNotificationConfigs: [
            {
                pubsubTopicName: additional_telemetry.id,
                subfolderMatches: "test/path",
            },
            {
                pubsubTopicName: default_telemetry.id,
                subfolderMatches: "",
            },
        ],
        stateNotificationConfig: {
            pubsub_topic_name: default_devicestatus.id,
        },
        mqttConfig: {
            mqtt_enabled_state: "MQTT_ENABLED",
        },
        httpConfig: {
            http_enabled_state: "HTTP_ENABLED",
        },
        logLevel: "INFO",
        credentials: [{
            publicKeyCertificate: {
                format: "X509_CERTIFICATE_PEM",
                certificate: fs.readFileSync("test-fixtures/rsa_cert.pem"),
            },
        }],
    });
    
    resources:
      default-devicestatus:
        type: gcp:pubsub:Topic
      default-telemetry:
        type: gcp:pubsub:Topic
      additional-telemetry:
        type: gcp:pubsub:Topic
      test-registry:
        type: gcp:iot:Registry
        properties:
          eventNotificationConfigs:
            - pubsubTopicName: ${["additional-telemetry"].id}
              subfolderMatches: test/path
            - pubsubTopicName: ${["default-telemetry"].id}
              subfolderMatches:
          stateNotificationConfig:
            pubsub_topic_name: ${["default-devicestatus"].id}
          mqttConfig:
            mqtt_enabled_state: MQTT_ENABLED
          httpConfig:
            http_enabled_state: HTTP_ENABLED
          logLevel: INFO
          credentials:
            - publicKeyCertificate:
                format: X509_CERTIFICATE_PEM
                certificate:
                  fn::readFile: test-fixtures/rsa_cert.pem
    

    Create Registry Resource

    new Registry(name: string, args?: RegistryArgs, opts?: CustomResourceOptions);
    @overload
    def Registry(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 credentials: Optional[Sequence[RegistryCredentialArgs]] = None,
                 event_notification_configs: Optional[Sequence[RegistryEventNotificationConfigItemArgs]] = None,
                 http_config: Optional[Mapping[str, Any]] = None,
                 log_level: Optional[str] = None,
                 mqtt_config: Optional[Mapping[str, Any]] = None,
                 name: Optional[str] = None,
                 project: Optional[str] = None,
                 region: Optional[str] = None,
                 state_notification_config: Optional[Mapping[str, Any]] = None)
    @overload
    def Registry(resource_name: str,
                 args: Optional[RegistryArgs] = None,
                 opts: Optional[ResourceOptions] = None)
    func NewRegistry(ctx *Context, name string, args *RegistryArgs, opts ...ResourceOption) (*Registry, error)
    public Registry(string name, RegistryArgs? args = null, CustomResourceOptions? opts = null)
    public Registry(String name, RegistryArgs args)
    public Registry(String name, RegistryArgs args, CustomResourceOptions options)
    
    type: gcp:kms:Registry
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args RegistryArgs
    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 RegistryArgs
    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 RegistryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RegistryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RegistryArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Credentials List<RegistryCredentialArgs>

    List of public key certificates to authenticate devices. The structure is documented below.

    EventNotificationConfigs List<RegistryEventNotificationConfigItemArgs>

    List of configurations for event notifications, such as PubSub topics to publish device events to. Structure is documented below.

    HttpConfig Dictionary<string, object>

    Activate or deactivate HTTP. The structure is documented below.

    LogLevel string

    The default logging verbosity for activity from devices in this registry. Specifies which events should be written to logs. For example, if the LogLevel is ERROR, only events that terminate in errors will be logged. LogLevel is inclusive; enabling INFO logging will also enable ERROR logging. Default value is NONE. Possible values are: NONE, ERROR, INFO, DEBUG.

    MqttConfig Dictionary<string, object>

    Activate or deactivate MQTT. The structure is documented below.

    Name string

    A unique name for the resource, required by device registry.


    Project string

    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Region string

    The region in which the created registry should reside. If it is not provided, the provider region is used.

    StateNotificationConfig Dictionary<string, object>

    A PubSub topic to publish device state updates. The structure is documented below.

    Credentials []RegistryCredentialArgs

    List of public key certificates to authenticate devices. The structure is documented below.

    EventNotificationConfigs []RegistryEventNotificationConfigItemArgs

    List of configurations for event notifications, such as PubSub topics to publish device events to. Structure is documented below.

    HttpConfig map[string]interface{}

    Activate or deactivate HTTP. The structure is documented below.

    LogLevel string

    The default logging verbosity for activity from devices in this registry. Specifies which events should be written to logs. For example, if the LogLevel is ERROR, only events that terminate in errors will be logged. LogLevel is inclusive; enabling INFO logging will also enable ERROR logging. Default value is NONE. Possible values are: NONE, ERROR, INFO, DEBUG.

    MqttConfig map[string]interface{}

    Activate or deactivate MQTT. The structure is documented below.

    Name string

    A unique name for the resource, required by device registry.


    Project string

    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Region string

    The region in which the created registry should reside. If it is not provided, the provider region is used.

    StateNotificationConfig map[string]interface{}

    A PubSub topic to publish device state updates. The structure is documented below.

    credentials List<RegistryCredentialArgs>

    List of public key certificates to authenticate devices. The structure is documented below.

    eventNotificationConfigs List<RegistryEventNotificationConfigItemArgs>

    List of configurations for event notifications, such as PubSub topics to publish device events to. Structure is documented below.

    httpConfig Map<String,Object>

    Activate or deactivate HTTP. The structure is documented below.

    logLevel String

    The default logging verbosity for activity from devices in this registry. Specifies which events should be written to logs. For example, if the LogLevel is ERROR, only events that terminate in errors will be logged. LogLevel is inclusive; enabling INFO logging will also enable ERROR logging. Default value is NONE. Possible values are: NONE, ERROR, INFO, DEBUG.

    mqttConfig Map<String,Object>

    Activate or deactivate MQTT. The structure is documented below.

    name String

    A unique name for the resource, required by device registry.


    project String

    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    region String

    The region in which the created registry should reside. If it is not provided, the provider region is used.

    stateNotificationConfig Map<String,Object>

    A PubSub topic to publish device state updates. The structure is documented below.

    credentials RegistryCredentialArgs[]

    List of public key certificates to authenticate devices. The structure is documented below.

    eventNotificationConfigs RegistryEventNotificationConfigItemArgs[]

    List of configurations for event notifications, such as PubSub topics to publish device events to. Structure is documented below.

    httpConfig {[key: string]: any}

    Activate or deactivate HTTP. The structure is documented below.

    logLevel string

    The default logging verbosity for activity from devices in this registry. Specifies which events should be written to logs. For example, if the LogLevel is ERROR, only events that terminate in errors will be logged. LogLevel is inclusive; enabling INFO logging will also enable ERROR logging. Default value is NONE. Possible values are: NONE, ERROR, INFO, DEBUG.

    mqttConfig {[key: string]: any}

    Activate or deactivate MQTT. The structure is documented below.

    name string

    A unique name for the resource, required by device registry.


    project string

    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    region string

    The region in which the created registry should reside. If it is not provided, the provider region is used.

    stateNotificationConfig {[key: string]: any}

    A PubSub topic to publish device state updates. The structure is documented below.

    credentials Sequence[RegistryCredentialArgs]

    List of public key certificates to authenticate devices. The structure is documented below.

    event_notification_configs Sequence[RegistryEventNotificationConfigItemArgs]

    List of configurations for event notifications, such as PubSub topics to publish device events to. Structure is documented below.

    http_config Mapping[str, Any]

    Activate or deactivate HTTP. The structure is documented below.

    log_level str

    The default logging verbosity for activity from devices in this registry. Specifies which events should be written to logs. For example, if the LogLevel is ERROR, only events that terminate in errors will be logged. LogLevel is inclusive; enabling INFO logging will also enable ERROR logging. Default value is NONE. Possible values are: NONE, ERROR, INFO, DEBUG.

    mqtt_config Mapping[str, Any]

    Activate or deactivate MQTT. The structure is documented below.

    name str

    A unique name for the resource, required by device registry.


    project str

    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    region str

    The region in which the created registry should reside. If it is not provided, the provider region is used.

    state_notification_config Mapping[str, Any]

    A PubSub topic to publish device state updates. The structure is documented below.

    credentials List<Property Map>

    List of public key certificates to authenticate devices. The structure is documented below.

    eventNotificationConfigs List<Property Map>

    List of configurations for event notifications, such as PubSub topics to publish device events to. Structure is documented below.

    httpConfig Map<Any>

    Activate or deactivate HTTP. The structure is documented below.

    logLevel String

    The default logging verbosity for activity from devices in this registry. Specifies which events should be written to logs. For example, if the LogLevel is ERROR, only events that terminate in errors will be logged. LogLevel is inclusive; enabling INFO logging will also enable ERROR logging. Default value is NONE. Possible values are: NONE, ERROR, INFO, DEBUG.

    mqttConfig Map<Any>

    Activate or deactivate MQTT. The structure is documented below.

    name String

    A unique name for the resource, required by device registry.


    project String

    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    region String

    The region in which the created registry should reside. If it is not provided, the provider region is used.

    stateNotificationConfig Map<Any>

    A PubSub topic to publish device state updates. The structure is documented below.

    Outputs

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

    Id string

    The provider-assigned unique ID for this managed resource.

    Id string

    The provider-assigned unique ID for this managed resource.

    id String

    The provider-assigned unique ID for this managed resource.

    id string

    The provider-assigned unique ID for this managed resource.

    id str

    The provider-assigned unique ID for this managed resource.

    id String

    The provider-assigned unique ID for this managed resource.

    Look up Existing Registry Resource

    Get an existing Registry 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?: RegistryState, opts?: CustomResourceOptions): Registry
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            credentials: Optional[Sequence[RegistryCredentialArgs]] = None,
            event_notification_configs: Optional[Sequence[RegistryEventNotificationConfigItemArgs]] = None,
            http_config: Optional[Mapping[str, Any]] = None,
            log_level: Optional[str] = None,
            mqtt_config: Optional[Mapping[str, Any]] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            region: Optional[str] = None,
            state_notification_config: Optional[Mapping[str, Any]] = None) -> Registry
    func GetRegistry(ctx *Context, name string, id IDInput, state *RegistryState, opts ...ResourceOption) (*Registry, error)
    public static Registry Get(string name, Input<string> id, RegistryState? state, CustomResourceOptions? opts = null)
    public static Registry get(String name, Output<String> id, RegistryState 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:
    Credentials List<RegistryCredentialArgs>

    List of public key certificates to authenticate devices. The structure is documented below.

    EventNotificationConfigs List<RegistryEventNotificationConfigItemArgs>

    List of configurations for event notifications, such as PubSub topics to publish device events to. Structure is documented below.

    HttpConfig Dictionary<string, object>

    Activate or deactivate HTTP. The structure is documented below.

    LogLevel string

    The default logging verbosity for activity from devices in this registry. Specifies which events should be written to logs. For example, if the LogLevel is ERROR, only events that terminate in errors will be logged. LogLevel is inclusive; enabling INFO logging will also enable ERROR logging. Default value is NONE. Possible values are: NONE, ERROR, INFO, DEBUG.

    MqttConfig Dictionary<string, object>

    Activate or deactivate MQTT. The structure is documented below.

    Name string

    A unique name for the resource, required by device registry.


    Project string

    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Region string

    The region in which the created registry should reside. If it is not provided, the provider region is used.

    StateNotificationConfig Dictionary<string, object>

    A PubSub topic to publish device state updates. The structure is documented below.

    Credentials []RegistryCredentialArgs

    List of public key certificates to authenticate devices. The structure is documented below.

    EventNotificationConfigs []RegistryEventNotificationConfigItemArgs

    List of configurations for event notifications, such as PubSub topics to publish device events to. Structure is documented below.

    HttpConfig map[string]interface{}

    Activate or deactivate HTTP. The structure is documented below.

    LogLevel string

    The default logging verbosity for activity from devices in this registry. Specifies which events should be written to logs. For example, if the LogLevel is ERROR, only events that terminate in errors will be logged. LogLevel is inclusive; enabling INFO logging will also enable ERROR logging. Default value is NONE. Possible values are: NONE, ERROR, INFO, DEBUG.

    MqttConfig map[string]interface{}

    Activate or deactivate MQTT. The structure is documented below.

    Name string

    A unique name for the resource, required by device registry.


    Project string

    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Region string

    The region in which the created registry should reside. If it is not provided, the provider region is used.

    StateNotificationConfig map[string]interface{}

    A PubSub topic to publish device state updates. The structure is documented below.

    credentials List<RegistryCredentialArgs>

    List of public key certificates to authenticate devices. The structure is documented below.

    eventNotificationConfigs List<RegistryEventNotificationConfigItemArgs>

    List of configurations for event notifications, such as PubSub topics to publish device events to. Structure is documented below.

    httpConfig Map<String,Object>

    Activate or deactivate HTTP. The structure is documented below.

    logLevel String

    The default logging verbosity for activity from devices in this registry. Specifies which events should be written to logs. For example, if the LogLevel is ERROR, only events that terminate in errors will be logged. LogLevel is inclusive; enabling INFO logging will also enable ERROR logging. Default value is NONE. Possible values are: NONE, ERROR, INFO, DEBUG.

    mqttConfig Map<String,Object>

    Activate or deactivate MQTT. The structure is documented below.

    name String

    A unique name for the resource, required by device registry.


    project String

    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    region String

    The region in which the created registry should reside. If it is not provided, the provider region is used.

    stateNotificationConfig Map<String,Object>

    A PubSub topic to publish device state updates. The structure is documented below.

    credentials RegistryCredentialArgs[]

    List of public key certificates to authenticate devices. The structure is documented below.

    eventNotificationConfigs RegistryEventNotificationConfigItemArgs[]

    List of configurations for event notifications, such as PubSub topics to publish device events to. Structure is documented below.

    httpConfig {[key: string]: any}

    Activate or deactivate HTTP. The structure is documented below.

    logLevel string

    The default logging verbosity for activity from devices in this registry. Specifies which events should be written to logs. For example, if the LogLevel is ERROR, only events that terminate in errors will be logged. LogLevel is inclusive; enabling INFO logging will also enable ERROR logging. Default value is NONE. Possible values are: NONE, ERROR, INFO, DEBUG.

    mqttConfig {[key: string]: any}

    Activate or deactivate MQTT. The structure is documented below.

    name string

    A unique name for the resource, required by device registry.


    project string

    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    region string

    The region in which the created registry should reside. If it is not provided, the provider region is used.

    stateNotificationConfig {[key: string]: any}

    A PubSub topic to publish device state updates. The structure is documented below.

    credentials Sequence[RegistryCredentialArgs]

    List of public key certificates to authenticate devices. The structure is documented below.

    event_notification_configs Sequence[RegistryEventNotificationConfigItemArgs]

    List of configurations for event notifications, such as PubSub topics to publish device events to. Structure is documented below.

    http_config Mapping[str, Any]

    Activate or deactivate HTTP. The structure is documented below.

    log_level str

    The default logging verbosity for activity from devices in this registry. Specifies which events should be written to logs. For example, if the LogLevel is ERROR, only events that terminate in errors will be logged. LogLevel is inclusive; enabling INFO logging will also enable ERROR logging. Default value is NONE. Possible values are: NONE, ERROR, INFO, DEBUG.

    mqtt_config Mapping[str, Any]

    Activate or deactivate MQTT. The structure is documented below.

    name str

    A unique name for the resource, required by device registry.


    project str

    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    region str

    The region in which the created registry should reside. If it is not provided, the provider region is used.

    state_notification_config Mapping[str, Any]

    A PubSub topic to publish device state updates. The structure is documented below.

    credentials List<Property Map>

    List of public key certificates to authenticate devices. The structure is documented below.

    eventNotificationConfigs List<Property Map>

    List of configurations for event notifications, such as PubSub topics to publish device events to. Structure is documented below.

    httpConfig Map<Any>

    Activate or deactivate HTTP. The structure is documented below.

    logLevel String

    The default logging verbosity for activity from devices in this registry. Specifies which events should be written to logs. For example, if the LogLevel is ERROR, only events that terminate in errors will be logged. LogLevel is inclusive; enabling INFO logging will also enable ERROR logging. Default value is NONE. Possible values are: NONE, ERROR, INFO, DEBUG.

    mqttConfig Map<Any>

    Activate or deactivate MQTT. The structure is documented below.

    name String

    A unique name for the resource, required by device registry.


    project String

    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    region String

    The region in which the created registry should reside. If it is not provided, the provider region is used.

    stateNotificationConfig Map<Any>

    A PubSub topic to publish device state updates. The structure is documented below.

    Supporting Types

    RegistryCredential

    PublicKeyCertificate Dictionary<string, object>

    A public key certificate format and data.

    PublicKeyCertificate map[string]interface{}

    A public key certificate format and data.

    publicKeyCertificate Map<String,Object>

    A public key certificate format and data.

    publicKeyCertificate {[key: string]: any}

    A public key certificate format and data.

    public_key_certificate Mapping[str, Any]

    A public key certificate format and data.

    publicKeyCertificate Map<Any>

    A public key certificate format and data.

    RegistryEventNotificationConfigItem

    PubsubTopicName string

    PubSub topic name to publish device events.

    SubfolderMatches string

    If the subfolder name matches this string exactly, this configuration will be used. The string must not include the leading '/' character. If empty, all strings are matched. Empty value can only be used for the last event_notification_configs item.

    PubsubTopicName string

    PubSub topic name to publish device events.

    SubfolderMatches string

    If the subfolder name matches this string exactly, this configuration will be used. The string must not include the leading '/' character. If empty, all strings are matched. Empty value can only be used for the last event_notification_configs item.

    pubsubTopicName String

    PubSub topic name to publish device events.

    subfolderMatches String

    If the subfolder name matches this string exactly, this configuration will be used. The string must not include the leading '/' character. If empty, all strings are matched. Empty value can only be used for the last event_notification_configs item.

    pubsubTopicName string

    PubSub topic name to publish device events.

    subfolderMatches string

    If the subfolder name matches this string exactly, this configuration will be used. The string must not include the leading '/' character. If empty, all strings are matched. Empty value can only be used for the last event_notification_configs item.

    pubsub_topic_name str

    PubSub topic name to publish device events.

    subfolder_matches str

    If the subfolder name matches this string exactly, this configuration will be used. The string must not include the leading '/' character. If empty, all strings are matched. Empty value can only be used for the last event_notification_configs item.

    pubsubTopicName String

    PubSub topic name to publish device events.

    subfolderMatches String

    If the subfolder name matches this string exactly, this configuration will be used. The string must not include the leading '/' character. If empty, all strings are matched. Empty value can only be used for the last event_notification_configs item.

    Import

    DeviceRegistry can be imported using any of these accepted formats

     $ pulumi import gcp:kms/registry:Registry default {{project}}/locations/{{region}}/registries/{{name}}
    
     $ pulumi import gcp:kms/registry:Registry default {{project}}/{{region}}/{{name}}
    
     $ pulumi import gcp:kms/registry:Registry default {{region}}/{{name}}
    
     $ pulumi import gcp:kms/registry:Registry default {{name}}
    

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the google-beta Terraform Provider.

    gcp logo
    Google Cloud Classic v6.58.0 published on Tuesday, Jun 6, 2023 by Pulumi