interface AuthProviderProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.AppSync.Mixins.CfnApiPropsMixin.AuthProviderProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsappsync/mixins#CfnApiPropsMixin_AuthProviderProperty
Java	software.amazon.awscdk.mixins.preview.services.appsync.mixins.CfnApiPropsMixin.AuthProviderProperty
Python	aws_cdk.mixins_preview.aws_appsync.mixins.CfnApiPropsMixin.AuthProviderProperty
TypeScript	@aws-cdk/mixins-preview » aws_appsync » mixins » CfnApiPropsMixin » AuthProviderProperty

Describes an authorization provider.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-authprovider.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as appsync_mixins } from '@aws-cdk/mixins-preview/aws-appsync';
const authProviderProperty: appsync_mixins.CfnApiPropsMixin.AuthProviderProperty = {
  authType: 'authType',
  cognitoConfig: {
    appIdClientRegex: 'appIdClientRegex',
    awsRegion: 'awsRegion',
    userPoolId: 'userPoolId',
  },
  lambdaAuthorizerConfig: {
    authorizerResultTtlInSeconds: 123,
    authorizerUri: 'authorizerUri',
    identityValidationExpression: 'identityValidationExpression',
  },
  openIdConnectConfig: {
    authTtl: 123,
    clientId: 'clientId',
    iatTtl: 123,
    issuer: 'issuer',
  },
};

Properties

Name	Type	Description
authType?	string	The authorization type.
cognitoConfig?	IResolvable | CognitoConfigProperty	Describes an Amazon Cognito user pool configuration.
lambdaAuthorizerConfig?	IResolvable | LambdaAuthorizerConfigProperty	A LambdaAuthorizerConfig specifies how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.
openIdConnectConfig?	IResolvable | OpenIDConnectConfigProperty	Describes an OpenID Connect (OIDC) configuration.

---

authType?

Type: string (optional)

The authorization type.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-authprovider.html#cfn-appsync-api-authprovider-authtype

---

cognitoConfig?

Type: IResolvable | CognitoConfigProperty (optional)

Describes an Amazon Cognito user pool configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-authprovider.html#cfn-appsync-api-authprovider-cognitoconfig

---

lambdaAuthorizerConfig?

Type: IResolvable | LambdaAuthorizerConfigProperty (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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-authprovider.html#cfn-appsync-api-authprovider-lambdaauthorizerconfig

---

openIdConnectConfig?

Type: IResolvable | OpenIDConnectConfigProperty (optional)

Describes an OpenID Connect (OIDC) configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-api-authprovider.html#cfn-appsync-api-authprovider-openidconnectconfig