aws-cdk-lib.aws_appsync.CfnGraphQLApi.AdditionalAuthenticationProviderProperty

interface AdditionalAuthenticationProviderProperty

LanguageType name
.NETAmazon.CDK.AWS.AppSync.CfnGraphQLApi.AdditionalAuthenticationProviderProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappsync#CfnGraphQLApi_AdditionalAuthenticationProviderProperty
Javasoftware.amazon.awscdk.services.appsync.CfnGraphQLApi.AdditionalAuthenticationProviderProperty
Pythonaws_cdk.aws_appsync.CfnGraphQLApi.AdditionalAuthenticationProviderProperty
TypeScript aws-cdk-lib » aws_appsync » CfnGraphQLApi » AdditionalAuthenticationProviderProperty

Describes an additional authentication 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 additionalAuthenticationProviderProperty: appsync.CfnGraphQLApi.AdditionalAuthenticationProviderProperty = {
  authenticationType: 'authenticationType',

  // the properties below are optional
  lambdaAuthorizerConfig: {
    authorizerResultTtlInSeconds: 123,
    authorizerUri: 'authorizerUri',
    identityValidationExpression: 'identityValidationExpression',
  },
  openIdConnectConfig: {
    authTtl: 123,
    clientId: 'clientId',
    iatTtl: 123,
    issuer: 'issuer',
  },
  userPoolConfig: {
    appIdClientRegex: 'appIdClientRegex',
    awsRegion: 'awsRegion',
    userPoolId: 'userPoolId',
  },
};

Properties

NameTypeDescription
authenticationTypestringThe authentication type for API key, AWS Identity and Access Management , OIDC, Amazon Cognito user pools , or AWS Lambda .
lambdaAuthorizerConfig?IResolvable | LambdaAuthorizerConfigPropertyConfiguration for AWS Lambda function authorization.
openIdConnectConfig?IResolvable | OpenIDConnectConfigPropertyThe OIDC configuration.
userPoolConfig?IResolvable | CognitoUserPoolConfigPropertyThe Amazon Cognito user pool configuration.

authenticationType

Type: string

The authentication type for API key, AWS Identity and Access Management , OIDC, Amazon Cognito user pools , or AWS Lambda .

Valid Values: API_KEY | AWS_IAM | OPENID_CONNECT | AMAZON_COGNITO_USER_POOLS | AWS_LAMBDA


lambdaAuthorizerConfig?

Type: IResolvable | LambdaAuthorizerConfigProperty (optional)

Configuration for AWS Lambda function authorization.


openIdConnectConfig?

Type: IResolvable | OpenIDConnectConfigProperty (optional)

The OIDC configuration.


userPoolConfig?

Type: IResolvable | CognitoUserPoolConfigProperty (optional)

The Amazon Cognito user pool configuration.