Class ITable.Jsii$Proxy
- All Implemented Interfaces:
IResource
,IResource.Jsii$Default
,ITable
,ITable.Jsii$Default
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IConstruct.Jsii$Default
,software.constructs.IDependable
,software.constructs.IDependable.Jsii$Default
- Enclosing interface:
ITable
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
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.s3tables.alpha.ITable
ITable.Jsii$Default, ITable.Jsii$Proxy
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddToResourcePolicy
(PolicyStatement statement) (experimental) Adds a statement to the resource policy for a principal (i.e.final void
applyRemovalPolicy
(RemovalPolicy policy) Apply the given removal policy to this resource.final String
(experimental) The accountId containing this table.final ResourceEnvironment
getEnv()
The environment this resource belongs to.final software.constructs.Node
getNode()
The tree node.final String
(experimental) The region containing this table.final Stack
getStack()
The stack in which this resource is defined.final String
(experimental) The ARN of this table.final String
(experimental) The name of this table.final Grant
grantRead
(IGrantable identity) (experimental) Grant read permissions for this table to an IAM principal (Role/Group/User).final Grant
grantReadWrite
(IGrantable identity) (experimental) Grant read and write permissions for this table to an IAM principal (Role/Group/User).final Grant
grantWrite
(IGrantable identity) (experimental) Grant write permissions for this table to an IAM principal (Role/Group/User).Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
-
-
Method Details
-
getNode
@Stability(Stable) @NotNull public final 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
- Specified by:
getNode
in interfaceITable.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
- Specified by:
getEnv
in interfaceITable.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
- Specified by:
getStack
in interfaceITable.Jsii$Default
-
getTableArn
(experimental) The ARN of this table.- Specified by:
getTableArn
in interfaceITable
- Specified by:
getTableArn
in interfaceITable.Jsii$Default
-
getTableName
(experimental) The name of this table.- Specified by:
getTableName
in interfaceITable
- Specified by:
getTableName
in interfaceITable.Jsii$Default
-
getAccount
(experimental) The accountId containing this table.- Specified by:
getAccount
in interfaceITable
- Specified by:
getAccount
in interfaceITable.Jsii$Default
-
getRegion
(experimental) The region containing this table.- Specified by:
getRegion
in interfaceITable
- Specified by:
getRegion
in interfaceITable.Jsii$Default
-
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
- Specified by:
applyRemovalPolicy
in interfaceITable.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
addToResourcePolicy
@Stability(Experimental) @NotNull public final AddToResourcePolicyResult addToResourcePolicy(@NotNull PolicyStatement statement) (experimental) Adds a statement to the resource policy for a principal (i.e. account/role/service) to perform actions on this table.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.- Specified by:
addToResourcePolicy
in interfaceITable
- Specified by:
addToResourcePolicy
in interfaceITable.Jsii$Default
- Parameters:
statement
- the policy statement to be added to the table's policy. This parameter is required.- Returns:
- metadata about the execution of this method. If the policy
was not added, the value of
statementAdded
will befalse
. 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.
-
grantRead
(experimental) Grant read permissions for this table to an IAM principal (Role/Group/User).If the parent TableBucket of this table has encryption, you should grant kms:Decrypt permission to use this key to the same principal.
- Specified by:
grantRead
in interfaceITable
- Specified by:
grantRead
in interfaceITable.Jsii$Default
- Parameters:
identity
- The principal to allow read permissions to. This parameter is required.
-
grantReadWrite
(experimental) Grant read and write permissions for this table to an IAM principal (Role/Group/User).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.
- Specified by:
grantReadWrite
in interfaceITable
- Specified by:
grantReadWrite
in interfaceITable.Jsii$Default
- Parameters:
identity
- The principal to allow read and write permissions to. This parameter is required.
-
grantWrite
(experimental) Grant write permissions for this table to an IAM principal (Role/Group/User).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.
- Specified by:
grantWrite
in interfaceITable
- Specified by:
grantWrite
in interfaceITable.Jsii$Default
- Parameters:
identity
- The principal to allow write permissions to. This parameter is required.
-