Package software.amazon.awscdk.mixins.preview.services.appsync.mixins

Interface CfnChannelNamespaceMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannelNamespaceMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:22.757Z")
@Stability(Stable)
public interface CfnChannelNamespaceMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnChannelNamespacePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.mixins.preview.services.appsync.mixins.*;
 CfnChannelNamespaceMixinProps cfnChannelNamespaceMixinProps = CfnChannelNamespaceMixinProps.builder()
         .apiId("apiId")
         .codeHandlers("codeHandlers")
         .codeS3Location("codeS3Location")
         .handlerConfigs(HandlerConfigsProperty.builder()
                 .onPublish(HandlerConfigProperty.builder()
                         .behavior("behavior")
                         .integration(IntegrationProperty.builder()
                                 .dataSourceName("dataSourceName")
                                 .lambdaConfig(LambdaConfigProperty.builder()
                                         .invokeType("invokeType")
                                         .build())
                                 .build())
                         .build())
                 .onSubscribe(HandlerConfigProperty.builder()
                         .behavior("behavior")
                         .integration(IntegrationProperty.builder()
                                 .dataSourceName("dataSourceName")
                                 .lambdaConfig(LambdaConfigProperty.builder()
                                         .invokeType("invokeType")
                                         .build())
                                 .build())
                         .build())
                 .build())
         .name("name")
         .publishAuthModes(List.of(AuthModeProperty.builder()
                 .authType("authType")
                 .build()))
         .subscribeAuthModes(List.of(AuthModeProperty.builder()
                 .authType("authType")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnChannelNamespaceMixinProps.Builder	A builder for CfnChannelNamespaceMixinProps
static final class	CfnChannelNamespaceMixinProps.Jsii$Proxy	An implementation for CfnChannelNamespaceMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnChannelNamespaceMixinProps.Builder	builder()
default String	getApiId()	The Api ID.
default String	getCodeHandlers()	The event handler functions that run custom business logic to process published events and subscribe requests.
default String	getCodeS3Location()	The Amazon S3 endpoint where the code is located.
default Object	getHandlerConfigs()	The configuration for the OnPublish and OnSubscribe handlers.
default String	getName()	The name of the channel namespace.
default Object	getPublishAuthModes()	The authorization mode to use for publishing messages on the channel namespace.
default Object	getSubscribeAuthModes()	The authorization mode to use for subscribing to messages on the channel namespace.
default List<CfnTag>	getTags()	A set of tags (key-value pairs) for this channel namespace.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

@Stability(Stable)
@Nullable
default String getApiId()

The Api ID.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-apiid

getCodeHandlers

@Stability(Stable)
@Nullable
default String getCodeHandlers()

The event handler functions that run custom business logic to process published events and subscribe requests.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-codehandlers

getCodeS3Location

@Stability(Stable)
@Nullable
default String getCodeS3Location()

The Amazon S3 endpoint where the code is located.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-codes3location

getHandlerConfigs

@Stability(Stable)
@Nullable
default Object getHandlerConfigs()

The configuration for the OnPublish and OnSubscribe handlers.

Returns union: either IResolvable or CfnChannelNamespacePropsMixin.HandlerConfigsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-handlerconfigs

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the channel namespace.

This name must be unique within the Api .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-name

getPublishAuthModes

@Stability(Stable)
@Nullable
default Object getPublishAuthModes()

The authorization mode to use for publishing messages on the channel namespace.

This configuration overrides the default Api authorization configuration.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnChannelNamespacePropsMixin.AuthModeProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-publishauthmodes

getSubscribeAuthModes

@Stability(Stable)
@Nullable
default Object getSubscribeAuthModes()

The authorization mode to use for subscribing to messages on the channel namespace.

This configuration overrides the default Api authorization configuration.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnChannelNamespacePropsMixin.AuthModeProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-subscribeauthmodes

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A set of tags (key-value pairs) for this channel namespace.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html#cfn-appsync-channelnamespace-tags

builder

@Stability(Stable)
static CfnChannelNamespaceMixinProps.Builder builder()

Returns:

a CfnChannelNamespaceMixinProps.Builder of CfnChannelNamespaceMixinProps