CfnChannelNamespaceProps

class aws_cdk.aws_appsync.CfnChannelNamespaceProps(*, api_id, name, code_handlers=None, code_s3_location=None, handler_configs=None, publish_auth_modes=None, subscribe_auth_modes=None, tags=None)

Bases: object

Properties for defining a CfnChannelNamespace.

Parameters:

api_id (str) – The Api ID.
name (str) – The name of the channel namespace. This name must be unique within the Api .
code_handlers (Optional[str]) – The event handler functions that run custom business logic to process published events and subscribe requests.
code_s3_location (Optional[str]) – The Amazon S3 endpoint where the code is located.
handler_configs (Union[IResolvable, HandlerConfigsProperty, Dict[str, Any], None]) – The configuration for the OnPublish and OnSubscribe handlers.
publish_auth_modes (Union[IResolvable, Sequence[Union[IResolvable, AuthModeProperty, Dict[str, Any]]], None]) – The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default Api authorization configuration.
subscribe_auth_modes (Union[IResolvable, Sequence[Union[IResolvable, AuthModeProperty, Dict[str, Any]]], None]) – The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default Api authorization configuration.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A set of tags (key-value pairs) for this channel namespace.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appsync as appsync

cfn_channel_namespace_props = appsync.CfnChannelNamespaceProps(
    api_id="apiId",
    name="name",

    # the properties below are optional
    code_handlers="codeHandlers",
    code_s3_location="codeS3Location",
    handler_configs=appsync.CfnChannelNamespace.HandlerConfigsProperty(
        on_publish=appsync.CfnChannelNamespace.HandlerConfigProperty(
            behavior="behavior",
            integration=appsync.CfnChannelNamespace.IntegrationProperty(
                data_source_name="dataSourceName",

                # the properties below are optional
                lambda_config=appsync.CfnChannelNamespace.LambdaConfigProperty(
                    invoke_type="invokeType"
                )
            )
        ),
        on_subscribe=appsync.CfnChannelNamespace.HandlerConfigProperty(
            behavior="behavior",
            integration=appsync.CfnChannelNamespace.IntegrationProperty(
                data_source_name="dataSourceName",

                # the properties below are optional
                lambda_config=appsync.CfnChannelNamespace.LambdaConfigProperty(
                    invoke_type="invokeType"
                )
            )
        )
    ),
    publish_auth_modes=[appsync.CfnChannelNamespace.AuthModeProperty(
        auth_type="authType"
    )],
    subscribe_auth_modes=[appsync.CfnChannelNamespace.AuthModeProperty(
        auth_type="authType"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)