Skip to content
v2.277.0

PartitionIndex Struct ​

Properties of a Partition Index.

Example ​

ts
declare const myTable: glue.S3Table;
myTable.addPartitionIndex({
  indexName: 'my-index',
  keyNames: ['year'],
});
python
# my_table: glue.S3Table

my_table.add_partition_index(
    index_name="my-index",
    key_names=["year"]
)
java
S3Table myTable;

myTable.addPartitionIndex(PartitionIndex.builder()
        .indexName("my-index")
        .keyNames(List.of("year"))
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
S3Table myTable;

myTable.AddPartitionIndex(new PartitionIndex {
    IndexName = "my-index",
    KeyNames = new [] { "year" }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var myTable S3Table

myTable.AddPartitionIndex(&PartitionIndex{
	IndexName: jsii.String("my-index"),
	KeyNames: []*string{
		jsii.String("year"),
	},
})

Properties ​

indexNameoptionalstringindex_nameoptionalstrindexNameoptionalStringIndexNameoptionalstringIndexNameoptional*string#
The name of the partition index.

Default: a name will be generated for you.

keyNamesstring[]key_namestyping.List[str]keyNamesList<String>KeyNamesstring[]KeyNames*[]*stringrequired#
The partition key names that comprise the partition index.

The names must correspond to a name in the table's partition keys.