Class AppSyncCognitoConfig

Configuration for Cognito user-pools in AppSync for Api.

Inheritance

object

AppSyncCognitoConfig

Implements

IAppSyncCognitoConfig

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class AppSyncCognitoConfig : IAppSyncCognitoConfig

Syntax (vb)

Public Class AppSyncCognitoConfig Implements IAppSyncCognitoConfig

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 appSyncCognitoConfig = new AppSyncCognitoConfig {
                UserPool = userPool,

                // the properties below are optional
                AppIdClientRegex = "appIdClientRegex"
            };

Synopsis

Constructors

AppSyncCognitoConfig()

Configuration for Cognito user-pools in AppSync for Api.

Properties

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

Constructors

AppSyncCognitoConfig()

Configuration for Cognito user-pools in AppSync for Api.

public AppSyncCognitoConfig()

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 appSyncCognitoConfig = new AppSyncCognitoConfig {
                UserPool = userPool,

                // the properties below are optional
                AppIdClientRegex = "appIdClientRegex"
            };

Properties

AppIdClientRegex

the optional app id regex.

public string? AppIdClientRegex { get; set; }

Property Value

string

Remarks

Default: - None

UserPool

The Cognito user pool to use as identity source.

public IUserPool UserPool { get; set; }

Property Value

IUserPool

Remarks

ExampleMetadata: fixture=_generated

Implements

IAppSyncCognitoConfig