interface GlobalSecondaryIndexProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.DynamoDB.CfnGlobalTable.GlobalSecondaryIndexProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsdynamodb#CfnGlobalTable_GlobalSecondaryIndexProperty |
![]() | software.amazon.awscdk.services.dynamodb.CfnGlobalTable.GlobalSecondaryIndexProperty |
![]() | aws_cdk.aws_dynamodb.CfnGlobalTable.GlobalSecondaryIndexProperty |
![]() | aws-cdk-lib » aws_dynamodb » CfnGlobalTable » GlobalSecondaryIndexProperty |
Allows you to specify a global secondary index for the global table.
The index will be defined on all replicas.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dynamodb as dynamodb } from 'aws-cdk-lib';
const globalSecondaryIndexProperty: dynamodb.CfnGlobalTable.GlobalSecondaryIndexProperty = {
indexName: 'indexName',
keySchema: [{
attributeName: 'attributeName',
keyType: 'keyType',
}],
projection: {
nonKeyAttributes: ['nonKeyAttributes'],
projectionType: 'projectionType',
},
// the properties below are optional
warmThroughput: {
readUnitsPerSecond: 123,
writeUnitsPerSecond: 123,
},
writeOnDemandThroughputSettings: {
maxWriteRequestUnits: 123,
},
writeProvisionedThroughputSettings: {
writeCapacityAutoScalingSettings: {
maxCapacity: 123,
minCapacity: 123,
targetTrackingScalingPolicyConfiguration: {
targetValue: 123,
// the properties below are optional
disableScaleIn: false,
scaleInCooldown: 123,
scaleOutCooldown: 123,
},
// the properties below are optional
seedCapacity: 123,
},
},
};
Properties
Name | Type | Description |
---|---|---|
index | string | The name of the global secondary index. |
key | IResolvable | IResolvable | Key [] | 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 . |
projection | IResolvable | Projection | Represents attributes that are copied (projected) from the table into the global secondary index. |
warm | IResolvable | Warm | Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. |
write | IResolvable | Write | Sets the write request settings for a global table or a global secondary index. |
write | IResolvable | Write | Defines write capacity settings for the global secondary index. |
indexName
Type:
string
The name of the global secondary index.
The name must be unique among all other indexes on this table.
keySchema
Type:
IResolvable
|
IResolvable
|
Key
[]
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.
projection
Type:
IResolvable
|
Projection
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.
warmThroughput?
Type:
IResolvable
|
Warm
(optional)
Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index.
If you use this parameter, you must specify ReadUnitsPerSecond
, WriteUnitsPerSecond
, or both.
writeOnDemandThroughputSettings?
Type:
IResolvable
|
Write
(optional)
Sets the write request settings for a global table or a global secondary index.
You can only specify this setting if your resource uses the PAY_PER_REQUEST
BillingMode
.
writeProvisionedThroughputSettings?
Type:
IResolvable
|
Write
(optional)
Defines write capacity settings for the global secondary index.
You must specify a value for this property if the table's BillingMode
is PROVISIONED
. All replicas will have the same write capacity settings for this global secondary index.