Show / Hide Table of Contents

Interface CfnApi.IAuthProviderProperty

Describes an authorization provider.

Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnApi.IAuthProviderProperty
Syntax (vb)
Public Interface CfnApi.IAuthProviderProperty
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.AppSync;

             var authProviderProperty = new AuthProviderProperty {
                 AuthType = "authType",

                 // the properties below are optional
                 CognitoConfig = new CognitoConfigProperty {
                     AwsRegion = "awsRegion",
                     UserPoolId = "userPoolId",

                     // the properties below are optional
                     AppIdClientRegex = "appIdClientRegex"
                 },
                 LambdaAuthorizerConfig = new LambdaAuthorizerConfigProperty {
                     AuthorizerUri = "authorizerUri",

                     // the properties below are optional
                     AuthorizerResultTtlInSeconds = 123,
                     IdentityValidationExpression = "identityValidationExpression"
                 },
                 OpenIdConnectConfig = new OpenIDConnectConfigProperty {
                     Issuer = "issuer",

                     // the properties below are optional
                     AuthTtl = 123,
                     ClientId = "clientId",
                     IatTtl = 123
                 }
             };

Synopsis

Properties

AuthType

The authorization type.

CognitoConfig

Describes an Amazon Cognito user pool configuration.

LambdaAuthorizerConfig

A LambdaAuthorizerConfig specifies how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.

OpenIdConnectConfig

Describes an OpenID Connect (OIDC) configuration.

Properties

AuthType

The authorization type.

string AuthType { get; }
Property Value

string

Remarks

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

CognitoConfig

Describes an Amazon Cognito user pool configuration.

object? CognitoConfig { get; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnApi.ICognitoConfigProperty

LambdaAuthorizerConfig

A LambdaAuthorizerConfig specifies how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.

object? LambdaAuthorizerConfig { get; }
Property Value

object

Remarks

Be aware that an AWS AppSync API can have only one AWS Lambda authorizer configured at a time.

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

Type union: either IResolvable or CfnApi.ILambdaAuthorizerConfigProperty

OpenIdConnectConfig

Describes an OpenID Connect (OIDC) configuration.

object? OpenIdConnectConfig { get; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnApi.IOpenIDConnectConfigProperty

Back to top Generated by DocFX