AWS::Connect::DataTableAttribute - AWS CloudFormation

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::Connect::DataTableAttribute

Represents an attribute (column) in a data table. Attributes define the schema and validation rules for values that can be stored in the table. They specify the data type, constraints, and whether the attribute is used as a primary key for record identification.

Syntax

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

JSON

{ "Type" : "AWS::Connect::DataTableAttribute", "Properties" : { "DataTableArn" : String, "Description" : String, "InstanceArn" : String, "Name" : String, "Primary" : Boolean, "Validation" : Validation, "ValueType" : String } }

YAML

Type: AWS::Connect::DataTableAttribute Properties: DataTableArn: String Description: String InstanceArn: String Name: String Primary: Boolean Validation: Validation ValueType: String

Properties

DataTableArn

The Amazon Resource Name (ARN) of the data table that contains this attribute.

Required: No

Type: String

Minimum: 1

Maximum: 2048

Update requires: Replacement

Description

An optional description explaining the purpose and usage of this attribute.

Required: No

Type: String

Pattern: ^[\P{C} ]+$

Minimum: 0

Maximum: 250

Update requires: No interruption

InstanceArn

The Amazon Resource Name (ARN) of the instance.

Required: No

Type: String

Pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$

Minimum: 1

Maximum: 100

Update requires: Replacement

Name

The human-readable name of the attribute. Must be unique within the data table and conform to Connect naming standards.

Required: No

Type: String

Pattern: ^[\p{L}\p{Z}\p{N}\-_.:=@'|]+$

Minimum: 1

Maximum: 128

Update requires: Some interruptions

Primary

Boolean indicating whether this attribute is used as a primary key for record identification. Primary attributes must have unique value combinations and cannot contain expressions.

Required: No

Type: Boolean

Update requires: No interruption

Validation

The validation rules applied to values of this attribute. Based on JSON Schema Draft 2020-12 with additional Connect-specific validations for data integrity.

Required: No

Type: Validation

Update requires: No interruption

ValueType

The type of value allowed for this attribute. Must be one of TEXT, TEXT_LIST, NUMBER, NUMBER_LIST, or BOOLEAN. Determines how values are validated and processed.

Required: No

Type: String

Allowed values: TEXT | NUMBER | BOOLEAN | TEXT_LIST | NUMBER_LIST

Update requires: No interruption

Return values

Ref

Fn::GetAtt

AttributeId

The unique identifier for the attribute within the data table.

LastModifiedRegion

The AWS Region where this attribute was last modified, used for region replication.

LastModifiedTime

The timestamp when this attribute was last modified.