AWS::AppSync::Api AuthProvider
Describes an authorization provider.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "AuthType" :String, "CognitoConfig" :CognitoConfig, "LambdaAuthorizerConfig" :LambdaAuthorizerConfig, "OpenIDConnectConfig" :OpenIDConnectConfig}
YAML
AuthType:StringCognitoConfig:CognitoConfigLambdaAuthorizerConfig:LambdaAuthorizerConfigOpenIDConnectConfig:OpenIDConnectConfig
Properties
AuthType-
The authorization type.
Required: Yes
Type: String
Allowed values:
AMAZON_COGNITO_USER_POOLS | AWS_IAM | API_KEY | OPENID_CONNECT | AWS_LAMBDAUpdate requires: No interruption
CognitoConfig-
Describes an Amazon Cognito user pool configuration.
Required: No
Type: CognitoConfig
Update requires: No interruption
-
A
LambdaAuthorizerConfigspecifies how to authorize AWS AppSync API access when using theAWS_LAMBDAauthorizer mode. Be aware that an AWS AppSync API can have only one AWS Lambda authorizer configured at a time.Required: No
Type: LambdaAuthorizerConfig
Update requires: No interruption
OpenIDConnectConfig-
Describes an OpenID Connect (OIDC) configuration.
Required: No
Type: OpenIDConnectConfig
Update requires: No interruption
