Skip to content

Commit

Permalink
cdktf: update index.md,resources/uuid.md,resources/string.md,resource…
Browse files Browse the repository at this point in the history
…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
team-tf-cdk authored Feb 19, 2025
1 parent ca14b1b commit 445c056
Show file tree
Hide file tree
Showing 4 changed files with 127 additions and 6 deletions.
56 changes: 56 additions & 0 deletions docs/cdktf/python/ephemeral-resources/password.md
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 -->
9 changes: 6 additions & 3 deletions docs/cdktf/python/resources/password.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,18 @@
page_title: "random_password Resource - terraform-provider-random"
subcategory: ""
description: |-
Identical to random_string string.html 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 https://www.terraform.io/docs/language/state/sensitive-data.html.
-> If the managed resource supports a write-only attribute for the password (first introduced in Terraform 1.11), then the ephemeral variant of random_password https://registry.terraform.io/providers/hashicorp/random/latest/docs/ephemeral-resources/password should be used, when possible, to avoid storing the password in the plan or state file.
Identical to random_string https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/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 https://developer.hashicorp.com/terraform/language/state/sensitive-data.
This resource does use a cryptographic random number generator.
---


<!-- Please do not edit this file, it is generated. -->
# random_password (Resource)

Identical to [random_string](string.html) 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](https://www.terraform.io/docs/language/state/sensitive-data.html).
-> If the managed resource supports a write-only attribute for the password (first introduced in Terraform 1.11), then the ephemeral variant of [`random_password`](https://registry.terraform.io/providers/hashicorp/random/latest/docs/ephemeral-resources/password) should be used, when possible, to avoid storing the password in the plan or state file.

Identical to [`random_string`](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/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](https://developer.hashicorp.com/terraform/language/state/sensitive-data).

This resource *does* use a cryptographic random number generator.

Expand Down Expand Up @@ -180,4 +183,4 @@ class MyConvertedCode(TerraformStack):
**NOTE** `ignore_changes` is only required until the resource is recreated after import,
after which it will use the configuration values specified.

<!-- cache-key: cdktf-0.20.8 input-4f3bbf00fd66a8220b635b87411f240ece545761c828563b01b2a6f1c565befe -->
<!-- cache-key: cdktf-0.20.8 input-0af3ff21d9e9e4744bb0e3a092f3c7b4f79488e12b70104f1a6e84f164bb87ee -->
59 changes: 59 additions & 0 deletions docs/cdktf/typescript/ephemeral-resources/password.md
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 -->
9 changes: 6 additions & 3 deletions docs/cdktf/typescript/resources/password.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,18 @@
page_title: "random_password Resource - terraform-provider-random"
subcategory: ""
description: |-
Identical to random_string string.html 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 https://www.terraform.io/docs/language/state/sensitive-data.html.
-> If the managed resource supports a write-only attribute for the password (first introduced in Terraform 1.11), then the ephemeral variant of random_password https://registry.terraform.io/providers/hashicorp/random/latest/docs/ephemeral-resources/password should be used, when possible, to avoid storing the password in the plan or state file.
Identical to random_string https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/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 https://developer.hashicorp.com/terraform/language/state/sensitive-data.
This resource does use a cryptographic random number generator.
---


<!-- Please do not edit this file, it is generated. -->
# random_password (Resource)

Identical to [random_string](string.html) 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](https://www.terraform.io/docs/language/state/sensitive-data.html).
-> If the managed resource supports a write-only attribute for the password (first introduced in Terraform 1.11), then the ephemeral variant of [`randomPassword`](https://registry.terraform.io/providers/hashicorp/random/latest/docs/ephemeral-resources/password) should be used, when possible, to avoid storing the password in the plan or state file.

Identical to [`random_string`](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/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](https://developer.hashicorp.com/terraform/language/state/sensitive-data).

This resource *does* use a cryptographic random number generator.

Expand Down Expand Up @@ -194,4 +197,4 @@ class MyConvertedCode extends TerraformStack {
**NOTE** `ignore_changes` is only required until the resource is recreated after import,
after which it will use the configuration values specified.

<!-- cache-key: cdktf-0.20.8 input-4f3bbf00fd66a8220b635b87411f240ece545761c828563b01b2a6f1c565befe -->
<!-- cache-key: cdktf-0.20.8 input-0af3ff21d9e9e4744bb0e3a092f3c7b4f79488e12b70104f1a6e84f164bb87ee -->

0 comments on commit 445c056

Please sign in to comment.