@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)", date="2022-05-20T22:20:01.511Z") public interface ITable extends IResource
Modifier and Type | Interface and Description |
---|---|
static interface |
ITable.Jsii$Default
Internal default implementation for
ITable . |
static class |
ITable.Jsii$Proxy
A proxy class which represents a concrete javascript instance of this type.
|
Modifier and Type | Method and Description |
---|---|
default IKey |
getEncryptionKey()
Optional KMS encryption key associated with this table.
|
java.lang.String |
getTableArn()
Arn of the dynamodb table.
|
java.lang.String |
getTableName()
Table name of the dynamodb table.
|
default java.lang.String |
getTableStreamArn()
ARN of the table's stream, if there is one.
|
Grant |
grant(IGrantable grantee,
java.lang.String... actions)
Adds an IAM policy statement associated with this table to an IAM principal's policy.
|
Grant |
grantFullAccess(IGrantable grantee)
Permits all DynamoDB operations ("dynamodb:*") to an IAM principal.
|
Grant |
grantReadData(IGrantable grantee)
Permits an IAM principal all data read operations from this table: BatchGetItem, GetRecords, GetShardIterator, Query, GetItem, Scan.
|
Grant |
grantReadWriteData(IGrantable grantee)
Permits an IAM principal to all data read/write operations to this table.
|
Grant |
grantStream(IGrantable grantee,
java.lang.String... actions)
Adds an IAM policy statement associated with this table's stream to an IAM principal's policy.
|
Grant |
grantStreamRead(IGrantable grantee)
Permits an IAM principal all stream data read operations for this table's stream: DescribeStream, GetRecords, GetShardIterator, ListStreams.
|
Grant |
grantTableListStreams(IGrantable grantee)
Permits an IAM Principal to list streams attached to current dynamodb table.
|
Grant |
grantWriteData(IGrantable grantee)
Permits an IAM principal all data write operations to this table: BatchWriteItem, PutItem, UpdateItem, DeleteItem.
|
Metric |
metric(java.lang.String metricName)
Metric for the number of Errors executing all Lambdas.
|
Metric |
metric(java.lang.String metricName,
MetricOptions props)
Metric for the number of Errors executing all Lambdas.
|
Metric |
metricConditionalCheckFailedRequests()
Metric for the conditional check failed requests.
|
Metric |
metricConditionalCheckFailedRequests(MetricOptions props)
Metric for the conditional check failed requests.
|
Metric |
metricConsumedReadCapacityUnits()
Metric for the consumed read capacity units.
|
Metric |
metricConsumedReadCapacityUnits(MetricOptions props)
Metric for the consumed read capacity units.
|
Metric |
metricConsumedWriteCapacityUnits()
Metric for the consumed write capacity units.
|
Metric |
metricConsumedWriteCapacityUnits(MetricOptions props)
Metric for the consumed write capacity units.
|
Metric |
metricSuccessfulRequestLatency()
Metric for the successful request latency.
|
Metric |
metricSuccessfulRequestLatency(MetricOptions props)
Metric for the successful request latency.
|
Metric |
metricSystemErrors()
Deprecated.
use `metricSystemErrorsForOperations`
|
Metric |
metricSystemErrors(MetricOptions props)
Deprecated.
use `metricSystemErrorsForOperations`
|
IMetric |
metricSystemErrorsForOperations()
Metric for the system errors this table.
|
IMetric |
metricSystemErrorsForOperations(SystemErrorsForOperationsMetricOptions props)
Metric for the system errors this table.
|
Metric |
metricThrottledRequests()
Metric for throttled requests.
|
Metric |
metricThrottledRequests(MetricOptions props)
Metric for throttled requests.
|
Metric |
metricUserErrors()
Metric for the user errors.
|
Metric |
metricUserErrors(MetricOptions props)
Metric for the user errors.
|
applyRemovalPolicy, getEnv, getStack
getNode
java.lang.String getTableArn()
java.lang.String getTableName()
default IKey getEncryptionKey()
default java.lang.String getTableStreamArn()
Grant grant(IGrantable grantee, java.lang.String... actions)
If encryptionKey
is present, appropriate grants to the key needs to be added
separately using the table.encryptionKey.grant*
methods.
grantee
- The principal (no-op if undefined). This parameter is required.actions
- The set of actions to allow (i.e. "dynamodb:PutItem", "dynamodb:GetItem", ...). This parameter is required.Grant grantFullAccess(IGrantable grantee)
Appropriate grants will also be added to the customer-managed KMS key if one was configured.
grantee
- The principal to grant access to. This parameter is required.Grant grantReadData(IGrantable grantee)
Appropriate grants will also be added to the customer-managed KMS key if one was configured.
grantee
- The principal to grant access to. This parameter is required.Grant grantReadWriteData(IGrantable grantee)
BatchGetItem, GetRecords, GetShardIterator, Query, GetItem, Scan, BatchWriteItem, PutItem, UpdateItem, DeleteItem
Appropriate grants will also be added to the customer-managed KMS key if one was configured.
grantee
- The principal to grant access to. This parameter is required.Grant grantStream(IGrantable grantee, java.lang.String... actions)
If encryptionKey
is present, appropriate grants to the key needs to be added
separately using the table.encryptionKey.grant*
methods.
grantee
- The principal (no-op if undefined). This parameter is required.actions
- The set of actions to allow (i.e. "dynamodb:DescribeStream", "dynamodb:GetRecords", ...). This parameter is required.Grant grantStreamRead(IGrantable grantee)
Appropriate grants will also be added to the customer-managed KMS key if one was configured.
grantee
- The principal to grant access to. This parameter is required.Grant grantTableListStreams(IGrantable grantee)
grantee
- The principal (no-op if undefined). This parameter is required.Grant grantWriteData(IGrantable grantee)
Appropriate grants will also be added to the customer-managed KMS key if one was configured.
grantee
- The principal to grant access to. This parameter is required.Metric metric(java.lang.String metricName, MetricOptions props)
metricName
- This parameter is required.props
- Metric metric(java.lang.String metricName)
metricName
- This parameter is required.Metric metricConditionalCheckFailedRequests(MetricOptions props)
props
- properties of a metric.Metric metricConditionalCheckFailedRequests()
Metric metricConsumedReadCapacityUnits(MetricOptions props)
props
- properties of a metric.Metric metricConsumedReadCapacityUnits()
Metric metricConsumedWriteCapacityUnits(MetricOptions props)
props
- properties of a metric.Metric metricConsumedWriteCapacityUnits()
Metric metricSuccessfulRequestLatency(MetricOptions props)
props
- properties of a metric.Metric metricSuccessfulRequestLatency()
@Deprecated Metric metricSystemErrors(MetricOptions props)
props
- properties of a metric.@Deprecated Metric metricSystemErrors()
IMetric metricSystemErrorsForOperations(SystemErrorsForOperationsMetricOptions props)
props
- properties of a metric.IMetric metricSystemErrorsForOperations()
Metric metricThrottledRequests(MetricOptions props)
props
- properties of a metric.Metric metricThrottledRequests()
Metric metricUserErrors(MetricOptions props)
props
- properties of a metric.Metric metricUserErrors()