class TableBucketPolicy (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.S3Tables.Alpha.TableBucketPolicy
Java	software.amazon.awscdk.services.s3tables.alpha.TableBucketPolicy
Python	aws_cdk.aws_s3tables_alpha.TableBucketPolicy
TypeScript (source)	@aws-cdk/aws-s3tables-alpha » TableBucketPolicy

Implements IConstruct, IDependable, IResource, IEnvironmentAware

A Bucket Policy for S3 TableBuckets.

You will almost never need to use this construct directly. Instead, TableBucket.addToResourcePolicy can be used to add more policies to your bucket directly

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as s3tables_alpha from '@aws-cdk/aws-s3tables-alpha';
import * as cdk from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';

declare const policyDocument: iam.PolicyDocument;
declare const tableBucket: s3tables_alpha.TableBucket;
const tableBucketPolicy = new s3tables_alpha.TableBucketPolicy(this, 'MyTableBucketPolicy', {
  tableBucket: tableBucket,

  // the properties below are optional
  removalPolicy: cdk.RemovalPolicy.DESTROY,
  resourcePolicy: policyDocument,
});

Initializer

new TableBucketPolicy(scope: Construct, id: string, props: TableBucketPolicyProps)

Parameters

• scope Construct
• id string
• props TableBucketPolicyProps

Construct Props

Name	Type	Description
tableBucket🔹	ITableBucket	The associated table bucket.
removalPolicy?🔹	RemovalPolicy	Policy to apply when the policy is removed from this stack.
resourcePolicy?🔹	PolicyDocument	The policy document for the bucket's resource policy.

---

tableBucket🔹

Type: ITableBucket

The associated table bucket.

---

removalPolicy?🔹

Type: RemovalPolicy (optional, default: RemovalPolicy.DESTROY.)

Policy to apply when the policy is removed from this stack.

---

resourcePolicy?🔹

Type: PolicyDocument (optional, default: undefined An empty iam.PolicyDocument will be initialized)

The policy document for the bucket's resource policy.

Properties

Name	Type	Description
document🔹	PolicyDocument	The IAM PolicyDocument containing permissions represented by this policy.
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.
static PROPERTY_INJECTION_ID🔹	string	Uniquely identifies this class.

---

document🔹

Type: PolicyDocument

The IAM PolicyDocument containing permissions represented by this policy.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

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.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
toString()🔹	Returns a string representation of this construct.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

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

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.