CfnAIPromptPropsMixin

class aws_cdk.mixins_preview.aws_wisdom.mixins.CfnAIPromptPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates an Amazon Q in Connect AI Prompt.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiprompt.html
CloudformationResource:: AWS::Wisdom::AIPrompt
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_wisdom import mixins as wisdom_mixins

cfn_aIPrompt_props_mixin = wisdom_mixins.CfnAIPromptPropsMixin(wisdom_mixins.CfnAIPromptMixinProps(
    api_format="apiFormat",
    assistant_id="assistantId",
    description="description",
    model_id="modelId",
    name="name",
    tags={
        "tags_key": "tags"
    },
    template_configuration=wisdom_mixins.CfnAIPromptPropsMixin.AIPromptTemplateConfigurationProperty(
        text_full_ai_prompt_edit_template_configuration=wisdom_mixins.CfnAIPromptPropsMixin.TextFullAIPromptEditTemplateConfigurationProperty(
            text="text"
        )
    ),
    template_type="templateType",
    type="type"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Wisdom::AIPrompt.

Parameters:

props (Union[CfnAIPromptMixinProps, 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 = ['apiFormat', 'assistantId', 'description', 'modelId', 'name', 'tags', 'templateConfiguration', 'templateType', 'type']

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

AIPromptTemplateConfigurationProperty

class CfnAIPromptPropsMixin.AIPromptTemplateConfigurationProperty(*, text_full_ai_prompt_edit_template_configuration=None)

Bases: object

A typed union that specifies the configuration for a prompt template based on its type.

Parameters:: text_full_ai_prompt_edit_template_configuration (Union[IResolvable, TextFullAIPromptEditTemplateConfigurationProperty, Dict[str, Any], None]) – The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiprompt-aiprompttemplateconfiguration.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_wisdom import mixins as wisdom_mixins

a_iPrompt_template_configuration_property = wisdom_mixins.CfnAIPromptPropsMixin.AIPromptTemplateConfigurationProperty(
    text_full_ai_prompt_edit_template_configuration=wisdom_mixins.CfnAIPromptPropsMixin.TextFullAIPromptEditTemplateConfigurationProperty(
        text="text"
    )
)

Attributes

text_full_ai_prompt_edit_template_configuration

The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiprompt-aiprompttemplateconfiguration.html#cfn-wisdom-aiprompt-aiprompttemplateconfiguration-textfullaipromptedittemplateconfiguration

TextFullAIPromptEditTemplateConfigurationProperty

class CfnAIPromptPropsMixin.TextFullAIPromptEditTemplateConfigurationProperty(*, text=None)

Bases: object

The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.

Parameters:: text (Optional[str]) – The YAML text for the AI Prompt template.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiprompt-textfullaipromptedittemplateconfiguration.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_wisdom import mixins as wisdom_mixins

text_full_aIPrompt_edit_template_configuration_property = wisdom_mixins.CfnAIPromptPropsMixin.TextFullAIPromptEditTemplateConfigurationProperty(
    text="text"
)

Attributes

text

The YAML text for the AI Prompt template.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiprompt-textfullaipromptedittemplateconfiguration.html#cfn-wisdom-aiprompt-textfullaipromptedittemplateconfiguration-text