Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. appsync
  5. ChannelNamespace
AWS v7.5.0 published on Wednesday, Aug 20, 2025 by Pulumi
pulumi/pulumi-aws

aws.appsync.ChannelNamespace

Explore with Pulumi AI

aws logo
AWS v7.5.0 published on Wednesday, Aug 20, 2025 by Pulumi
pulumi/pulumi-aws

    Manages an AWS AppSync Channel Namespace.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.appsync.ChannelNamespace("example", {
    name: "example-channel-namespace",
    apiId: exampleAwsAppsyncApi.apiId,
});

    import pulumi
import pulumi_aws as aws

example = aws.appsync.ChannelNamespace("example",
    name="example-channel-namespace",
    api_id=example_aws_appsync_api["apiId"])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/appsync"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := appsync.NewChannelNamespace(ctx, "example", &appsync.ChannelNamespaceArgs{
			Name:  pulumi.String("example-channel-namespace"),
			ApiId: pulumi.Any(exampleAwsAppsyncApi.ApiId),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.AppSync.ChannelNamespace("example", new()
    {
        Name = "example-channel-namespace",
        ApiId = exampleAwsAppsyncApi.ApiId,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.appsync.ChannelNamespace;
import com.pulumi.aws.appsync.ChannelNamespaceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ChannelNamespace("example", ChannelNamespaceArgs.builder()
            .name("example-channel-namespace")
            .apiId(exampleAwsAppsyncApi.apiId())
            .build());

    }
}

    resources:
  example:
    type: aws:appsync:ChannelNamespace
    properties:
      name: example-channel-namespace
      apiId: ${exampleAwsAppsyncApi.apiId}

    Create ChannelNamespace Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ChannelNamespace(name: string, args: ChannelNamespaceArgs, opts?: CustomResourceOptions);
    @overload
