# SecretStringValueBeta1

An experimental class used to specify an initial secret value for a Secret.

The class wraps a simple string (or JSON representation) in order to provide some safety checks and warnings
about the dangers of using plaintext strings as initial secret seed values via CDK/CloudFormation.

- Source: [`aws-secretsmanager/lib/secret.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-secretsmanager/lib/secret.ts#L261)
- Type last changed: v2.21.0 · 22 Apr 2022

## Example

```ts
const user = new iam.User(this, 'User');
const accessKey = new iam.AccessKey(this, 'AccessKey', { user });
const secretValue = secretsmanager.SecretStringValueBeta1.fromToken(JSON.stringify({
  username: user.userName,
  database: 'foo',
  password: accessKey.secretAccessKey.unsafeUnwrap(),
}));
```

## Methods

- `fromToken(secretValueFromToken: string): SecretStringValueBeta1 // chainable` (static) — Creates a `SecretValueValueBeta1` from a string value coming from a Token.

  The intent is to enable creating secrets from references (e.g., `Ref`, `Fn::GetAtt`) from other resources.
  This might be the direct output of another Construct, or the output of a Custom Resource.
  This method throws if it determines the input is an unsafe plaintext string.

  For example:

  ```ts
  // Creates a new IAM user, access and secret keys, and stores the secret access key in a Secret.
  const user = new iam.User(this, 'User');
  const accessKey = new iam.AccessKey(this, 'AccessKey', { user });
  const secret = new secretsmanager.Secret(this, 'Secret', {
  	secretStringValue: accessKey.secretAccessKey,
  });
  ```

  The secret may also be embedded in a string representation of a JSON structure:

  ```ts
  const user = new iam.User(this, 'User');
  const accessKey = new iam.AccessKey(this, 'AccessKey', { user });
  const secretValue = secretsmanager.SecretStringValueBeta1.fromToken(JSON.stringify({
    username: user.userName,
    database: 'foo',
    password: accessKey.secretAccessKey.unsafeUnwrap(),
  }));
  ```

  Note that the value being a Token does *not* guarantee safety. For example, a Lazy-evaluated string
  (e.g., `Lazy.string({ produce: () => 'myInsecurePassword' }))`) is a Token, but as the output is
  ultimately a plaintext string, and so insecure.

  **Parameters**

  - `secretValueFromToken` — a secret value coming from a Construct attribute or Custom Resource output.

- `fromUnsafePlaintext(secretValue: string): SecretStringValueBeta1 // chainable` (static) — Creates a `SecretStringValueBeta1` from a plaintext value.

  This approach is inherently unsafe, as the secret value may be visible in your source control repository
  and will also appear in plaintext in the resulting CloudFormation template, including in the AWS Console or APIs.
  Usage of this method is discouraged, especially for production workloads.

- `secretValue(): string` — Returns the secret value.