interface AppSyncAuthProvider

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

Auth provider settings for AppSync Event APIs.

See also: https://docs.aws.amazon.com/appsync/latest/eventapi/configure-event-api-auth.html

Example

import * as logs from 'aws-cdk-lib/aws-logs';

const apiKeyProvider: appsync.AppSyncAuthProvider = {
  authorizationType: appsync.AppSyncAuthorizationType.API_KEY,
};

const api = new appsync.EventApi(this, 'api', {
  apiName: 'Api',
  ownerContact: 'OwnerContact',
  authorizationConfig: {
    authProviders: [
      apiKeyProvider,
    ],
    connectionAuthModeTypes: [
      appsync.AppSyncAuthorizationType.API_KEY,
    ],
    defaultPublishAuthModeTypes: [
      appsync.AppSyncAuthorizationType.API_KEY,
    ],
    defaultSubscribeAuthModeTypes: [
      appsync.AppSyncAuthorizationType.API_KEY,
    ],
  },
  logConfig: {
    fieldLogLevel: appsync.AppSyncFieldLogLevel.INFO,
    retention: logs.RetentionDays.ONE_WEEK,
  },
});

api.addChannelNamespace('default');

Properties

Name	Type	Description
authorizationType	AppSyncAuthorizationType	One of possible authorization types AppSync supports.
apiKeyConfig?	AppSyncApiKeyConfig	If authorizationType is AuthorizationType.API_KEY, this option can be configured.
cognitoConfig?	AppSyncCognitoConfig	If authorizationType is AuthorizationType.USER_POOL, this option is required.
lambdaAuthorizerConfig?	AppSyncLambdaAuthorizerConfig	If authorizationType is AuthorizationType.LAMBDA, this option is required.
openIdConnectConfig?	AppSyncOpenIdConnectConfig	If authorizationType is AuthorizationType.OIDC, this option is required.

---

authorizationType

Type: AppSyncAuthorizationType

One of possible authorization types AppSync supports.

---

apiKeyConfig?

Type: AppSyncApiKeyConfig (optional, default: name: 'DefaultAPIKey')

If authorizationType is AuthorizationType.API_KEY, this option can be configured.

---

cognitoConfig?

Type: AppSyncCognitoConfig (optional, default: none)

If authorizationType is AuthorizationType.USER_POOL, this option is required.

---

lambdaAuthorizerConfig?

Type: AppSyncLambdaAuthorizerConfig (optional, default: none)

If authorizationType is AuthorizationType.LAMBDA, this option is required.

---

openIdConnectConfig?

Type: AppSyncOpenIdConnectConfig (optional, default: none)

If authorizationType is AuthorizationType.OIDC, this option is required.