Class TableAttributes
Reference to a dynamodb table.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.DynamoDB
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class TableAttributes : Object, ITableAttributes
Syntax (vb)
Public Class TableAttributes
Inherits Object
Implements 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" },
GrantIndexPermissions = false,
LocalIndexes = new [] { "localIndexes" },
TableArn = "tableArn",
TableName = "tableName",
TableStreamArn = "tableStreamArn"
};
Synopsis
Constructors
TableAttributes() |
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. |
GrantIndexPermissions | If set to true, grant methods always grant permissions for all indexes. |
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. |
Constructors
TableAttributes()
public TableAttributes()
Properties
EncryptionKey
KMS encryption key, if this table uses a customer-managed encryption key.
public IKey EncryptionKey { get; set; }
Property Value
Remarks
Default: - no key
GlobalIndexes
The name of the global indexes set for this Table.
public string[] GlobalIndexes { get; set; }
Property Value
System.String[]
Remarks
Note that you need to set either this property,
or localIndexes
,
if you want methods like grantReadData()
to grant permissions for indexes as well as the table itself.
Default: - no global indexes
GrantIndexPermissions
If set to true, grant methods always grant permissions for all indexes.
public Nullable<bool> GrantIndexPermissions { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
If false is provided, grant methods grant the permissions
only when globalIndexes
or localIndexes
is specified.
Default: - false
LocalIndexes
The name of the local indexes set for this Table.
public string[] LocalIndexes { get; set; }
Property Value
System.String[]
Remarks
Note that you need to set either this property,
or 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.
public string TableArn { get; set; }
Property Value
System.String
Remarks
One of this, or tableName
, is required.
Default: - no table arn
TableName
The table name of the dynamodb table.
public string TableName { get; set; }
Property Value
System.String
Remarks
One of this, or tableArn
, is required.
Default: - no table name
TableStreamArn
The ARN of the table's stream.
public string TableStreamArn { get; set; }
Property Value
System.String
Remarks
Default: - no table stream