Package software.amazon.awscdk.services.appsync

Class CfnChannelNamespace

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.appsync.CfnChannelNamespace
All Implemented Interfaces:
IInspectable, ITaggableV2, IChannelNamespaceRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:32.588Z") @Stability(Stable) public class CfnChannelNamespace extends CfnResource implements IInspectable, IChannelNamespaceRef, ITaggableV2
The AWS::AppSync::ChannelNamespace resource creates a channel namespace associated with an Api .

The ChannelNamespace contains the definitions for code handlers for the 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.*;
 CfnChannelNamespace cfnChannelNamespace = CfnChannelNamespace.Builder.create(this, "MyCfnChannelNamespace")
         .apiId("apiId")
         .name("name")
         // the properties below are optional
         .codeHandlers("codeHandlers")
         .codeS3Location("codeS3Location")
         .handlerConfigs(HandlerConfigsProperty.builder()
                 .onPublish(HandlerConfigProperty.builder()
                         .behavior("behavior")
                         .integration(IntegrationProperty.builder()
                                 .dataSourceName("dataSourceName")
                                 // the properties below are optional
                                 .lambdaConfig(LambdaConfigProperty.builder()
                                         .invokeType("invokeType")
                                         .build())
                                 .build())
                         .build())
                 .onSubscribe(HandlerConfigProperty.builder()
                         .behavior("behavior")
                         .integration(IntegrationProperty.builder()
                                 .dataSourceName("dataSourceName")
                                 // the properties below are optional
                                 .lambdaConfig(LambdaConfigProperty.builder()
                                         .invokeType("invokeType")
                                         .build())
                                 .build())
                         .build())
                 .build())
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnChannelNamespace

      protected CfnChannelNamespace(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnChannelNamespace

      protected CfnChannelNamespace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnChannelNamespace

      @Stability(Stable) public CfnChannelNamespace(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnChannelNamespaceProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrChannelNamespaceArn

      @Stability(Stable) @NotNull public String getAttrChannelNamespaceArn()
      The Amazon Resource Name (ARN) of the channel namespace.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getChannelNamespaceRef

      @Stability(Stable) @NotNull public ChannelNamespaceReference getChannelNamespaceRef()
      A reference to a ChannelNamespace resource.
      Specified by:
      getChannelNamespaceRef in interface IChannelNamespaceRef

    • getApiId

      @Stability(Stable) @NotNull public String getApiId()
      The Api ID.

    • setApiId

      @Stability(Stable) public void setApiId(@NotNull String value)
      The Api ID.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the channel namespace.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the channel namespace.

    • getCodeHandlers

      @Stability(Stable) @Nullable public String getCodeHandlers()
      The event handler functions that run custom business logic to process published events and subscribe requests.

    • setCodeHandlers

      @Stability(Stable) public void setCodeHandlers(@Nullable String value)
      The event handler functions that run custom business logic to process published events and subscribe requests.

    • getCodeS3Location

      @Stability(Stable) @Nullable public String getCodeS3Location()
      The Amazon S3 endpoint where the code is located.

    • setCodeS3Location

      @Stability(Stable) public void setCodeS3Location(@Nullable String value)
      The Amazon S3 endpoint where the code is located.

    • getHandlerConfigs

      @Stability(Stable) @Nullable public Object getHandlerConfigs()
      The configuration for the OnPublish and OnSubscribe handlers.

      Returns union: either IResolvable or CfnChannelNamespace.HandlerConfigsProperty

    • setHandlerConfigs

      @Stability(Stable) public void setHandlerConfigs(@Nullable IResolvable value)
      The configuration for the OnPublish and OnSubscribe handlers.

    • setHandlerConfigs

      @Stability(Stable) public void setHandlerConfigs(@Nullable CfnChannelNamespace.HandlerConfigsProperty value)
      The configuration for the OnPublish and OnSubscribe handlers.

    • getPublishAuthModes

      @Stability(Stable) @Nullable public Object getPublishAuthModes()
      The authorization mode to use for publishing messages on the channel namespace.

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

    • setPublishAuthModes

      @Stability(Stable) public void setPublishAuthModes(@Nullable IResolvable value)
      The authorization mode to use for publishing messages on the channel namespace.

    • setPublishAuthModes

      @Stability(Stable) public void setPublishAuthModes(@Nullable List<Object> value)
      The authorization mode to use for publishing messages on the channel namespace.

    • getSubscribeAuthModes

      @Stability(Stable) @Nullable public Object getSubscribeAuthModes()
      The authorization mode to use for subscribing to messages on the channel namespace.

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

    • setSubscribeAuthModes

      @Stability(Stable) public void setSubscribeAuthModes(@Nullable IResolvable value)
      The authorization mode to use for subscribing to messages on the channel namespace.

    • setSubscribeAuthModes

      @Stability(Stable) public void setSubscribeAuthModes(@Nullable List<Object> value)
      The authorization mode to use for subscribing to messages on the channel namespace.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A set of tags (key-value pairs) for this channel namespace.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A set of tags (key-value pairs) for this channel namespace.