CfnDataTableAttributePropsMixin

class aws_cdk.mixins_preview.aws_connect.mixins.CfnDataTableAttributePropsMixin(props, *, strategy=None)

Bases: Mixin

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-datatableattribute.html

CloudformationResource:

AWS::Connect::DataTableAttribute

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins

cfn_data_table_attribute_props_mixin = connect_mixins.CfnDataTableAttributePropsMixin(connect_mixins.CfnDataTableAttributeMixinProps(
    data_table_arn="dataTableArn",
    description="description",
    instance_arn="instanceArn",
    name="name",
    primary=False,
    validation=connect_mixins.CfnDataTableAttributePropsMixin.ValidationProperty(
        enum=connect_mixins.CfnDataTableAttributePropsMixin.EnumProperty(
            strict=False,
            values=["values"]
        ),
        exclusive_maximum=123,
        exclusive_minimum=123,
        maximum=123,
        max_length=123,
        max_values=123,
        minimum=123,
        min_length=123,
        min_values=123,
        multiple_of=123
    ),
    value_type="valueType"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Connect::DataTableAttribute.

Parameters:

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['dataTableArn', 'description', 'instanceArn', 'name', 'primary', 'validation', 'valueType']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

EnumProperty

class CfnDataTableAttributePropsMixin.EnumProperty(*, strict=None, values=None)

Bases: object

Parameters:
  • strict (Union[bool, IResolvable, None])

  • values (Optional[Sequence[str]])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-datatableattribute-enum.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins

enum_property = connect_mixins.CfnDataTableAttributePropsMixin.EnumProperty(
    strict=False,
    values=["values"]
)

Attributes

strict

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-datatableattribute-enum.html#cfn-connect-datatableattribute-enum-strict

Type:

see

values

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-datatableattribute-enum.html#cfn-connect-datatableattribute-enum-values

Type:

see

LockVersionProperty

class CfnDataTableAttributePropsMixin.LockVersionProperty(*, attribute=None, data_table=None)

Bases: object

Parameters:
  • attribute (Optional[str])

  • data_table (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-datatableattribute-lockversion.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins

lock_version_property = connect_mixins.CfnDataTableAttributePropsMixin.LockVersionProperty(
    attribute="attribute",
    data_table="dataTable"
)

Attributes

attribute

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-datatableattribute-lockversion.html#cfn-connect-datatableattribute-lockversion-attribute

Type:

see

data_table

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-datatableattribute-lockversion.html#cfn-connect-datatableattribute-lockversion-datatable

Type:

see

ValidationProperty

class CfnDataTableAttributePropsMixin.ValidationProperty(*, enum=None, exclusive_maximum=None, exclusive_minimum=None, maximum=None, max_length=None, max_values=None, minimum=None, min_length=None, min_values=None, multiple_of=None)

Bases: object

Defines validation rules for data table attribute values.

Based on JSON Schema Draft 2020-12 with additional Connect-specific validations. Validation rules ensure data integrity and consistency across the data table.

Parameters:
  • enum (Union[IResolvable, EnumProperty, Dict[str, Any], None]) – Defines enumeration constraints for attribute values. Can specify a list of allowed values and whether custom values are permitted beyond the enumerated list.

  • exclusive_maximum (Union[int, float, None]) – The largest exclusive numeric value for NUMBER value type. Can be provided alongside Maximum where both operate independently. Must be greater than ExclusiveMinimum and Minimum. Applies to NUMBER and values within NUMBER_LIST.

  • exclusive_minimum (Union[int, float, None]) – The smallest exclusive numeric value for NUMBER value type. Can be provided alongside Minimum where both operate independently. Must be less than ExclusiveMaximum and Maximum. Applies to NUMBER and values within NUMBER_LIST.

  • maximum (Union[int, float, None]) – The largest inclusive numeric value for NUMBER value type. Can be provided alongside ExclusiveMaximum where both operate independently. Must be greater than or equal to Minimum and greater than ExclusiveMinimum. Applies to NUMBER and values within NUMBER_LIST.

  • max_length (Union[int, float, None]) – The maximum number of characters a text value can contain. Applies to TEXT value type and values within a TEXT_LIST. Must be greater than or equal to MinLength.

  • max_values (Union[int, float, None]) – The maximum number of values in a list. Must be an integer greater than or equal to 0 and greater than or equal to MinValues. Applies to all list types.

  • minimum (Union[int, float, None]) – The smallest inclusive numeric value for NUMBER value type. Cannot be provided when ExclusiveMinimum is also provided. Must be less than or equal to Maximum and less than ExclusiveMaximum. Applies to NUMBER and values within NUMBER_LIST.

  • min_length (Union[int, float, None]) – The minimum number of characters a text value can contain. Applies to TEXT value type and values within a TEXT_LIST. Must be less than or equal to MaxLength.

  • min_values (Union[int, float, None]) – The minimum number of values in a list. Must be an integer greater than or equal to 0 and less than or equal to MaxValues. Applies to all list types.

  • multiple_of (Union[int, float, None]) – Specifies that numeric values must be multiples of this number. Must be greater than 0. The result of dividing a value by this multiple must result in an integer. Applies to NUMBER and values within NUMBER_LIST.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-datatableattribute-validation.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins

validation_property = connect_mixins.CfnDataTableAttributePropsMixin.ValidationProperty(
    enum=connect_mixins.CfnDataTableAttributePropsMixin.EnumProperty(
        strict=False,
        values=["values"]
    ),
    exclusive_maximum=123,
    exclusive_minimum=123,
    maximum=123,
    max_length=123,
    max_values=123,
    minimum=123,
    min_length=123,
    min_values=123,
    multiple_of=123
)

Attributes

enum

Defines enumeration constraints for attribute values.

Can specify a list of allowed values and whether custom values are permitted beyond the enumerated list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-datatableattribute-validation.html#cfn-connect-datatableattribute-validation-enum

exclusive_maximum

The largest exclusive numeric value for NUMBER value type.

Can be provided alongside Maximum where both operate independently. Must be greater than ExclusiveMinimum and Minimum. Applies to NUMBER and values within NUMBER_LIST.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-datatableattribute-validation.html#cfn-connect-datatableattribute-validation-exclusivemaximum

exclusive_minimum

The smallest exclusive numeric value for NUMBER value type.

Can be provided alongside Minimum where both operate independently. Must be less than ExclusiveMaximum and Maximum. Applies to NUMBER and values within NUMBER_LIST.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-datatableattribute-validation.html#cfn-connect-datatableattribute-validation-exclusiveminimum

max_length

The maximum number of characters a text value can contain.

Applies to TEXT value type and values within a TEXT_LIST. Must be greater than or equal to MinLength.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-datatableattribute-validation.html#cfn-connect-datatableattribute-validation-maxlength

max_values

The maximum number of values in a list.

Must be an integer greater than or equal to 0 and greater than or equal to MinValues. Applies to all list types.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-datatableattribute-validation.html#cfn-connect-datatableattribute-validation-maxvalues

maximum

The largest inclusive numeric value for NUMBER value type.

Can be provided alongside ExclusiveMaximum where both operate independently. Must be greater than or equal to Minimum and greater than ExclusiveMinimum. Applies to NUMBER and values within NUMBER_LIST.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-datatableattribute-validation.html#cfn-connect-datatableattribute-validation-maximum

min_length

The minimum number of characters a text value can contain.

Applies to TEXT value type and values within a TEXT_LIST. Must be less than or equal to MaxLength.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-datatableattribute-validation.html#cfn-connect-datatableattribute-validation-minlength

min_values

The minimum number of values in a list.

Must be an integer greater than or equal to 0 and less than or equal to MaxValues. Applies to all list types.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-datatableattribute-validation.html#cfn-connect-datatableattribute-validation-minvalues

minimum

The smallest inclusive numeric value for NUMBER value type.

Cannot be provided when ExclusiveMinimum is also provided. Must be less than or equal to Maximum and less than ExclusiveMaximum. Applies to NUMBER and values within NUMBER_LIST.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-datatableattribute-validation.html#cfn-connect-datatableattribute-validation-minimum

multiple_of

Specifies that numeric values must be multiples of this number.

Must be greater than 0. The result of dividing a value by this multiple must result in an integer. Applies to NUMBER and values within NUMBER_LIST.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-datatableattribute-validation.html#cfn-connect-datatableattribute-validation-multipleof