AWS::AppSync::ChannelNamespace - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::AppSync::ChannelNamespace

The AWS::AppSync::ChannelNamespace resource creates a channel namespace associated with an Api. The ChannelNamespace contains the definitions for code handlers for the Api.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::AppSync::ChannelNamespace",
  "Properties" : {
      "ApiId" : String,
      "CodeHandlers" : String,
      "CodeS3Location" : String,
      "HandlerConfigs" : HandlerConfigs,
      "Name" : String,
      "PublishAuthModes" : [ AuthMode, ... ],
      "SubscribeAuthModes" : [ AuthMode, ... ],
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::AppSync::ChannelNamespace
Properties:
  ApiId: String
  CodeHandlers: String
  CodeS3Location: String
  HandlerConfigs: 
    HandlerConfigs
  Name: String
  PublishAuthModes: 
    - AuthMode
  SubscribeAuthModes: 
    - AuthMode
  Tags: 
    - Tag

Properties

ApiId

The Api ID.

Required: Yes

Type: String

Update requires: Replacement

CodeHandlers

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

Required: No

Type: String

Minimum: 1

Maximum: 32768

Update requires: No interruption

CodeS3Location

The Amazon S3 endpoint where the code is located.

Required: No

Type: String

Update requires: No interruption

HandlerConfigs

The configuration for the OnPublish and OnSubscribe handlers.

Required: No

Type: HandlerConfigs

Update requires: No interruption

Name

The name of the channel namespace. This name must be unique within the Api.

Required: Yes

Type: String

Pattern: ([A-Za-z0-9](?:[A-Za-z0-9\-]{0,48}[A-Za-z0-9])?)

Minimum: 1

Maximum: 50

Update requires: Replacement

PublishAuthModes

The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default Apiauthorization configuration.

Required: No

Type: Array of AuthMode

Update requires: No interruption

SubscribeAuthModes

The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default Apiauthorization configuration.

Required: No

Type: Array of AuthMode

Update requires: No interruption

Tags

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

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns The Amazon Resource Name (ARN) of the channel namespace.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

ChannelNamespaceArn

The Amazon Resource Name (ARN) of the channel namespace.