GlobalSecondaryIndexArgs

data class GlobalSecondaryIndexArgs(val contributorInsightsSpecification: Output<ContributorInsightsSpecificationArgs>? = null, val indexName: Output<String>? = null, val keySchema: Output<List<KeySchemaArgs>>? = null, val projection: Output<ProjectionArgs>? = null, val provisionedThroughput: Output<ProvisionedThroughputArgs>? = null) : ConvertibleToJava<GlobalSecondaryIndexArgs>

Definition of GlobalSecondaryIndex

Constructors

Link copied to clipboard
constructor(contributorInsightsSpecification: Output<ContributorInsightsSpecificationArgs>? = null, indexName: Output<String>? = null, keySchema: Output<List<KeySchemaArgs>>? = null, projection: Output<ProjectionArgs>? = null, provisionedThroughput: Output<ProvisionedThroughputArgs>? = null)

Properties

Link copied to clipboard

The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index. The settings used to enable or disable CloudWatch Contributor Insights.

Link copied to clipboard
val indexName: Output<String>? = null

The name of the global secondary index. The name must be unique among all other indexes on this table.

Link copied to clipboard
val keySchema: Output<List<KeySchemaArgs>>? = null

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: + `HASH` - partition key + `RANGE` - sort key The partition key of an item is also known as its hash attribute. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

Link copied to clipboard
val projection: Output<ProjectionArgs>? = null

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Link copied to clipboard

Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide. Throughput for the specified table, which consists of values for `ReadCapacityUnits` and `WriteCapacityUnits`. For more information about the contents of a provisioned throughput structure, see Table ProvisionedThroughput.

Functions

Link copied to clipboard
open override fun toJava(): GlobalSecondaryIndexArgs