alicloud_ecs_auto_snapshot_policy_Terraform(Terraform)-阿里云帮助中心

Provides a ECS Auto Snapshot Policy resource.

For information about ECS Auto Snapshot Policy and how to use it, see What is Auto Snapshot Policy.

-> NOTE: Available since v1.117.0.

Example Usage

Basic Usage

resource "alicloud_ecs_auto_snapshot_policy" "example" {
  name            = "terraform-example"
  repeat_weekdays = ["1", "2", "3"]
  retention_days  = -1
  time_points     = ["1", "22", "23"]
}

Argument Reference

The following arguments are supported:

auto_snapshot_policy_name - (Optional, Available since v1.236.0) The name of the automatic snapshot policy. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).
copied_snapshots_retention_days - (Optional, Int) The retention period of the snapshot copy in the destination region. Unit: days. Valid values:
- -1: The snapshot copy is retained until it is deleted.
- 1 to 65535: The snapshot copy is retained for the specified number of days. After the retention period of the snapshot copy expires, the snapshot copy is automatically deleted.
copy_encryption_configuration - (Optional, Set, Available since v1.236.0) The encryption parameters for cross-region snapshot replication. See copy_encryption_configuration below.
enable_cross_region_copy - (Optional, Bool) Specifies whether to enable cross-region replication for snapshots. Valid values: true, false.
repeat_weekdays - (Required, List) The days of the week on which to create automatic snapshots. Valid values: 1 to 7, which correspond to the days of the week. For example, 1 indicates Monday. One or more days can be specified.
resource_group_id - (Optional, Available since v1.236.0) The ID of the resource group. If this parameter is specified to query resources, up to 1,000 resources that belong to the specified resource group can be displayed in the response.
retention_days - (Required, Int) The retention period of the automatic snapshots. Unit: days. Valid values:
- -1: Automatic snapshots are retained until they are deleted.
- 1 to 65536: Auto snapshots are retained for the specified number of days. After the retention period of auto snapshots expires, the auto snapshots are automatically deleted.
tags - (Optional, Map) A mapping of tags to assign to the resource.
target_copy_regions - (Optional, List) The destination region to which to copy the snapshot. You can specify only a single destination region.
time_points - (Required, List) The points in time of the day at which to create automatic snapshots.

The time is displayed in UTC+8. Unit: hours. Valid values: 0 to 23, which correspond to the 24 points in time on the hour from 00:00:00 to 23:00:00. For example, 1 indicates 01:00:00. Multiple points in time can be specified.

The parameter value is a JSON array that contains up to 24 points in time separated by commas (,). Example: ["0", "1", ... "23"].

The following arguments will be discarded. Please use new fields as soon as possible:

name - (Deprecated since v1.236.0). Field name has been deprecated from provider version 1.236.0. New field auto_snapshot_policy_name instead.

`copy_encryption_configuration`

The copy_encryption_configuration supports the following:

encrypted - (Optional, Bool) Whether to enable encryption for cross-region snapshot replication. Default value: false. Valid values: true, false.
kms_key_id - (Optional) The ID of the Key Management Service (KMS) key used to encrypt snapshots in cross-region snapshot replication.

Attributes Reference

The following attributes are exported:

id - The resource ID in terraform of Auto Snapshot Policy.
create_time - (Available since v1.236.0) The time when the automatic snapshot policy was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.
region_id - (Available since v1.236.0) The region ID of the automatic snapshot policy.
status - The status of the automatic snapshot policy.

Timeouts

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

create - (Defaults to 5 mins) Used when create the Auto Snapshot Policy.
delete - (Defaults to 5 mins) Used when delete the Auto Snapshot Policy.
update - (Defaults to 5 mins) Used when update the Auto Snapshot Policy.

Import

ECS Auto Snapshot Policy can be imported using the id, e.g.

$ terraform import alicloud_ecs_auto_snapshot_policy.example <id>