AuthorizationMode

class aws_cdk.aws_appsync.AuthorizationMode(*, authorization_type, api_key_config=None, open_id_connect_config=None, user_pool_config=None)

Bases: object

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

Parameters
  • authorization_type (AuthorizationType) – (experimental) One of possible four values AppSync supports. Default: - AuthorizationType.API_KEY

  • api_key_config (Optional[ApiKeyConfig]) – (experimental) If authorizationType is AuthorizationType.API_KEY, this option can be configured. Default: - name: ‘DefaultAPIKey’ | description: ‘Default API Key created by CDK’

  • open_id_connect_config (Optional[OpenIdConnectConfig]) – (experimental) If authorizationType is AuthorizationType.OIDC, this option is required. Default: - none

  • user_pool_config (Optional[UserPoolConfig]) – (experimental) If authorizationType is AuthorizationType.USER_POOL, this option is required. Default: - none

Stability

experimental

Attributes

api_key_config

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

Default
  • name: ‘DefaultAPIKey’ | description: ‘Default API Key created by CDK’

Stability

experimental

Return type

Optional[ApiKeyConfig]

authorization_type

(experimental) One of possible four values AppSync supports.

Default
  • AuthorizationType.API_KEY

See

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

Stability

experimental

Return type

AuthorizationType

open_id_connect_config

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

Default
  • none

Stability

experimental

Return type

Optional[OpenIdConnectConfig]

user_pool_config

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

Default
  • none

Stability

experimental

Return type

Optional[UserPoolConfig]