Skip to content

CognitoUserPoolClient

Reference doc for the `sst.aws.CognitoUserPoolClient` component.

The CognitoUserPoolClient component is internally used by the CognitoUserPool component to add clients to your Amazon Cognito user pool.

You’ll find this component returned by the addClient method of the CognitoUserPool component.


Constructor

new CognitoUserPoolClient(name, args, opts?)

Parameters

Properties

id

Type Output<string>

The Cognito user pool client ID.

nodes

Type Object

The underlying resources this component creates.

nodes.client

Type UserPoolClient

The Amazon Cognito user pool client.

secret

Type Output<string>

The Cognito user pool client secret.

SDK

The following are accessible through the SDK at runtime.

  • id string

    The Cognito user pool client ID.
  • secret string

    The Cognito user pool client secret.

ClientArgs

transform?

Type Object

Transform how this component creates its underlying resources.

transform.client?

Type UserPoolClientArgs | (args: UserPoolClientArgs => void)

Transform the Cognito user pool client resource.

userPool

Type Input<string>

The Cognito user pool ID.