Package software.amazon.awscdk.services.s3tables

Class CfnTablePolicy

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.s3tables.CfnTablePolicy

All Implemented Interfaces:

IEnvironmentAware, IInspectable, ITablePolicyRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:49.580Z")
@Stability(Stable)
public class CfnTablePolicy
extends CfnResource
implements IInspectable, ITablePolicyRef

Creates a new maintenance configuration or replaces an existing table policy for a table.

For more information, see Adding a table policy in the Amazon Simple Storage Service User Guide .

• Permissions - You must have the s3tables:PutTablePolicy permission to use this operation.
• Cloud Development Kit - To use S3 Tables AWS CDK constructs, add the @aws-cdk/aws-s3tables-alpha dependency with one of the following options:
• NPM: `npm i

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3tables.*;
 Object resourcePolicy;
 CfnTablePolicy cfnTablePolicy = CfnTablePolicy.Builder.create(this, "MyCfnTablePolicy")
         .resourcePolicy(resourcePolicy)
         .tableArn("tableArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-tablepolicy.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnTablePolicy.Builder	A fluent builder for CfnTablePolicy.

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.s3tables.ITablePolicyRef

ITablePolicyRef.Jsii$Default, ITablePolicyRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnTablePolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTablePolicy(software.amazon.jsii.JsiiObjectRef objRef)
	CfnTablePolicy(software.constructs.Construct scope, String id, CfnTablePolicyProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrNamespace()	The namespace to associated with the table.
String	getAttrTableBucketArn()	The Amazon Resource Name (ARN) of the table bucket that contains the table.
String	getAttrTableName()	The name of the table.
protected Map<String,Object>	getCfnProperties()
Object	getResourcePolicy()	The JSON that defines the policy.
String	getTableArn()	The Amazon Resource Name (ARN) of the table.
TablePolicyReference	getTablePolicyRef()	A reference to a TablePolicy resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setResourcePolicy(Object value)	The JSON that defines the policy.
void	setTableArn(String value)	The Amazon Resource Name (ARN) of the table.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnTablePolicy

protected CfnTablePolicy(software.amazon.jsii.JsiiObjectRef objRef)

CfnTablePolicy

protected CfnTablePolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnTablePolicy

@Stability(Stable)
public CfnTablePolicy(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnTablePolicyProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrNamespace

@Stability(Stable)
@NotNull
public String getAttrNamespace()

The namespace to associated with the table.

getAttrTableBucketArn

@Stability(Stable)
@NotNull
public String getAttrTableBucketArn()

The Amazon Resource Name (ARN) of the table bucket that contains the table.

getAttrTableName

@Stability(Stable)
@NotNull
public String getAttrTableName()

The name of the table.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTablePolicyRef

@Stability(Stable)
@NotNull
public TablePolicyReference getTablePolicyRef()

A reference to a TablePolicy resource.

Specified by:

getTablePolicyRef in interface ITablePolicyRef

getResourcePolicy

@Stability(Stable)
@NotNull
public Object getResourcePolicy()

The JSON that defines the policy.

setResourcePolicy

@Stability(Stable)
public void setResourcePolicy(@NotNull
 Object value)

The JSON that defines the policy.

getTableArn

@Stability(Stable)
@NotNull
public String getTableArn()

The Amazon Resource Name (ARN) of the table.

setTableArn

@Stability(Stable)
public void setTableArn(@NotNull
 String value)

The Amazon Resource Name (ARN) of the table.