Package software.amazon.awscdk.services.connect

Class CfnDataTableAttribute

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.connect.CfnDataTableAttribute
All Implemented Interfaces:
IInspectable, IDataTableAttributeRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)", date="2026-02-03T13:58:20.441Z") @Stability(Stable) public class CfnDataTableAttribute extends CfnResource implements IInspectable, IDataTableAttributeRef
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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.connect.*;
 CfnDataTableAttribute cfnDataTableAttribute = CfnDataTableAttribute.Builder.create(this, "MyCfnDataTableAttribute")
         .dataTableArn("dataTableArn")
         .description("description")
         .instanceArn("instanceArn")
         .name("name")
         .primary(false)
         .validation(ValidationProperty.builder()
                 .enum(EnumProperty.builder()
                         .strict(false)
                         .values(List.of("values"))
                         .build())
                 .exclusiveMaximum(123)
                 .exclusiveMinimum(123)
                 .maximum(123)
                 .maxLength(123)
                 .maxValues(123)
                 .minimum(123)
                 .minLength(123)
                 .minValues(123)
                 .multipleOf(123)
                 .build())
         .valueType("valueType")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDataTableAttribute

      protected CfnDataTableAttribute(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDataTableAttribute

      protected CfnDataTableAttribute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDataTableAttribute

      @Stability(Stable) public CfnDataTableAttribute(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnDataTableAttributeProps props)
      Create a new AWS::Connect::DataTableAttribute.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnDataTableAttribute

      @Stability(Stable) public CfnDataTableAttribute(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::Connect::DataTableAttribute.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • isCfnDataTableAttribute

      @Stability(Stable) @NotNull public static Boolean isCfnDataTableAttribute(@NotNull Object x)
      Checks whether the given object is a CfnDataTableAttribute.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAttributeId

      @Stability(Stable) @NotNull public String getAttrAttributeId()
      The unique identifier for the attribute within the data table.

    • getAttrLastModifiedRegion

      @Stability(Stable) @NotNull public String getAttrLastModifiedRegion()
      The AWS Region where this attribute was last modified, used for region replication.

    • getAttrLastModifiedTime

      @Stability(Stable) @NotNull public IResolvable getAttrLastModifiedTime()
      The timestamp when this attribute was last modified.

    • getAttrLockVersion

      @Stability(Stable) @NotNull public IResolvable getAttrLockVersion()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDataTableAttributeRef

      @Stability(Stable) @NotNull public DataTableAttributeReference getDataTableAttributeRef()
      A reference to a DataTableAttribute resource.
      Specified by:
      getDataTableAttributeRef in interface IDataTableAttributeRef

    • getDataTableArn

      @Stability(Stable) @Nullable public String getDataTableArn()
      The Amazon Resource Name (ARN) of the data table that contains this attribute.

    • setDataTableArn

      @Stability(Stable) public void setDataTableArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the data table that contains this attribute.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      An optional description explaining the purpose and usage of this attribute.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      An optional description explaining the purpose and usage of this attribute.

    • getInstanceArn

      @Stability(Stable) @Nullable public String getInstanceArn()
      The Amazon Resource Name (ARN) of the instance.

    • setInstanceArn

      @Stability(Stable) public void setInstanceArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the instance.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The human-readable name of the attribute.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The human-readable name of the attribute.

    • getPrimary

      @Stability(Stable) @Nullable public Object getPrimary()
      Boolean indicating whether this attribute is used as a primary key for record identification.

      Returns union: either Boolean or IResolvable

    • setPrimary

      @Stability(Stable) public void setPrimary(@Nullable Boolean value)
      Boolean indicating whether this attribute is used as a primary key for record identification.

    • setPrimary

      @Stability(Stable) public void setPrimary(@Nullable IResolvable value)
      Boolean indicating whether this attribute is used as a primary key for record identification.

    • getValidation

      @Stability(Stable) @Nullable public Object getValidation()
      The validation rules applied to values of this attribute.

      Returns union: either IResolvable or CfnDataTableAttribute.ValidationProperty

    • setValidation

      @Stability(Stable) public void setValidation(@Nullable IResolvable value)
      The validation rules applied to values of this attribute.

    • setValidation

      @Stability(Stable) public void setValidation(@Nullable CfnDataTableAttribute.ValidationProperty value)
      The validation rules applied to values of this attribute.

    • getValueType

      @Stability(Stable) @Nullable public String getValueType()
      The type of value allowed for this attribute.

    • setValueType

      @Stability(Stable) public void setValueType(@Nullable String value)
      The type of value allowed for this attribute.