public static interface ITable.Jsii$Default extends ITable, IResource.Jsii$Default
ITable
.ITable.Jsii$Default, ITable.Jsii$Proxy
Modifier and Type | Method and Description |
---|---|
default void |
applyRemovalPolicy(RemovalPolicy policy)
Apply the given removal policy to this resource.
|
default IKey |
getEncryptionKey()
Optional KMS encryption key associated with this table.
|
default ResourceEnvironment |
getEnv()
The environment this resource belongs to.
|
default ConstructNode |
getNode()
The construct tree node for this construct.
|
default Stack |
getStack()
The stack in which this resource is defined.
|
default java.lang.String |
getTableArn()
Arn of the dynamodb table.
|
default 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.
|
default Grant |
grant(IGrantable grantee,
java.lang.String... actions)
Adds an IAM policy statement associated with this table to an IAM principal's policy.
|
default Grant |
grantFullAccess(IGrantable grantee)
Permits all DynamoDB operations ("dynamodb:*") to an IAM principal.
|
default Grant |
grantReadData(IGrantable grantee)
Permits an IAM principal all data read operations from this table: BatchGetItem, GetRecords, GetShardIterator, Query, GetItem, Scan.
|
default Grant |
grantReadWriteData(IGrantable grantee)
Permits an IAM principal to all data read/write operations to this table.
|
default 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.
|
default Grant |
grantStreamRead(IGrantable grantee)
Permits an IAM principal all stream data read operations for this table's stream: DescribeStream, GetRecords, GetShardIterator, ListStreams.
|
default Grant |
grantTableListStreams(IGrantable grantee)
Permits an IAM Principal to list streams attached to current dynamodb table.
|
default Grant |
grantWriteData(IGrantable grantee)
Permits an IAM principal all data write operations to this table: BatchWriteItem, PutItem, UpdateItem, DeleteItem.
|
default Metric |
metric(java.lang.String metricName,
MetricOptions props)
Metric for the number of Errors executing all Lambdas.
|
default Metric |
metricConditionalCheckFailedRequests(MetricOptions props)
Metric for the conditional check failed requests.
|
default Metric |
metricConsumedReadCapacityUnits(MetricOptions props)
Metric for the consumed read capacity units.
|
default Metric |
metricConsumedWriteCapacityUnits(MetricOptions props)
Metric for the consumed write capacity units.
|
default Metric |
metricSuccessfulRequestLatency(MetricOptions props)
Metric for the successful request latency.
|
default Metric |
metricSystemErrors(MetricOptions props)
Deprecated.
use `metricSystemErrorsForOperations`
|
default IMetric |
metricSystemErrorsForOperations(SystemErrorsForOperationsMetricOptions props)
Metric for the system errors this table.
|
default Metric |
metricThrottledRequests(MetricOptions props)
Metric for throttled requests.
|
default Metric |
metricUserErrors(MetricOptions props)
Metric for the user errors.
|
metric, metricConditionalCheckFailedRequests, metricConsumedReadCapacityUnits, metricConsumedWriteCapacityUnits, metricSuccessfulRequestLatency, metricSystemErrors, metricSystemErrorsForOperations, metricThrottledRequests, metricUserErrors
default ConstructNode getNode()
getNode
in interface IConstruct
getNode
in interface IConstruct.Jsii$Default
getNode
in interface IResource.Jsii$Default
default ResourceEnvironment getEnv()
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
getEnv
in interface IResource
getEnv
in interface IResource.Jsii$Default
default Stack getStack()
getStack
in interface IResource
getStack
in interface IResource.Jsii$Default
default java.lang.String getTableArn()
getTableArn
in interface ITable
default java.lang.String getTableName()
getTableName
in interface ITable
default IKey getEncryptionKey()
getEncryptionKey
in interface ITable
default java.lang.String getTableStreamArn()
getTableStreamArn
in interface ITable
default void applyRemovalPolicy(RemovalPolicy policy)
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
).
applyRemovalPolicy
in interface IResource
applyRemovalPolicy
in interface IResource.Jsii$Default
policy
- This parameter is required.default 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.
default Grant grantFullAccess(IGrantable grantee)
Appropriate grants will also be added to the customer-managed KMS key if one was configured.
grantFullAccess
in interface ITable
grantee
- The principal to grant access to. This parameter is required.default Grant grantReadData(IGrantable grantee)
Appropriate grants will also be added to the customer-managed KMS key if one was configured.
grantReadData
in interface ITable
grantee
- The principal to grant access to. This parameter is required.default 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.
grantReadWriteData
in interface ITable
grantee
- The principal to grant access to. This parameter is required.default 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.
grantStream
in interface ITable
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.default Grant grantStreamRead(IGrantable grantee)
Appropriate grants will also be added to the customer-managed KMS key if one was configured.
grantStreamRead
in interface ITable
grantee
- The principal to grant access to. This parameter is required.default Grant grantTableListStreams(IGrantable grantee)
grantTableListStreams
in interface ITable
grantee
- The principal (no-op if undefined). This parameter is required.default Grant grantWriteData(IGrantable grantee)
Appropriate grants will also be added to the customer-managed KMS key if one was configured.
grantWriteData
in interface ITable
grantee
- The principal to grant access to. This parameter is required.default Metric metric(java.lang.String metricName, MetricOptions props)
default Metric metricConditionalCheckFailedRequests(MetricOptions props)
metricConditionalCheckFailedRequests
in interface ITable
props
- properties of a metric.default Metric metricConsumedReadCapacityUnits(MetricOptions props)
metricConsumedReadCapacityUnits
in interface ITable
props
- properties of a metric.default Metric metricConsumedWriteCapacityUnits(MetricOptions props)
metricConsumedWriteCapacityUnits
in interface ITable
props
- properties of a metric.default Metric metricSuccessfulRequestLatency(MetricOptions props)
metricSuccessfulRequestLatency
in interface ITable
props
- properties of a metric.@Deprecated default Metric metricSystemErrors(MetricOptions props)
metricSystemErrors
in interface ITable
props
- properties of a metric.default IMetric metricSystemErrorsForOperations(SystemErrorsForOperationsMetricOptions props)
metricSystemErrorsForOperations
in interface ITable
props
- properties of a metric.default Metric metricThrottledRequests(MetricOptions props)
metricThrottledRequests
in interface ITable
props
- properties of a metric.default Metric metricUserErrors(MetricOptions props)
metricUserErrors
in interface ITable
props
- properties of a metric.