diff --git a/docs/data-sources/csbs_backup_policy_v1.md b/docs/data-sources/csbs_backup_policy_v1.md index 2fd1673c..99e1b1f4 100644 --- a/docs/data-sources/csbs_backup_policy_v1.md +++ b/docs/data-sources/csbs_backup_policy_v1.md @@ -20,13 +20,16 @@ data "flexibleengine_csbs_backup_policy_v1" "csbs_policy" { The following arguments are supported: -* `id` - (Optional) Specifies the ID of backup policy. +* `region` - (Optional, String) The region in which to query the data source. If omitted, the provider-level region + will be used. -* `name` - (Optional) Specifies the backup policy name. +* `id` - (Optional, String) Specifies the ID of backup policy. -* `status` - (Optional) Specifies the backup policy status. +* `name` - (Optional, String) Specifies the backup policy name. -## Attributes Reference +* `status` - (Optional, String) Specifies the backup policy status. + +## Attribute Reference In addition to all arguments above, the following attributes are exported: @@ -34,39 +37,46 @@ In addition to all arguments above, the following attributes are exported: * `provider_id` - Provides the Backup provider ID. -* `parameters` - Specifies the parameters of a backup policy. +* `common` - General backup policy parameters, which are blank by default. + +* `scheduled_operation` - Backup plan information. + The [scheduled_operation](#functiongraph_scheduled_operation) object structure is documented below. + +* `resource` - Backup Object. The [resource](#functiongraph_resource) object structure is documented below. -* `scheduled_operation` block supports the following arguments: + +The `scheduled_operation` block supports: - + `name` - Specifies Scheduling period name. +* `name` - Specifies Scheduling period name. - + `description` - Specifies Scheduling period description. +* `description` - Specifies Scheduling period description. - + `enabled` - Specifies whether the scheduling period is enabled. +* `enabled` - Specifies whether the scheduling period is enabled. - + `max_backups` - Specifies maximum number of backups that can be automatically created for a backup object. +* `max_backups` - Specifies maximum number of backups that can be automatically created for a backup object. - + `retention_duration_days` - Specifies duration of retaining a backup, in days. +* `retention_duration_days` - Specifies duration of retaining a backup, in days. - + `permanent` - Specifies whether backups are permanently retained. +* `permanent` - Specifies whether backups are permanently retained. - + `trigger_pattern` - Specifies Scheduling policy of the scheduler. +* `trigger_pattern` - Specifies Scheduling policy of the scheduler. - + `operation_type` - Specifies Operation type, which can be backup. +* `operation_type` - Specifies Operation type, which can be backup. - + `id` - Specifies Scheduling period ID. +* `id` - Specifies Scheduling period ID. - + `trigger_id` - Specifies Scheduler ID. +* `trigger_id` - Specifies Scheduler ID. - + `trigger_name` - Specifies Scheduler name. +* `trigger_name` - Specifies Scheduler name. - + `trigger_type` - Specifies Scheduler type. +* `trigger_type` - Specifies Scheduler type. -* `resource` block supports the following arguments: + +The `resource` block supports: - + `id` - Specifies the ID of the object to be backed up. +* `id` - Specifies the ID of the object to be backed up. - + `type` - Entity object type of the backup object. +* `type` - Entity object type of the backup object. - + `name` - Specifies backup object name. +* `name` - Specifies backup object name. \ No newline at end of file diff --git a/docs/data-sources/csbs_backup_v1.md b/docs/data-sources/csbs_backup_v1.md index 95c1f5b5..c255e5ca 100644 --- a/docs/data-sources/csbs_backup_v1.md +++ b/docs/data-sources/csbs_backup_v1.md @@ -20,25 +20,28 @@ data "flexibleengine_csbs_backup_v1" "csbs" { The following arguments are supported: -* `id` - (Optional) Specifies the ID of backup. +* `region` - (Optional, String) The region in which to query the data source. If omitted, the provider-level region + will be used. -* `backup_name` - (Optional) Specifies the backup name. +* `id` - (Optional, String) Specifies the ID of backup. -* `status` - (Optional) Specifies the backup status. +* `backup_name` - (Optional, String) Specifies the backup name. -* `resource_name` - (Optional) Specifies the backup object name. +* `status` - (Optional, String) Specifies the backup status. -* `backup_record_id` - (Optional) Specifies the backup record ID. +* `resource_name` - (Optional, String) Specifies the backup object name. -* `resource_type` - (Optional) Specifies the type of backup objects. +* `backup_record_id` - (Optional, String) Specifies the backup record ID. -* `resource_id` - (Optional) Specifies the backup object ID. +* `resource_type` - (Optional, String) Specifies the type of backup objects. -* `policy_id` - (Optional) Specifies the Policy Id. +* `resource_id` - (Optional, String) Specifies the backup object ID. -* `vm_ip` - (Optional) Specifies the ip of VM. +* `policy_id` - (Optional, String) Specifies the Policy Id. -## Attributes Reference +* `vm_ip` - (Optional, String) Specifies the ip of VM. + +## Attribute Reference In addition to all arguments above, the following attributes are exported: @@ -50,48 +53,54 @@ In addition to all arguments above, the following attributes are exported: * `size` - Specifies the backup capacity. -* `volume_backups` - block supports the following arguments: +* `volume_backups` - The [volume_backups](#functiongraph_volume_backups) object structure is documented below. + +* `vm_metadata` - The [vm_metadata](#functiongraph_vm_metadata) object structure is documented below. + + +The `volume_backups` block supports: - + `status` - Status of backup Volume. +* `status` - Status of backup Volume. - + `space_saving_ratio` - Specifies the space saving rate. +* `space_saving_ratio` - Specifies the space saving rate. - + `name` - It gives EVS disk backup name. +* `name` - It gives EVS disk backup name. - + `bootable` - Specifies whether the disk is bootable. +* `bootable` - Specifies whether the disk is bootable. - + `average_speed` - Specifies the average speed. +* `average_speed` - Specifies the average speed. - + `source_volume_size` - Shows source volume size in GB. +* `source_volume_size` - Shows source volume size in GB. - + `source_volume_id` - It specifies source volume ID. +* `source_volume_id` - It specifies source volume ID. - + `incremental` - Shows whether incremental backup is used. +* `incremental` - Shows whether incremental backup is used. - + `snapshot_id` - ID of snapshot. +* `snapshot_id` - ID of snapshot. - + `source_volume_name` - Specifies source volume name. +* `source_volume_name` - Specifies source volume name. - + `image_type` - It specifies backup. The default value is backup. +* `image_type` - It specifies backup. The default value is backup. - + `id` - Specifies Cinder backup ID. +* `id` - Specifies Cinder backup ID. - + `size` - Specifies accumulated size (MB) of backups. +* `size` - Specifies accumulated size (MB) of backups. -* `vm_metadata` - block supports the following arguments: + +The `vm_metadata` block supports: - + `name` - Name of backup data. +* `name` - Name of backup data. - + `eip` - Specifies elastic IP address of the ECS. +* `eip` - Specifies elastic IP address of the ECS. - + `cloud_service_type` - Specifies ECS type. +* `cloud_service_type` - Specifies ECS type. - + `ram` - Specifies memory size of the ECS, in MB. +* `ram` - Specifies memory size of the ECS, in MB. - + `vcpus` - Specifies CPU cores corresponding to the ECS. +* `vcpus` - Specifies CPU cores corresponding to the ECS. - + `private_ip` - It specifies internal IP address of the ECS. +* `private_ip` - It specifies internal IP address of the ECS. - + `disk` - Shows system disk size corresponding to the ECS specifications. +* `disk` - Shows system disk size corresponding to the ECS specifications. - + `image_type` - Specifies image type. +* `image_type` - Specifies image type. diff --git a/docs/resources/csbs_backup_policy_v1.md b/docs/resources/csbs_backup_policy_v1.md index 50df43da..168a6eb9 100644 --- a/docs/resources/csbs_backup_policy_v1.md +++ b/docs/resources/csbs_backup_policy_v1.md @@ -34,45 +34,51 @@ Provides a FlexibleEngine Backup Policy of Resources. The following arguments are supported: -* `name` - (Required) Specifies the name of backup policy. The value consists of 1 to 255 characters and +* `region` - (Optional, String, ForceNew) Specifies the region in which to create the CSBS backup policy resource. + If omitted, the provider-level region will be used. Changing this will create a new CSBS backup policy resource. + +* `name` - (Required, String) Specifies the name of backup policy. The value consists of 1 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-). -* `description` - (Optional) Backup policy description. The value consists of 0 to 255 characters and +* `description` - (Optional, String) Backup policy description. The value consists of 0 to 255 characters and must not contain a greater-than sign (>) or less-than sign (<). -* `provider_id` - (Required) Specifies backup provider ID. Default value is **fc4d5750-22e7-4798-8a46-f48f62c4c1da** +* `provider_id` - (Required, String, ForceNew) Specifies backup provider ID. Default value is + **fc4d5750-22e7-4798-8a46-f48f62c4c1da** -* `common` - (Optional) General backup policy parameters, which are blank by default. +* `common` - (Optional, Map) General backup policy parameters, which are blank by default. -* `scheduled_operation` block supports the following arguments: +* `scheduled_operation` - (Required, Set) Backup plan information. - + `name` - (Optional) Specifies Scheduling period name.The value consists of 1 to 255 characters and + + `name` - (Optional, String) Specifies Scheduling period name.The value consists of 1 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-). - + `description` - (Optional) Specifies Scheduling period description.The value consists of 0 to 255 characters and - must not contain a greater-than sign (>) or less-than sign (<). + + `description` - (Optional, String) Specifies Scheduling period description.The value consists of 0 to 255 + characters and must not contain a greater-than sign (>) or less-than sign (<). - + `enabled` - (Optional) Specifies whether the scheduling period is enabled. Default value is **true** + + `enabled` - (Optional, Bool) Specifies whether the scheduling period is enabled. Default value is **true**. - + `max_backups` - (Optional) Specifies maximum number of backups that can be automatically created for a backup object. + + `max_backups` - (Optional, Int) Specifies maximum number of backups that can be automatically created for a + backup object. - + `retention_duration_days` - (Optional) Specifies duration of retaining a backup, in days. + + `retention_duration_days` - (Optional, Int) Specifies duration of retaining a backup, in days. - + `permanent` - (Optional) Specifies whether backups are permanently retained. + + `permanent` - (Optional, Bool) Specifies whether backups are permanently retained. - + `trigger_pattern` - (Required) Specifies Scheduling policy of the scheduler. + + `trigger_pattern` - (Required, String) Specifies Scheduling policy of the scheduler. - + `operation_type` - (Required) Specifies Operation type, which can be backup. + + `operation_type` - (Required, String) Specifies Operation type, which can be backup. -* `resource` block supports the following arguments: +* `resource` - (Required, Set, ForceNew) Backup Object. - + `id` - (Required) Specifies the ID of the object to be backed up. + + `id` - (Required, String) Specifies the ID of the object to be backed up. - + `type` - (Required) Entity object type of the backup object. If the type is VMs, the value is **OS::Nova::Server**. + + `type` - (Required, String) Entity object type of the backup object. + If the type is VMs, the value is **OS::Nova::Server**. - + `name` - (Required) Specifies backup object name. + + `name` - (Required, String) Specifies backup object name. -## Attributes Reference +## Attribute Reference In addition to all arguments above, the following attributes are exported: @@ -80,15 +86,26 @@ In addition to all arguments above, the following attributes are exported: * `id` - Backup Policy ID. -* scheduled_operation - Backup plan information +* `scheduled_operation` - Backup plan information. + The [scheduled_operation](#functiongraph_scheduled_operation) object structure is documented below. + + +The `scheduled_operation` block supports: + +* `id` - Specifies Scheduling period ID. + +* `trigger_id` - Specifies Scheduler ID. + +* `trigger_name` - Specifies Scheduler name. - + `id` - Specifies Scheduling period ID. +* `trigger_type` - Specifies Scheduler type. - + `trigger_id` - Specifies Scheduler ID. +## Timeouts - + `trigger_name` - Specifies Scheduler name. +This resource provides the following timeouts configuration options: - + `trigger_type` - Specifies Scheduler type. +* `create` - Default is 10 minutes. +* `delete` - Default is 10 minutes. ## Import diff --git a/docs/resources/csbs_backup_v1.md b/docs/resources/csbs_backup_v1.md index c375161e..3cef4600 100644 --- a/docs/resources/csbs_backup_v1.md +++ b/docs/resources/csbs_backup_v1.md @@ -25,18 +25,22 @@ Provides a FlexibleEngine Backup of Resources. The following arguments are supported: -* `backup_name` - (Optional) Name for the backup. The value consists of 1 to 255 characters and can contain - only letters, digits, underscores (_), and hyphens (-). Changing backup_name creates a new backup. +* `region` - (Optional, String, ForceNew) Specifies the region in which to create the CSBS backup resource. + If omitted, the provider-level region will be used. Changing this will create a new CSBS backup resource. -* `description` - (Optional) Backup description. The value consists of 0 to 255 characters and must not contain - a greater-than sign (>) or less-than sign (<). Changing description creates a new backup. +* `backup_name` - (Optional, String, ForceNew) Name for the backup. The value consists of 1 to 255 characters and can + contain only letters, digits, underscores (_), and hyphens (-). Changing backup_name creates a new backup. -* `resource_id` - (Required) ID of the target to which the backup is restored. Changing this creates a new backup. +* `description` - (Optional, String, ForceNew) Backup description. The value consists of 0 to 255 characters and must + not contain a greater-than sign (>) or less-than sign (<). Changing description creates a new backup. -* `resource_type` - (Optional) Type of the target to which the backup is restored. The default value is - **OS::Nova::Server** for an ECS. Changing this creates a new backup. +* `resource_id` - (Required, String, ForceNew) ID of the target to which the backup is restored. + Changing this creates a new backup. -## Attributes Reference +* `resource_type` - (Optional, String, ForceNew) Type of the target to which the backup is restored. The default value + is **OS::Nova::Server** for an ECS. Changing this creates a new backup. + +## Attribute Reference In addition to all arguments above, the following attributes are exported: @@ -44,51 +48,64 @@ In addition to all arguments above, the following attributes are exported: * `backup_record_id` - Specifies backup record ID. -* `volume_backups` block supports the following arguments: +* `volume_backups` - The [volume_backups](#functiongraph_volume_backups) object structure is documented below. + +* `vm_metadata` - The [vm_metadata](#functiongraph_vm_metadata) object structure is documented below. + + +The `volume_backups` block supports: + +* `status` - Status of backup Volume. + +* `space_saving_ratio` - Specifies space saving rate. + +* `name` - It gives EVS disk backup name. - + `status` - Status of backup Volume. +* `bootable` - Specifies whether the disk is bootable. - + `space_saving_ratio` - Specifies space saving rate. +* `average_speed` - Specifies the average speed. - + `name` - It gives EVS disk backup name. +* `source_volume_size` - Shows source volume size in GB. - + `bootable` - Specifies whether the disk is bootable. +* `source_volume_id` - It specifies source volume ID. - + `average_speed` - Specifies the average speed. +* `incremental` - Shows whether incremental backup is used. - + `source_volume_size` - Shows source volume size in GB. +* `snapshot_id` - ID of snapshot. - + `source_volume_id` - It specifies source volume ID. +* `source_volume_name` - Specifies source volume name. - + `incremental` - Shows whether incremental backup is used. +* `image_type` - It specifies backup. The default value is backup. - + `snapshot_id` - ID of snapshot. +* `id` - Specifies Cinder backup ID. - + `source_volume_name` - Specifies source volume name. +* `size` - Specifies accumulated size (MB) of backups. - + `image_type` - It specifies backup. The default value is backup. + +The `vm_metadata` block supports: - + `id` - Specifies Cinder backup ID. +* `name` - Name of backup data. - + `size` - Specifies accumulated size (MB) of backups. +* `eip` - Specifies elastic IP address of the ECS. -* `vm_metadata` block supports the following arguments: +* `cloud_service_type` - Specifies ECS type. - + `name` - Name of backup data. +* `ram` - Specifies memory size of the ECS, in MB. - + `eip` - Specifies elastic IP address of the ECS. +* `vcpus` - Specifies CPU cores corresponding to the ECS. - + `cloud_service_type` - Specifies ECS type. +* `private_ip` - It specifies internal IP address of the ECS. - + `ram` - Specifies memory size of the ECS, in MB. +* `disk` - Shows system disk size corresponding to the ECS specifications. - + `vcpus` - Specifies CPU cores corresponding to the ECS. +* `image_type` - Specifies image type. - + `private_ip` - It specifies internal IP address of the ECS. +## Timeouts - + `disk` - Shows system disk size corresponding to the ECS specifications. +This resource provides the following timeouts configuration options: - + `image_type` - Specifies image type. +* `create` - Default is 30 minutes. +* `delete` - Default is 30 minutes. ## Import