Interface ITable
(experimental) Represents an S3 Table.
Namespace: Amazon.CDK.AWS.S3Tables.Alpha
Assembly: Amazon.CDK.AWS.S3Tables.Alpha.dll
Syntax (csharp)
public interface ITable : IResource, IConstruct, IDependable, IEnvironmentAwareSyntax (vb)
Public Interface ITable Inherits IResource, IConstruct, IDependable, IEnvironmentAwareRemarks
Stability: Experimental
Synopsis
Properties
| Account | (experimental) The accountId containing this table. |
| Region | (experimental) The region containing this table. |
| TableArn | (experimental) The ARN of this table. |
| TableName | (experimental) The name of this table. |
Methods
| AddToResourcePolicy(PolicyStatement) | (experimental) Adds a statement to the resource policy for a principal (i.e. account/role/service) to perform actions on this table. |
| GrantRead(IGrantable) | (experimental) Grant read permissions for this table to an IAM principal (Role/Group/User). |
| GrantReadWrite(IGrantable) | (experimental) Grant read and write permissions for this table to an IAM principal (Role/Group/User). |
| GrantWrite(IGrantable) | (experimental) Grant write permissions for this table to an IAM principal (Role/Group/User). |
Properties
Account
(experimental) The accountId containing this table.
string? Account { get; }Property Value
Remarks
Stability: Experimental
Attribute: true
Region
(experimental) The region containing this table.
string? Region { get; }Property Value
Remarks
Stability: Experimental
Attribute: true
TableArn
(experimental) The ARN of this table.
string TableArn { get; }Property Value
Remarks
Stability: Experimental
Attribute: true
TableName
(experimental) The name of this table.
string TableName { get; }Property Value
Remarks
Stability: Experimental
Attribute: true
Methods
AddToResourcePolicy(PolicyStatement)
(experimental) Adds a statement to the resource policy for a principal (i.e. account/role/service) to perform actions on this table.
IAddToResourcePolicyResult AddToResourcePolicy(PolicyStatement statement)Parameters
- statement PolicyStatement
the policy statement to be added to the table's policy.
Returns
metadata about the execution of this method. If the policy
was not added, the value of statementAdded will be false. You
should always check this value to make sure that the operation was
actually carried out. Otherwise, synthesis and deploy will terminate
silently, which may be confusing.
Remarks
Note that the policy statement may or may not be added to the policy.
For example, when an ITable is created from an existing table,
it's not possible to tell whether the table already has a policy
attached, let alone to re-use that policy to add more statements to it.
So it's safest to do nothing in these cases.
Stability: Experimental
GrantRead(IGrantable)
(experimental) Grant read permissions for this table to an IAM principal (Role/Group/User).
Grant GrantRead(IGrantable identity)Parameters
- identity IGrantable
The principal to allow read permissions to.
Returns
Remarks
If the parent TableBucket of this table has encryption, you should grant kms:Decrypt permission to use this key to the same principal.
Stability: Experimental
GrantReadWrite(IGrantable)
(experimental) Grant read and write permissions for this table to an IAM principal (Role/Group/User).
Grant GrantReadWrite(IGrantable identity)Parameters
- identity IGrantable
The principal to allow read and write permissions to.
Returns
Remarks
If the parent TableBucket of this table has encryption, you should grant kms:GenerateDataKey and kms:Decrypt permission to use this key to the same principal.
Stability: Experimental
GrantWrite(IGrantable)
(experimental) Grant write permissions for this table to an IAM principal (Role/Group/User).
Grant GrantWrite(IGrantable identity)Parameters
- identity IGrantable
The principal to allow write permissions to.
Returns
Remarks
If the parent TableBucket of this table has encryption, you should grant kms:GenerateDataKey and kms:Decrypt permission to use this key to the same principal.
Stability: Experimental