CfnChannelNamespacePropsMixin

class aws_cdk.mixins_preview.aws_appsync.mixins.CfnChannelNamespacePropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::AppSync::ChannelNamespace resource creates a channel namespace associated with an Api .

The ChannelNamespace contains the definitions for code handlers for the Api .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-channelnamespace.html
CloudformationResource:: AWS::AppSync::ChannelNamespace
Mixin:: true
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 import mixins
from aws_cdk.mixins_preview.aws_appsync import mixins as appsync_mixins

cfn_channel_namespace_props_mixin = appsync_mixins.CfnChannelNamespacePropsMixin(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"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::AppSync::ChannelNamespace.

Parameters:

props (Union[CfnChannelNamespaceMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['apiId', 'codeHandlers', 'codeS3Location', 'handlerConfigs', 'name', 'publishAuthModes', 'subscribeAuthModes', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AuthModeProperty

class CfnChannelNamespacePropsMixin.AuthModeProperty(*, auth_type=None)

Bases: object

Describes an authorization configuration.

Use AuthMode to specify the publishing and subscription authorization configuration for an Event API.

Parameters:: auth_type (Optional[str]) – The authorization type.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-authmode.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

auth_mode_property = appsync_mixins.CfnChannelNamespacePropsMixin.AuthModeProperty(
    auth_type="authType"
)

Attributes

auth_type

The authorization type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-authmode.html#cfn-appsync-channelnamespace-authmode-authtype

HandlerConfigProperty

class CfnChannelNamespacePropsMixin.HandlerConfigProperty(*, behavior=None, integration=None)

Bases: object

The HandlerConfig property type specifies the configuration for the handler.

Parameters:

behavior (Optional[str]) – The behavior for the handler.
integration (Union[IResolvable, IntegrationProperty, Dict[str, Any], None]) – The integration data source configuration for the handler.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-handlerconfig.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

handler_config_property = appsync_mixins.CfnChannelNamespacePropsMixin.HandlerConfigProperty(
    behavior="behavior",
    integration=appsync_mixins.CfnChannelNamespacePropsMixin.IntegrationProperty(
        data_source_name="dataSourceName",
        lambda_config=appsync_mixins.CfnChannelNamespacePropsMixin.LambdaConfigProperty(
            invoke_type="invokeType"
        )
    )
)

Attributes

behavior

The behavior for the handler.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-handlerconfig.html#cfn-appsync-channelnamespace-handlerconfig-behavior

integration

The integration data source configuration for the handler.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-handlerconfig.html#cfn-appsync-channelnamespace-handlerconfig-integration

HandlerConfigsProperty

class CfnChannelNamespacePropsMixin.HandlerConfigsProperty(*, on_publish=None, on_subscribe=None)

Bases: object

The HandlerConfigs property type specifies the configuration for the OnPublish and OnSubscribe handlers.

Parameters:

on_publish (Union[IResolvable, HandlerConfigProperty, Dict[str, Any], None]) – The configuration for the OnPublish handler.
on_subscribe (Union[IResolvable, HandlerConfigProperty, Dict[str, Any], None]) – The configuration for the OnSubscribe handler.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-handlerconfigs.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

handler_configs_property = 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"
            )
        )
    )
)

Attributes

on_publish

The configuration for the OnPublish handler.

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

on_subscribe

The configuration for the OnSubscribe handler.

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

IntegrationProperty

class CfnChannelNamespacePropsMixin.IntegrationProperty(*, data_source_name=None, lambda_config=None)

Bases: object

The Integration property type specifies the integration data source configuration for the handler.

Parameters:

data_source_name (Optional[str]) – The unique name of the data source that has been configured on the API.
lambda_config (Union[IResolvable, LambdaConfigProperty, Dict[str, Any], None]) – The configuration for a Lambda data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-integration.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

integration_property = appsync_mixins.CfnChannelNamespacePropsMixin.IntegrationProperty(
    data_source_name="dataSourceName",
    lambda_config=appsync_mixins.CfnChannelNamespacePropsMixin.LambdaConfigProperty(
        invoke_type="invokeType"
    )
)

Attributes

data_source_name

The unique name of the data source that has been configured on the API.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-integration.html#cfn-appsync-channelnamespace-integration-datasourcename

lambda_config

The configuration for a Lambda data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-integration.html#cfn-appsync-channelnamespace-integration-lambdaconfig

LambdaConfigProperty

class CfnChannelNamespacePropsMixin.LambdaConfigProperty(*, invoke_type=None)

Bases: object

The LambdaConfig property type specifies the integration configuration for a Lambda data source.

Parameters:: invoke_type (Optional[str]) – The invocation type for a Lambda data source.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-lambdaconfig.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

lambda_config_property = appsync_mixins.CfnChannelNamespacePropsMixin.LambdaConfigProperty(
    invoke_type="invokeType"
)

Attributes

invoke_type

The invocation type for a Lambda data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-channelnamespace-lambdaconfig.html#cfn-appsync-channelnamespace-lambdaconfig-invoketype