TableBuilder (FsCDK)

TableBuilder Type

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

Constructors

Constructor Description

Constructor	Description
`TableBuilder(name)` Full Usage: `TableBuilder(name)` Parameters: name : `string` Returns: `TableBuilder`	name : `string` Returns: `TableBuilder`


                
                  
                    
                      TableBuilder(name)

Full Usage: TableBuilder(name)

Parameters:

name : string

Returns: TableBuilder

name : string

Returns: TableBuilder

Instance members

Instance member	Description
`billingMode mode` Full Usage: `billingMode mode` Parameters: mode : `BillingMode` - The billing mode (PAY_PER_REQUEST or PROVISIONED). Returns: `TableConfig`	Sets the billing mode for the table. mode : `BillingMode` The billing mode (PAY_PER_REQUEST or PROVISIONED). Returns: `TableConfig`
`this.Combine` Full Usage: `this.Combine` Parameters: config1 : `TableConfig` config2 : `TableConfig` Returns: `TableConfig`	config1 : `TableConfig` config2 : `TableConfig` Returns: `TableConfig`
`constructId id` Full Usage: `constructId id` Parameters: id : `string` - The construct ID. Returns: `TableConfig`	Sets the construct ID for the table. id : `string` The construct ID. Returns: `TableConfig`
`contributorInsightsEnabled enabled` Full Usage: `contributorInsightsEnabled enabled` Parameters: enabled : `bool` - Whether to enable contributor insights. Returns: `TableConfig`	Configures CloudWatch Contributor Insights for the table. enabled : `bool` Whether to enable contributor insights. Returns: `TableConfig`
`contributorInsightsSpecification enabled mode` Full Usage: `contributorInsightsSpecification enabled mode` Parameters: enabled : `bool` - Whether to enable contributor insights. mode : `ContributorInsightsMode` - The contributor insights mode. Returns: `TableConfig`	Configures CloudWatch Contributor Insights for the table. enabled : `bool` Whether to enable contributor insights. mode : `ContributorInsightsMode` The contributor insights mode. Returns: `TableConfig`
`contributorInsightsSpecification contributorInsights` Full Usage: `contributorInsightsSpecification contributorInsights` Parameters: contributorInsights : `ContributorInsightsSpecification` - Whether to enable contributor insights. Returns: `TableConfig`	Configures CloudWatch Contributor Insights for the table. contributorInsights : `ContributorInsightsSpecification` Whether to enable contributor insights. Returns: `TableConfig`
`this.Delay` Full Usage: `this.Delay` Parameters: f : `unit -> TableConfig` Returns: `TableConfig` Modifiers: inline	f : `unit -> TableConfig` Returns: `TableConfig`
`encryption encryption` Full Usage: `encryption encryption` Parameters: encryption : `TableEncryption` - The encryption type (AWS_MANAGED, CUSTOMER_MANAGED, or DEFAULT). Returns: `TableConfig`	Sets the encryption type for the table. encryption : `TableEncryption` The encryption type (AWS_MANAGED, CUSTOMER_MANAGED, or DEFAULT). Returns: `TableConfig`
`encryptionKey key` Full Usage: `encryptionKey key` Parameters: key : `IKey` - The KMS key. Returns: `TableConfig`	Sets the KMS encryption key for the table. key : `IKey` The KMS key. Returns: `TableConfig`
`this.For` Full Usage: `this.For` Parameters: config : `TableConfig` f : `unit -> TableConfig` Returns: `TableConfig` Modifiers: inline	config : `TableConfig` f : `unit -> TableConfig` Returns: `TableConfig`
`globalSecondaryIndexes indexes` Full Usage: `globalSecondaryIndexes indexes` Parameters: indexes : `GlobalSecondaryIndexProps list` - The global secondary index specification. Returns: `TableConfig`	Adds a global secondary index to the table. indexes : `GlobalSecondaryIndexProps list` The global secondary index specification. Returns: `TableConfig`
`grant grantee actions` Full Usage: `grant grantee actions` Parameters: grantee : `IGrantable` - The grantee to receive custom permissions. actions : `string list` - The list of actions to grant. Returns: `TableConfig`	Grants custom permissions to the specified grantee with specific actions. grantee : `IGrantable` The grantee to receive custom permissions. actions : `string list` The list of actions to grant. Returns: `TableConfig`
`grantFullAccess grantee` Full Usage: `grantFullAccess grantee` Parameters: grantee : `IGrantable` - The grantee to receive full access permissions. Returns: `TableConfig`	Grants full access permissions to the specified grantee. grantee : `IGrantable` The grantee to receive full access permissions. Returns: `TableConfig`
`grantReadData grantee` Full Usage: `grantReadData grantee` Parameters: grantee : `IGrantable` - The grantee to receive read data permissions. Returns: `TableConfig`	Grants read data permissions to the specified grantee. grantee : `IGrantable` The grantee to receive read data permissions. Returns: `TableConfig`
`grantReadWriteData grantee` Full Usage: `grantReadWriteData grantee` Parameters: grantee : `IGrantable` - The grantee to receive read and write data permissions. Returns: `TableConfig`	Grants read and write data permissions to the specified grantee. grantee : `IGrantable` The grantee to receive read and write data permissions. Returns: `TableConfig`
`grantStream grantee actions` Full Usage: `grantStream grantee actions` Parameters: grantee : `IGrantable` - The grantee to receive stream permissions. actions : `string list` - The list of actions to grant. Returns: `TableConfig`	Grants stream permissions to the specified grantee with specific actions. grantee : `IGrantable` The grantee to receive stream permissions. actions : `string list` The list of actions to grant. Returns: `TableConfig`
`grantStreamRead grantee` Full Usage: `grantStreamRead grantee` Parameters: grantee : `IGrantable` - The grantee to receive stream read permissions. Returns: `TableConfig`	Grants stream read permissions to the specified grantee. grantee : `IGrantable` The grantee to receive stream read permissions. Returns: `TableConfig`
`grantTableListStreams grantee` Full Usage: `grantTableListStreams grantee` Parameters: grantee : `IGrantable` - The grantee to receive table list streams permissions. Returns: `TableConfig`	Grants table list streams permissions to the specified grantee. grantee : `IGrantable` The grantee to receive table list streams permissions. Returns: `TableConfig`
`grantWriteData grantee` Full Usage: `grantWriteData grantee` Parameters: grantee : `IGrantable` - The grantee to receive write data permissions. Returns: `TableConfig`	Grants write data permissions to the specified grantee. grantee : `IGrantable` The grantee to receive write data permissions. Returns: `TableConfig`
`kinesisStream stream` Full Usage: `kinesisStream stream` Parameters: stream : `IStream` - The Kinesis stream to use. Returns: `TableConfig`	Sets a Kinesis stream for the table. stream : `IStream` The Kinesis stream to use. Returns: `TableConfig`
`localSecondaryIndexes indexes` Full Usage: `localSecondaryIndexes indexes` Parameters: indexes : `LocalSecondaryIndexProps list` - The local secondary index specification. Returns: `TableConfig`	Adds a local secondary index to the table. indexes : `LocalSecondaryIndexProps list` The local secondary index specification. Returns: `TableConfig`
`partitionKey name attrType` Full Usage: `partitionKey name attrType` Parameters: name : `string` - The attribute name for the partition key. attrType : `AttributeType` - The attribute type (STRING, NUMBER, or BINARY). Returns: `TableConfig`	Sets the partition key for the table. name : `string` The attribute name for the partition key. attrType : `AttributeType` The attribute type (STRING, NUMBER, or BINARY). Returns: `TableConfig`
`pointInTimeRecovery enabled` Full Usage: `pointInTimeRecovery enabled` Parameters: enabled : `bool` - Whether point-in-time recovery is enabled. Returns: `TableConfig`	Enables or disables point-in-time recovery. enabled : `bool` Whether point-in-time recovery is enabled. Returns: `TableConfig`
`removalPolicy policy` Full Usage: `removalPolicy policy` Parameters: policy : `RemovalPolicy` - The removal policy (DESTROY, RETAIN, or SNAPSHOT). Returns: `TableConfig`	Sets the removal policy for the table. policy : `RemovalPolicy` The removal policy (DESTROY, RETAIN, or SNAPSHOT). Returns: `TableConfig`
`this.Run` Full Usage: `this.Run` Parameters: config : `TableConfig` Returns: `TableSpec`	config : `TableConfig` Returns: `TableSpec`
`sortKey name attrType` Full Usage: `sortKey name attrType` Parameters: name : `string` - The attribute name for the sort key. attrType : `AttributeType` - The attribute type (STRING, NUMBER, or BINARY). Returns: `TableConfig`	Sets the sort key for the table. name : `string` The attribute name for the sort key. attrType : `AttributeType` The attribute type (STRING, NUMBER, or BINARY). Returns: `TableConfig`
`stream streamType` Full Usage: `stream streamType` Parameters: streamType : `StreamViewType` - The stream view type (KEYS_ONLY, NEW_IMAGE, OLD_IMAGE, or NEW_AND_OLD_IMAGES). Returns: `TableConfig`	Enables DynamoDB Streams for the table. streamType : `StreamViewType` The stream view type (KEYS_ONLY, NEW_IMAGE, OLD_IMAGE, or NEW_AND_OLD_IMAGES). Returns: `TableConfig`
`tableClass tableClass` Full Usage: `tableClass tableClass` Parameters: tableClass : `TableClass` - The table class (STANDARD or STANDARD_INFREQUENT_ACCESS). Returns: `TableConfig`	Sets the table class for cost optimization. tableClass : `TableClass` The table class (STANDARD or STANDARD_INFREQUENT_ACCESS). Returns: `TableConfig`
`timeToLive attributeName` Full Usage: `timeToLive attributeName` Parameters: attributeName : `string` - The attribute name that stores the TTL timestamp (Unix epoch seconds). Returns: `TableConfig`	Sets the Time-to-Live attribute for automatic item expiration. attributeName : `string` The attribute name that stores the TTL timestamp (Unix epoch seconds). Returns: `TableConfig`
`this.Yield` Full Usage: `this.Yield` Parameters: lsi : `LocalSecondaryIndexProps` Returns: `TableConfig`	lsi : `LocalSecondaryIndexProps` Returns: `TableConfig`
`this.Yield` Full Usage: `this.Yield` Parameters: gsi : `GlobalSecondaryIndexProps` Returns: `TableConfig`	gsi : `GlobalSecondaryIndexProps` Returns: `TableConfig`
`this.Yield` Full Usage: `this.Yield` Parameters: spec : `IImportSourceSpecification` Returns: `TableConfig`	spec : `IImportSourceSpecification` Returns: `TableConfig`
`this.Yield` Full Usage: `this.Yield` Parameters: () : `unit` Returns: `TableConfig`	() : `unit` Returns: `TableConfig`
`this.Zero` Full Usage: `this.Zero` Returns: `TableConfig`	Returns: `TableConfig`