Skip to content
v2.277.0

Experimental

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

TablePolicy L2 construct ​

A Policy for S3 Tables.

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

Example ​

ts
// 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 table: s3tables_alpha.Table;
const tablePolicy = new s3tables_alpha.TablePolicy(this, 'MyTablePolicy', {
  table: table,

  // the properties below are optional
  removalPolicy: cdk.RemovalPolicy.DESTROY,
  resourcePolicy: policyDocument,
});
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_s3tables_alpha as s3tables_alpha
import aws_cdk as cdk
from aws_cdk import aws_iam as iam

# policy_document: iam.PolicyDocument
# table: s3tables_alpha.Table

table_policy = s3tables_alpha.TablePolicy(self, "MyTablePolicy",
    table=table,

    # the properties below are optional
    removal_policy=cdk.RemovalPolicy.DESTROY,
    resource_policy=policy_document
)
java
// 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.alpha.*;
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.iam.*;

PolicyDocument policyDocument;
Table table;

TablePolicy tablePolicy = TablePolicy.Builder.create(this, "MyTablePolicy")
        .table(table)

        // the properties below are optional
        .removalPolicy(RemovalPolicy.DESTROY)
        .resourcePolicy(policyDocument)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.S3Tables.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.S3Tables.Alpha;
using Amazon.CDK;
using Amazon.CDK.AWS.IAM;

PolicyDocument policyDocument;
Table table;

var tablePolicy = new TablePolicy(this, "MyTablePolicy", new TablePolicyProps {
    Table = table,

    // the properties below are optional
    RemovalPolicy = RemovalPolicy.DESTROY,
    ResourcePolicy = policyDocument
});
go
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import s3tables_alpha "github.com/aws-samples/dummy/awscdkawss3tablesalpha"
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var policyDocument PolicyDocument
var table Table

tablePolicy := s3tables_alpha.NewTablePolicy(this, jsii.String("MyTablePolicy"), &TablePolicyProps{
	Table: table,

	// the properties below are optional
	RemovalPolicy: cdk.RemovalPolicy_DESTROY,
	ResourcePolicy: policyDocument,
})

Initializer ​

ts
new TablePolicy(scope: Construct, id: string, props: TablePolicyProps)
python
TablePolicy(scope: Construct, id: str, props: TablePolicyProps)
java
new TablePolicy(Construct scope, String id, TablePolicyProps props)
csharp
new TablePolicy(Construct scope, string id, TablePolicyProps props)
go
NewTablePolicy(Scope Construct, Id *string, Props TablePolicyProps)

Construct Props ​

removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy= RemovalPolicy.DESTROY.#
Policy to apply when the policy is removed from this stack.
resourcePolicyoptionalPolicyDocumentresource_policyoptionalPolicyDocumentresourcePolicyoptionalPolicyDocumentResourcePolicyoptionalPolicyDocumentResourcePolicyoptionalPolicyDocument#
The policy document for the table's resource policy.

Default: undefined An empty iam.PolicyDocument will be initialized

tableITabletableITabletableITableTableITableTableITablerequired#
The associated table.

Properties ​

The IAM PolicyDocument containing permissions represented by this policy.
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.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#
Uniquely identifies this class.
stackStackstackStackstackStackStackStackStackStack#
The stack in which this resource is defined.

Methods ​

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#
Override the cross-stack reference strength for this resource.
notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

  • strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.
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).

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#
Checks if `x` is a construct.
notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

  • xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#
Returns true if the construct was created by CDK, and false otherwise.
isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#
Check whether the given construct is a Resource.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#
Returns a string representation of this construct.
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. Use multiple with() calls if subsequent mixins should apply to added constructs.