aws-cdk-lib.aws_connect.CfnDataTableAttributeProps

CfnDataTableAttributeProps Struct

Properties for defining a CfnDataTableAttribute.

Source

Generated code

Type last changed

v2.264.0 · 10 Aug 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_connect as connect } from 'aws-cdk-lib';
const cfnDataTableAttributeProps: connect.CfnDataTableAttributeProps = {
  dataTableArn: 'dataTableArn',
  instanceArn: 'instanceArn',
  name: 'name',
  valueType: 'valueType',

  // the properties below are optional
  description: 'description',
  primary: false,
  validation: {
    enum: {
      strict: false,
      values: ['values'],
    },
    exclusiveMaximum: 123,
    exclusiveMinimum: 123,
    maximum: 123,
    maxLength: 123,
    maxValues: 123,
    minimum: 123,
    minLength: 123,
    minValues: 123,
    multipleOf: 123,
  },
};

Properties

dataTableArnstringdata_table_arnstrdataTableArnStringDataTableArnstringDataTableArn*stringrequired#

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

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

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

instanceArnstringinstance_arnstrinstanceArnStringInstanceArnstringInstanceArn*stringrequired#

The Amazon Resource Name (ARN) of the instance.

namestringnamestrnameStringNamestringName*stringrequired#

The human-readable name of the attribute.

Must be unique within the data table and conform to Connect naming standards.

primaryboolean | IResolvableprimarytyping.Union[bool, IResolvable]primaryBooleanPrimaryboolPrimaryinterface{}#

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.

validationIResolvable | CfnDataTableAttribute.ValidationPropertyvalidationtyping.Union[IResolvable, ValidationProperty]validationIResolvableValidationIResolvableValidationinterface{}#

The validation rules applied to values of this attribute.

Based on JSON Schema Draft 2020-12 with additional Connect-specific validations for data integrity.

valueTypestringvalue_typestrvalueTypeStringValueTypestringValueType*stringrequired#

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.

Used as props by

• CfnDataTableAttribute