Interface CfnApi.AuthProviderProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnApi.AuthProviderProperty.Jsii$Proxy
- Enclosing class:
CfnApi
@Stability(Stable)
public static interface CfnApi.AuthProviderProperty
extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.appsync.*;
AuthProviderProperty authProviderProperty = AuthProviderProperty.builder()
.authType("authType")
// the properties below are optional
.cognitoConfig(CognitoConfigProperty.builder()
.awsRegion("awsRegion")
.userPoolId("userPoolId")
// the properties below are optional
.appIdClientRegex("appIdClientRegex")
.build())
.lambdaAuthorizerConfig(LambdaAuthorizerConfigProperty.builder()
.authorizerUri("authorizerUri")
// the properties below are optional
.authorizerResultTtlInSeconds(123)
.identityValidationExpression("identityValidationExpression")
.build())
.openIdConnectConfig(OpenIDConnectConfigProperty.builder()
.issuer("issuer")
// the properties below are optional
.authTtl(123)
.clientId("clientId")
.iatTtl(123)
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnApi.AuthProviderPropertystatic final classAn implementation forCfnApi.AuthProviderProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()The authorization type.default ObjectDescribes an Amazon Cognito user pool configuration.default ObjectALambdaAuthorizerConfigspecifies how to authorize AWS AppSync API access when using theAWS_LAMBDAauthorizer mode.default ObjectDescribes an OpenID Connect (OIDC) configuration.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAuthType
The authorization type.- See Also:
-
getCognitoConfig
Describes an Amazon Cognito user pool configuration.Returns union: either
IResolvableorCfnApi.CognitoConfigProperty- See Also:
-
getLambdaAuthorizerConfig
ALambdaAuthorizerConfigspecifies how to authorize AWS AppSync API access when using theAWS_LAMBDAauthorizer mode.Be aware that an AWS AppSync API can have only one AWS Lambda authorizer configured at a time.
Returns union: either
IResolvableorCfnApi.LambdaAuthorizerConfigProperty- See Also:
-
getOpenIdConnectConfig
Describes an OpenID Connect (OIDC) configuration.Returns union: either
IResolvableorCfnApi.OpenIDConnectConfigProperty- See Also:
-
builder
-