ChannelNamespace L2 construct

A Channel Namespace.

CloudFormation: AWS::AppSync::ChannelNamespace
L1 type: CfnChannelNamespace
Source: aws-appsync/lib/channel-namespace.ts
Type last changed: v2.234.0 · 8 Jan 2026

Example

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 }
    }
});

// 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,
		},
	},
})

Initializer

new ChannelNamespace(scope: Construct, id: string, props: ChannelNamespaceProps)

python

ChannelNamespace(scope: Construct, id: str, props: ChannelNamespaceProps)

java

new ChannelNamespace(Construct scope, String id, ChannelNamespaceProps props)

csharp

new ChannelNamespace(Construct scope, string id, ChannelNamespaceProps props)

NewChannelNamespace(Scope Construct, Id *string, Props ChannelNamespaceProps)

Construct Props

apiIEventApiapiIEventApiapiIEventApiApiIEventApiApiIEventApirequired#

The API this channel namespace is associated with.

authorizationConfigoptionalNamespaceAuthConfigauthorization_configoptionalNamespaceAuthConfigauthorizationConfigoptionalNamespaceAuthConfigAuthorizationConfigoptionalNamespaceAuthConfigAuthorizationConfigoptionalNamespaceAuthConfig#

Authorization config for channel namespace.

Default: defaults to Event API default auth config

channelNamespaceNameoptionalstringchannel_namespace_nameoptionalstrchannelNamespaceNameoptionalStringChannelNamespaceNameoptionalstringChannelNamespaceNameoptional*string#

the name of the channel namespace.

Default: the construct's id will be used

codeoptionalCodecodeoptionalCodecodeoptionalCodeCodeoptionalCodeCodeoptionalCode#

The Event Handler code.

Default: no code is used

publishHandlerConfigoptionalHandlerConfigpublish_handler_configoptionalHandlerConfigpublishHandlerConfigoptionalHandlerConfigPublishHandlerConfigoptionalHandlerConfigPublishHandlerConfigoptionalHandlerConfig#

onPublish handler config.

Default: no handler config

subscribeHandlerConfigoptionalHandlerConfigsubscribe_handler_configoptionalHandlerConfigsubscribeHandlerConfigoptionalHandlerConfigSubscribeHandlerConfigoptionalHandlerConfigSubscribeHandlerConfigoptionalHandlerConfig#

onSubscribe handler config.

Default: no handler config

Properties

channelNamespaceArnstringchannel_namespace_arnstrchannelNamespaceArnStringChannelNamespaceArnstringChannelNamespaceArn*string#

the ARN of the channel namespace.

channelNamespaceRefChannelNamespaceReferencechannel_namespace_refChannelNamespaceReferencechannelNamespaceRefChannelNamespaceReferenceChannelNamespaceRefChannelNamespaceReferenceChannelNamespaceRefChannelNamespaceReference#

A reference to a ChannelNamespace resource.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#

Uniquely identifies this class.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

Methods

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

fromChannelNamespaceArn(scope: Construct, id: string, channelNamespaceArn: string): IChannelNamespace@staticmethod def from_channel_namespace_arn(scope: Construct, id: str, channel_namespace_arn: str) -> IChannelNamespacepublic static IChannelNamespace fromChannelNamespaceArn(Construct scope, String id, String channelNamespaceArn)public static IChannelNamespace FromChannelNamespaceArn(Construct scope, string id, string channelNamespaceArn)func FromChannelNamespaceArn(Scope Construct, Id *string, ChannelNamespaceArn *string) IChannelNamespacestatic#

Use an existing channel namespace by ARN.

grantPublish(grantee: IGrantable): Grantdef grant_publish(self, grantee: IGrantable) -> Grantpublic Grant grantPublish(IGrantable grantee)public Grant GrantPublish(IGrantable grantee)func GrantPublish(Grantee IGrantable) Grant#

Adds an IAM policy statement for EventPublish access to this channel namespace to an IAM principal's policy.

[disable-awslint:no-grants]

1 parameter

Parameters

granteegranteegranteegranteeGrantee — The principal.

grantPublishAndSubscribe(grantee: IGrantable): Grantdef grant_publish_and_subscribe(self, grantee: IGrantable) -> Grantpublic Grant grantPublishAndSubscribe(IGrantable grantee)public Grant GrantPublishAndSubscribe(IGrantable grantee)func GrantPublishAndSubscribe(Grantee IGrantable) Grant#

Adds an IAM policy statement for EventPublish and EventSubscribe access to this channel namespace to an IAM principal's policy.

[disable-awslint:no-grants]

1 parameter

Parameters

granteegranteegranteegranteeGrantee — The principal.

grantSubscribe(grantee: IGrantable): Grantdef grant_subscribe(self, grantee: IGrantable) -> Grantpublic Grant grantSubscribe(IGrantable grantee)public Grant GrantSubscribe(IGrantable grantee)func GrantSubscribe(Grantee IGrantable) Grant#

Adds an IAM policy statement for EventSubscribe access to this channel namespace to an IAM principal's policy.

[disable-awslint:no-grants]

1 parameter

Parameters

granteegranteegranteegranteeGrantee — The principal.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#

Returns true if the construct was created by CDK, and false otherwise.

isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#

Check whether the given construct is a Resource.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

ChannelNamespace L2 construct ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​

ChannelNamespace L2 construct

Example

Initializer

Construct Props

Properties

Methods