CognitoIdentityProvider

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

The CognitoIdentityProvider component is internally used by the CognitoUserPool component to add identity providers to your Amazon Cognito user pool.

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

Constructor

new CognitoIdentityProvider(name, args, opts?)

Parameters

name string
args Args
opts? ComponentResourceOptions

Properties

nodes

Type Object

identityProvider

The underlying resources this component creates.

nodes.identityProvider

Type IdentityProvider

The Cognito identity provider.

providerName

Type Output<string>

The Cognito identity provider name.

Args

attributes?

Type Input<Record<string, Input<string>>>

Define a mapping between identity provider attributes and user pool attributes.

{
  email: "email",
  username: "sub"
}

details

Type Input<Record<string, Input<string>>>

Configure the identity provider details, including the scopes, URLs, and identifiers.

{
  authorize_scopes: "email profile",
  client_id: "your-client-id",
  client_secret: "your-client-secret"
}

transform?

Type Object

identityProvider?

Transform how this component creates its underlying resources.

transform.identityProvider?

Type IdentityProviderArgs | (args: IdentityProviderArgs, opts: ComponentResourceOptions, name: string) => void

Transform the Cognito identity provider resource.

type

The type of identity provider.

userPool

Type Input<string>

The Cognito user pool ID.