Registry

A Google Cloud IoT Core device registry.

To get more information about DeviceRegistry, see:

API documentation
How-to Guides
- Official Documentation

Create a Registry Resource

new Registry(name: string, args?: RegistryArgs, opts?: CustomResourceOptions);

def Registry(resource_name, opts=None, credentials=None, event_notification_configs=None, http_config=None, log_level=None, mqtt_config=None, name=None, project=None, region=None, state_notification_config=None, __props__=None);

func NewRegistry(ctx *Context, name string, args *RegistryArgs, opts ...ResourceOption) (*Registry, error)

public Registry(string name, RegistryArgs? args = null, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Registry Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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 RegistryHttpConfigArgs: 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.
MqttConfig RegistryMqttConfigArgs: 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 RegistryStateNotificationConfigArgs: A PubSub topic to publish device state updates. The structure is documented below.

Credentials []RegistryCredential: List of public key certificates to authenticate devices. The structure is documented below.
EventNotificationConfigs []RegistryEventNotificationConfigItem: List of configurations for event notifications, such as PubSub topics to publish device events to. Structure is documented below.
HttpConfig RegistryHttpConfig: 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.
MqttConfig RegistryMqttConfig: 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 RegistryStateNotificationConfig: A PubSub topic to publish device state updates. The structure is documented below.

credentials RegistryCredential[]: List of public key certificates to authenticate devices. The structure is documented below.
eventNotificationConfigs RegistryEventNotificationConfigItem[]: List of configurations for event notifications, such as PubSub topics to publish device events to. Structure is documented below.
httpConfig RegistryHttpConfig: 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.
mqttConfig RegistryMqttConfig: 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 RegistryStateNotificationConfig: A PubSub topic to publish device state updates. The structure is documented below.

credentials List[RegistryCredential]: List of public key certificates to authenticate devices. The structure is documented below.
event_notification_configs List[RegistryEventNotificationConfigItem]: List of configurations for event notifications, such as PubSub topics to publish device events to. Structure is documented below.
http_config Dict[RegistryHttpConfig]: 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.
mqtt_config Dict[RegistryMqttConfig]: 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 Dict[RegistryStateNotificationConfig]: 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 str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, credentials=None, event_notification_configs=None, http_config=None, log_level=None, mqtt_config=None, name=None, project=None, region=None, state_notification_config=None, __props__=None);

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)

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.

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 RegistryHttpConfigArgs: 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.
MqttConfig RegistryMqttConfigArgs: 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 RegistryStateNotificationConfigArgs: A PubSub topic to publish device state updates. The structure is documented below.

Credentials []RegistryCredential: List of public key certificates to authenticate devices. The structure is documented below.
EventNotificationConfigs []RegistryEventNotificationConfigItem: List of configurations for event notifications, such as PubSub topics to publish device events to. Structure is documented below.
HttpConfig RegistryHttpConfig: 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.
MqttConfig RegistryMqttConfig: 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 RegistryStateNotificationConfig: A PubSub topic to publish device state updates. The structure is documented below.

credentials RegistryCredential[]: List of public key certificates to authenticate devices. The structure is documented below.
eventNotificationConfigs RegistryEventNotificationConfigItem[]: List of configurations for event notifications, such as PubSub topics to publish device events to. Structure is documented below.
httpConfig RegistryHttpConfig: 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.
mqttConfig RegistryMqttConfig: 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 RegistryStateNotificationConfig: A PubSub topic to publish device state updates. The structure is documented below.

credentials List[RegistryCredential]: List of public key certificates to authenticate devices. The structure is documented below.
event_notification_configs List[RegistryEventNotificationConfigItem]: List of configurations for event notifications, such as PubSub topics to publish device events to. Structure is documented below.
http_config Dict[RegistryHttpConfig]: 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.
mqtt_config Dict[RegistryMqttConfig]: 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 Dict[RegistryStateNotificationConfig]: A PubSub topic to publish device state updates. The structure is documented below.

Supporting Types

RegistryCredential

See the input and output API doc for this type.

PublicKeyCertificate RegistryCredentialPublicKeyCertificateArgs: A public key certificate format and data.

PublicKeyCertificate RegistryCredentialPublicKeyCertificate: A public key certificate format and data.

publicKeyCertificate RegistryCredentialPublicKeyCertificate: A public key certificate format and data.

publicKeyCertificate Dict[RegistryCredentialPublicKeyCertificate]: A public key certificate format and data.

RegistryCredentialPublicKeyCertificate

See the input and output API doc for this type.

Certificate string: The certificate data.
Format string: The field allows only X509_CERTIFICATE_PEM.

Certificate string: The certificate data.
Format string: The field allows only X509_CERTIFICATE_PEM.

certificate string: The certificate data.
format string: The field allows only X509_CERTIFICATE_PEM.

certificate str: The certificate data.
format str: The field allows only X509_CERTIFICATE_PEM.

RegistryEventNotificationConfigItem

See the input and output API doc for this type.

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.
subfolderMatches 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.

RegistryHttpConfig

See the input and output API doc for this type.

HttpEnabledState string: The field allows HTTP_ENABLED or HTTP_DISABLED.

HttpEnabledState string: The field allows HTTP_ENABLED or HTTP_DISABLED.

httpEnabledState string: The field allows HTTP_ENABLED or HTTP_DISABLED.

http_enabled_state str: The field allows HTTP_ENABLED or HTTP_DISABLED.

RegistryMqttConfig

See the input and output API doc for this type.

MqttEnabledState string: The field allows MQTT_ENABLED or MQTT_DISABLED.

MqttEnabledState string: The field allows MQTT_ENABLED or MQTT_DISABLED.

mqttEnabledState string: The field allows MQTT_ENABLED or MQTT_DISABLED.

mqtt_enabled_state str: The field allows MQTT_ENABLED or MQTT_DISABLED.

RegistryStateNotificationConfig

See the input and output API doc for this type.

PubsubTopicName string: PubSub topic name to publish device events.

PubsubTopicName string: PubSub topic name to publish device events.

pubsubTopicName string: PubSub topic name to publish device events.

pubsub_topic_name str: PubSub topic name to publish device events.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Registry

Create a Registry Resource

Registry Resource Properties

Inputs

Outputs

Look up an Existing Registry Resource

Supporting Types

RegistryCredential

RegistryCredentialPublicKeyCertificate

RegistryEventNotificationConfigItem

RegistryHttpConfig

RegistryMqttConfig

RegistryStateNotificationConfig

Package Details

On This Page