interface EventConfigProperty

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

Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.

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 eventConfigProperty: appsync.CfnApi.EventConfigProperty = {
  authProviders: [{
    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,
    },
  }],
  connectionAuthModes: [{
    authType: 'authType',
  }],
  defaultPublishAuthModes: [{
    authType: 'authType',
  }],
  defaultSubscribeAuthModes: [{
    authType: 'authType',
  }],

  // the properties below are optional
  logConfig: {
    cloudWatchLogsRoleArn: 'cloudWatchLogsRoleArn',
    logLevel: 'logLevel',
  },
};

Properties

Name	Type	Description
authProviders	`IResolvable` `\|` `IResolvable` `\|` `AuthProviderProperty[]`	A list of authorization providers.
connectionAuthModes	`IResolvable` `\|` `IResolvable` `\|` `AuthModeProperty[]`	A list of valid authorization modes for the Event API connections.
defaultPublishAuthModes	`IResolvable` `\|` `IResolvable` `\|` `AuthModeProperty[]`	A list of valid authorization modes for the Event API publishing.
defaultSubscribeAuthModes	`IResolvable` `\|` `IResolvable` `\|` `AuthModeProperty[]`	A list of valid authorization modes for the Event API subscriptions.
logConfig?	`IResolvable` `\|` `EventLogConfigProperty`	The CloudWatch Logs configuration for the Event API.

authProviders

Type: IResolvable | IResolvable | AuthProviderProperty[]

A list of authorization providers.

connectionAuthModes

Type: IResolvable | IResolvable | AuthModeProperty[]

A list of valid authorization modes for the Event API connections.

defaultPublishAuthModes

Type: IResolvable | IResolvable | AuthModeProperty[]

A list of valid authorization modes for the Event API publishing.

defaultSubscribeAuthModes

Type: IResolvable | IResolvable | AuthModeProperty[]

A list of valid authorization modes for the Event API subscriptions.

logConfig?

Type: IResolvable | EventLogConfigProperty (optional)

The CloudWatch Logs configuration for the Event API.