interface AuthProviderProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.AppSync.CfnApi.AuthProviderProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#CfnApi_AuthProviderProperty |
![]() | software.amazon.awscdk.services.appsync.CfnApi.AuthProviderProperty |
![]() | aws_cdk.aws_appsync.CfnApi.AuthProviderProperty |
![]() | aws-cdk-lib » aws_appsync » CfnApi » AuthProviderProperty |
Describes an authorization provider.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
const authProviderProperty: appsync.CfnApi.AuthProviderProperty = {
authType: 'authType',
// the properties below are optional
cognitoConfig: {
awsRegion: 'awsRegion',
userPoolId: 'userPoolId',
// the properties below are optional
appIdClientRegex: 'appIdClientRegex',
},
lambdaAuthorizerConfig: {
authorizerUri: 'authorizerUri',
// the properties below are optional
authorizerResultTtlInSeconds: 123,
identityValidationExpression: 'identityValidationExpression',
},
openIdConnectConfig: {
issuer: 'issuer',
// the properties below are optional
authTtl: 123,
clientId: 'clientId',
iatTtl: 123,
},
};
Properties
Name | Type | Description |
---|---|---|
auth | string | The authorization type. |
cognito | IResolvable | Cognito | Describes an Amazon Cognito user pool configuration. |
lambda | IResolvable | Lambda | A LambdaAuthorizerConfig specifies how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. |
open | IResolvable | Open | Describes an OpenID Connect (OIDC) configuration. |
authType
Type:
string
The authorization type.
cognitoConfig?
Type:
IResolvable
|
Cognito
(optional)
Describes an Amazon Cognito user pool configuration.
lambdaAuthorizerConfig?
Type:
IResolvable
|
Lambda
(optional)
A LambdaAuthorizerConfig
specifies how to authorize AWS AppSync API access when using the AWS_LAMBDA
authorizer mode.
Be aware that an AWS AppSync API can have only one AWS Lambda authorizer configured at a time.
openIdConnectConfig?
Type:
IResolvable
|
Open
(optional)
Describes an OpenID Connect (OIDC) configuration.