Interface ITable.Jsii$Default
- All Superinterfaces:
software.constructs.IConstruct
,software.constructs.IConstruct.Jsii$Default
,software.constructs.IDependable
,software.constructs.IDependable.Jsii$Default
,IResource
,IResource.Jsii$Default
,ITable
,software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
ITableV2.Jsii$Default
- All Known Implementing Classes:
ITable.Jsii$Proxy
,ITableV2.Jsii$Proxy
- Enclosing interface:
ITable
ITable
.-
Nested Class Summary
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.dynamodb.ITable
ITable.Jsii$Default, ITable.Jsii$Proxy
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
applyRemovalPolicy
(RemovalPolicy policy) Apply the given removal policy to this resource.default IKey
Optional KMS encryption key associated with this table.default ResourceEnvironment
getEnv()
The environment this resource belongs to.default software.constructs.Node
getNode()
The tree node.default Stack
getStack()
The stack in which this resource is defined.default String
Arn of the dynamodb table.default String
Table name of the dynamodb table.default String
ARN of the table's stream, if there is one.default Grant
grant
(IGrantable grantee, @NotNull 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, @NotNull 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
(String metricName, MetricOptions props) Metric for the number of Errors executing all Lambdas.default Metric
Metric for the conditional check failed requests.default Metric
Metric for the consumed read capacity units.default Metric
Metric for the consumed write capacity units.default Metric
Metric for the successful request latency.default IMetric
Metric for the system errors this table.default Metric
Deprecated.default IMetric
Metric for throttled requests.default Metric
metricUserErrors
(MetricOptions props) Metric for the user errors.Methods inherited from interface software.amazon.awscdk.services.dynamodb.ITable
metric, metricConditionalCheckFailedRequests, metricConsumedReadCapacityUnits, metricConsumedWriteCapacityUnits, metricSuccessfulRequestLatency, metricSystemErrorsForOperations, metricThrottledRequests, metricThrottledRequestsForOperations, metricUserErrors
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getNode
@Stability(Stable) @NotNull default software.constructs.Node getNode()The tree node.- Specified by:
getNode
in interfacesoftware.constructs.IConstruct
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
-
getEnv
The environment this resource belongs to.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.
- Specified by:
getEnv
in interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
-
getTableArn
Arn of the dynamodb table.- Specified by:
getTableArn
in interfaceITable
-
getTableName
Table name of the dynamodb table.- Specified by:
getTableName
in interfaceITable
-
getEncryptionKey
Optional KMS encryption key associated with this table.- Specified by:
getEncryptionKey
in interfaceITable
-
getTableStreamArn
ARN of the table's stream, if there is one.- Specified by:
getTableStreamArn
in interfaceITable
-
applyRemovalPolicy
Apply the given removal policy to this resource.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
).- Specified by:
applyRemovalPolicy
in interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
grant
@Stability(Stable) @NotNull default Grant grant(@NotNull IGrantable grantee, @NotNull @NotNull String... actions) Adds an IAM policy statement associated with this table to an IAM principal's policy.If
encryptionKey
is present, appropriate grants to the key needs to be added separately using thetable.encryptionKey.grant*
methods. -
grantFullAccess
Permits all DynamoDB operations ("dynamodb:*") to an IAM principal.Appropriate grants will also be added to the customer-managed KMS key if one was configured.
- Specified by:
grantFullAccess
in interfaceITable
- Parameters:
grantee
- The principal to grant access to. This parameter is required.
-
grantReadData
Permits an IAM principal all data read operations from this table: BatchGetItem, GetRecords, GetShardIterator, Query, GetItem, Scan.Appropriate grants will also be added to the customer-managed KMS key if one was configured.
- Specified by:
grantReadData
in interfaceITable
- Parameters:
grantee
- The principal to grant access to. This parameter is required.
-
grantReadWriteData
Permits an IAM principal to all data read/write operations to this table.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.
- Specified by:
grantReadWriteData
in interfaceITable
- Parameters:
grantee
- The principal to grant access to. This parameter is required.
-
grantStream
@Stability(Stable) @NotNull default Grant grantStream(@NotNull IGrantable grantee, @NotNull @NotNull String... actions) Adds an IAM policy statement associated with this table's stream to an IAM principal's policy.If
encryptionKey
is present, appropriate grants to the key needs to be added separately using thetable.encryptionKey.grant*
methods.- Specified by:
grantStream
in interfaceITable
- Parameters:
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.
-
grantStreamRead
Permits an IAM principal all stream data read operations for this table's stream: DescribeStream, GetRecords, GetShardIterator, ListStreams.Appropriate grants will also be added to the customer-managed KMS key if one was configured.
- Specified by:
grantStreamRead
in interfaceITable
- Parameters:
grantee
- The principal to grant access to. This parameter is required.
-
grantTableListStreams
Permits an IAM Principal to list streams attached to current dynamodb table.- Specified by:
grantTableListStreams
in interfaceITable
- Parameters:
grantee
- The principal (no-op if undefined). This parameter is required.
-
grantWriteData
Permits an IAM principal all data write operations to this table: BatchWriteItem, PutItem, UpdateItem, DeleteItem.Appropriate grants will also be added to the customer-managed KMS key if one was configured.
- Specified by:
grantWriteData
in interfaceITable
- Parameters:
grantee
- The principal to grant access to. This parameter is required.
-
metric
@Stability(Stable) @NotNull default Metric metric(@NotNull String metricName, @Nullable MetricOptions props) Metric for the number of Errors executing all Lambdas. -
metricConditionalCheckFailedRequests
@Stability(Stable) @NotNull default Metric metricConditionalCheckFailedRequests(@Nullable MetricOptions props) Metric for the conditional check failed requests.- Specified by:
metricConditionalCheckFailedRequests
in interfaceITable
- Parameters:
props
- properties of a metric.
-
metricConsumedReadCapacityUnits
@Stability(Stable) @NotNull default Metric metricConsumedReadCapacityUnits(@Nullable MetricOptions props) Metric for the consumed read capacity units.- Specified by:
metricConsumedReadCapacityUnits
in interfaceITable
- Parameters:
props
- properties of a metric.
-
metricConsumedWriteCapacityUnits
@Stability(Stable) @NotNull default Metric metricConsumedWriteCapacityUnits(@Nullable MetricOptions props) Metric for the consumed write capacity units.- Specified by:
metricConsumedWriteCapacityUnits
in interfaceITable
- Parameters:
props
- properties of a metric.
-
metricSuccessfulRequestLatency
@Stability(Stable) @NotNull default Metric metricSuccessfulRequestLatency(@Nullable MetricOptions props) Metric for the successful request latency.- Specified by:
metricSuccessfulRequestLatency
in interfaceITable
- Parameters:
props
- properties of a metric.
-
metricSystemErrorsForOperations
@Stability(Stable) @NotNull default IMetric metricSystemErrorsForOperations(@Nullable SystemErrorsForOperationsMetricOptions props) Metric for the system errors this table.- Specified by:
metricSystemErrorsForOperations
in interfaceITable
- Parameters:
props
- properties of a metric.
-
metricThrottledRequests
@Stability(Deprecated) @Deprecated @NotNull default Metric metricThrottledRequests(@Nullable MetricOptions props) Deprecated.usemetricThrottledRequestsForOperations
(deprecated) Metric for throttled requests.- Specified by:
metricThrottledRequests
in interfaceITable
- Parameters:
props
- properties of a metric.
-
metricThrottledRequestsForOperations
@Stability(Stable) @NotNull default IMetric metricThrottledRequestsForOperations(@Nullable OperationsMetricOptions props) Metric for throttled requests.- Specified by:
metricThrottledRequestsForOperations
in interfaceITable
- Parameters:
props
- properties of a metric.
-
metricUserErrors
Metric for the user errors.- Specified by:
metricUserErrors
in interfaceITable
- Parameters:
props
- properties of a metric.
-
metricThrottledRequestsForOperations