CfnChannelFlowPropsMixin

class aws_cdk.cfn_property_mixins.aws_chime.CfnChannelFlowPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a channel flow in the Amazon Chime SDK Messaging service.

A channel flow is a container for processors (Lambda functions) that perform actions on chat messages.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chime-channelflow.html
CloudformationResource:: AWS::Chime::ChannelFlow
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.cfn_property_mixins import aws_chime as chime
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_channel_flow_props_mixin = chime.CfnChannelFlowPropsMixin(chime.CfnChannelFlowMixinProps(
    app_instance_arn="appInstanceArn",
    name="name",
    processors=[chime.CfnChannelFlowPropsMixin.ProcessorProperty(
        configuration=chime.CfnChannelFlowPropsMixin.ProcessorConfigurationProperty(
            lambda_=chime.CfnChannelFlowPropsMixin.LambdaConfigurationProperty(
                invocation_type="invocationType",
                resource_arn="resourceArn"
            )
        ),
        execution_order=123,
        fallback_action="fallbackAction",
        name="name"
    )],
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::Chime::ChannelFlow.

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['appInstanceArn', 'name', 'processors', 'tags']

Static Methods

classmethod is_mixin(x)

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.

LambdaConfigurationProperty

class CfnChannelFlowPropsMixin.LambdaConfigurationProperty(*, invocation_type=None, resource_arn=None)

Bases: object

Stores metadata about a Lambda processor.

Parameters:

invocation_type (Optional[str]) – Controls how the Lambda function is invoked.
resource_arn (Optional[str]) – The ARN of the Lambda message processing function.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-channelflow-lambdaconfiguration.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.cfn_property_mixins import aws_chime as chime

lambda_configuration_property = chime.CfnChannelFlowPropsMixin.LambdaConfigurationProperty(
    invocation_type="invocationType",
    resource_arn="resourceArn"
)

Attributes

invocation_type

Controls how the Lambda function is invoked.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-channelflow-lambdaconfiguration.html#cfn-chime-channelflow-lambdaconfiguration-invocationtype

resource_arn

The ARN of the Lambda message processing function.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-channelflow-lambdaconfiguration.html#cfn-chime-channelflow-lambdaconfiguration-resourcearn

ProcessorConfigurationProperty

class CfnChannelFlowPropsMixin.ProcessorConfigurationProperty(*, lambda_=None)

Bases: object

A processor’s metadata.

Parameters:: lambda – Stores metadata about a Lambda processor.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-channelflow-processorconfiguration.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.cfn_property_mixins import aws_chime as chime

processor_configuration_property = chime.CfnChannelFlowPropsMixin.ProcessorConfigurationProperty(
    lambda_=chime.CfnChannelFlowPropsMixin.LambdaConfigurationProperty(
        invocation_type="invocationType",
        resource_arn="resourceArn"
    )
)

Attributes

lambda_

Stores metadata about a Lambda processor.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-channelflow-processorconfiguration.html#cfn-chime-channelflow-processorconfiguration-lambda

ProcessorProperty

class CfnChannelFlowPropsMixin.ProcessorProperty(*, configuration=None, execution_order=None, fallback_action=None, name=None)

Bases: object

Information about a processor in a channel flow.

Parameters:

configuration (Union[IResolvable, ProcessorConfigurationProperty, Dict[str, Any], None]) – A processor’s metadata.
execution_order (Union[int, float, None]) – The sequence in which processors run.
fallback_action (Optional[str]) – Determines whether to continue or stop processing when communication with a processor fails.
name (Optional[str]) – The name of the processor.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-channelflow-processor.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.cfn_property_mixins import aws_chime as chime

processor_property = chime.CfnChannelFlowPropsMixin.ProcessorProperty(
    configuration=chime.CfnChannelFlowPropsMixin.ProcessorConfigurationProperty(
        lambda_=chime.CfnChannelFlowPropsMixin.LambdaConfigurationProperty(
            invocation_type="invocationType",
            resource_arn="resourceArn"
        )
    ),
    execution_order=123,
    fallback_action="fallbackAction",
    name="name"
)

Attributes

configuration

A processor’s metadata.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-channelflow-processor.html#cfn-chime-channelflow-processor-configuration

execution_order

The sequence in which processors run.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-channelflow-processor.html#cfn-chime-channelflow-processor-executionorder

fallback_action

Determines whether to continue or stop processing when communication with a processor fails.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-channelflow-processor.html#cfn-chime-channelflow-processor-fallbackaction

name

The name of the processor.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-channelflow-processor.html#cfn-chime-channelflow-processor-name