View a markdown version of this page

AWS::Wisdom::Content - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Wisdom::Content

Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Wisdom::Content",
  "Properties" : {
      "KnowledgeBaseId" : String,
      "Metadata" : {Key: Value, ...},
      "Name" : String,
      "OverrideLinkOutUri" : String,
      "Tags" : [ Tag, ... ],
      "Title" : String,
      "UploadId" : String
    }
}

YAML

Type: AWS::Wisdom::Content
Properties:
  KnowledgeBaseId: String
  Metadata: 
    Key: Value
  Name: String
  OverrideLinkOutUri: String
  Tags: 
    - Tag
  Title: String
  UploadId: String

Properties

KnowledgeBaseId

The identifier of the knowledge base.

Required: Yes

Type: String

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Update requires: Replacement

Metadata

A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

Required: No

Type: Object of String

Pattern: ^.+$

Minimum: 1

Maximum: 4096

Update requires: No interruption

Name

The name of the content.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9\s_.,-]+

Minimum: 1

Maximum: 255

Update requires: Replacement

OverrideLinkOutUri

Property description not available.

Required: No

Type: String

Minimum: 1

Maximum: 4096

Update requires: No interruption

Tags

The tags used to organize, track, or control access for this resource.

Required: No

Type: Array of Tag

Update requires: No interruption

Title

The title of the content.

Required: No

Type: String

Minimum: 1

Maximum: 255

Update requires: No interruption

UploadId

Property description not available.

Required: No

Type: String

Minimum: 1

Maximum: 1200

Update requires: No interruption

Return values

Ref

Fn::GetAtt

ContentArn

The Amazon Resource Name (ARN) of the content.

ContentId

The identifier of the content.

ContentType

The media type of the content.

KnowledgeBaseArn

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

LinkOutUri

The URI of the content.

RevisionId

The identifier of the content revision.

Status

The status of the content.