API.md

API Reference

Constructs

UserPoolClientSecret

Exports a user pool's client secret to a secrets manager secret.

Initializers

import { UserPoolClientSecret } from '@rayova/cdk-cognito-secret'

new UserPoolClientSecret(scope: Construct, id: string, props: UserPoolClientSecretProps)

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: @rayova/cdk-cognito-secret.UserPoolClientSecretProps

---

Structs

UserPoolClientSecretProps

Initializer

import { UserPoolClientSecretProps } from '@rayova/cdk-cognito-secret'

const userPoolClientSecretProps: UserPoolClientSecretProps = { ... }

secret^Required

public readonly secret: Secret;

• Type: aws-cdk-lib.aws_secretsmanager.Secret

Stores client credentials in this secret.

---

userPool^Required

public readonly userPool: UserPool;

• Type: aws-cdk-lib.aws_cognito.UserPool

Provide the user pool of the user pool client.

---

userPoolClient^Required

public readonly userPoolClient: UserPoolClient;

• Type: aws-cdk-lib.aws_cognito.UserPoolClient

Provide the user pool client from which to get the secret.

---