azurermDigitalTwinsInstance
Manages a Digital Twins instance.
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.*/
new azurerm.provider.AzurermProvider(this, "azurerm", {
features: [{}],
});
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
this,
"example",
{
location: "West Europe",
name: "example_resources",
}
);
const azurermDigitalTwinsInstanceExample =
new azurerm.digitalTwinsInstance.DigitalTwinsInstance(this, "example_2", {
location: azurermResourceGroupExample.location,
name: "example-DT",
resource_group_name: azurermResourceGroupExample.name,
tags: {
foo: "bar",
},
});
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermDigitalTwinsInstanceExample.overrideLogicalId("example");
Arguments Reference
The following arguments are supported:
-
name- (Required) The name which should be used for this Digital Twins instance. Changing this forces a new Digital Twins instance to be created. -
resourceGroupName- (Required) The name of the Resource Group where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created. -
location- (Required) The Azure Region where the Digital Twins instance should exist. Changing this forces a new Digital Twins instance to be created.
*
-
identity- (Optional) Anidentityblock as defined below. -
tags- (Optional) A mapping of tags which should be assigned to the Digital Twins instance.
An identity block supports the following:
type- (Required) The type of Managed Service Identity that is configured on this Digital Twins instance. The only possible value issystemAssigned.
Attributes Reference
In addition to the Arguments listed above - the following Attributes are exported:
-
id- The ID of the Digital Twins instance. -
hostName- The API endpoint to work with this Digital Twins instance.
Timeouts
The timeouts block allows you to specify timeouts for certain actions:
create- (Defaults to 30 minutes) Used when creating the Digital Twins instance.read- (Defaults to 5 minutes) Used when retrieving the Digital Twins instance.update- (Defaults to 30 minutes) Used when updating the Digital Twins instance.delete- (Defaults to 30 minutes) Used when deleting the Digital Twins instance.
Import
Digital Twins instances can be imported using the resourceId, e.g.