AWS::Wisdom::Assistant
Specifies an Amazon Connect Wisdom assistant.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Wisdom::Assistant", "Properties" : { "Description" :
String
, "Name" :String
, "ServerSideEncryptionConfiguration" :ServerSideEncryptionConfiguration
, "Tags" :[ Tag, ... ]
, "Type" :String
} }
YAML
Type: AWS::Wisdom::Assistant Properties: Description:
String
Name:String
ServerSideEncryptionConfiguration:ServerSideEncryptionConfiguration
Tags:- Tag
Type:String
Properties
Description
-
The description of the assistant.
Required: No
Type: String
Minimum:
1
Maximum:
255
Update requires: Replacement
Name
-
The name of the assistant.
Required: Yes
Type: String
Minimum:
1
Maximum:
255
Update requires: Replacement
ServerSideEncryptionConfiguration
-
The configuration information for the customer managed key used for encryption. The customer managed key must have a policy that allows
kms:CreateGrant
andkms:DescribeKey
permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom with chat, the key policy must also allowkms:Decrypt
,kms:GenerateDataKey*
, andkms:DescribeKey
permissions to theconnect.amazonaws.com
service principal. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.Required: No
Type: ServerSideEncryptionConfiguration
Update requires: Replacement
-
The tags used to organize, track, or control access for this resource.
Required: No
Type: Array of Tag
Update requires: Replacement
Type
-
The type of assistant.
Required: Yes
Type: String
Allowed values:
AGENT
Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the assistant ID.
For more information about using the Ref
function, see Ref
.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt
.
AssistantArn
-
The Amazon Resource Name (ARN) of the assistant.
AssistantId
-
The ID of the Wisdom assistant.