Experimental
@aws-cdk/aws-s3tables-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
TableBucketAttributes Struct
A reference to a table bucket outside this stack.
The tableBucketName, region, and account can be provided explicitly or will be inferred from the tableBucketArn
| Stability | Experimental |
|---|---|
| Source | lib/table-bucket.ts |
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 { aws_kms as kms } from 'aws-cdk-lib';
declare const key: kms.Key;
const tableBucketAttributes: s3tables_alpha.TableBucketAttributes = {
account: 'account',
encryptionKey: key,
region: 'region',
tableBucketArn: 'tableBucketArn',
tableBucketName: 'tableBucketName',
};
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
from aws_cdk import aws_kms as kms
# key: kms.Key
table_bucket_attributes = s3tables_alpha.TableBucketAttributes(
account="account",
encryption_key=key,
region="region",
table_bucket_arn="tableBucketArn",
table_bucket_name="tableBucketName"
)
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.services.kms.*;
Key key;
TableBucketAttributes tableBucketAttributes = TableBucketAttributes.builder()
.account("account")
.encryptionKey(key)
.region("region")
.tableBucketArn("tableBucketArn")
.tableBucketName("tableBucketName")
.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.AWS.KMS;
Key key;
var tableBucketAttributes = new TableBucketAttributes {
Account = "account",
EncryptionKey = key,
Region = "region",
TableBucketArn = "tableBucketArn",
TableBucketName = "tableBucketName"
};
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 "github.com/aws/aws-cdk-go/awscdk"
var key Key
tableBucketAttributes := &TableBucketAttributes{
Account: jsii.String("account"),
EncryptionKey: key,
Region: jsii.String("region"),
TableBucketArn: jsii.String("tableBucketArn"),
TableBucketName: jsii.String("tableBucketName"),
}
Properties
accountoptionalstringaccountoptionalstraccountoptionalStringAccountoptionalstringAccountoptional*string #The accountId containing this table bucket.
Default: account inferred from scope
encryptionKeyoptionalIKeyencryption_keyoptionalIKeyencryptionKeyoptionalIKeyEncryptionKeyoptionalIKeyEncryptionKeyoptionalIKey = undefined #Optional KMS encryption key associated with this bucket.
regionoptionalstringregionoptionalstrregionoptionalStringRegionoptionalstringRegionoptional*string #AWS region this table bucket exists in.
Default: region inferred from scope
tableBucketArnoptionalstringtable_bucket_arnoptionalstrtableBucketArnoptionalStringTableBucketArnoptionalstringTableBucketArnoptional*string #The table bucket's ARN.
Default: tableBucketArn constructed from region, account and tableBucketName are provided
tableBucketNameoptionalstringtable_bucket_nameoptionalstrtableBucketNameoptionalStringTableBucketNameoptionalstringTableBucketNameoptional*string #The table bucket name, unique per region.
Default: tableBucketName inferred from arn