GlobalSecondaryIndexBuilder (FsCDK)

GlobalSecondaryIndexBuilder Type

Namespace: FsCDK
Assembly: FsCDK.dll
Base Type: obj

Constructors

Constructor Description

Constructor	Description
`GlobalSecondaryIndexBuilder(indexName)` Full Usage: `GlobalSecondaryIndexBuilder(indexName)` Parameters: indexName : `string` Returns: `GlobalSecondaryIndexBuilder`	indexName : `string` Returns: `GlobalSecondaryIndexBuilder`


                
                  
                    
                      GlobalSecondaryIndexBuilder(indexName)

Full Usage: GlobalSecondaryIndexBuilder(indexName)

Parameters:

indexName : string

Returns: GlobalSecondaryIndexBuilder

indexName : string

Returns: GlobalSecondaryIndexBuilder

Instance members

Instance member	Description
`this.Combine` Full Usage: `this.Combine` Parameters: config1 : `GlobalSecondaryIndexConfig` config2 : `GlobalSecondaryIndexConfig` Returns: `GlobalSecondaryIndexConfig`	config1 : `GlobalSecondaryIndexConfig` config2 : `GlobalSecondaryIndexConfig` Returns: `GlobalSecondaryIndexConfig`
`contributorInsightsEnabled enabled` Full Usage: `contributorInsightsEnabled enabled` Parameters: enabled : `bool` - Whether to enable contributor insights. Returns: `GlobalSecondaryIndexConfig`	Configures CloudWatch Contributor Insights for the table. enabled : `bool` Whether to enable contributor insights. Returns: `GlobalSecondaryIndexConfig`
`contributorInsightsSpecification enabled mode` Full Usage: `contributorInsightsSpecification enabled mode` Parameters: enabled : `bool` - Whether contributor insights are enabled. mode : `ContributorInsightsMode` - The contributor insights mode. Returns: `GlobalSecondaryIndexConfig`	Configures CloudWatch Contributor Insights for the GSI. enabled : `bool` Whether contributor insights are enabled. mode : `ContributorInsightsMode` The contributor insights mode. Returns: `GlobalSecondaryIndexConfig`
`contributorInsightsSpecification spec` Full Usage: `contributorInsightsSpecification spec` Parameters: spec : `ContributorInsightsSpecification` - The contributor insights specification. Returns: `GlobalSecondaryIndexConfig`	Sets the CloudWatch Contributor Insights specification for the GSI. spec : `ContributorInsightsSpecification` The contributor insights specification. Returns: `GlobalSecondaryIndexConfig`
`this.Delay` Full Usage: `this.Delay` Parameters: f : `unit -> GlobalSecondaryIndexConfig` Returns: `GlobalSecondaryIndexConfig` Modifiers: inline	f : `unit -> GlobalSecondaryIndexConfig` Returns: `GlobalSecondaryIndexConfig`
`this.For` Full Usage: `this.For` Parameters: config : `GlobalSecondaryIndexConfig` f : `unit -> GlobalSecondaryIndexConfig` Returns: `GlobalSecondaryIndexConfig` Modifiers: inline	config : `GlobalSecondaryIndexConfig` f : `unit -> GlobalSecondaryIndexConfig` Returns: `GlobalSecondaryIndexConfig`
`maxReadRequestUnits max` Full Usage: `maxReadRequestUnits max` Parameters: max : `float` - The maximum read request units. Returns: `GlobalSecondaryIndexConfig`	Sets the maximum on-demand read request units for the GSI. max : `float` The maximum read request units. Returns: `GlobalSecondaryIndexConfig`
`maxWriteRequestUnits max` Full Usage: `maxWriteRequestUnits max` Parameters: max : `float` - The maximum write request units. Returns: `GlobalSecondaryIndexConfig`	Sets the maximum on-demand write request units for the GSI. max : `float` The maximum write request units. Returns: `GlobalSecondaryIndexConfig`
`nonKeyAttributes attrs` Full Usage: `nonKeyAttributes attrs` Parameters: attrs : `string list` - The list of non-key attribute names to include. Returns: `GlobalSecondaryIndexConfig`	Specifies additional non-key attributes to include in the GSI projection. Only used when `projectionType` is `INCLUDE`. attrs : `string list` The list of non-key attribute names to include. Returns: `GlobalSecondaryIndexConfig`
`partitionKey attrName attrType` Full Usage: `partitionKey attrName attrType` Parameters: attrName : `string` - The attribute name for the partition key. attrType : `AttributeType` - The attribute type (STRING, NUMBER, or BINARY). Returns: `GlobalSecondaryIndexConfig`	Sets the partition key for the Global Secondary Index (GSI). attrName : `string` The attribute name for the partition key. attrType : `AttributeType` The attribute type (STRING, NUMBER, or BINARY). Returns: `GlobalSecondaryIndexConfig`
`partitionKey attr` Full Usage: `partitionKey attr` Parameters: attr : `Attribute` - The attribute definition to use as the partition key. Returns: `GlobalSecondaryIndexConfig`	Sets the partition key for the Global Secondary Index (GSI). attr : `Attribute` The attribute definition to use as the partition key. Returns: `GlobalSecondaryIndexConfig`
`projectionType projType` Full Usage: `projectionType projType` Parameters: projType : `ProjectionType` - The projection type (ALL, KEYS_ONLY, or INCLUDE). Returns: `GlobalSecondaryIndexConfig`	Sets the projection type for the GSI. projType : `ProjectionType` The projection type (ALL, KEYS_ONLY, or INCLUDE). Returns: `GlobalSecondaryIndexConfig`
`readCapacity read` Full Usage: `readCapacity read` Parameters: read : `float` - The provisioned read capacity units. Returns: `GlobalSecondaryIndexConfig`	Sets the provisioned read capacity for the GSI. Only applicable when using PROVISIONED capacity mode. read : `float` The provisioned read capacity units. Returns: `GlobalSecondaryIndexConfig`
`this.Run` Full Usage: `this.Run` Parameters: config : `GlobalSecondaryIndexConfig` Returns: `GlobalSecondaryIndexProps`	config : `GlobalSecondaryIndexConfig` Returns: `GlobalSecondaryIndexProps`
`sortKey attrName attrType` Full Usage: `sortKey attrName attrType` Parameters: attrName : `string` - The attribute name for the sort key. attrType : `AttributeType` - The attribute type (STRING, NUMBER, or BINARY). Returns: `GlobalSecondaryIndexConfig`	Sets the sort key for the Global Secondary Index (GSI). attrName : `string` The attribute name for the sort key. attrType : `AttributeType` The attribute type (STRING, NUMBER, or BINARY). Returns: `GlobalSecondaryIndexConfig`
`sortKey attr` Full Usage: `sortKey attr` Parameters: attr : `Attribute` - The attribute definition to use as the sort key. Returns: `GlobalSecondaryIndexConfig`	Sets the sort key for the Global Secondary Index (GSI). attr : `Attribute` The attribute definition to use as the sort key. Returns: `GlobalSecondaryIndexConfig`
`warmThroughput warm` Full Usage: `warmThroughput warm` Parameters: warm : `IWarmThroughput` - The warm throughput configuration. Returns: `GlobalSecondaryIndexConfig`	Sets warm throughput settings for the GSI in on-demand mode. warm : `IWarmThroughput` The warm throughput configuration. Returns: `GlobalSecondaryIndexConfig`
`writeCapacity write` Full Usage: `writeCapacity write` Parameters: write : `float` - The provisioned write capacity units. Returns: `GlobalSecondaryIndexConfig`	Sets the provisioned write capacity for the GSI. Only applicable when using PROVISIONED capacity mode. write : `float` The provisioned write capacity units. Returns: `GlobalSecondaryIndexConfig`
`this.Yield` Full Usage: `this.Yield` Parameters: () : `unit` Returns: `GlobalSecondaryIndexConfig`	() : `unit` Returns: `GlobalSecondaryIndexConfig`
`this.Zero` Full Usage: `this.Zero` Returns: `GlobalSecondaryIndexConfig`	Returns: `GlobalSecondaryIndexConfig`