-
Notifications
You must be signed in to change notification settings - Fork 119
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
cdktf: update index.md,resources/uuid.md,resources/string.md,resource…
…s/shuffle.md,resources/pet.md,resources/password.md,resources/integer.md,resources/id.md,resources/bytes.md,ephemeral-resources/password.md (#652)
- Loading branch information
1 parent
ca14b1b
commit 445c056
Showing
4 changed files
with
127 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
--- | ||
|
||
<!-- Please do not edit this file, it is generated. --> | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "random_password Ephemeral Resource - terraform-provider-random" | ||
subcategory: "" | ||
description: |- | ||
-> If the managed resource doesn't have a write-only attribute available for the password (first introduced in Terraform 1.11), then the password can only be created with the managed resource variant of random_password https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password. | ||
Generates an ephemeral password string using a cryptographic random number generator. | ||
The primary use-case for generating an ephemeral random password is to be used in combination with a write-only attribute in a managed resource, which will avoid Terraform storing the password string in the plan or state file. | ||
--- | ||
|
||
# random_password (Ephemeral Resource) | ||
|
||
-> If the managed resource doesn't have a write-only attribute available for the password (first introduced in Terraform 1.11), then the password can only be created with the managed resource variant of [`random_password`](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password). | ||
|
||
Generates an ephemeral password string using a cryptographic random number generator. | ||
|
||
The primary use-case for generating an ephemeral random password is to be used in combination with a write-only attribute in a managed resource, which will avoid Terraform storing the password string in the plan or state file. | ||
|
||
## Example Usage | ||
|
||
```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 | ||
class MyConvertedCode(TerraformStack): | ||
def __init__(self, scope, name): | ||
super().__init__(scope, name) | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## 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 | ||
|
||
- `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`. | ||
- `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 | ||
|
||
- `bcrypt_hash` (String, Sensitive) A bcrypt hash of the generated random string. **NOTE**: If the generated random string is greater than 72 bytes in length, `bcrypt_hash` will contain a hash of the first 72 bytes. | ||
- `result` (String, Sensitive) The generated random string. | ||
|
||
<!-- cache-key: cdktf-0.20.8 input-8673628508fea3a3eb46c9f117059a3e105a2caae3de359049eb11a27206b22c --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
--- | ||
|
||
<!-- Please do not edit this file, it is generated. --> | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "random_password Ephemeral Resource - terraform-provider-random" | ||
subcategory: "" | ||
description: |- | ||
-> If the managed resource doesn't have a write-only attribute available for the password (first introduced in Terraform 1.11), then the password can only be created with the managed resource variant of random_password https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password. | ||
Generates an ephemeral password string using a cryptographic random number generator. | ||
The primary use-case for generating an ephemeral random password is to be used in combination with a write-only attribute in a managed resource, which will avoid Terraform storing the password string in the plan or state file. | ||
--- | ||
|
||
# random_password (Ephemeral Resource) | ||
|
||
-> If the managed resource doesn't have a write-only attribute available for the password (first introduced in Terraform 1.11), then the password can only be created with the managed resource variant of [`randomPassword`](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password). | ||
|
||
Generates an ephemeral password string using a cryptographic random number generator. | ||
|
||
The primary use-case for generating an ephemeral random password is to be used in combination with a write-only attribute in a managed resource, which will avoid Terraform storing the password string in the plan or state file. | ||
|
||
## Example Usage | ||
|
||
```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"; | ||
class MyConvertedCode extends TerraformStack { | ||
constructor(scope: Construct, name: string) { | ||
super(scope, name); | ||
} | ||
} | ||
|
||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `length` (Number) The length of the string desired. The minimum value for length is 1 and, length must also be >= (`minUpper` + `minLower` + `minNumeric` + `minSpecial`). | ||
|
||
### Optional | ||
|
||
- `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`. | ||
- `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`. | ||
- `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`. | ||
|
||
### Read-Only | ||
|
||
- `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. | ||
- `result` (String, Sensitive) The generated random string. | ||
|
||
<!-- cache-key: cdktf-0.20.8 input-8673628508fea3a3eb46c9f117059a3e105a2caae3de359049eb11a27206b22c --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters