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.
Contents
- Name
-
The human-readable name of the attribute. Must be unique within the data table and conform to Connect naming standards.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern:
^[\p{L}\p{Z}\p{N}\-_.:=@'|]+$Required: Yes
- 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.
Type: String
Valid Values:
TEXT | NUMBER | BOOLEAN | TEXT_LIST | NUMBER_LISTRequired: Yes
- AttributeId
-
The unique identifier for the attribute within the data table.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- DataTableArn
-
The Amazon Resource Name (ARN) of the data table that contains this attribute.
Type: String
Required: No
- DataTableId
-
The unique identifier of the data table that contains this attribute.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- Description
-
An optional description explaining the purpose and usage of this attribute.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 250.
Pattern:
^[\\P{C}\r\n\t]+$Required: No
- LastModifiedRegion
-
The AWS region where this attribute was last modified, used for region replication.
Type: String
Pattern:
[a-z]{2}(-[a-z]+){1,2}(-[0-9])?Required: No
- LastModifiedTime
-
The timestamp when this attribute was last modified.
Type: Timestamp
Required: No
- LockVersion
-
The lock version for this attribute, used for optimistic locking to prevent concurrent modification conflicts.
Type: DataTableLockVersion object
Required: No
- 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.
Type: Boolean
Required: No
- 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.
Type: Validation object
Required: No
- Version
-
The version identifier for this attribute, used for versioning and change tracking.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
