@aws-cdk/aws-s3tables-alpha.ITableBucket

Experimental

@aws-cdk/aws-s3tables-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ITableBucket Interface

Interface definition for S3 Table Buckets.

ITableBucket

extends

• IResource

implemented by

• TableBucket

Stability

Experimental

Source

lib/table-bucket.ts

Properties

account?may be undefinedstringaccount?may be undefinedstraccount?may be undefinedStringAccount?may be undefinedstringAccount?may be undefined*string#

The accountId containing the table bucket.

encryptionKey?may be undefinedIKeyencryption_key?may be undefinedIKeyencryptionKey?may be undefinedIKeyEncryptionKey?may be undefinedIKeyEncryptionKey?may be undefinedIKey#

Optional KMS encryption key associated with this table bucket.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

region?may be undefinedstringregion?may be undefinedstrregion?may be undefinedStringRegion?may be undefinedstringRegion?may be undefined*string#

The region containing the table bucket.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

tableBucketArnstringtable_bucket_arnstrtableBucketArnStringTableBucketArnstringTableBucketArn*string#

The ARN of the table bucket.

tableBucketNamestringtable_bucket_namestrtableBucketNameStringTableBucketNamestringTableBucketName*string#

The name of the table bucket.

Methods

addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResultdef add_to_resource_policy(self, statement: PolicyStatement) -> AddToResourcePolicyResultpublic AddToResourcePolicyResult addToResourcePolicy(PolicyStatement statement)public AddToResourcePolicyResult AddToResourcePolicy(PolicyStatement statement)func AddToResourcePolicy(Statement PolicyStatement) AddToResourcePolicyResult#

Adds a statement to the resource policy for a principal (i.e. account/role/service) to perform actions on this table bucket and/or its tables.

notes · 1 parameter · returns

Note that the policy statement may or may not be added to the policy. For example, when an ITableBucket is created from an existing table bucket, it's not possible to tell whether the bucket 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.

Parameters

• statementstatementstatementstatementStatement — the policy statement to be added to the bucket'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.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

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).

grantRead(identity: IGrantable, tableId: string): Grantdef grant_read(self, identity: IGrantable, table_id: str) -> Grantpublic Grant grantRead(IGrantable identity, String tableId)public Grant GrantRead(IGrantable identity, string tableId)func GrantRead(Identity IGrantable, TableId *string) Grant#

Grant read permissions for this table bucket and its tables to an IAM principal (Role/Group/User).

If encryption is used, permission to use the key to decrypt the contents of the bucket will also be granted to the same principal.

2 parameters

Parameters

• identityidentityidentityidentityIdentity — The principal to allow read permissions to.
• tableIdtable_idtableIdtableIdTableId — Allow the permissions to all tables using '*' or to single table by its unique ID.

grantReadWrite(identity: IGrantable, tableId: string): Grantdef grant_read_write(self, identity: IGrantable, table_id: str) -> Grantpublic Grant grantReadWrite(IGrantable identity, String tableId)public Grant GrantReadWrite(IGrantable identity, string tableId)func GrantReadWrite(Identity IGrantable, TableId *string) Grant#

Grant read and write permissions for this table bucket and its tables to an IAM principal (Role/Group/User).

If encryption is used, permission to use the key to encrypt/decrypt the contents of the bucket will also be granted to the same principal.

2 parameters

Parameters

• identityidentityidentityidentityIdentity — The principal to allow read and write permissions to.
• tableIdtable_idtableIdtableIdTableId — Allow the permissions to all tables using '*' or to single table by its unique ID.

grantWrite(identity: IGrantable, tableId: string): Grantdef grant_write(self, identity: IGrantable, table_id: str) -> Grantpublic Grant grantWrite(IGrantable identity, String tableId)public Grant GrantWrite(IGrantable identity, string tableId)func GrantWrite(Identity IGrantable, TableId *string) Grant#

Grant write permissions for this table bucket and its tables to an IAM principal (Role/Group/User).

If encryption is used, permission to use the key to encrypt the contents of the bucket will also be granted to the same principal.

2 parameters

Parameters

• identityidentityidentityidentityIdentity — The principal to allow write permissions to.
• tableIdtable_idtableIdtableIdTableId — Allow the permissions to all tables using '*' or to single table by its unique ID.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining