CfnAssistantAssociationPropsMixin

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

Bases: Mixin

Specifies an association between an Amazon Connect Wisdom assistant and another resource.

Currently, the only supported association is with a knowledge base. An assistant can have only a single association.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-assistantassociation.html
CloudformationResource:: AWS::Wisdom::AssistantAssociation
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

from aws_cdk import CfnTag
# 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_assistant_association_props_mixin = wisdom_mixins.CfnAssistantAssociationPropsMixin(wisdom_mixins.CfnAssistantAssociationMixinProps(
    assistant_id="assistantId",
    association=wisdom_mixins.CfnAssistantAssociationPropsMixin.AssociationDataProperty(
        external_bedrock_knowledge_base_config=wisdom_mixins.CfnAssistantAssociationPropsMixin.ExternalBedrockKnowledgeBaseConfigProperty(
            access_role_arn="accessRoleArn",
            bedrock_knowledge_base_arn="bedrockKnowledgeBaseArn"
        ),
        knowledge_base_id="knowledgeBaseId"
    ),
    association_type="associationType",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnAssistantAssociationMixinProps, 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 = ['assistantId', 'association', 'associationType', '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

AssociationDataProperty

class CfnAssistantAssociationPropsMixin.AssociationDataProperty(*, external_bedrock_knowledge_base_config=None, knowledge_base_id=None)

Bases: object

A union type that currently has a single argument, which is the knowledge base ID.

Parameters:

external_bedrock_knowledge_base_config (Union[IResolvable, ExternalBedrockKnowledgeBaseConfigProperty, Dict[str, Any], None])
knowledge_base_id (Optional[str]) – The identifier of the knowledge base.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-assistantassociation-associationdata.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

association_data_property = wisdom_mixins.CfnAssistantAssociationPropsMixin.AssociationDataProperty(
    external_bedrock_knowledge_base_config=wisdom_mixins.CfnAssistantAssociationPropsMixin.ExternalBedrockKnowledgeBaseConfigProperty(
        access_role_arn="accessRoleArn",
        bedrock_knowledge_base_arn="bedrockKnowledgeBaseArn"
    ),
    knowledge_base_id="knowledgeBaseId"
)

Attributes

external_bedrock_knowledge_base_config

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-assistantassociation-associationdata.html#cfn-wisdom-assistantassociation-associationdata-externalbedrockknowledgebaseconfig

Type:: see

knowledge_base_id

The identifier of the knowledge base.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-assistantassociation-associationdata.html#cfn-wisdom-assistantassociation-associationdata-knowledgebaseid

ExternalBedrockKnowledgeBaseConfigProperty

class CfnAssistantAssociationPropsMixin.ExternalBedrockKnowledgeBaseConfigProperty(*, access_role_arn=None, bedrock_knowledge_base_arn=None)

Bases: object

Configuration for an external Bedrock knowledge base.

Parameters:

access_role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM role used to access the external Bedrock knowledge base.
bedrock_knowledge_base_arn (Optional[str]) – The Amazon Resource Name (ARN) of the external Bedrock knowledge base.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-assistantassociation-externalbedrockknowledgebaseconfig.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

external_bedrock_knowledge_base_config_property = wisdom_mixins.CfnAssistantAssociationPropsMixin.ExternalBedrockKnowledgeBaseConfigProperty(
    access_role_arn="accessRoleArn",
    bedrock_knowledge_base_arn="bedrockKnowledgeBaseArn"
)

Attributes

access_role_arn

The Amazon Resource Name (ARN) of the IAM role used to access the external Bedrock knowledge base.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-assistantassociation-externalbedrockknowledgebaseconfig.html#cfn-wisdom-assistantassociation-externalbedrockknowledgebaseconfig-accessrolearn

bedrock_knowledge_base_arn

The Amazon Resource Name (ARN) of the external Bedrock knowledge base.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-assistantassociation-externalbedrockknowledgebaseconfig.html#cfn-wisdom-assistantassociation-externalbedrockknowledgebaseconfig-bedrockknowledgebasearn