Package software.amazon.awscdk.services.appsync

Interface AuthorizationConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AuthorizationConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)",
           date="2024-03-14T22:21:50.353Z")
@Stability(Stable)
public interface AuthorizationConfig
extends software.amazon.jsii.JsiiSerializable

Configuration of the API authorization modes.

Example:

 import software.amazon.awscdk.services.lambda.*;
 Function authFunction;
 GraphqlApi.Builder.create(this, "api")
         .name("api")
         .definition(Definition.fromFile(join(__dirname, "appsync.test.graphql")))
         .authorizationConfig(AuthorizationConfig.builder()
                 .defaultAuthorization(AuthorizationMode.builder()
                         .authorizationType(AuthorizationType.LAMBDA)
                         .lambdaAuthorizerConfig(LambdaAuthorizerConfig.builder()
                                 .handler(authFunction)
                                 .build())
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AuthorizationConfig.Builder	builder()
default List<AuthorizationMode>	getAdditionalAuthorizationModes()	Additional authorization modes.
default AuthorizationMode	getDefaultAuthorization()	Optional authorization configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAdditionalAuthorizationModes

@Stability(Stable)
@Nullable
default List<AuthorizationMode> getAdditionalAuthorizationModes()

Additional authorization modes.

Default: - No other modes

getDefaultAuthorization

@Stability(Stable)
@Nullable
default AuthorizationMode getDefaultAuthorization()

Optional authorization configuration.

Default: - API Key authorization

builder

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

Returns:

a AuthorizationConfig.Builder of AuthorizationConfig