aws-cdk-lib.aws_appsync.AuthorizationMode

AuthorizationMode Struct

Interface to specify default or additional authorization(s).

Source

aws-appsync/lib/graphqlapi.ts

Type last changed

v2.60.0 · 12 Jan 2023

Example

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

const api = new appsync.GraphqlApi(this, 'api', {
  name: 'api',
  definition: appsync.Definition.fromFile('schema.graphql'),
  authorizationConfig: {
    defaultAuthorization: { authorizationType: appsync.AuthorizationType.IAM }
  },
});

const rule = new events.Rule(this, 'Rule', {
  schedule: events.Schedule.rate(cdk.Duration.hours(1)),
});

rule.addTarget(new targets.AppSync(api, {
  graphQLOperation: 'mutation Publish($message: String!){ publish(message: $message) { message } }',
  variables: events.RuleTargetInput.fromObject({
    message: 'hello world',
  }),
}));

Properties

apiKeyConfig?optionalApiKeyConfigapi_key_config?optionalApiKeyConfigapiKeyConfig?optionalApiKeyConfigApiKeyConfig?optionalApiKeyConfigApiKeyConfig?optionalApiKeyConfig#

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

Default: name: 'DefaultAPIKey' | description: 'Default API Key created by CDK'

authorizationTypeAuthorizationTypeauthorization_typeAuthorizationTypeauthorizationTypeAuthorizationTypeAuthorizationTypeAuthorizationTypeAuthorizationTypeAuthorizationType= `AuthorizationType.API_KEY`required#

One of possible four values AppSync supports.

lambdaAuthorizerConfig?optionalLambdaAuthorizerConfiglambda_authorizer_config?optionalLambdaAuthorizerConfiglambdaAuthorizerConfig?optionalLambdaAuthorizerConfigLambdaAuthorizerConfig?optionalLambdaAuthorizerConfigLambdaAuthorizerConfig?optionalLambdaAuthorizerConfig= none#

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

openIdConnectConfig?optionalOpenIdConnectConfigopen_id_connect_config?optionalOpenIdConnectConfigopenIdConnectConfig?optionalOpenIdConnectConfigOpenIdConnectConfig?optionalOpenIdConnectConfigOpenIdConnectConfig?optionalOpenIdConnectConfig= none#

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

userPoolConfig?optionalUserPoolConfiguser_pool_config?optionalUserPoolConfiguserPoolConfig?optionalUserPoolConfigUserPoolConfig?optionalUserPoolConfigUserPoolConfig?optionalUserPoolConfig= none#

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