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
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 |
| OpenIdConnectConfig | Describes an OpenID Connect (OIDC) configuration. |
Properties
AuthType
The authorization type.
string AuthType { get; }
Property Value
Remarks
CognitoConfig
Describes an Amazon Cognito user pool configuration.
object? CognitoConfig { get; }
Property Value
Remarks
LambdaAuthorizerConfig
A LambdaAuthorizerConfig specifies how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.
object? LambdaAuthorizerConfig { get; }
Property Value
Remarks
Be aware that an AWS AppSync API can have only one AWS Lambda authorizer configured at a time.
Type union: either IResolvable or CfnApi.ILambdaAuthorizerConfigProperty
OpenIdConnectConfig
Describes an OpenID Connect (OIDC) configuration.
object? OpenIdConnectConfig { get; }