string.md

page_title	subcategory	description
random_string Resource - terraform-provider-random		The resource random_string generates a random permutation of alphanumeric characters and optionally special characters. This resource does use a cryptographic random number generator. Historically this resource's intended usage has been ambiguous as the original example used it in a password. For backwards compatibility it will continue to exist. For unique ids please use random_id id.html, for sensitive random values please use random_password password.html.

random_string (Resource)

The resource random_string generates a random permutation of alphanumeric characters and optionally special characters.

This resource does use a cryptographic random number generator.

Historically this resource's intended usage has been ambiguous as the original example used it in a password. For backwards compatibility it will continue to exist. For unique ids please use random_id, for sensitive random values please use random_password.

Example Usage

resource "random_string" "random" {
  length           = 16
  special          = true
  override_special = "/@£$"
}

Schema

Required

• length (Number) The length of the string desired. The minimum value for length is 1 and, length must also be >= (min_upper + min_lower + min_numeric + min_special).

Optional

• keepers (Map of String) Arbitrary map of values that, when changed, will trigger recreation of resource. See the main provider documentation for more information.
• lower (Boolean) Include lowercase alphabet characters in the result. Default value is true.
• min_lower (Number) Minimum number of lowercase alphabet characters in the result. Default value is 0.
• min_numeric (Number) Minimum number of numeric characters in the result. Default value is 0.
• min_special (Number) Minimum number of special characters in the result. Default value is 0.
• min_upper (Number) Minimum number of uppercase alphabet characters in the result. Default value is 0.
• number (Boolean, Deprecated) Include numeric characters in the result. Default value is true. If number, upper, lower, and special are all configured, at least one of them must be set to true. NOTE: This is deprecated, use numeric instead.
• numeric (Boolean) Include numeric characters in the result. Default value is true. If numeric, upper, lower, and special are all configured, at least one of them must be set to true.
• override_special (String) Supply your own list of special characters to use for string generation. This overrides the default character list in the special argument. The special argument must still be set to true for any overwritten characters to be used in generation.
• special (Boolean) Include special characters in the result. These are !@#$%&*()-_=+[]{}<>:?. Default value is true.
• upper (Boolean) Include uppercase alphabet characters in the result. Default value is true.

Read-Only

• id (String) The generated random string.
• result (String) The generated random string.

Import

Import is supported using the following syntax:

terraform import random_string.test test

Limitations of Import

Any attribute values that are specified within Terraform config will be ignored during import and all attributes that have defaults defined within the schema will have the default assigned.

For instance, using the following config during import:

resource "random_string" "test" {
  length = 16
  lower  = false
}

Then importing the resource using terraform import random_string.test test, would result in the triggering of a replacement (i.e., destroy-create) during the next terraform apply.

Avoiding Replacement

If the resource were imported using terraform import random_string.test test, replacement can be avoided by using:

1. Attribute values that match the imported ID and defaults:

   resource "random_string" "test" {
     length = 4
     lower  = true
   }

2. Attribute values that match the imported ID and omit the attributes with defaults:

   resource "random_string" "test" {
     length = 4
   }

3. ignore_changes specifying the attributes to ignore:

   resource "random_string" "test" {
     length = 16
     lower  = false
   
     lifecycle {
       ignore_changes = [
         length,
         lower,
       ]
     }
   }

   NOTE ignore_changes is only required until the resource is recreated after import, after which it will use the configuration values specified.