Identical to random_string with the exception that the result is treated as sensitive and, thus, _not_ displayed in console output. Read more about sensitive data handling in the Terraform documentation.
This resource does use a cryptographic random number generator.
// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
import { Construct } from "constructs";
import { TerraformStack } from "cdktf";
/*
* Provider bindings are generated by running `cdktf get`.
* See https://cdk.tf/provider-generation for more details.
*/
import { DbInstance } from "./.gen/providers/aws/db-instance";
import { Password } from "./.gen/providers/random/password";
class MyConvertedCode extends TerraformStack {
constructor(scope: Construct, name: string) {
super(scope, name);
const password = new Password(this, "password", {
length: 16,
overrideSpecial: "!#$%&*()-_=+[]{}<>:?",
special: true,
});
new DbInstance(this, "example", {
allocatedStorage: 64,
engine: "mysql",
instanceClass: "db.t3.micro",
password: password.result,
username: "someone",
});
}
}
length
(Number) The length of the string desired. The minimum value for length is 1 and, length must also be >= (minUpper
+ minLower
+ minNumeric
+ minSpecial
).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
.minLower
(Number) Minimum number of lowercase alphabet characters in the result. Default value is 0
.minNumeric
(Number) Minimum number of numeric characters in the result. Default value is 0
.minSpecial
(Number) Minimum number of special characters in the result. Default value is 0
.minUpper
(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
. NOTE: This is deprecated, use numeric
instead.numeric
(Boolean) Include numeric characters in the result. Default value is true
.overrideSpecial
(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
.bcryptHash
(String, Sensitive) A bcrypt hash of the generated random string. NOTE: If the generated random string is greater than 72 bytes in length, bcryptHash
will contain a hash of the first 72 bytes.id
(String) A static value used internally by Terraform, this should not be referenced in configurations.result
(String, Sensitive) The generated random string.Import is supported using the following syntax:
terraform import random_password.password securepassword
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
import { Construct } from "constructs";
import { TerraformStack } from "cdktf";
/*
* Provider bindings are generated by running `cdktf get`.
* See https://cdk.tf/provider-generation for more details.
*/
import { Password } from "./.gen/providers/random/password";
class MyConvertedCode extends TerraformStack {
constructor(scope: Construct, name: string) {
super(scope, name);
new Password(this, "password", {
length: 16,
lower: false,
});
}
}
Then importing the resource using terraform import random_password.password securepassword
,
would result in the triggering of a replacement (i.e., destroy-create) during the next
terraform apply
.
If the resource were imported using terraform import random_password.password securepassword
,
replacement could be avoided by using:
Attribute values that match the imported ID and defaults:
```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; import { TerraformStack } from "cdktf"; /*
cdktf get
.
2. Attribute values that match the imported ID and omit the attributes with defaults:
```typescript
// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
import { Construct } from "constructs";
import { TerraformStack } from "cdktf";
/*
* Provider bindings are generated by running `cdktf get`.
* See https://cdk.tf/provider-generation for more details.
*/
import { Password } from "./.gen/providers/random/password";
class MyConvertedCode extends TerraformStack {
constructor(scope: Construct, name: string) {
super(scope, name);
new Password(this, "password", {
length: 14,
});
}
}
ignore_changes
specifying the attributes to ignore:
```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; import { TerraformStack } from "cdktf"; /*
cdktf get
.```
**NOTE** `ignore_changes` is only required until the resource is recreated after import,
after which it will use the configuration values specified.