interface AuthProviderProperty

Language	Type name
.NET	`Amazon.CDK.AWS.AppSync.CfnApi.AuthProviderProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#CfnApi_AuthProviderProperty`
Java	`software.amazon.awscdk.services.appsync.CfnApi.AuthProviderProperty`
Python	`aws_cdk.aws_appsync.CfnApi.AuthProviderProperty`
TypeScript	`aws-cdk-lib` » `aws_appsync` » `CfnApi` » `AuthProviderProperty`

Describes an authorization provider.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
const authProviderProperty: appsync.CfnApi.AuthProviderProperty = {
  authType: 'authType',

  // the properties below are optional
  cognitoConfig: {
    awsRegion: 'awsRegion',
    userPoolId: 'userPoolId',

    // the properties below are optional
    appIdClientRegex: 'appIdClientRegex',
  },
  lambdaAuthorizerConfig: {
    authorizerUri: 'authorizerUri',

    // the properties below are optional
    authorizerResultTtlInSeconds: 123,
    identityValidationExpression: 'identityValidationExpression',
  },
  openIdConnectConfig: {
    issuer: 'issuer',

    // the properties below are optional
    authTtl: 123,
    clientId: 'clientId',
    iatTtl: 123,
  },
};

Properties

Name	Type	Description
authType	`string`	The authorization type.
cognitoConfig?	`IResolvable` `\|` `CognitoConfigProperty`	Describes an Amazon Cognito user pool configuration.
lambdaAuthorizerConfig?	`IResolvable` `\|` `LambdaAuthorizerConfigProperty`	A `LambdaAuthorizerConfig` specifies how to authorize AWS AppSync API access when using the `AWS_LAMBDA` authorizer mode.
openIdConnectConfig?	`IResolvable` `\|` `OpenIDConnectConfigProperty`	Describes an OpenID Connect (OIDC) configuration.

authType

Type: string

The authorization type.

cognitoConfig?

Type: IResolvable | CognitoConfigProperty (optional)

Describes an Amazon Cognito user pool configuration.

lambdaAuthorizerConfig?

Type: IResolvable | LambdaAuthorizerConfigProperty (optional)

A LambdaAuthorizerConfig specifies how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.

Be aware that an AWS AppSync API can have only one AWS Lambda authorizer configured at a time.

openIdConnectConfig?

Type: IResolvable | OpenIDConnectConfigProperty (optional)

Describes an OpenID Connect (OIDC) configuration.