# SecretProps

The properties required to create a new secret in AWS Secrets Manager.

Extends: SecretProps
Used as props by: Secret

- Source: [`aws-secretsmanager/lib/secret.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-secretsmanager/lib/secret.ts#L121)
- Type last changed: v2.32.0 · 14 Jul 2022

## Example

```ts
const user = new iam.User(this, 'User');
const accessKey = new iam.AccessKey(this, 'AccessKey', { user });
declare const stack: Stack;

new secretsmanager.Secret(this, 'Secret', {
  secretObjectValue: {
    username: SecretValue.unsafePlainText(user.userName),
    database: SecretValue.unsafePlainText('foo'),
    password: accessKey.secretAccessKey,
  },
})
```

## Properties

- `description`: string — An optional, human-friendly description of the secret.

  **Default:** No description.

- `encryptionKey`: [IKey](/cdk/api/v2/docs/aws-cdk-lib.aws_kms.IKey.html) — The customer-managed encryption key to use for encrypting the secret value.

  **Default:** A default KMS key for the account and region is used.

- `generateSecretString`: [SecretStringGenerator](/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.SecretStringGenerator.html) — Configuration for how to generate a secret value.

  **Default:** 32 characters with upper-case letters, lower-case letters, punctuation and numbers (at least one from each category), per the default values of ``SecretStringGenerator``.

  Only one of `secretString` and `generateSecretString` can be provided.

- `removalPolicy`: [RemovalPolicy](/cdk/api/v2/docs/aws-cdk-lib.RemovalPolicy.html) — Policy to apply when the secret is removed from this stack.

  **Default:** Not set.

- `replicaRegions`: [ReplicaRegion](/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.ReplicaRegion.html)[] — A list of regions where to replicate this secret.

  **Default:** Secret is not replicated

- `secretName`: string — A name for the secret.

  **Default:** A name is generated by CloudFormation.

  Note that deleting secrets from SecretsManager does not happen immediately, but after a 7 to
  30 days blackout period. During that period, it is not possible to create another secret that shares the same name.

- `secretObjectValue`: { [key: string]: [SecretValue](/cdk/api/v2/docs/aws-cdk-lib.SecretValue.html) } — Initial value for a JSON secret.

  **Default:** SecretsManager generates a new secret value.

  **NOTE:** *It is **highly** encouraged to leave this field undefined and allow SecretsManager to create the secret value.
  The secret object -- if provided -- will be included in the output of the cdk as part of synthesis,
  and will appear in the CloudFormation template in the console. This can be secure(-ish) if that value is merely reference to
  another resource (or one of its attributes), but if the value is a plaintext string, it will be visible to anyone with access
  to the CloudFormation template (via the AWS Console, SDKs, or CLI).

  Specifies a JSON object that you want to encrypt and store in this new version of the secret.
  To specify a simple string value instead, use `SecretProps.secretStringValue`

  Only one of `secretStringBeta1`, `secretStringValue`, 'secretObjectValue', and `generateSecretString` can be provided.

  ```ts
  declare const user: iam.User;
  declare const accessKey: iam.AccessKey;
  declare const stack: Stack;
  new secretsmanager.Secret(stack, 'JSONSecret', {
    secretObjectValue: {
      username: SecretValue.unsafePlainText(user.userName), // intrinsic reference, not exposed as plaintext
      database: SecretValue.unsafePlainText('foo'), // rendered as plain text, but not a secret
      password: accessKey.secretAccessKey, // SecretValue
    },
  });
  ```

- `secretStringBeta1`: [SecretStringValueBeta1](/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.SecretStringValueBeta1.html) — Use `secretStringValue` instead.

  **Default:** SecretsManager generates a new secret value.

  **NOTE:** *It is **highly** encouraged to leave this field undefined and allow SecretsManager to create the secret value.
  The secret string -- if provided -- will be included in the output of the cdk as part of synthesis,
  and will appear in the CloudFormation template in the console. This can be secure(-ish) if that value is merely reference to
  another resource (or one of its attributes), but if the value is a plaintext string, it will be visible to anyone with access
  to the CloudFormation template (via the AWS Console, SDKs, or CLI).

  Specifies text data that you want to encrypt and store in this new version of the secret.
  May be a simple string value, or a string representation of a JSON structure.

  Only one of `secretStringBeta1`, `secretStringValue`, and `generateSecretString` can be provided.

- `secretStringValue`: [SecretValue](/cdk/api/v2/docs/aws-cdk-lib.SecretValue.html) — Initial value for the secret.

  **Default:** SecretsManager generates a new secret value.

  **NOTE:** *It is **highly** encouraged to leave this field undefined and allow SecretsManager to create the secret value.
  The secret string -- if provided -- will be included in the output of the cdk as part of synthesis,
  and will appear in the CloudFormation template in the console. This can be secure(-ish) if that value is merely reference to
  another resource (or one of its attributes), but if the value is a plaintext string, it will be visible to anyone with access
  to the CloudFormation template (via the AWS Console, SDKs, or CLI).

  Specifies text data that you want to encrypt and store in this new version of the secret.
  May be a simple string value. To provide a string representation of JSON structure, use `SecretProps.secretObjectValue` instead.

  Only one of `secretStringBeta1`, `secretStringValue`, 'secretObjectValue', and `generateSecretString` can be provided.