azurermStreamAnalyticsStreamInputIothub
Manages a Stream Analytics Stream Input IoTHub.
Example Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
this,
"example",
{
location: "West Europe",
name: "example-resources",
}
);
const dataAzurermStreamAnalyticsJobExample =
new azurerm.dataAzurermStreamAnalyticsJob.DataAzurermStreamAnalyticsJob(
this,
"example_1",
{
name: "example-job",
resource_group_name: azurermResourceGroupExample.name,
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
dataAzurermStreamAnalyticsJobExample.overrideLogicalId("example");
const azurermIothubExample = new azurerm.iothub.Iothub(this, "example_2", {
location: azurermResourceGroupExample.location,
name: "example-iothub",
resource_group_name: azurermResourceGroupExample.name,
sku: [
{
capacity: "1",
name: "S1",
},
],
});
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermIothubExample.overrideLogicalId("example");
const azurermStreamAnalyticsStreamInputIothubExample =
new azurerm.streamAnalyticsStreamInputIothub.StreamAnalyticsStreamInputIothub(
this,
"example_3",
{
endpoint: "messages/events",
eventhub_consumer_group_name: "$Default",
iothub_namespace: azurermIothubExample.name,
name: "example-iothub-input",
resource_group_name:
dataAzurermStreamAnalyticsJobExample.resourceGroupName,
serialization: [
{
encoding: "UTF8",
type: "Json",
},
],
shared_access_policy_key: `\${${azurermIothubExample.sharedAccessPolicy.fqn}[0].primary_key}`,
shared_access_policy_name: "iothubowner",
stream_analytics_job_name: dataAzurermStreamAnalyticsJobExample.name,
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermStreamAnalyticsStreamInputIothubExample.overrideLogicalId("example");
Argument Reference
The following arguments are supported:
-
name- (Required) The name of the Stream Input IoTHub. Changing this forces a new resource to be created. -
resourceGroupName- (Required) The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created. -
streamAnalyticsJobName- (Required) The name of the Stream Analytics Job. Changing this forces a new resource to be created. -
eventhubConsumerGroupName- (Required) The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. -
endpoint- (Required) The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.). -
iothubNamespace- (Required) The name or the URI of the IoT Hub. -
serialization- (Required) Aserializationblock as defined below. -
sharedAccessPolicyKey- (Required) The shared access policy key for the specified shared access policy. Changing this forces a new resource to be created. -
sharedAccessPolicyName- (Required) The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc.
A serialization block supports the following:
-
type- (Required) The serialization format used for incoming data streams. Possible values areavro,csvandjson. -
encoding- (Optional) The encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. It currently can only be set toutf8.
-> NOTE: This is required when type is set to csv or json.
fieldDelimiter- (Optional) The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are(space), `,` (comma),(tab),|(pipe) and;.
-> NOTE: This is required when type is set to csv.
Attributes Reference
The following attributes are exported in addition to the arguments listed above:
id- The ID of the Stream Analytics Stream Input IoTHub.
Timeouts
The timeouts block allows you to specify timeouts for certain actions:
create- (Defaults to 30 minutes) Used when creating the Stream Analytics Stream Input IoTHub.update- (Defaults to 30 minutes) Used when updating the Stream Analytics Stream Input IoTHub.read- (Defaults to 5 minutes) Used when retrieving the Stream Analytics Stream Input IoTHub.delete- (Defaults to 30 minutes) Used when deleting the Stream Analytics Stream Input IoTHub.
Import
Stream Analytics Stream Input IoTHub's can be imported using the resourceId, e.g.