Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Adjust write-only wording to favor argument over attribute #660

Merged
merged 1 commit into from
Feb 24, 2025
Merged

docs: Adjust write-only wording to favor argument over attribute #660

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/ephemeral-resources/password.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@
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.
-> If the managed resource doesn't have a write-only argument 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.
The primary use-case for generating an ephemeral random password is to be used in combination with a write-only argument 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).
-> If the managed resource doesn't have a write-only argument 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.
The primary use-case for generating an ephemeral random password is to be used in combination with a write-only argument in a managed resource, which will avoid Terraform storing the password string in the plan or state file.

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions internal/provider/ephemeral_password.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,12 @@ func (e *passwordEphemeralResource) Metadata(ctx context.Context, req ephemeral.

func (e *passwordEphemeralResource) Schema(ctx context.Context, req ephemeral.SchemaRequest, resp *ephemeral.SchemaResponse) {
resp.Schema = schema.Schema{
Description: "-> If the managed resource doesn't have a write-only attribute available for the password (first introduced in Terraform 1.11), then the " +
Description: "-> If the managed resource doesn't have a write-only argument 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).\n" +
"\n" +
"Generates an ephemeral password string using a cryptographic random number generator.\n" +
"\n" +
"The primary use-case for generating an ephemeral random password is to be used in combination with a write-only attribute " +
"The primary use-case for generating an ephemeral random password is to be used in combination with a write-only argument " +
"in a managed resource, which will avoid Terraform storing the password string in the plan or state file.",
Attributes: map[string]schema.Attribute{
"length": schema.Int64Attribute{
Expand Down
Loading