AWS::S3Tables::Table IcebergSortField - AWS CloudFormation
SyntaxProperties
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

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::S3Tables::Table IcebergSortField

Defines a single sort field in an Iceberg sort order specification.

Syntax

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

JSON

{
  "Direction" : String,
  "NullOrder" : String,
  "SourceId" : Integer,
  "Transform" : String
}

YAML

  Direction: String
  NullOrder: String
  SourceId: Integer
  Transform: String

Properties

Direction

The sort direction. Valid values are asc for ascending order or desc for descending order.

Required: Yes

Type: String

Allowed values: asc | desc

Update requires: Replacement

NullOrder

Specifies how null values are ordered. Valid values are nulls-first to place nulls before non-null values, or nulls-last to place nulls after non-null values.

Required: Yes

Type: String

Allowed values: nulls-first | nulls-last

Update requires: Replacement

SourceId

The ID of the source schema field to sort by. This must reference a valid field ID from the table schema.

Required: Yes

Type: Integer

Update requires: Replacement

Transform

The transform to apply to the source field before sorting. Use identity to sort by the field value directly, or specify other transforms as needed.

Required: Yes

Type: String

Update requires: Replacement