Class ChannelNamespace.Builder
java.lang.Object
software.amazon.awscdk.services.appsync.ChannelNamespace.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<ChannelNamespace>
- Enclosing class:
ChannelNamespace
@Stability(Stable)
public static final class ChannelNamespace.Builder
extends Object
implements software.amazon.jsii.Builder<ChannelNamespace>
A fluent builder for
ChannelNamespace.-
Method Summary
Modifier and TypeMethodDescriptionThe API this channel namespace is associated with.authorizationConfig(NamespaceAuthConfig authorizationConfig) Authorization config for channel namespace.build()channelNamespaceName(String channelNamespaceName) the name of the channel namespace.The Event Handler code.static ChannelNamespace.BuilderpublishHandlerConfig(HandlerConfig publishHandlerConfig) onPublish handler config.subscribeHandlerConfig(HandlerConfig subscribeHandlerConfig) onSubscribe handler config.
-
Method Details
-
create
@Stability(Stable) public static ChannelNamespace.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope- This parameter is required.id- This parameter is required.- Returns:
- a new instance of
ChannelNamespace.Builder.
-
authorizationConfig
@Stability(Stable) public ChannelNamespace.Builder authorizationConfig(NamespaceAuthConfig authorizationConfig) Authorization config for channel namespace.Default: - defaults to Event API default auth config
- Parameters:
authorizationConfig- Authorization config for channel namespace. This parameter is required.- Returns:
this
-
channelNamespaceName
@Stability(Stable) public ChannelNamespace.Builder channelNamespaceName(String channelNamespaceName) the name of the channel namespace.Default: - the construct's id will be used
- Parameters:
channelNamespaceName- the name of the channel namespace. This parameter is required.- Returns:
this
-
code
The Event Handler code.Default: - no code is used
- Parameters:
code- The Event Handler code. This parameter is required.- Returns:
this
-
publishHandlerConfig
@Stability(Stable) public ChannelNamespace.Builder publishHandlerConfig(HandlerConfig publishHandlerConfig) onPublish handler config.Default: - no handler config
- Parameters:
publishHandlerConfig- onPublish handler config. This parameter is required.- Returns:
this
-
subscribeHandlerConfig
@Stability(Stable) public ChannelNamespace.Builder subscribeHandlerConfig(HandlerConfig subscribeHandlerConfig) onSubscribe handler config.Default: - no handler config
- Parameters:
subscribeHandlerConfig- onSubscribe handler config. This parameter is required.- Returns:
this
-
api
The API this channel namespace is associated with.- Parameters:
api- The API this channel namespace is associated with. This parameter is required.- Returns:
this
-
build
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<ChannelNamespace>- Returns:
- a newly built instance of
ChannelNamespace.
-