NamespaceAuthConfig Struct
Authorization configuration for the Channel Namespace.
| Source | aws-appsync/lib/channel-namespace.ts |
|---|---|
| Type last changed |
Example
ts
declare const api: appsync.EventApi;
new appsync.ChannelNamespace(this, 'Namespace', {
api,
authorizationConfig: {
// Override publishing authorization to API Key
publishAuthModeTypes: [appsync.AppSyncAuthorizationType.API_KEY],
// Override subscribing authorization to Lambda
subscribeAuthModeTypes: [appsync.AppSyncAuthorizationType.LAMBDA],
},
});
python
# api: appsync.EventApi
appsync.ChannelNamespace(self, "Namespace",
api=api,
authorization_config=appsync.NamespaceAuthConfig(
# Override publishing authorization to API Key
publish_auth_mode_types=[appsync.AppSyncAuthorizationType.API_KEY],
# Override subscribing authorization to Lambda
subscribe_auth_mode_types=[appsync.AppSyncAuthorizationType.LAMBDA]
)
)
java
EventApi api;
ChannelNamespace.Builder.create(this, "Namespace")
.api(api)
.authorizationConfig(NamespaceAuthConfig.builder()
// Override publishing authorization to API Key
.publishAuthModeTypes(List.of(AppSyncAuthorizationType.API_KEY))
// Override subscribing authorization to Lambda
.subscribeAuthModeTypes(List.of(AppSyncAuthorizationType.LAMBDA))
.build())
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
EventApi api;
new ChannelNamespace(this, "Namespace", new ChannelNamespaceProps {
Api = api,
AuthorizationConfig = new NamespaceAuthConfig {
// Override publishing authorization to API Key
PublishAuthModeTypes = new [] { AppSyncAuthorizationType.API_KEY },
// Override subscribing authorization to Lambda
SubscribeAuthModeTypes = new [] { AppSyncAuthorizationType.LAMBDA }
}
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var api EventApi
appsync.NewChannelNamespace(this, jsii.String("Namespace"), &ChannelNamespaceProps{
Api: Api,
AuthorizationConfig: &NamespaceAuthConfig{
// Override publishing authorization to API Key
PublishAuthModeTypes: []AppSyncAuthorizationType{
appsync.AppSyncAuthorizationType_API_KEY,
},
// Override subscribing authorization to Lambda
SubscribeAuthModeTypes: []AppSyncAuthorizationType{
appsync.AppSyncAuthorizationType_LAMBDA,
},
},
})
Properties
publishAuthModeTypesoptionalAppSyncAuthorizationType[]publish_auth_mode_typesoptionaltyping.List[AppSyncAuthorizationType]publishAuthModeTypesoptionalList<AppSyncAuthorizationType>PublishAuthModeTypesoptionalAppSyncAuthorizationType[]PublishAuthModeTypesoptional*[]AppSyncAuthorizationType #The publish auth modes for this Event Api.
Default: API Key authorization
subscribeAuthModeTypesoptionalAppSyncAuthorizationType[]subscribe_auth_mode_typesoptionaltyping.List[AppSyncAuthorizationType]subscribeAuthModeTypesoptionalList<AppSyncAuthorizationType>SubscribeAuthModeTypesoptionalAppSyncAuthorizationType[]SubscribeAuthModeTypesoptional*[]AppSyncAuthorizationType #The subscribe auth modes for this Event Api.
Default: API Key authorization