Interface ITableAttributes
Reference to a dynamodb table.
Namespace: Amazon.CDK.AWS.DynamoDB
Assembly: Amazon.CDK.AWS.DynamoDB.dll
Syntax (csharp)
public interface ITableAttributes
Syntax (vb)
Public Interface ITableAttributes
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DynamoDB;
using Amazon.CDK.AWS.KMS;
Key key;
var tableAttributes = new TableAttributes {
EncryptionKey = key,
GlobalIndexes = new [] { "globalIndexes" },
LocalIndexes = new [] { "localIndexes" },
TableArn = "tableArn",
TableName = "tableName",
TableStreamArn = "tableStreamArn"
};
Synopsis
Properties
EncryptionKey | KMS encryption key, if this table uses a customer-managed encryption key. |
GlobalIndexes | The name of the global indexes set for this Table. |
LocalIndexes | The name of the local indexes set for this Table. |
TableArn | The ARN of the dynamodb table. |
TableName | The table name of the dynamodb table. |
TableStreamArn | The ARN of the table's stream. |
Properties
EncryptionKey
KMS encryption key, if this table uses a customer-managed encryption key.
virtual IKey EncryptionKey { get; }
Property Value
Remarks
Default: - no key
GlobalIndexes
The name of the global indexes set for this Table.
virtual string[] GlobalIndexes { get; }
Property Value
System.String[]
Remarks
Note that you need to set either this property, or {@link localIndexes}, if you want methods like grantReadData() to grant permissions for indexes as well as the table itself.
Default: - no global indexes
LocalIndexes
The name of the local indexes set for this Table.
virtual string[] LocalIndexes { get; }
Property Value
System.String[]
Remarks
Note that you need to set either this property, or {@link globalIndexes}, if you want methods like grantReadData() to grant permissions for indexes as well as the table itself.
Default: - no local indexes
TableArn
The ARN of the dynamodb table.
virtual string TableArn { get; }
Property Value
System.String
Remarks
One of this, or {@link tableName}, is required.
Default: - no table arn
TableName
The table name of the dynamodb table.
virtual string TableName { get; }
Property Value
System.String
Remarks
One of this, or {@link tableArn}, is required.
Default: - no table name
TableStreamArn
The ARN of the table's stream.
virtual string TableStreamArn { get; }
Property Value
System.String
Remarks
Default: - no table stream