Interface IUserPoolConfig

Configuration for Cognito user-pools in AppSync.

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IUserPoolConfig

Syntax (vb)

Public Interface IUserPoolConfig

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.AppSync;
            using Amazon.CDK.AWS.Cognito;

            UserPool userPool;

            var userPoolConfig = new UserPoolConfig {
                UserPool = userPool,

                // the properties below are optional
                AppIdClientRegex = "appIdClientRegex",
                DefaultAction = UserPoolDefaultAction.ALLOW
            };

Synopsis

Properties

AppIdClientRegex	the optional app id regex.
DefaultAction	Default auth action.
UserPool	The Cognito user pool to use as identity source.

Properties

AppIdClientRegex

the optional app id regex.

string? AppIdClientRegex { get; }

Property Value

string

Remarks

Default: - None

DefaultAction

Default auth action.

UserPoolDefaultAction? DefaultAction { get; }

Property Value

UserPoolDefaultAction?

Remarks

Default: ALLOW

UserPool

The Cognito user pool to use as identity source.

IUserPool UserPool { get; }

Property Value

IUserPool

Remarks

ExampleMetadata: fixture=_generated