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

# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
#
from imports.random.string_resource import StringResource
class MyConvertedCode(TerraformStack):
    def __init__(self, scope, name):
        super().__init__(scope, name)
        StringResource(self, "random",
            length=16,
            override_special="/@£$",
            special=True
        )

Schema

Required

Optional

Read-Only

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:

# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
#
from imports.random.string_resource import StringResource
class MyConvertedCode(TerraformStack):
    def __init__(self, scope, name):
        super().__init__(scope, name)
        StringResource(self, "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: ```python

    DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug

from constructs import Construct from cdktf import TerraformStack #

Provider bindings are generated by running cdktf get.

See https://cdk.tf/provider-generation for more details.

# from imports.random.string_resource import StringResource class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) StringResource(self, "test", length=4, lower=True )


2. Attribute values that match the imported ID and omit the attributes with defaults:
    ```python
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
#
from imports.random.string_resource import StringResource
class MyConvertedCode(TerraformStack):
    def __init__(self, scope, name):
        super().__init__(scope, name)
        StringResource(self, "test",
            length=4
        )
  1. ignore_changes specifying the attributes to ignore: ```python

    DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug

from cdktf import TerraformResourceLifecycle from constructs import Construct from cdktf import TerraformStack #

Provider bindings are generated by running cdktf get.

See https://cdk.tf/provider-generation for more details.

# from imports.random.string_resource import StringResource class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) StringResource(self, "test", length=16, lifecycle=TerraformResourceLifecycle( ignore_changes=[length, lower] ), lower=False ) ```

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