Updated June 28, 2023

Terraform module to deploy a Bypass Censorship Redirector in AWS.


provider "aws" {
  region = "us-east-2"

provider "aws" {
  alias  = "acm"
  region = "us-east-1"

resource "random_password" "secret_key" {
  length  = 43
  special = false

module "redirector" {
  providers = {
    aws     = aws,
    aws.acm = aws.acm
  source                    = "sr2c/bc-redirector/aws"
  # TODO: version           = "x.x.x"
  namespace                 = "eg"
  name                      = "redirector"
  default_redirector_domain = "example.com"

  entry_points = [

  public_key   = var.public_key
  secret_key   = random_password.secret_key.result
  update_key   = var.update_key


terraform>= 1.3.0
aws>= 4.48.0, < 5.0.0
cloudinit>= 2.2.0
random>= 3.4.3






aws_ami.ubuntudata source
aws_availability_zones.availabledata source
aws_subnet.firstdata source
aws_subnet.seconddata source
aws_vpc.defaultdata source
cloudinit_config.thisdata source


additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
attributesID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.
contextSingle object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
“additional_tag_map”: {},
“attributes”: [],
“delimiter”: null,
“descriptor_formats”: {},
“enabled”: true,
“environment”: null,
“id_length_limit”: null,
“label_key_case”: null,
“label_order”: [],
“label_value_case”: null,
“labels_as_tags”: [
“name”: null,
“namespace”: null,
“regex_replace_chars”: null,
“stage”: null,
“tags”: {},
“tenant”: null
default_redirector_domainDefault domain name to use for short links where a pool does not have a dedicated redirector domain.stringn/ayes
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br> format = string<br> labels = list(string)<br>}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).
enabledSet to false to prevent the module from creating any resourcesboolnullno
entry_pointsList of domain names to present the redirector at.list(string)n/ayes
environmentID element. Usually used for region e.g. ‘uw2’, ‘us-west-2’, OR role ‘prod’, ‘staging’, ‘dev’, ‘UAT’stringnullno
id_length_limitLimit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.
label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.
label_orderThe order in which the labels (ID elements) appear in the id.
Defaults to [“namespace”, “environment”, “stage”, “name”, “attributes”].
You can omit any of the 6 labels (“tenant” is the 6th), but at least one must be present.
label_value_caseControls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.
labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
maxmind_account_idMaxMind account ID of an account with at least a GeoIP2 Country subscription.stringn/ayes
maxmind_licence_keyMaxMind licence key of an account with at least a GeoIP2 Country subscription.stringn/ayes
mirror_countriesList of ISO 3166-2 country codes for countries where a mirror is required.list(string)n/ayes
nameID element. Usually the component or solution name, e.g. ‘app’ or ‘jenkins’.
This is the only ID element not also included as a tag.
The “name” tag is set to the full id string. There is no tag with the value of the name input.
namespaceID element. Usually an abbreviation of your organization name, e.g. ’eg’ or ‘cp’, to help ensure generated IDs are globally uniquestringnullno
public_keyAPI key of the public pool from the Bypass Censorship portal.stringn/ayes
regex_replace_charsTerraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.
secret_keySecret key used for Flask sessions and hash ID generation. WARNING: changing this in a deployment will cause all
existing short URLs to break.
stageID element. Usually used to indicate role, e.g. ‘prod’, ‘staging’, ‘source’, ‘build’, ’test’, ‘deploy’, ‘release’stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
update_keyUpdate key that will be used by the Bypass Censorship portal to authenticate updates.stringn/ayes


No outputs.