Skip to content

azurermStorageSyncGroup

Manages a Storage Sync Group.

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 azurermStorageSyncExample = new azurerm.storageSync.StorageSync(
  this,
  "example_2",
  {
    location: azurermResourceGroupExample.location,
    name: "example-ss",
    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.*/
azurermStorageSyncExample.overrideLogicalId("example");
const azurermStorageSyncGroupExample =
  new azurerm.storageSyncGroup.StorageSyncGroup(this, "example_3", {
    name: "example-ss-group",
    storage_sync_id: azurermStorageSyncExample.id,
  });
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermStorageSyncGroupExample.overrideLogicalId("example");

Arguments Reference

The following arguments are supported:

  • name - (Required) The name which should be used for this Storage Sync Group. Changing this forces a new Storage Sync Group to be created.

  • storageSyncId - (Required) The resource ID of the Storage Sync where this Storage Sync Group is. Changing this forces a new Storage Sync Group to be created.

Attributes Reference

In addition to the Arguments listed above - the following Attributes are exported:

  • id - The ID of the Storage Sync Group.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • create - (Defaults to 30 minutes) Used when creating the Storage Sync Group.
  • read - (Defaults to 5 minutes) Used when retrieving the Storage Sync Group.
  • delete - (Defaults to 30 minutes) Used when deleting the Storage Sync Group.

Import

Storage Sync Groups can be imported using the resourceId, e.g.

terraform import azurerm_storage_sync_group.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resGroup1/providers/Microsoft.StorageSync/storageSyncServices/sync1/syncGroups/group1