TableAttributes¶
-
class
aws_cdk.aws_dynamodb.
TableAttributes
(*, encryption_key=None, global_indexes=None, local_indexes=None, table_arn=None, table_name=None, table_stream_arn=None)¶ Bases:
object
Reference to a dynamodb table.
- Parameters
encryption_key (
Optional
[IKey
]) – KMS encryption key, if this table uses a customer-managed encryption key. Default: - no keyglobal_indexes (
Optional
[List
[str
]]) – The name of the global indexes set for this Table. 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 indexeslocal_indexes (
Optional
[List
[str
]]) – The name of the local indexes set for this Table. 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 indexestable_arn (
Optional
[str
]) – The ARN of the dynamodb table. One of this, or {@link tableName}, is required. Default: - no table arntable_name (
Optional
[str
]) – The table name of the dynamodb table. One of this, or {@link tableArn}, is required. Default: - no table nametable_stream_arn (
Optional
[str
]) – The ARN of the table’s stream. Default: - no table stream
Attributes
-
encryption_key
¶ KMS encryption key, if this table uses a customer-managed encryption key.
- Default
no key
- Return type
Optional
[IKey
]
-
global_indexes
¶ The name of the global indexes set for this Table.
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
- Return type
Optional
[List
[str
]]
-
local_indexes
¶ The name of the local indexes set for this Table.
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
- Return type
Optional
[List
[str
]]
-
table_arn
¶ The ARN of the dynamodb table.
One of this, or {@link tableName}, is required.
- Default
no table arn
- Return type
Optional
[str
]
-
table_name
¶ The table name of the dynamodb table.
One of this, or {@link tableArn}, is required.
- Default
no table name
- Return type
Optional
[str
]
-
table_stream_arn
¶ The ARN of the table’s stream.
- Default
no table stream
- Return type
Optional
[str
]