def ChannelNamespace(resource_name: str,
                     args: ChannelNamespaceArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def ChannelNamespace(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     api_id: Optional[str] = None,
                     code_handlers: Optional[str] = None,
                     handler_configs: Optional[ChannelNamespaceHandlerConfigsArgs] = None,
                     name: Optional[str] = None,
                     publish_auth_modes: Optional[Sequence[ChannelNamespacePublishAuthModeArgs]] = None,
                     region: Optional[str] = None,
                     subscribe_auth_modes: Optional[Sequence[ChannelNamespaceSubscribeAuthModeArgs]] = None,
                     tags: Optional[Mapping[str, str]] = None)
    func NewChannelNamespace(ctx *Context, name string, args ChannelNamespaceArgs, opts ...ResourceOption) (*ChannelNamespace, error)
    public ChannelNamespace(string name, ChannelNamespaceArgs args, CustomResourceOptions? opts = null)
    public ChannelNamespace(String name, ChannelNamespaceArgs args)
public ChannelNamespace(String name, ChannelNamespaceArgs args, CustomResourceOptions options)

    type: aws:appsync:ChannelNamespace
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ChannelNamespaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ChannelNamespaceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ChannelNamespaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ChannelNamespaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ChannelNamespaceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var channelNamespaceResource = new Aws.AppSync.ChannelNamespace("channelNamespaceResource", new()
{
    ApiId = "string",
    CodeHandlers = "string",
    HandlerConfigs = new Aws.AppSync.Inputs.ChannelNamespaceHandlerConfigsArgs
    {
        OnPublish = new Aws.AppSync.Inputs.ChannelNamespaceHandlerConfigsOnPublishArgs
        {
            Behavior = "string",
            Integration = new Aws.AppSync.Inputs.ChannelNamespaceHandlerConfigsOnPublishIntegrationArgs
            {
                DataSourceName = "string",
                LambdaConfig = new Aws.AppSync.Inputs.ChannelNamespaceHandlerConfigsOnPublishIntegrationLambdaConfigArgs
                {
                    InvokeType = "string",
                },
            },
        },
        OnSubscribe = new Aws.AppSync.Inputs.ChannelNamespaceHandlerConfigsOnSubscribeArgs
        {
            Behavior = "string",
            Integration = new Aws.AppSync.Inputs.ChannelNamespaceHandlerConfigsOnSubscribeIntegrationArgs
            {
                DataSourceName = "string",
                LambdaConfig = new Aws.AppSync.Inputs.ChannelNamespaceHandlerConfigsOnSubscribeIntegrationLambdaConfigArgs
                {
                    InvokeType = "string",
                },
            },
        },
    },
    Name = "string",
    PublishAuthModes = new[]
    {
        new Aws.AppSync.Inputs.ChannelNamespacePublishAuthModeArgs
        {
            AuthType = "string",
        },
    },
    Region = "string",
    SubscribeAuthModes = new[]
    {
        new Aws.AppSync.Inputs.ChannelNamespaceSubscribeAuthModeArgs
        {
            AuthType = "string",
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := appsync.NewChannelNamespace(ctx, "channelNamespaceResource", &appsync.ChannelNamespaceArgs{
	ApiId:        pulumi.String("string"),
	CodeHandlers: pulumi.String("string"),
	HandlerConfigs: &appsync.ChannelNamespaceHandlerConfigsArgs{
		OnPublish: &appsync.ChannelNamespaceHandlerConfigsOnPublishArgs{
			Behavior: pulumi.String("string"),
			Integration: &appsync.ChannelNamespaceHandlerConfigsOnPublishIntegrationArgs{
				DataSourceName: pulumi.String("string"),
				LambdaConfig: &appsync.ChannelNamespaceHandlerConfigsOnPublishIntegrationLambdaConfigArgs{
					InvokeType: pulumi.String("string"),
				},
			},
		},
		OnSubscribe: &appsync.ChannelNamespaceHandlerConfigsOnSubscribeArgs{
			Behavior: pulumi.String("string"),
			Integration: &appsync.ChannelNamespaceHandlerConfigsOnSubscribeIntegrationArgs{
				DataSourceName: pulumi.String("string"),
				LambdaConfig: &appsync.ChannelNamespaceHandlerConfigsOnSubscribeIntegrationLambdaConfigArgs{
					InvokeType: pulumi.String("string"),
				},
			},
		},
	},
	Name: pulumi.String("string"),
	PublishAuthModes: appsync.ChannelNamespacePublishAuthModeArray{
		&appsync.ChannelNamespacePublishAuthModeArgs{
			AuthType: pulumi.String("string"),
		},
	},
	Region: pulumi.String("string"),
	SubscribeAuthModes: appsync.ChannelNamespaceSubscribeAuthModeArray{
		&appsync.ChannelNamespaceSubscribeAuthModeArgs{
			AuthType: pulumi.String("string"),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var channelNamespaceResource = new ChannelNamespace("channelNamespaceResource", ChannelNamespaceArgs.builder()
    .apiId("string")
    .codeHandlers("string")
    .handlerConfigs(ChannelNamespaceHandlerConfigsArgs.builder()
        .onPublish(ChannelNamespaceHandlerConfigsOnPublishArgs.builder()
            .behavior("string")
            .integration(ChannelNamespaceHandlerConfigsOnPublishIntegrationArgs.builder()
                .dataSourceName("string")
                .lambdaConfig(ChannelNamespaceHandlerConfigsOnPublishIntegrationLambdaConfigArgs.builder()
                    .invokeType("string")
                    .build())
                .build())
            .build())
        .onSubscribe(ChannelNamespaceHandlerConfigsOnSubscribeArgs.builder()
            .behavior("string")
            .integration(ChannelNamespaceHandlerConfigsOnSubscribeIntegrationArgs.builder()
                .dataSourceName("string")
                .lambdaConfig(ChannelNamespaceHandlerConfigsOnSubscribeIntegrationLambdaConfigArgs.builder()
                    .invokeType("string")
                    .build())
                .build())
            .build())
        .build())
    .name("string")
    .publishAuthModes(ChannelNamespacePublishAuthModeArgs.builder()
        .authType("string")
        .build())
    .region("string")
    .subscribeAuthModes(ChannelNamespaceSubscribeAuthModeArgs.builder()
        .authType("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());

    channel_namespace_resource = aws.appsync.ChannelNamespace("channelNamespaceResource",
    api_id="string",
    code_handlers="string",
    handler_configs={
        "on_publish": {
            "behavior": "string",
            "integration": {
                "data_source_name": "string",
                "lambda_config": {
                    "invoke_type": "string",
                },
            },
        },
        "on_subscribe": {
            "behavior": "string",
            "integration": {
                "data_source_name": "string",
                "lambda_config": {
                    "invoke_type": "string",
                },
            },
        },
    },
    name="string",
    publish_auth_modes=[{
        "auth_type": "string",
    }],
    region="string",
    subscribe_auth_modes=[{
        "auth_type": "string",
    }],
    tags={
        "string": "string",
    })

    const channelNamespaceResource = new aws.appsync.ChannelNamespace("channelNamespaceResource", {
    apiId: "string",
    codeHandlers: "string",
    handlerConfigs: {
        onPublish: {
            behavior: "string",
            integration: {
                dataSourceName: "string",
                lambdaConfig: {
                    invokeType: "string",
                },
            },
        },
        onSubscribe: {
            behavior: "string",
            integration: {
                dataSourceName: "string",
                lambdaConfig: {
                    invokeType: "string",
                },
            },
        },
    },
    name: "string",
    publishAuthModes: [{
        authType: "string",
    }],
    region: "string",
    subscribeAuthModes: [{
        authType: "string",
    }],
    tags: {
        string: "string",
    },
});

    type: aws:appsync:ChannelNamespace
properties:
    apiId: string
    codeHandlers: string
    handlerConfigs:
        onPublish:
            behavior: string
            integration:
                dataSourceName: string
                lambdaConfig:
                    invokeType: string
        onSubscribe:
            behavior: string
            integration:
                dataSourceName: string
                lambdaConfig:
                    invokeType: string
    name: string
    publishAuthModes:
        - authType: string
    region: string
    subscribeAuthModes:
        - authType: string
    tags:
        string: string

    ChannelNamespace Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ChannelNamespace resource accepts the following input properties:

    ApiId string
    Event API ID.
    CodeHandlers string
    Event handler functions that run custom business logic to process published events and subscribe requests.
    HandlerConfigs ChannelNamespaceHandlerConfigs
    Configuration for the on_publish and on_subscribe handlers. See Handler Configs below.
    Name string

    Name of the channel namespace.

    The following arguments are optional:

    PublishAuthModes List<ChannelNamespacePublishAuthMode>
    Authorization modes to use for publishing messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SubscribeAuthModes List<ChannelNamespaceSubscribeAuthMode>
    Authorization modes to use for subscribing to messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    Tags Dictionary<string, string>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    ApiId string
    Event API ID.
    CodeHandlers string
    Event handler functions that run custom business logic to process published events and subscribe requests.
    HandlerConfigs ChannelNamespaceHandlerConfigsArgs
    Configuration for the on_publish and on_subscribe handlers. See Handler Configs below.
    Name string

    Name of the channel namespace.

    The following arguments are optional:

    PublishAuthModes []ChannelNamespacePublishAuthModeArgs
    Authorization modes to use for publishing messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SubscribeAuthModes []ChannelNamespaceSubscribeAuthModeArgs
    Authorization modes to use for subscribing to messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    Tags map[string]string
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    apiId String
    Event API ID.
    codeHandlers String
    Event handler functions that run custom business logic to process published events and subscribe requests.
    handlerConfigs ChannelNamespaceHandlerConfigs
    Configuration for the on_publish and on_subscribe handlers. See Handler Configs below.
    name String

    Name of the channel namespace.

    The following arguments are optional:

    publishAuthModes List<ChannelNamespacePublishAuthMode>
    Authorization modes to use for publishing messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    subscribeAuthModes List<ChannelNamespaceSubscribeAuthMode>
    Authorization modes to use for subscribing to messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    tags Map<String,String>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    apiId string
    Event API ID.
    codeHandlers string
    Event handler functions that run custom business logic to process published events and subscribe requests.
    handlerConfigs ChannelNamespaceHandlerConfigs
    Configuration for the on_publish and on_subscribe handlers. See Handler Configs below.
    name string

    Name of the channel namespace.

    The following arguments are optional:

    publishAuthModes ChannelNamespacePublishAuthMode[]
    Authorization modes to use for publishing messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    subscribeAuthModes ChannelNamespaceSubscribeAuthMode[]
    Authorization modes to use for subscribing to messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    tags {[key: string]: string}
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    api_id str
    Event API ID.
    code_handlers str
    Event handler functions that run custom business logic to process published events and subscribe requests.
    handler_configs ChannelNamespaceHandlerConfigsArgs
    Configuration for the on_publish and on_subscribe handlers. See Handler Configs below.
    name str

    Name of the channel namespace.

    The following arguments are optional:

    publish_auth_modes Sequence[ChannelNamespacePublishAuthModeArgs]
    Authorization modes to use for publishing messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    subscribe_auth_modes Sequence[ChannelNamespaceSubscribeAuthModeArgs]
    Authorization modes to use for subscribing to messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    tags Mapping[str, str]
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    apiId String
    Event API ID.
    codeHandlers String
    Event handler functions that run custom business logic to process published events and subscribe requests.
    handlerConfigs Property Map
    Configuration for the on_publish and on_subscribe handlers. See Handler Configs below.
    name String

    Name of the channel namespace.

    The following arguments are optional:

    publishAuthModes List<Property Map>
    Authorization modes to use for publishing messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    subscribeAuthModes List<Property Map>
    Authorization modes to use for subscribing to messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    tags Map<String>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ChannelNamespace resource produces the following output properties:

    ChannelNamespaceArn string
    ARN of the channel namespace.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    ChannelNamespaceArn string
    ARN of the channel namespace.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    channelNamespaceArn String
    ARN of the channel namespace.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    channelNamespaceArn string
    ARN of the channel namespace.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    channel_namespace_arn str
    ARN of the channel namespace.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    channelNamespaceArn String
    ARN of the channel namespace.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Look up Existing ChannelNamespace Resource

    Get an existing ChannelNamespace resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ChannelNamespaceState, opts?: CustomResourceOptions): ChannelNamespace
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_id: Optional[str] = None,
        channel_namespace_arn: Optional[str] = None,
        code_handlers: Optional[str] = None,
        handler_configs: Optional[ChannelNamespaceHandlerConfigsArgs] = None,
        name: Optional[str] = None,
        publish_auth_modes: Optional[Sequence[ChannelNamespacePublishAuthModeArgs]] = None,
        region: Optional[str] = None,
        subscribe_auth_modes: Optional[Sequence[ChannelNamespaceSubscribeAuthModeArgs]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> ChannelNamespace
    func GetChannelNamespace(ctx *Context, name string, id IDInput, state *ChannelNamespaceState, opts ...ResourceOption) (*ChannelNamespace, error)
    public static ChannelNamespace Get(string name, Input<string> id, ChannelNamespaceState? state, CustomResourceOptions? opts = null)
    public static ChannelNamespace get(String name, Output<String> id, ChannelNamespaceState state, CustomResourceOptions options)
    resources:  _:    type: aws:appsync:ChannelNamespace    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiId string
    Event API ID.
    ChannelNamespaceArn string
    ARN of the channel namespace.
    CodeHandlers string
    Event handler functions that run custom business logic to process published events and subscribe requests.
    HandlerConfigs ChannelNamespaceHandlerConfigs
    Configuration for the on_publish and on_subscribe handlers. See Handler Configs below.
    Name string

    Name of the channel namespace.

    The following arguments are optional:

    PublishAuthModes List<ChannelNamespacePublishAuthMode>
    Authorization modes to use for publishing messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SubscribeAuthModes List<ChannelNamespaceSubscribeAuthMode>
    Authorization modes to use for subscribing to messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    Tags Dictionary<string, string>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    ApiId string
    Event API ID.
    ChannelNamespaceArn string
    ARN of the channel namespace.
    CodeHandlers string
    Event handler functions that run custom business logic to process published events and subscribe requests.
    HandlerConfigs ChannelNamespaceHandlerConfigsArgs
    Configuration for the on_publish and on_subscribe handlers. See Handler Configs below.
    Name string

    Name of the channel namespace.

    The following arguments are optional:

    PublishAuthModes []ChannelNamespacePublishAuthModeArgs
    Authorization modes to use for publishing messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SubscribeAuthModes []ChannelNamespaceSubscribeAuthModeArgs
    Authorization modes to use for subscribing to messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    Tags map[string]string
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    apiId String
    Event API ID.
    channelNamespaceArn String
    ARN of the channel namespace.
    codeHandlers String
    Event handler functions that run custom business logic to process published events and subscribe requests.
    handlerConfigs ChannelNamespaceHandlerConfigs
    Configuration for the on_publish and on_subscribe handlers. See Handler Configs below.
    name String

    Name of the channel namespace.

    The following arguments are optional:

    publishAuthModes List<ChannelNamespacePublishAuthMode>
    Authorization modes to use for publishing messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    subscribeAuthModes List<ChannelNamespaceSubscribeAuthMode>
    Authorization modes to use for subscribing to messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    tags Map<String,String>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    apiId string
    Event API ID.
    channelNamespaceArn string
    ARN of the channel namespace.
    codeHandlers string
    Event handler functions that run custom business logic to process published events and subscribe requests.
    handlerConfigs ChannelNamespaceHandlerConfigs
    Configuration for the on_publish and on_subscribe handlers. See Handler Configs below.
    name string

    Name of the channel namespace.

    The following arguments are optional:

    publishAuthModes ChannelNamespacePublishAuthMode[]
    Authorization modes to use for publishing messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    subscribeAuthModes ChannelNamespaceSubscribeAuthMode[]
    Authorization modes to use for subscribing to messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    tags {[key: string]: string}
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    api_id str
    Event API ID.
    channel_namespace_arn str
    ARN of the channel namespace.
    code_handlers str
    Event handler functions that run custom business logic to process published events and subscribe requests.
    handler_configs ChannelNamespaceHandlerConfigsArgs
    Configuration for the on_publish and on_subscribe handlers. See Handler Configs below.
    name str

    Name of the channel namespace.

    The following arguments are optional:

    publish_auth_modes Sequence[ChannelNamespacePublishAuthModeArgs]
    Authorization modes to use for publishing messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    subscribe_auth_modes Sequence[ChannelNamespaceSubscribeAuthModeArgs]
    Authorization modes to use for subscribing to messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    tags Mapping[str, str]
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    apiId String
    Event API ID.
    channelNamespaceArn String
    ARN of the channel namespace.
    codeHandlers String
    Event handler functions that run custom business logic to process published events and subscribe requests.
    handlerConfigs Property Map
    Configuration for the on_publish and on_subscribe handlers. See Handler Configs below.
    name String

    Name of the channel namespace.

    The following arguments are optional:

    publishAuthModes List<Property Map>
    Authorization modes to use for publishing messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    subscribeAuthModes List<Property Map>
    Authorization modes to use for subscribing to messages on the channel namespace. This configuration overrides the default API authorization configuration. See Auth Modes below.
    tags Map<String>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Supporting Types

    ChannelNamespaceHandlerConfigs, ChannelNamespaceHandlerConfigsArgs

    OnPublish ChannelNamespaceHandlerConfigsOnPublish
    Handler configuration. See Handler Config below.
    OnSubscribe ChannelNamespaceHandlerConfigsOnSubscribe
    Handler configuration. See Handler Config below.
    OnPublish ChannelNamespaceHandlerConfigsOnPublish
    Handler configuration. See Handler Config below.
    OnSubscribe ChannelNamespaceHandlerConfigsOnSubscribe
    Handler configuration. See Handler Config below.
    onPublish ChannelNamespaceHandlerConfigsOnPublish
    Handler configuration. See Handler Config below.
    onSubscribe ChannelNamespaceHandlerConfigsOnSubscribe
    Handler configuration. See Handler Config below.
    onPublish ChannelNamespaceHandlerConfigsOnPublish
    Handler configuration. See Handler Config below.
    onSubscribe ChannelNamespaceHandlerConfigsOnSubscribe
    Handler configuration. See Handler Config below.
    on_publish ChannelNamespaceHandlerConfigsOnPublish
    Handler configuration. See Handler Config below.
    on_subscribe ChannelNamespaceHandlerConfigsOnSubscribe
    Handler configuration. See Handler Config below.
    onPublish Property Map
    Handler configuration. See Handler Config below.
    onSubscribe Property Map
    Handler configuration. See Handler Config below.

    ChannelNamespaceHandlerConfigsOnPublish, ChannelNamespaceHandlerConfigsOnPublishArgs

    Behavior string
    Behavior for the handler. Valid values: CODE, DIRECT.
    Integration ChannelNamespaceHandlerConfigsOnPublishIntegration
    Integration data source configuration for the handler. See Integration below.
    Behavior string
    Behavior for the handler. Valid values: CODE, DIRECT.
    Integration ChannelNamespaceHandlerConfigsOnPublishIntegration
    Integration data source configuration for the handler. See Integration below.
    behavior String
    Behavior for the handler. Valid values: CODE, DIRECT.
    integration ChannelNamespaceHandlerConfigsOnPublishIntegration
    Integration data source configuration for the handler. See Integration below.
    behavior string
    Behavior for the handler. Valid values: CODE, DIRECT.
    integration ChannelNamespaceHandlerConfigsOnPublishIntegration
    Integration data source configuration for the handler. See Integration below.
    behavior str
    Behavior for the handler. Valid values: CODE, DIRECT.
    integration ChannelNamespaceHandlerConfigsOnPublishIntegration
    Integration data source configuration for the handler. See Integration below.
    behavior String
    Behavior for the handler. Valid values: CODE, DIRECT.
    integration Property Map
    Integration data source configuration for the handler. See Integration below.

    ChannelNamespaceHandlerConfigsOnPublishIntegration, ChannelNamespaceHandlerConfigsOnPublishIntegrationArgs

    DataSourceName string
    Unique name of the data source that has been configured on the API.
    LambdaConfig ChannelNamespaceHandlerConfigsOnPublishIntegrationLambdaConfig
    Configuration for a Lambda data source. See Lambda Config below.
    DataSourceName string
    Unique name of the data source that has been configured on the API.
    LambdaConfig ChannelNamespaceHandlerConfigsOnPublishIntegrationLambdaConfig
    Configuration for a Lambda data source. See Lambda Config below.
    dataSourceName String
    Unique name of the data source that has been configured on the API.
    lambdaConfig ChannelNamespaceHandlerConfigsOnPublishIntegrationLambdaConfig
    Configuration for a Lambda data source. See Lambda Config below.
    dataSourceName string
    Unique name of the data source that has been configured on the API.
    lambdaConfig ChannelNamespaceHandlerConfigsOnPublishIntegrationLambdaConfig
    Configuration for a Lambda data source. See Lambda Config below.
    data_source_name str
    Unique name of the data source that has been configured on the API.
    lambda_config ChannelNamespaceHandlerConfigsOnPublishIntegrationLambdaConfig
    Configuration for a Lambda data source. See Lambda Config below.
    dataSourceName String
    Unique name of the data source that has been configured on the API.
    lambdaConfig Property Map
    Configuration for a Lambda data source. See Lambda Config below.

    ChannelNamespaceHandlerConfigsOnPublishIntegrationLambdaConfig, ChannelNamespaceHandlerConfigsOnPublishIntegrationLambdaConfigArgs

    InvokeType string
    Invocation type for a Lambda data source. Valid values: REQUEST_RESPONSE, EVENT.
    InvokeType string
    Invocation type for a Lambda data source. Valid values: REQUEST_RESPONSE, EVENT.
    invokeType String
    Invocation type for a Lambda data source. Valid values: REQUEST_RESPONSE, EVENT.
    invokeType string
    Invocation type for a Lambda data source. Valid values: REQUEST_RESPONSE, EVENT.
    invoke_type str
    Invocation type for a Lambda data source. Valid values: REQUEST_RESPONSE, EVENT.
    invokeType String
    Invocation type for a Lambda data source. Valid values: REQUEST_RESPONSE, EVENT.

    ChannelNamespaceHandlerConfigsOnSubscribe, ChannelNamespaceHandlerConfigsOnSubscribeArgs

    Behavior string
    Behavior for the handler. Valid values: CODE, DIRECT.
    Integration ChannelNamespaceHandlerConfigsOnSubscribeIntegration
    Integration data source configuration for the handler. See Integration below.
    Behavior string
    Behavior for the handler. Valid values: CODE, DIRECT.
    Integration ChannelNamespaceHandlerConfigsOnSubscribeIntegration
    Integration data source configuration for the handler. See Integration below.
    behavior String
    Behavior for the handler. Valid values: CODE, DIRECT.
    integration ChannelNamespaceHandlerConfigsOnSubscribeIntegration
    Integration data source configuration for the handler. See Integration below.
    behavior string
    Behavior for the handler. Valid values: CODE, DIRECT.
    integration ChannelNamespaceHandlerConfigsOnSubscribeIntegration
    Integration data source configuration for the handler. See Integration below.
    behavior str
    Behavior for the handler. Valid values: CODE, DIRECT.
    integration ChannelNamespaceHandlerConfigsOnSubscribeIntegration
    Integration data source configuration for the handler. See Integration below.
    behavior String
    Behavior for the handler. Valid values: CODE, DIRECT.
    integration Property Map
    Integration data source configuration for the handler. See Integration below.

    ChannelNamespaceHandlerConfigsOnSubscribeIntegration, ChannelNamespaceHandlerConfigsOnSubscribeIntegrationArgs

    DataSourceName string
    Unique name of the data source that has been configured on the API.
    LambdaConfig ChannelNamespaceHandlerConfigsOnSubscribeIntegrationLambdaConfig
    Configuration for a Lambda data source. See Lambda Config below.
    DataSourceName string
    Unique name of the data source that has been configured on the API.
    LambdaConfig ChannelNamespaceHandlerConfigsOnSubscribeIntegrationLambdaConfig
    Configuration for a Lambda data source. See Lambda Config below.
    dataSourceName String
    Unique name of the data source that has been configured on the API.
    lambdaConfig ChannelNamespaceHandlerConfigsOnSubscribeIntegrationLambdaConfig
    Configuration for a Lambda data source. See Lambda Config below.
    dataSourceName string
    Unique name of the data source that has been configured on the API.
    lambdaConfig ChannelNamespaceHandlerConfigsOnSubscribeIntegrationLambdaConfig
    Configuration for a Lambda data source. See Lambda Config below.
    data_source_name str
    Unique name of the data source that has been configured on the API.
    lambda_config ChannelNamespaceHandlerConfigsOnSubscribeIntegrationLambdaConfig
    Configuration for a Lambda data source. See Lambda Config below.
    dataSourceName String
    Unique name of the data source that has been configured on the API.
    lambdaConfig Property Map
    Configuration for a Lambda data source. See Lambda Config below.

    ChannelNamespaceHandlerConfigsOnSubscribeIntegrationLambdaConfig, ChannelNamespaceHandlerConfigsOnSubscribeIntegrationLambdaConfigArgs

    InvokeType string
    Invocation type for a Lambda data source. Valid values: REQUEST_RESPONSE, EVENT.
    InvokeType string
    Invocation type for a Lambda data source. Valid values: REQUEST_RESPONSE, EVENT.
    invokeType String
    Invocation type for a Lambda data source. Valid values: REQUEST_RESPONSE, EVENT.
    invokeType string
    Invocation type for a Lambda data source. Valid values: REQUEST_RESPONSE, EVENT.
    invoke_type str
    Invocation type for a Lambda data source. Valid values: REQUEST_RESPONSE, EVENT.
    invokeType String
    Invocation type for a Lambda data source. Valid values: REQUEST_RESPONSE, EVENT.

    ChannelNamespacePublishAuthMode, ChannelNamespacePublishAuthModeArgs

    AuthType string
    Type of authentication. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA.
    AuthType string
    Type of authentication. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA.
    authType String
    Type of authentication. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA.
    authType string
    Type of authentication. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA.
    auth_type str
    Type of authentication. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA.
    authType String
    Type of authentication. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA.

    ChannelNamespaceSubscribeAuthMode, ChannelNamespaceSubscribeAuthModeArgs

    AuthType string
    Type of authentication. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA.
    AuthType string
    Type of authentication. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA.
    authType String
    Type of authentication. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA.
    authType string
    Type of authentication. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA.
    auth_type str
    Type of authentication. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA.
    authType String
    Type of authentication. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA.

    Import

    Using pulumi import, import AppSync Channel Namespace using the api_id and name separated by a comma (,). For example:

    $ pulumi import aws:appsync/channelNamespace:ChannelNamespace example example-api-id,example-channel-namespace

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v7.5.0 published on Wednesday, Aug 20, 2025 by Pulumi
    pulumi/pulumi-aws