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.26.0 (build 7d76e02)",
           date="2021-03-25T11:29:26.950Z")
 @Stability(value=Experimental)
public interface AuthorizationMode
extends software.amazon.jsii.JsiiSerializable

(experimental) Interface to specify default or additional authorization(s).

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAuthorizationType

@Stability(value=Experimental)
 @NotNull
AuthorizationType getAuthorizationType()

(experimental) 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(value=Experimental)
 @Nullable
default ApiKeyConfig getApiKeyConfig()

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

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

getOpenIdConnectConfig

@Stability(value=Experimental)
 @Nullable
default OpenIdConnectConfig getOpenIdConnectConfig()

(experimental) If authorizationType is `AuthorizationType.OIDC`, this option is required.

Default: - none

getUserPoolConfig

@Stability(value=Experimental)
 @Nullable
default UserPoolConfig getUserPoolConfig()

(experimental) If authorizationType is `AuthorizationType.USER_POOL`, this option is required.

Default: - none

builder

@Stability(value=Experimental)
static AuthorizationMode.Builder builder()

Returns:

a AuthorizationMode.Builder of AuthorizationMode