alicloud_oss_bucket_referer

Provides a OSS Bucket Referer resource. Bucket Referer configuration (Hotlink protection).

For information about OSS Bucket Referer and how to use it, see What is Bucket Referer.

-> NOTE: Available since v1.220.0.

Example Usage

Basic Usage

variable "name" {
  default = "terraform-example"
}

provider "alicloud" {
  region = "cn-hangzhou"
}

resource "random_integer" "default" {
  min = 10000
  max = 99999
}

resource "alicloud_oss_bucket" "CreateBucket" {
  storage_class = "Standard"
  bucket        = "${var.name}-${random_integer.default.result}"
  lifecycle {
    ignore_changes = [
      referer_config,
    ]
  }
}


resource "alicloud_oss_bucket_referer" "default" {
  depends_on = [alicloud_oss_bucket.CreateBucket]

  allow_empty_referer = "true"
  referer_blacklist = [
    "*.forbidden.com"
  ]
  bucket                      = alicloud_oss_bucket.CreateBucket.bucket
  truncate_path               = "false"
  allow_truncate_query_string = "true"
  referer_list = [
    "*.aliyun.com",
    "*.example.com"
  ]
}

Argument Reference

The following arguments are supported:

• allow_empty_referer - (Required) Whether to allow empty Referer request headers.
• allow_truncate_query_string - (Optional, Computed) Specifies whether to truncate the query string in the URL when the Referer is matched. Valid values: true, false.
• bucket - (Required, ForceNew) Name of the Bucket.
• referer_blacklist - (Optional) The container that holds the Referer blacklist.
• referer_list - (Optional) The container that holds the Referer whitelist.
• truncate_path - (Optional) Specifies whether to truncate the path and parts that follow the path in the URL when the Referer is matched. Valid values: true, false. If TruncatePath is set to true, the value of AllowTruncateQueryString must be also true because the query string follows the path component. When the path is truncated, the query string is also truncated.

Attributes Reference

The following attributes are exported:

• id - The ID of the resource supplied above.

Timeouts

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

• create - (Defaults to 5 mins) Used when create the Bucket Referer.
• delete - (Defaults to 5 mins) Used when delete the Bucket Referer.
• update - (Defaults to 5 mins) Used when update the Bucket Referer.

Import

OSS Bucket Referer can be imported using the id, e.g.

$ terraform import alicloud_oss_bucket_referer.example <id>