CfnChannelNamespaceMixinProps

class aws_cdk.mixins_preview.aws_appsync.mixins.CfnChannelNamespaceMixinProps(*, api_id=None, code_handlers=None, code_s3_location=None, handler_configs=None, name=None, publish_auth_modes=None, subscribe_auth_modes=None, tags=None)

Bases: object

Properties for CfnChannelNamespacePropsMixin.

Parameters:
  • api_id (Optional[str]) – The Api ID.

  • 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.

  • name (Optional[str]) – The name of the channel namespace. This name must be unique within the Api .

  • 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.mixins_preview.aws_appsync import mixins as appsync_mixins

cfn_channel_namespace_mixin_props = appsync_mixins.CfnChannelNamespaceMixinProps(
    api_id="apiId",
    code_handlers="codeHandlers",
    code_s3_location="codeS3Location",
    handler_configs=appsync_mixins.CfnChannelNamespacePropsMixin.HandlerConfigsProperty(
        on_publish=appsync_mixins.CfnChannelNamespacePropsMixin.HandlerConfigProperty(
            behavior="behavior",
            integration=appsync_mixins.CfnChannelNamespacePropsMixin.IntegrationProperty(
                data_source_name="dataSourceName",
                lambda_config=appsync_mixins.CfnChannelNamespacePropsMixin.LambdaConfigProperty(
                    invoke_type="invokeType"
                )
            )
        ),
        on_subscribe=appsync_mixins.CfnChannelNamespacePropsMixin.HandlerConfigProperty(
            behavior="behavior",
            integration=appsync_mixins.CfnChannelNamespacePropsMixin.IntegrationProperty(
                data_source_name="dataSourceName",
                lambda_config=appsync_mixins.CfnChannelNamespacePropsMixin.LambdaConfigProperty(
                    invoke_type="invokeType"
                )
            )
        )
    ),
    name="name",
    publish_auth_modes=[appsync_mixins.CfnChannelNamespacePropsMixin.AuthModeProperty(
        auth_type="authType"
    )],
    subscribe_auth_modes=[appsync_mixins.CfnChannelNamespacePropsMixin.AuthModeProperty(
        auth_type="authType"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

api_id

The Api ID.

See:

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

code_handlers

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

See:

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

code_s3_location

The Amazon S3 endpoint where the code is located.

See:

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

handler_configs

The configuration for the OnPublish and OnSubscribe handlers.

See:

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

name

The name of the channel namespace.

This name must be unique within the Api .

See:

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

publish_auth_modes

The authorization mode to use for publishing messages on the channel namespace.

This configuration overrides the default Api authorization configuration.

See:

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

subscribe_auth_modes

The authorization mode to use for subscribing to messages on the channel namespace.

This configuration overrides the default Api authorization configuration.

See:

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

tags

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#cfn-appsync-channelnamespace-tags