CfnAppInstanceBotPropsMixin

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

Bases: Mixin

Resource Type definition for AWS::Chime::AppInstanceBot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chime-appinstancebot.html

CloudformationResource:

AWS::Chime::AppInstanceBot

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_app_instance_bot_props_mixin = chime.CfnAppInstanceBotPropsMixin(chime.CfnAppInstanceBotMixinProps(
    app_instance_arn="appInstanceArn",
    configuration=chime.CfnAppInstanceBotPropsMixin.ConfigurationProperty(
        lex=chime.CfnAppInstanceBotPropsMixin.LexConfigurationProperty(
            invoked_by=chime.CfnAppInstanceBotPropsMixin.InvokedByProperty(
                standard_messages="standardMessages",
                targeted_messages="targetedMessages"
            ),
            lex_bot_alias_arn="lexBotAliasArn",
            locale_id="localeId",
            responds_to="respondsTo",
            welcome_intent="welcomeIntent"
        )
    ),
    metadata="metadata",
    name="name",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

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

Parameters:
  • props (Union[CfnAppInstanceBotMixinProps, 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', 'configuration', 'metadata', 'name', '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.

ConfigurationProperty

class CfnAppInstanceBotPropsMixin.ConfigurationProperty(*, lex=None)

Bases: object

A structure that contains configuration data.

Parameters:

lex (Union[IResolvable, LexConfigurationProperty, Dict[str, Any], None]) – The configuration for an Amazon Lex V2 bot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-appinstancebot-configuration.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

configuration_property = chime.CfnAppInstanceBotPropsMixin.ConfigurationProperty(
    lex=chime.CfnAppInstanceBotPropsMixin.LexConfigurationProperty(
        invoked_by=chime.CfnAppInstanceBotPropsMixin.InvokedByProperty(
            standard_messages="standardMessages",
            targeted_messages="targetedMessages"
        ),
        lex_bot_alias_arn="lexBotAliasArn",
        locale_id="localeId",
        responds_to="respondsTo",
        welcome_intent="welcomeIntent"
    )
)

Attributes

lex

The configuration for an Amazon Lex V2 bot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-appinstancebot-configuration.html#cfn-chime-appinstancebot-configuration-lex

InvokedByProperty

class CfnAppInstanceBotPropsMixin.InvokedByProperty(*, standard_messages=None, targeted_messages=None)

Bases: object

Specifies the type of message that triggers a bot.

Parameters:
  • standard_messages (Optional[str]) – Sets standard messages as the bot trigger.

  • targeted_messages (Optional[str]) – Sets targeted messages as the bot trigger.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-appinstancebot-invokedby.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

invoked_by_property = chime.CfnAppInstanceBotPropsMixin.InvokedByProperty(
    standard_messages="standardMessages",
    targeted_messages="targetedMessages"
)

Attributes

standard_messages

Sets standard messages as the bot trigger.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-appinstancebot-invokedby.html#cfn-chime-appinstancebot-invokedby-standardmessages

targeted_messages

Sets targeted messages as the bot trigger.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-appinstancebot-invokedby.html#cfn-chime-appinstancebot-invokedby-targetedmessages

LexConfigurationProperty

class CfnAppInstanceBotPropsMixin.LexConfigurationProperty(*, invoked_by=None, lex_bot_alias_arn=None, locale_id=None, responds_to=None, welcome_intent=None)

Bases: object

The configuration for an Amazon Lex V2 bot.

Parameters:
  • invoked_by (Union[IResolvable, InvokedByProperty, Dict[str, Any], None]) – Specifies the type of message that triggers a bot.

  • lex_bot_alias_arn (Optional[str]) – The ARN of the Amazon Lex V2 bot’s alias.

  • locale_id (Optional[str]) – Identifies the Amazon Lex V2 bot’s language and locale.

  • responds_to (Optional[str]) – Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.

  • welcome_intent (Optional[str]) – The name of the welcome intent configured in the Amazon Lex V2 bot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-appinstancebot-lexconfiguration.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

lex_configuration_property = chime.CfnAppInstanceBotPropsMixin.LexConfigurationProperty(
    invoked_by=chime.CfnAppInstanceBotPropsMixin.InvokedByProperty(
        standard_messages="standardMessages",
        targeted_messages="targetedMessages"
    ),
    lex_bot_alias_arn="lexBotAliasArn",
    locale_id="localeId",
    responds_to="respondsTo",
    welcome_intent="welcomeIntent"
)

Attributes

invoked_by

Specifies the type of message that triggers a bot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-appinstancebot-lexconfiguration.html#cfn-chime-appinstancebot-lexconfiguration-invokedby

lex_bot_alias_arn

The ARN of the Amazon Lex V2 bot’s alias.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-appinstancebot-lexconfiguration.html#cfn-chime-appinstancebot-lexconfiguration-lexbotaliasarn

locale_id

Identifies the Amazon Lex V2 bot’s language and locale.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-appinstancebot-lexconfiguration.html#cfn-chime-appinstancebot-lexconfiguration-localeid

responds_to

Determines whether the Amazon Lex V2 bot responds to all standard messages.

Control messages are not supported.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-appinstancebot-lexconfiguration.html#cfn-chime-appinstancebot-lexconfiguration-respondsto

welcome_intent

The name of the welcome intent configured in the Amazon Lex V2 bot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-chime-appinstancebot-lexconfiguration.html#cfn-chime-appinstancebot-lexconfiguration-welcomeintent