Package software.amazon.awscdk.services.appsync

Interface AuthorizationMode

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AuthorizationMode.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:45.378Z")
@Stability(Stable)
public interface AuthorizationMode
extends software.amazon.jsii.JsiiSerializable

Interface to specify default or additional authorization(s).

Example:

 import software.amazon.awscdk.services.appsync.*;
 GraphqlApi api = GraphqlApi.Builder.create(this, "api")
         .name("api")
         .definition(Definition.fromFile("schema.graphql"))
         .authorizationConfig(AuthorizationConfig.builder()
                 .defaultAuthorization(AuthorizationMode.builder().authorizationType(AuthorizationType.IAM).build())
                 .build())
         .build();
 Rule rule = Rule.Builder.create(this, "Rule")
         .schedule(Schedule.rate(Duration.hours(1)))
         .build();
 rule.addTarget(AppSync.Builder.create(api)
         .graphQLOperation("mutation Publish($message: String!){ publish(message: $message) { message } }")
         .variables(RuleTargetInput.fromObject(Map.of(
                 "message", "hello world")))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AuthorizationMode.Builder	A builder for AuthorizationMode
static final class	AuthorizationMode.Jsii$Proxy	An implementation for AuthorizationMode

Method Summary

Modifier and Type	Method	Description
static AuthorizationMode.Builder	builder()
default ApiKeyConfig	getApiKeyConfig()	If authorizationType is AuthorizationType.API_KEY, this option can be configured.
AuthorizationType	getAuthorizationType()	One of possible four values AppSync supports.
default LambdaAuthorizerConfig	getLambdaAuthorizerConfig()	If authorizationType is AuthorizationType.LAMBDA, this option is required.
default OpenIdConnectConfig	getOpenIdConnectConfig()	If authorizationType is AuthorizationType.OIDC, this option is required.
default UserPoolConfig	getUserPoolConfig()	If authorizationType is AuthorizationType.USER_POOL, this option is required.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthorizationType

@Stability(Stable)
@NotNull
AuthorizationType getAuthorizationType()

One of possible four values AppSync supports.

Default: - `AuthorizationType.API_KEY`

See Also:

• https://docs.aws.amazon.com/appsync/latest/devguide/security.html

getApiKeyConfig

@Stability(Stable)
@Nullable
default ApiKeyConfig getApiKeyConfig()

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

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

getLambdaAuthorizerConfig

@Stability(Stable)
@Nullable
default LambdaAuthorizerConfig getLambdaAuthorizerConfig()

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

Default: - none

getOpenIdConnectConfig

@Stability(Stable)
@Nullable
default OpenIdConnectConfig getOpenIdConnectConfig()

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

Default: - none

getUserPoolConfig

@Stability(Stable)
@Nullable
default UserPoolConfig getUserPoolConfig()

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

Default: - none

builder

@Stability(Stable)
static AuthorizationMode.Builder builder()

Returns:

a AuthorizationMode.Builder of AuthorizationMode