Interface CfnApi.EventConfigProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnApi.EventConfigProperty.Jsii$Proxy
- Enclosing class:
CfnApi
@Stability(Stable)
public static interface CfnApi.EventConfigProperty
extends software.amazon.jsii.JsiiSerializable
Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.
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.*;
EventConfigProperty eventConfigProperty = EventConfigProperty.builder()
.authProviders(List.of(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()))
.connectionAuthModes(List.of(AuthModeProperty.builder()
.authType("authType")
.build()))
.defaultPublishAuthModes(List.of(AuthModeProperty.builder()
.authType("authType")
.build()))
.defaultSubscribeAuthModes(List.of(AuthModeProperty.builder()
.authType("authType")
.build()))
// the properties below are optional
.logConfig(EventLogConfigProperty.builder()
.cloudWatchLogsRoleArn("cloudWatchLogsRoleArn")
.logLevel("logLevel")
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnApi.EventConfigPropertystatic final classAn implementation forCfnApi.EventConfigProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()A list of authorization providers.A list of valid authorization modes for the Event API connections.A list of valid authorization modes for the Event API publishing.A list of valid authorization modes for the Event API subscriptions.default ObjectThe CloudWatch Logs configuration for the Event API.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAuthProviders
A list of authorization providers.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnApi.AuthProviderProperty>- See Also:
-
getConnectionAuthModes
A list of valid authorization modes for the Event API connections.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnApi.AuthModeProperty>- See Also:
-
getDefaultPublishAuthModes
A list of valid authorization modes for the Event API publishing.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnApi.AuthModeProperty>- See Also:
-
getDefaultSubscribeAuthModes
A list of valid authorization modes for the Event API subscriptions.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnApi.AuthModeProperty>- See Also:
-
getLogConfig
The CloudWatch Logs configuration for the Event API.Returns union: either
IResolvableorCfnApi.EventLogConfigProperty- See Also:
-
builder
- Returns:
- a
CfnApi.EventConfigProperty.BuilderofCfnApi.EventConfigProperty
-