@aws-cdk/aws-s3tables-alpha 2.207.0-alpha.0 → 2.209.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +1295 -85
- package/.jsii.tabl.json.gz +0 -0
- package/.warnings.jsii.js +111 -1
- package/README.md +55 -2
- package/lib/index.d.ts +2 -0
- package/lib/index.js +3 -1
- package/lib/namespace.d.ts +81 -0
- package/lib/namespace.js +117 -0
- package/lib/table-bucket-policy.js +1 -1
- package/lib/table-bucket.js +1 -1
- package/lib/table.d.ts +246 -0
- package/lib/table.js +163 -0
- package/package.json +7 -7
- package/rosetta/default.ts-fixture +5 -1
package/.jsii
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"url": "https://aws.amazon.com"
|
|
9
9
|
},
|
|
10
10
|
"dependencies": {
|
|
11
|
-
"aws-cdk-lib": "^2.
|
|
11
|
+
"aws-cdk-lib": "^2.209.0",
|
|
12
12
|
"constructs": "^10.0.0"
|
|
13
13
|
},
|
|
14
14
|
"dependencyClosure": {
|
|
@@ -4030,7 +4030,7 @@
|
|
|
4030
4030
|
"stability": "experimental"
|
|
4031
4031
|
},
|
|
4032
4032
|
"homepage": "https://github.com/aws/aws-cdk",
|
|
4033
|
-
"jsiiVersion": "5.7.
|
|
4033
|
+
"jsiiVersion": "5.7.20 (build 433aee4)",
|
|
4034
4034
|
"keywords": [
|
|
4035
4035
|
"aws",
|
|
4036
4036
|
"cdk",
|
|
@@ -4053,7 +4053,7 @@
|
|
|
4053
4053
|
},
|
|
4054
4054
|
"name": "@aws-cdk/aws-s3tables-alpha",
|
|
4055
4055
|
"readme": {
|
|
4056
|
-
"markdown": "# Amazon S3 Tables Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n\n<!--END STABILITY BANNER-->\n\n## Amazon S3 Tables\n\nAmazon S3 Tables deliver the first cloud object store with built-in Apache Iceberg support and streamline storing tabular data at scale.\n\n[Product Page](https://aws.amazon.com/s3/features/tables/) | [User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables.html)\n\n\n## Usage\n\n### Define an S3 Table Bucket\n\n```ts\n// Build a Table bucket\nconst sampleTableBucket = new TableBucket(scope, 'ExampleTableBucket', {\n tableBucketName: 'example-bucket-1',\n // optional fields:\n unreferencedFileRemoval: {\n status: UnreferencedFileRemovalStatus.ENABLED,\n noncurrentDays: 20,\n unreferencedDays: 20,\n }\n});\n```\n\nLearn more about table buckets maintenance operations and default behavior from the [S3 Tables User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-table-buckets-maintenance.html)\n\n### Controlling Table Bucket Permissions\n\n```ts\n// Grant the principal read permissions to the bucket and all tables within\nconst accountId = '123456789012'\ntableBucket.grantRead(new iam.AccountPrincipal(accountId), '*');\n\n// Grant the role write permissions to the bucket and all tables within\nconst role = new iam.Role(stack, 'MyRole', { assumedBy: new iam.ServicePrincipal('sample') });\ntableBucket.grantWrite(role, '*');\n\n// Grant the user read and write permissions to the bucket and all tables within\ntableBucket.grantReadWrite(new iam.User(stack, 'MyUser'), '*');\n\n// Grant permissions to the bucket and a particular table within it\nconst tableId = '6ba046b2-26de-44cf-9144-0c7862593a7b'\ntableBucket.grantReadWrite(new iam.AccountPrincipal(accountId), tableId);\n\n// Add custom resource policy statements\nconst permissions = new iam.PolicyStatement({\n effect: iam.Effect.ALLOW,\n actions: ['s3tables:*'],\n principals: [ new iam.ServicePrincipal('example.aws.internal') ],\n resources: ['*']\n});\n\ntableBucket.addToResourcePolicy(permissions);\n```\n\n### Controlling Table Bucket Encryption Settings\n\nS3 TableBuckets have SSE (server-side encryption with AES-256) enabled by default with S3 managed keys.\nYou can also bring your own KMS key for KMS-SSE or have S3 create a KMS key for you.\n\nIf a bucket is encrypted with KMS, grant functions on the bucket will also grant access\nto the TableBucket's associated KMS key.\n\n```ts\n// Provide a user defined KMS Key:\nconst key = new kms.Key(scope, 'UserKey', {});\nconst encryptedBucket = new TableBucket(scope, 'EncryptedTableBucket', {\n tableBucketName: 'table-bucket-1',\n encryption: TableBucketEncryption.KMS,\n encryptionKey: key,\n});\n// This account principal will also receive kms:Decrypt access to the KMS key\nencryptedBucket.grantRead(new iam.AccountPrincipal('123456789012'), '*');\n\n// Use S3 managed server side encryption (default)\nconst encryptedBucketDefault = new TableBucket(scope, 'EncryptedTableBucketDefault', {\n tableBucketName: 'table-bucket-3',\n encryption: TableBucketEncryption.S3_MANAGED, // Uses AES-256 encryption by default\n});\n```\n\nWhen using KMS encryption (`TableBucketEncryption.KMS`), if no encryption key is provided, CDK will automatically create a new KMS key for the table bucket with necessary permissions.\n\n```ts\n// If no key is provided, one will be created automatically\nconst encryptedBucketAuto = new TableBucket(scope, 'EncryptedTableBucketAuto', {\n tableBucketName: 'table-bucket-2',\n encryption: TableBucketEncryption.KMS,\n});\n```\n\n## Coming Soon\n\nL2 Construct support for:\n\n-
|
|
4056
|
+
"markdown": "# Amazon S3 Tables Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n\n<!--END STABILITY BANNER-->\n\n## Amazon S3 Tables\n\nAmazon S3 Tables deliver the first cloud object store with built-in Apache Iceberg support and streamline storing tabular data at scale.\n\n[Product Page](https://aws.amazon.com/s3/features/tables/) | [User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables.html)\n\n\n## Usage\n\n### Define an S3 Table Bucket\n\n```ts\n// Build a Table bucket\nconst sampleTableBucket = new TableBucket(scope, 'ExampleTableBucket', {\n tableBucketName: 'example-bucket-1',\n // optional fields:\n unreferencedFileRemoval: {\n status: UnreferencedFileRemovalStatus.ENABLED,\n noncurrentDays: 20,\n unreferencedDays: 20,\n }\n});\n```\n\n### Define an S3 Tables Namespace\n\n```ts\n// Build a namespace\nconst sampleNamespace = new Namespace(scope, 'ExampleNamespace', {\n namespaceName: 'example-namespace-1',\n tableBucket: tableBucket,\n});\n```\n\n### Define an S3 Table\n\n```ts\n// Build a table\nconst sampleTable = new Table(scope, 'ExampleTable', {\n tableName: 'example_table',\n namespace: namespace,\n openTableFormat: OpenTableFormat.ICEBERG,\n withoutMetadata: true,\n});\n\n// Build a table with an Iceberg Schema\nconst sampleTableWithSchema = new Table(scope, 'ExampleSchemaTable', {\n tableName: 'example_table_with_schema',\n namespace: namespace,\n openTableFormat: OpenTableFormat.ICEBERG,\n icebergMetadata: {\n icebergSchema: {\n schemaFieldList: [\n {\n name: 'id',\n type: 'int',\n required: true,\n },\n {\n name: 'name',\n type: 'string',\n },\n ],\n },\n },\n compaction: {\n status: Status.ENABLED,\n targetFileSizeMb: 128,\n },\n snapshotManagement: {\n status: Status.ENABLED,\n maxSnapshotAgeHours: 48,\n minSnapshotsToKeep: 5,\n },\n});\n```\n\nLearn more about table buckets maintenance operations and default behavior from the [S3 Tables User Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-table-buckets-maintenance.html)\n\n### Controlling Table Bucket Permissions\n\n```ts\n// Grant the principal read permissions to the bucket and all tables within\nconst accountId = '123456789012'\ntableBucket.grantRead(new iam.AccountPrincipal(accountId), '*');\n\n// Grant the role write permissions to the bucket and all tables within\nconst role = new iam.Role(stack, 'MyRole', { assumedBy: new iam.ServicePrincipal('sample') });\ntableBucket.grantWrite(role, '*');\n\n// Grant the user read and write permissions to the bucket and all tables within\ntableBucket.grantReadWrite(new iam.User(stack, 'MyUser'), '*');\n\n// Grant permissions to the bucket and a particular table within it\nconst tableId = '6ba046b2-26de-44cf-9144-0c7862593a7b'\ntableBucket.grantReadWrite(new iam.AccountPrincipal(accountId), tableId);\n\n// Add custom resource policy statements\nconst permissions = new iam.PolicyStatement({\n effect: iam.Effect.ALLOW,\n actions: ['s3tables:*'],\n principals: [ new iam.ServicePrincipal('example.aws.internal') ],\n resources: ['*']\n});\n\ntableBucket.addToResourcePolicy(permissions);\n```\n\n### Controlling Table Bucket Encryption Settings\n\nS3 TableBuckets have SSE (server-side encryption with AES-256) enabled by default with S3 managed keys.\nYou can also bring your own KMS key for KMS-SSE or have S3 create a KMS key for you.\n\nIf a bucket is encrypted with KMS, grant functions on the bucket will also grant access\nto the TableBucket's associated KMS key.\n\n```ts\n// Provide a user defined KMS Key:\nconst key = new kms.Key(scope, 'UserKey', {});\nconst encryptedBucket = new TableBucket(scope, 'EncryptedTableBucket', {\n tableBucketName: 'table-bucket-1',\n encryption: TableBucketEncryption.KMS,\n encryptionKey: key,\n});\n// This account principal will also receive kms:Decrypt access to the KMS key\nencryptedBucket.grantRead(new iam.AccountPrincipal('123456789012'), '*');\n\n// Use S3 managed server side encryption (default)\nconst encryptedBucketDefault = new TableBucket(scope, 'EncryptedTableBucketDefault', {\n tableBucketName: 'table-bucket-3',\n encryption: TableBucketEncryption.S3_MANAGED, // Uses AES-256 encryption by default\n});\n```\n\nWhen using KMS encryption (`TableBucketEncryption.KMS`), if no encryption key is provided, CDK will automatically create a new KMS key for the table bucket with necessary permissions.\n\n```ts\n// If no key is provided, one will be created automatically\nconst encryptedBucketAuto = new TableBucket(scope, 'EncryptedTableBucketAuto', {\n tableBucketName: 'table-bucket-2',\n encryption: TableBucketEncryption.KMS,\n});\n```\n\n## Coming Soon\n\nL2 Construct support for:\n\n- Table Policy\n- KMS encryption support for Tables\n"
|
|
4057
4057
|
},
|
|
4058
4058
|
"repository": {
|
|
4059
4059
|
"directory": "packages/@aws-cdk/aws-s3tables-alpha",
|
|
@@ -4087,6 +4087,217 @@
|
|
|
4087
4087
|
}
|
|
4088
4088
|
},
|
|
4089
4089
|
"types": {
|
|
4090
|
+
"@aws-cdk/aws-s3tables-alpha.CompactionProperty": {
|
|
4091
|
+
"assembly": "@aws-cdk/aws-s3tables-alpha",
|
|
4092
|
+
"datatype": true,
|
|
4093
|
+
"docs": {
|
|
4094
|
+
"default": "- No compaction settings",
|
|
4095
|
+
"stability": "experimental",
|
|
4096
|
+
"summary": "Settings governing the Compaction maintenance action.",
|
|
4097
|
+
"example": "// Build a table\nconst sampleTable = new Table(scope, 'ExampleTable', {\n tableName: 'example_table',\n namespace: namespace,\n openTableFormat: OpenTableFormat.ICEBERG,\n withoutMetadata: true,\n});\n\n// Build a table with an Iceberg Schema\nconst sampleTableWithSchema = new Table(scope, 'ExampleSchemaTable', {\n tableName: 'example_table_with_schema',\n namespace: namespace,\n openTableFormat: OpenTableFormat.ICEBERG,\n icebergMetadata: {\n icebergSchema: {\n schemaFieldList: [\n {\n name: 'id',\n type: 'int',\n required: true,\n },\n {\n name: 'name',\n type: 'string',\n },\n ],\n },\n },\n compaction: {\n status: Status.ENABLED,\n targetFileSizeMb: 128,\n },\n snapshotManagement: {\n status: Status.ENABLED,\n maxSnapshotAgeHours: 48,\n minSnapshotsToKeep: 5,\n },\n});",
|
|
4098
|
+
"custom": {
|
|
4099
|
+
"exampleMetadata": "infused"
|
|
4100
|
+
}
|
|
4101
|
+
},
|
|
4102
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.CompactionProperty",
|
|
4103
|
+
"kind": "interface",
|
|
4104
|
+
"locationInModule": {
|
|
4105
|
+
"filename": "lib/table.ts",
|
|
4106
|
+
"line": 115
|
|
4107
|
+
},
|
|
4108
|
+
"name": "CompactionProperty",
|
|
4109
|
+
"properties": [
|
|
4110
|
+
{
|
|
4111
|
+
"abstract": true,
|
|
4112
|
+
"docs": {
|
|
4113
|
+
"stability": "experimental",
|
|
4114
|
+
"summary": "Status of the compaction maintenance action."
|
|
4115
|
+
},
|
|
4116
|
+
"immutable": true,
|
|
4117
|
+
"locationInModule": {
|
|
4118
|
+
"filename": "lib/table.ts",
|
|
4119
|
+
"line": 119
|
|
4120
|
+
},
|
|
4121
|
+
"name": "status",
|
|
4122
|
+
"type": {
|
|
4123
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.Status"
|
|
4124
|
+
}
|
|
4125
|
+
},
|
|
4126
|
+
{
|
|
4127
|
+
"abstract": true,
|
|
4128
|
+
"docs": {
|
|
4129
|
+
"stability": "experimental",
|
|
4130
|
+
"summary": "Target file size in megabytes for compaction."
|
|
4131
|
+
},
|
|
4132
|
+
"immutable": true,
|
|
4133
|
+
"locationInModule": {
|
|
4134
|
+
"filename": "lib/table.ts",
|
|
4135
|
+
"line": 123
|
|
4136
|
+
},
|
|
4137
|
+
"name": "targetFileSizeMb",
|
|
4138
|
+
"type": {
|
|
4139
|
+
"primitive": "number"
|
|
4140
|
+
}
|
|
4141
|
+
}
|
|
4142
|
+
],
|
|
4143
|
+
"symbolId": "lib/table:CompactionProperty"
|
|
4144
|
+
},
|
|
4145
|
+
"@aws-cdk/aws-s3tables-alpha.INamespace": {
|
|
4146
|
+
"assembly": "@aws-cdk/aws-s3tables-alpha",
|
|
4147
|
+
"docs": {
|
|
4148
|
+
"stability": "experimental",
|
|
4149
|
+
"summary": "Represents an S3 Tables Namespace."
|
|
4150
|
+
},
|
|
4151
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.INamespace",
|
|
4152
|
+
"interfaces": [
|
|
4153
|
+
"aws-cdk-lib.IResource"
|
|
4154
|
+
],
|
|
4155
|
+
"kind": "interface",
|
|
4156
|
+
"locationInModule": {
|
|
4157
|
+
"filename": "lib/namespace.ts",
|
|
4158
|
+
"line": 12
|
|
4159
|
+
},
|
|
4160
|
+
"name": "INamespace",
|
|
4161
|
+
"properties": [
|
|
4162
|
+
{
|
|
4163
|
+
"abstract": true,
|
|
4164
|
+
"docs": {
|
|
4165
|
+
"custom": {
|
|
4166
|
+
"attribute": "true"
|
|
4167
|
+
},
|
|
4168
|
+
"stability": "experimental",
|
|
4169
|
+
"summary": "The name of this namespace."
|
|
4170
|
+
},
|
|
4171
|
+
"immutable": true,
|
|
4172
|
+
"locationInModule": {
|
|
4173
|
+
"filename": "lib/namespace.ts",
|
|
4174
|
+
"line": 17
|
|
4175
|
+
},
|
|
4176
|
+
"name": "namespaceName",
|
|
4177
|
+
"type": {
|
|
4178
|
+
"primitive": "string"
|
|
4179
|
+
}
|
|
4180
|
+
},
|
|
4181
|
+
{
|
|
4182
|
+
"abstract": true,
|
|
4183
|
+
"docs": {
|
|
4184
|
+
"custom": {
|
|
4185
|
+
"attribute": "true"
|
|
4186
|
+
},
|
|
4187
|
+
"stability": "experimental",
|
|
4188
|
+
"summary": "The table bucket which this namespace belongs to."
|
|
4189
|
+
},
|
|
4190
|
+
"immutable": true,
|
|
4191
|
+
"locationInModule": {
|
|
4192
|
+
"filename": "lib/namespace.ts",
|
|
4193
|
+
"line": 23
|
|
4194
|
+
},
|
|
4195
|
+
"name": "tableBucket",
|
|
4196
|
+
"type": {
|
|
4197
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.ITableBucket"
|
|
4198
|
+
}
|
|
4199
|
+
}
|
|
4200
|
+
],
|
|
4201
|
+
"symbolId": "lib/namespace:INamespace"
|
|
4202
|
+
},
|
|
4203
|
+
"@aws-cdk/aws-s3tables-alpha.ITable": {
|
|
4204
|
+
"assembly": "@aws-cdk/aws-s3tables-alpha",
|
|
4205
|
+
"docs": {
|
|
4206
|
+
"stability": "experimental",
|
|
4207
|
+
"summary": "Represents an S3 Table."
|
|
4208
|
+
},
|
|
4209
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.ITable",
|
|
4210
|
+
"interfaces": [
|
|
4211
|
+
"aws-cdk-lib.IResource"
|
|
4212
|
+
],
|
|
4213
|
+
"kind": "interface",
|
|
4214
|
+
"locationInModule": {
|
|
4215
|
+
"filename": "lib/table.ts",
|
|
4216
|
+
"line": 18
|
|
4217
|
+
},
|
|
4218
|
+
"name": "ITable",
|
|
4219
|
+
"properties": [
|
|
4220
|
+
{
|
|
4221
|
+
"abstract": true,
|
|
4222
|
+
"docs": {
|
|
4223
|
+
"custom": {
|
|
4224
|
+
"attribute": "true"
|
|
4225
|
+
},
|
|
4226
|
+
"stability": "experimental",
|
|
4227
|
+
"summary": "The ARN of this table."
|
|
4228
|
+
},
|
|
4229
|
+
"immutable": true,
|
|
4230
|
+
"locationInModule": {
|
|
4231
|
+
"filename": "lib/table.ts",
|
|
4232
|
+
"line": 23
|
|
4233
|
+
},
|
|
4234
|
+
"name": "tableArn",
|
|
4235
|
+
"type": {
|
|
4236
|
+
"primitive": "string"
|
|
4237
|
+
}
|
|
4238
|
+
},
|
|
4239
|
+
{
|
|
4240
|
+
"abstract": true,
|
|
4241
|
+
"docs": {
|
|
4242
|
+
"custom": {
|
|
4243
|
+
"attribute": "true"
|
|
4244
|
+
},
|
|
4245
|
+
"stability": "experimental",
|
|
4246
|
+
"summary": "The name of this table."
|
|
4247
|
+
},
|
|
4248
|
+
"immutable": true,
|
|
4249
|
+
"locationInModule": {
|
|
4250
|
+
"filename": "lib/table.ts",
|
|
4251
|
+
"line": 29
|
|
4252
|
+
},
|
|
4253
|
+
"name": "tableName",
|
|
4254
|
+
"type": {
|
|
4255
|
+
"primitive": "string"
|
|
4256
|
+
}
|
|
4257
|
+
},
|
|
4258
|
+
{
|
|
4259
|
+
"abstract": true,
|
|
4260
|
+
"docs": {
|
|
4261
|
+
"custom": {
|
|
4262
|
+
"attribute": "true"
|
|
4263
|
+
},
|
|
4264
|
+
"stability": "experimental",
|
|
4265
|
+
"summary": "The accountId containing this table."
|
|
4266
|
+
},
|
|
4267
|
+
"immutable": true,
|
|
4268
|
+
"locationInModule": {
|
|
4269
|
+
"filename": "lib/table.ts",
|
|
4270
|
+
"line": 35
|
|
4271
|
+
},
|
|
4272
|
+
"name": "account",
|
|
4273
|
+
"optional": true,
|
|
4274
|
+
"type": {
|
|
4275
|
+
"primitive": "string"
|
|
4276
|
+
}
|
|
4277
|
+
},
|
|
4278
|
+
{
|
|
4279
|
+
"abstract": true,
|
|
4280
|
+
"docs": {
|
|
4281
|
+
"custom": {
|
|
4282
|
+
"attribute": "true"
|
|
4283
|
+
},
|
|
4284
|
+
"stability": "experimental",
|
|
4285
|
+
"summary": "The region containing this table."
|
|
4286
|
+
},
|
|
4287
|
+
"immutable": true,
|
|
4288
|
+
"locationInModule": {
|
|
4289
|
+
"filename": "lib/table.ts",
|
|
4290
|
+
"line": 41
|
|
4291
|
+
},
|
|
4292
|
+
"name": "region",
|
|
4293
|
+
"optional": true,
|
|
4294
|
+
"type": {
|
|
4295
|
+
"primitive": "string"
|
|
4296
|
+
}
|
|
4297
|
+
}
|
|
4298
|
+
],
|
|
4299
|
+
"symbolId": "lib/table:ITable"
|
|
4300
|
+
},
|
|
4090
4301
|
"@aws-cdk/aws-s3tables-alpha.ITableBucket": {
|
|
4091
4302
|
"assembly": "@aws-cdk/aws-s3tables-alpha",
|
|
4092
4303
|
"docs": {
|
|
@@ -4164,189 +4375,1025 @@
|
|
|
4164
4375
|
"primitive": "string"
|
|
4165
4376
|
}
|
|
4166
4377
|
}
|
|
4167
|
-
],
|
|
4168
|
-
"returns": {
|
|
4378
|
+
],
|
|
4379
|
+
"returns": {
|
|
4380
|
+
"type": {
|
|
4381
|
+
"fqn": "aws-cdk-lib.aws_iam.Grant"
|
|
4382
|
+
}
|
|
4383
|
+
}
|
|
4384
|
+
},
|
|
4385
|
+
{
|
|
4386
|
+
"abstract": true,
|
|
4387
|
+
"docs": {
|
|
4388
|
+
"remarks": "If encryption is used, permission to use the key to encrypt/decrypt the contents\nof the bucket will also be granted to the same principal.",
|
|
4389
|
+
"stability": "experimental",
|
|
4390
|
+
"summary": "Grant read and write permissions for this table bucket and its tables to an IAM principal (Role/Group/User)."
|
|
4391
|
+
},
|
|
4392
|
+
"locationInModule": {
|
|
4393
|
+
"filename": "lib/table-bucket.ts",
|
|
4394
|
+
"line": 101
|
|
4395
|
+
},
|
|
4396
|
+
"name": "grantReadWrite",
|
|
4397
|
+
"parameters": [
|
|
4398
|
+
{
|
|
4399
|
+
"docs": {
|
|
4400
|
+
"summary": "The principal to allow read and write permissions to."
|
|
4401
|
+
},
|
|
4402
|
+
"name": "identity",
|
|
4403
|
+
"type": {
|
|
4404
|
+
"fqn": "aws-cdk-lib.aws_iam.IGrantable"
|
|
4405
|
+
}
|
|
4406
|
+
},
|
|
4407
|
+
{
|
|
4408
|
+
"docs": {
|
|
4409
|
+
"summary": "Allow the permissions to all tables using '*' or to single table by its unique ID."
|
|
4410
|
+
},
|
|
4411
|
+
"name": "tableId",
|
|
4412
|
+
"type": {
|
|
4413
|
+
"primitive": "string"
|
|
4414
|
+
}
|
|
4415
|
+
}
|
|
4416
|
+
],
|
|
4417
|
+
"returns": {
|
|
4418
|
+
"type": {
|
|
4419
|
+
"fqn": "aws-cdk-lib.aws_iam.Grant"
|
|
4420
|
+
}
|
|
4421
|
+
}
|
|
4422
|
+
},
|
|
4423
|
+
{
|
|
4424
|
+
"abstract": true,
|
|
4425
|
+
"docs": {
|
|
4426
|
+
"remarks": "If encryption is used, permission to use the key to encrypt the contents\nof the bucket will also be granted to the same principal.",
|
|
4427
|
+
"stability": "experimental",
|
|
4428
|
+
"summary": "Grant write permissions for this table bucket and its tables to an IAM principal (Role/Group/User)."
|
|
4429
|
+
},
|
|
4430
|
+
"locationInModule": {
|
|
4431
|
+
"filename": "lib/table-bucket.ts",
|
|
4432
|
+
"line": 89
|
|
4433
|
+
},
|
|
4434
|
+
"name": "grantWrite",
|
|
4435
|
+
"parameters": [
|
|
4436
|
+
{
|
|
4437
|
+
"docs": {
|
|
4438
|
+
"summary": "The principal to allow write permissions to."
|
|
4439
|
+
},
|
|
4440
|
+
"name": "identity",
|
|
4441
|
+
"type": {
|
|
4442
|
+
"fqn": "aws-cdk-lib.aws_iam.IGrantable"
|
|
4443
|
+
}
|
|
4444
|
+
},
|
|
4445
|
+
{
|
|
4446
|
+
"docs": {
|
|
4447
|
+
"summary": "Allow the permissions to all tables using '*' or to single table by its unique ID."
|
|
4448
|
+
},
|
|
4449
|
+
"name": "tableId",
|
|
4450
|
+
"type": {
|
|
4451
|
+
"primitive": "string"
|
|
4452
|
+
}
|
|
4453
|
+
}
|
|
4454
|
+
],
|
|
4455
|
+
"returns": {
|
|
4456
|
+
"type": {
|
|
4457
|
+
"fqn": "aws-cdk-lib.aws_iam.Grant"
|
|
4458
|
+
}
|
|
4459
|
+
}
|
|
4460
|
+
}
|
|
4461
|
+
],
|
|
4462
|
+
"name": "ITableBucket",
|
|
4463
|
+
"properties": [
|
|
4464
|
+
{
|
|
4465
|
+
"abstract": true,
|
|
4466
|
+
"docs": {
|
|
4467
|
+
"custom": {
|
|
4468
|
+
"attribute": "true"
|
|
4469
|
+
},
|
|
4470
|
+
"stability": "experimental",
|
|
4471
|
+
"summary": "The ARN of the table bucket."
|
|
4472
|
+
},
|
|
4473
|
+
"immutable": true,
|
|
4474
|
+
"locationInModule": {
|
|
4475
|
+
"filename": "lib/table-bucket.ts",
|
|
4476
|
+
"line": 21
|
|
4477
|
+
},
|
|
4478
|
+
"name": "tableBucketArn",
|
|
4479
|
+
"type": {
|
|
4480
|
+
"primitive": "string"
|
|
4481
|
+
}
|
|
4482
|
+
},
|
|
4483
|
+
{
|
|
4484
|
+
"abstract": true,
|
|
4485
|
+
"docs": {
|
|
4486
|
+
"custom": {
|
|
4487
|
+
"attribute": "true"
|
|
4488
|
+
},
|
|
4489
|
+
"stability": "experimental",
|
|
4490
|
+
"summary": "The name of the table bucket."
|
|
4491
|
+
},
|
|
4492
|
+
"immutable": true,
|
|
4493
|
+
"locationInModule": {
|
|
4494
|
+
"filename": "lib/table-bucket.ts",
|
|
4495
|
+
"line": 27
|
|
4496
|
+
},
|
|
4497
|
+
"name": "tableBucketName",
|
|
4498
|
+
"type": {
|
|
4499
|
+
"primitive": "string"
|
|
4500
|
+
}
|
|
4501
|
+
},
|
|
4502
|
+
{
|
|
4503
|
+
"abstract": true,
|
|
4504
|
+
"docs": {
|
|
4505
|
+
"custom": {
|
|
4506
|
+
"attribute": "true"
|
|
4507
|
+
},
|
|
4508
|
+
"stability": "experimental",
|
|
4509
|
+
"summary": "The accountId containing the table bucket."
|
|
4510
|
+
},
|
|
4511
|
+
"immutable": true,
|
|
4512
|
+
"locationInModule": {
|
|
4513
|
+
"filename": "lib/table-bucket.ts",
|
|
4514
|
+
"line": 33
|
|
4515
|
+
},
|
|
4516
|
+
"name": "account",
|
|
4517
|
+
"optional": true,
|
|
4518
|
+
"type": {
|
|
4519
|
+
"primitive": "string"
|
|
4520
|
+
}
|
|
4521
|
+
},
|
|
4522
|
+
{
|
|
4523
|
+
"abstract": true,
|
|
4524
|
+
"docs": {
|
|
4525
|
+
"stability": "experimental",
|
|
4526
|
+
"summary": "Optional KMS encryption key associated with this table bucket."
|
|
4527
|
+
},
|
|
4528
|
+
"immutable": true,
|
|
4529
|
+
"locationInModule": {
|
|
4530
|
+
"filename": "lib/table-bucket.ts",
|
|
4531
|
+
"line": 44
|
|
4532
|
+
},
|
|
4533
|
+
"name": "encryptionKey",
|
|
4534
|
+
"optional": true,
|
|
4535
|
+
"type": {
|
|
4536
|
+
"fqn": "aws-cdk-lib.aws_kms.IKey"
|
|
4537
|
+
}
|
|
4538
|
+
},
|
|
4539
|
+
{
|
|
4540
|
+
"abstract": true,
|
|
4541
|
+
"docs": {
|
|
4542
|
+
"custom": {
|
|
4543
|
+
"attribute": "true"
|
|
4544
|
+
},
|
|
4545
|
+
"stability": "experimental",
|
|
4546
|
+
"summary": "The region containing the table bucket."
|
|
4547
|
+
},
|
|
4548
|
+
"immutable": true,
|
|
4549
|
+
"locationInModule": {
|
|
4550
|
+
"filename": "lib/table-bucket.ts",
|
|
4551
|
+
"line": 39
|
|
4552
|
+
},
|
|
4553
|
+
"name": "region",
|
|
4554
|
+
"optional": true,
|
|
4555
|
+
"type": {
|
|
4556
|
+
"primitive": "string"
|
|
4557
|
+
}
|
|
4558
|
+
}
|
|
4559
|
+
],
|
|
4560
|
+
"symbolId": "lib/table-bucket:ITableBucket"
|
|
4561
|
+
},
|
|
4562
|
+
"@aws-cdk/aws-s3tables-alpha.IcebergMetadataProperty": {
|
|
4563
|
+
"assembly": "@aws-cdk/aws-s3tables-alpha",
|
|
4564
|
+
"datatype": true,
|
|
4565
|
+
"docs": {
|
|
4566
|
+
"see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergmetadata.html",
|
|
4567
|
+
"stability": "experimental",
|
|
4568
|
+
"summary": "Contains details about the metadata for an Iceberg table.",
|
|
4569
|
+
"example": "// Build a table\nconst sampleTable = new Table(scope, 'ExampleTable', {\n tableName: 'example_table',\n namespace: namespace,\n openTableFormat: OpenTableFormat.ICEBERG,\n withoutMetadata: true,\n});\n\n// Build a table with an Iceberg Schema\nconst sampleTableWithSchema = new Table(scope, 'ExampleSchemaTable', {\n tableName: 'example_table_with_schema',\n namespace: namespace,\n openTableFormat: OpenTableFormat.ICEBERG,\n icebergMetadata: {\n icebergSchema: {\n schemaFieldList: [\n {\n name: 'id',\n type: 'int',\n required: true,\n },\n {\n name: 'name',\n type: 'string',\n },\n ],\n },\n },\n compaction: {\n status: Status.ENABLED,\n targetFileSizeMb: 128,\n },\n snapshotManagement: {\n status: Status.ENABLED,\n maxSnapshotAgeHours: 48,\n minSnapshotsToKeep: 5,\n },\n});",
|
|
4570
|
+
"custom": {
|
|
4571
|
+
"exampleMetadata": "infused"
|
|
4572
|
+
}
|
|
4573
|
+
},
|
|
4574
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.IcebergMetadataProperty",
|
|
4575
|
+
"kind": "interface",
|
|
4576
|
+
"locationInModule": {
|
|
4577
|
+
"filename": "lib/table.ts",
|
|
4578
|
+
"line": 144
|
|
4579
|
+
},
|
|
4580
|
+
"name": "IcebergMetadataProperty",
|
|
4581
|
+
"properties": [
|
|
4582
|
+
{
|
|
4583
|
+
"abstract": true,
|
|
4584
|
+
"docs": {
|
|
4585
|
+
"see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-table-icebergmetadata.html#cfn-s3tables-table-icebergmetadata-icebergschema",
|
|
4586
|
+
"stability": "experimental",
|
|
4587
|
+
"summary": "Contains details about the schema for an Iceberg table."
|
|
4588
|
+
},
|
|
4589
|
+
"immutable": true,
|
|
4590
|
+
"locationInModule": {
|
|
4591
|
+
"filename": "lib/table.ts",
|
|
4592
|
+
"line": 150
|
|
4593
|
+
},
|
|
4594
|
+
"name": "icebergSchema",
|
|
4595
|
+
"type": {
|
|
4596
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.IcebergSchemaProperty"
|
|
4597
|
+
}
|
|
4598
|
+
}
|
|
4599
|
+
],
|
|
4600
|
+
"symbolId": "lib/table:IcebergMetadataProperty"
|
|
4601
|
+
},
|
|
4602
|
+
"@aws-cdk/aws-s3tables-alpha.IcebergSchemaProperty": {
|
|
4603
|
+
"assembly": "@aws-cdk/aws-s3tables-alpha",
|
|
4604
|
+
"datatype": true,
|
|
4605
|
+
"docs": {
|
|
4606
|
+
"stability": "experimental",
|
|
4607
|
+
"summary": "Contains details about the schema for an Iceberg table.",
|
|
4608
|
+
"example": "// Build a table\nconst sampleTable = new Table(scope, 'ExampleTable', {\n tableName: 'example_table',\n namespace: namespace,\n openTableFormat: OpenTableFormat.ICEBERG,\n withoutMetadata: true,\n});\n\n// Build a table with an Iceberg Schema\nconst sampleTableWithSchema = new Table(scope, 'ExampleSchemaTable', {\n tableName: 'example_table_with_schema',\n namespace: namespace,\n openTableFormat: OpenTableFormat.ICEBERG,\n icebergMetadata: {\n icebergSchema: {\n schemaFieldList: [\n {\n name: 'id',\n type: 'int',\n required: true,\n },\n {\n name: 'name',\n type: 'string',\n },\n ],\n },\n },\n compaction: {\n status: Status.ENABLED,\n targetFileSizeMb: 128,\n },\n snapshotManagement: {\n status: Status.ENABLED,\n maxSnapshotAgeHours: 48,\n minSnapshotsToKeep: 5,\n },\n});",
|
|
4609
|
+
"custom": {
|
|
4610
|
+
"exampleMetadata": "infused"
|
|
4611
|
+
}
|
|
4612
|
+
},
|
|
4613
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.IcebergSchemaProperty",
|
|
4614
|
+
"kind": "interface",
|
|
4615
|
+
"locationInModule": {
|
|
4616
|
+
"filename": "lib/table.ts",
|
|
4617
|
+
"line": 156
|
|
4618
|
+
},
|
|
4619
|
+
"name": "IcebergSchemaProperty",
|
|
4620
|
+
"properties": [
|
|
4621
|
+
{
|
|
4622
|
+
"abstract": true,
|
|
4623
|
+
"docs": {
|
|
4624
|
+
"stability": "experimental",
|
|
4625
|
+
"summary": "Contains details about the schema for an Iceberg table."
|
|
4626
|
+
},
|
|
4627
|
+
"immutable": true,
|
|
4628
|
+
"locationInModule": {
|
|
4629
|
+
"filename": "lib/table.ts",
|
|
4630
|
+
"line": 160
|
|
4631
|
+
},
|
|
4632
|
+
"name": "schemaFieldList",
|
|
4633
|
+
"type": {
|
|
4634
|
+
"collection": {
|
|
4635
|
+
"elementtype": {
|
|
4636
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.SchemaFieldProperty"
|
|
4637
|
+
},
|
|
4638
|
+
"kind": "array"
|
|
4639
|
+
}
|
|
4640
|
+
}
|
|
4641
|
+
}
|
|
4642
|
+
],
|
|
4643
|
+
"symbolId": "lib/table:IcebergSchemaProperty"
|
|
4644
|
+
},
|
|
4645
|
+
"@aws-cdk/aws-s3tables-alpha.Namespace": {
|
|
4646
|
+
"assembly": "@aws-cdk/aws-s3tables-alpha",
|
|
4647
|
+
"base": "aws-cdk-lib.Resource",
|
|
4648
|
+
"docs": {
|
|
4649
|
+
"remarks": "A namespace is a logical container for tables within a table bucket.",
|
|
4650
|
+
"stability": "experimental",
|
|
4651
|
+
"summary": "An S3 Tables Namespace with helpers.",
|
|
4652
|
+
"example": "// Build a namespace\nconst sampleNamespace = new Namespace(scope, 'ExampleNamespace', {\n namespaceName: 'example-namespace-1',\n tableBucket: tableBucket,\n});",
|
|
4653
|
+
"custom": {
|
|
4654
|
+
"exampleMetadata": "infused"
|
|
4655
|
+
}
|
|
4656
|
+
},
|
|
4657
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.Namespace",
|
|
4658
|
+
"initializer": {
|
|
4659
|
+
"docs": {
|
|
4660
|
+
"stability": "experimental"
|
|
4661
|
+
},
|
|
4662
|
+
"locationInModule": {
|
|
4663
|
+
"filename": "lib/namespace.ts",
|
|
4664
|
+
"line": 155
|
|
4665
|
+
},
|
|
4666
|
+
"parameters": [
|
|
4667
|
+
{
|
|
4668
|
+
"name": "scope",
|
|
4669
|
+
"type": {
|
|
4670
|
+
"fqn": "constructs.Construct"
|
|
4671
|
+
}
|
|
4672
|
+
},
|
|
4673
|
+
{
|
|
4674
|
+
"name": "id",
|
|
4675
|
+
"type": {
|
|
4676
|
+
"primitive": "string"
|
|
4677
|
+
}
|
|
4678
|
+
},
|
|
4679
|
+
{
|
|
4680
|
+
"name": "props",
|
|
4681
|
+
"type": {
|
|
4682
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.NamespaceProps"
|
|
4683
|
+
}
|
|
4684
|
+
}
|
|
4685
|
+
]
|
|
4686
|
+
},
|
|
4687
|
+
"interfaces": [
|
|
4688
|
+
"@aws-cdk/aws-s3tables-alpha.INamespace"
|
|
4689
|
+
],
|
|
4690
|
+
"kind": "class",
|
|
4691
|
+
"locationInModule": {
|
|
4692
|
+
"filename": "lib/namespace.ts",
|
|
4693
|
+
"line": 65
|
|
4694
|
+
},
|
|
4695
|
+
"methods": [
|
|
4696
|
+
{
|
|
4697
|
+
"docs": {
|
|
4698
|
+
"stability": "experimental",
|
|
4699
|
+
"summary": "Import an existing namespace from its attributes."
|
|
4700
|
+
},
|
|
4701
|
+
"locationInModule": {
|
|
4702
|
+
"filename": "lib/namespace.ts",
|
|
4703
|
+
"line": 73
|
|
4704
|
+
},
|
|
4705
|
+
"name": "fromNamespaceAttributes",
|
|
4706
|
+
"parameters": [
|
|
4707
|
+
{
|
|
4708
|
+
"name": "scope",
|
|
4709
|
+
"type": {
|
|
4710
|
+
"fqn": "constructs.Construct"
|
|
4711
|
+
}
|
|
4712
|
+
},
|
|
4713
|
+
{
|
|
4714
|
+
"name": "id",
|
|
4715
|
+
"type": {
|
|
4716
|
+
"primitive": "string"
|
|
4717
|
+
}
|
|
4718
|
+
},
|
|
4719
|
+
{
|
|
4720
|
+
"name": "attrs",
|
|
4721
|
+
"type": {
|
|
4722
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.NamespaceAttributes"
|
|
4723
|
+
}
|
|
4724
|
+
}
|
|
4725
|
+
],
|
|
4726
|
+
"returns": {
|
|
4727
|
+
"type": {
|
|
4728
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.INamespace"
|
|
4729
|
+
}
|
|
4730
|
+
},
|
|
4731
|
+
"static": true
|
|
4732
|
+
},
|
|
4733
|
+
{
|
|
4734
|
+
"docs": {
|
|
4735
|
+
"custom": {
|
|
4736
|
+
"throws": "UnscopedValidationError if any naming errors are detected"
|
|
4737
|
+
},
|
|
4738
|
+
"stability": "experimental",
|
|
4739
|
+
"summary": "See https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-naming.html."
|
|
4740
|
+
},
|
|
4741
|
+
"locationInModule": {
|
|
4742
|
+
"filename": "lib/namespace.ts",
|
|
4743
|
+
"line": 86
|
|
4744
|
+
},
|
|
4745
|
+
"name": "validateNamespaceName",
|
|
4746
|
+
"parameters": [
|
|
4747
|
+
{
|
|
4748
|
+
"docs": {
|
|
4749
|
+
"summary": "Name of the namespace."
|
|
4750
|
+
},
|
|
4751
|
+
"name": "namespaceName",
|
|
4752
|
+
"type": {
|
|
4753
|
+
"primitive": "string"
|
|
4754
|
+
}
|
|
4755
|
+
}
|
|
4756
|
+
],
|
|
4757
|
+
"static": true
|
|
4758
|
+
}
|
|
4759
|
+
],
|
|
4760
|
+
"name": "Namespace",
|
|
4761
|
+
"properties": [
|
|
4762
|
+
{
|
|
4763
|
+
"const": true,
|
|
4764
|
+
"docs": {
|
|
4765
|
+
"stability": "experimental",
|
|
4766
|
+
"summary": "Uniquely identifies this class."
|
|
4767
|
+
},
|
|
4768
|
+
"immutable": true,
|
|
4769
|
+
"locationInModule": {
|
|
4770
|
+
"filename": "lib/namespace.ts",
|
|
4771
|
+
"line": 68
|
|
4772
|
+
},
|
|
4773
|
+
"name": "PROPERTY_INJECTION_ID",
|
|
4774
|
+
"static": true,
|
|
4775
|
+
"type": {
|
|
4776
|
+
"primitive": "string"
|
|
4777
|
+
}
|
|
4778
|
+
},
|
|
4779
|
+
{
|
|
4780
|
+
"docs": {
|
|
4781
|
+
"stability": "experimental",
|
|
4782
|
+
"summary": "The name of this namespace."
|
|
4783
|
+
},
|
|
4784
|
+
"immutable": true,
|
|
4785
|
+
"locationInModule": {
|
|
4786
|
+
"filename": "lib/namespace.ts",
|
|
4787
|
+
"line": 148
|
|
4788
|
+
},
|
|
4789
|
+
"name": "namespaceName",
|
|
4790
|
+
"overrides": "@aws-cdk/aws-s3tables-alpha.INamespace",
|
|
4791
|
+
"type": {
|
|
4792
|
+
"primitive": "string"
|
|
4793
|
+
}
|
|
4794
|
+
},
|
|
4795
|
+
{
|
|
4796
|
+
"docs": {
|
|
4797
|
+
"stability": "experimental",
|
|
4798
|
+
"summary": "The table bucket which this namespace belongs to."
|
|
4799
|
+
},
|
|
4800
|
+
"immutable": true,
|
|
4801
|
+
"locationInModule": {
|
|
4802
|
+
"filename": "lib/namespace.ts",
|
|
4803
|
+
"line": 153
|
|
4804
|
+
},
|
|
4805
|
+
"name": "tableBucket",
|
|
4806
|
+
"overrides": "@aws-cdk/aws-s3tables-alpha.INamespace",
|
|
4807
|
+
"type": {
|
|
4808
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.ITableBucket"
|
|
4809
|
+
}
|
|
4810
|
+
}
|
|
4811
|
+
],
|
|
4812
|
+
"symbolId": "lib/namespace:Namespace"
|
|
4813
|
+
},
|
|
4814
|
+
"@aws-cdk/aws-s3tables-alpha.NamespaceAttributes": {
|
|
4815
|
+
"assembly": "@aws-cdk/aws-s3tables-alpha",
|
|
4816
|
+
"datatype": true,
|
|
4817
|
+
"docs": {
|
|
4818
|
+
"stability": "experimental",
|
|
4819
|
+
"summary": "Attributes for importing an existing namespace.",
|
|
4820
|
+
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as s3tables_alpha from '@aws-cdk/aws-s3tables-alpha';\n\ndeclare const tableBucket: s3tables_alpha.TableBucket;\nconst namespaceAttributes: s3tables_alpha.NamespaceAttributes = {\n namespaceName: 'namespaceName',\n tableBucket: tableBucket,\n};",
|
|
4821
|
+
"custom": {
|
|
4822
|
+
"exampleMetadata": "fixture=_generated"
|
|
4823
|
+
}
|
|
4824
|
+
},
|
|
4825
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.NamespaceAttributes",
|
|
4826
|
+
"kind": "interface",
|
|
4827
|
+
"locationInModule": {
|
|
4828
|
+
"filename": "lib/namespace.ts",
|
|
4829
|
+
"line": 48
|
|
4830
|
+
},
|
|
4831
|
+
"name": "NamespaceAttributes",
|
|
4832
|
+
"properties": [
|
|
4833
|
+
{
|
|
4834
|
+
"abstract": true,
|
|
4835
|
+
"docs": {
|
|
4836
|
+
"stability": "experimental",
|
|
4837
|
+
"summary": "The name of the namespace."
|
|
4838
|
+
},
|
|
4839
|
+
"immutable": true,
|
|
4840
|
+
"locationInModule": {
|
|
4841
|
+
"filename": "lib/namespace.ts",
|
|
4842
|
+
"line": 52
|
|
4843
|
+
},
|
|
4844
|
+
"name": "namespaceName",
|
|
4845
|
+
"type": {
|
|
4846
|
+
"primitive": "string"
|
|
4847
|
+
}
|
|
4848
|
+
},
|
|
4849
|
+
{
|
|
4850
|
+
"abstract": true,
|
|
4851
|
+
"docs": {
|
|
4852
|
+
"stability": "experimental",
|
|
4853
|
+
"summary": "The table bucket this namespace belongs to."
|
|
4854
|
+
},
|
|
4855
|
+
"immutable": true,
|
|
4856
|
+
"locationInModule": {
|
|
4857
|
+
"filename": "lib/namespace.ts",
|
|
4858
|
+
"line": 57
|
|
4859
|
+
},
|
|
4860
|
+
"name": "tableBucket",
|
|
4861
|
+
"type": {
|
|
4862
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.ITableBucket"
|
|
4863
|
+
}
|
|
4864
|
+
}
|
|
4865
|
+
],
|
|
4866
|
+
"symbolId": "lib/namespace:NamespaceAttributes"
|
|
4867
|
+
},
|
|
4868
|
+
"@aws-cdk/aws-s3tables-alpha.NamespaceProps": {
|
|
4869
|
+
"assembly": "@aws-cdk/aws-s3tables-alpha",
|
|
4870
|
+
"datatype": true,
|
|
4871
|
+
"docs": {
|
|
4872
|
+
"stability": "experimental",
|
|
4873
|
+
"summary": "Parameters for constructing a Namespace.",
|
|
4874
|
+
"example": "// Build a namespace\nconst sampleNamespace = new Namespace(scope, 'ExampleNamespace', {\n namespaceName: 'example-namespace-1',\n tableBucket: tableBucket,\n});",
|
|
4875
|
+
"custom": {
|
|
4876
|
+
"exampleMetadata": "infused"
|
|
4877
|
+
}
|
|
4878
|
+
},
|
|
4879
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.NamespaceProps",
|
|
4880
|
+
"kind": "interface",
|
|
4881
|
+
"locationInModule": {
|
|
4882
|
+
"filename": "lib/namespace.ts",
|
|
4883
|
+
"line": 29
|
|
4884
|
+
},
|
|
4885
|
+
"name": "NamespaceProps",
|
|
4886
|
+
"properties": [
|
|
4887
|
+
{
|
|
4888
|
+
"abstract": true,
|
|
4889
|
+
"docs": {
|
|
4890
|
+
"stability": "experimental",
|
|
4891
|
+
"summary": "A name for the namespace."
|
|
4892
|
+
},
|
|
4893
|
+
"immutable": true,
|
|
4894
|
+
"locationInModule": {
|
|
4895
|
+
"filename": "lib/namespace.ts",
|
|
4896
|
+
"line": 33
|
|
4897
|
+
},
|
|
4898
|
+
"name": "namespaceName",
|
|
4899
|
+
"type": {
|
|
4900
|
+
"primitive": "string"
|
|
4901
|
+
}
|
|
4902
|
+
},
|
|
4903
|
+
{
|
|
4904
|
+
"abstract": true,
|
|
4905
|
+
"docs": {
|
|
4906
|
+
"stability": "experimental",
|
|
4907
|
+
"summary": "The table bucket this namespace belongs to."
|
|
4908
|
+
},
|
|
4909
|
+
"immutable": true,
|
|
4910
|
+
"locationInModule": {
|
|
4911
|
+
"filename": "lib/namespace.ts",
|
|
4912
|
+
"line": 37
|
|
4913
|
+
},
|
|
4914
|
+
"name": "tableBucket",
|
|
4915
|
+
"type": {
|
|
4916
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.ITableBucket"
|
|
4917
|
+
}
|
|
4918
|
+
},
|
|
4919
|
+
{
|
|
4920
|
+
"abstract": true,
|
|
4921
|
+
"docs": {
|
|
4922
|
+
"default": "RemovalPolicy.DESTROY",
|
|
4923
|
+
"stability": "experimental",
|
|
4924
|
+
"summary": "Policy to apply when the policy is removed from this stack."
|
|
4925
|
+
},
|
|
4926
|
+
"immutable": true,
|
|
4927
|
+
"locationInModule": {
|
|
4928
|
+
"filename": "lib/namespace.ts",
|
|
4929
|
+
"line": 42
|
|
4930
|
+
},
|
|
4931
|
+
"name": "removalPolicy",
|
|
4932
|
+
"optional": true,
|
|
4933
|
+
"type": {
|
|
4934
|
+
"fqn": "aws-cdk-lib.RemovalPolicy"
|
|
4935
|
+
}
|
|
4936
|
+
}
|
|
4937
|
+
],
|
|
4938
|
+
"symbolId": "lib/namespace:NamespaceProps"
|
|
4939
|
+
},
|
|
4940
|
+
"@aws-cdk/aws-s3tables-alpha.OpenTableFormat": {
|
|
4941
|
+
"assembly": "@aws-cdk/aws-s3tables-alpha",
|
|
4942
|
+
"docs": {
|
|
4943
|
+
"stability": "experimental",
|
|
4944
|
+
"summary": "Supported open table formats."
|
|
4945
|
+
},
|
|
4946
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.OpenTableFormat",
|
|
4947
|
+
"kind": "enum",
|
|
4948
|
+
"locationInModule": {
|
|
4949
|
+
"filename": "lib/table.ts",
|
|
4950
|
+
"line": 103
|
|
4951
|
+
},
|
|
4952
|
+
"members": [
|
|
4953
|
+
{
|
|
4954
|
+
"docs": {
|
|
4955
|
+
"stability": "experimental",
|
|
4956
|
+
"summary": "Apache Iceberg table format."
|
|
4957
|
+
},
|
|
4958
|
+
"name": "ICEBERG"
|
|
4959
|
+
}
|
|
4960
|
+
],
|
|
4961
|
+
"name": "OpenTableFormat",
|
|
4962
|
+
"symbolId": "lib/table:OpenTableFormat"
|
|
4963
|
+
},
|
|
4964
|
+
"@aws-cdk/aws-s3tables-alpha.SchemaFieldProperty": {
|
|
4965
|
+
"assembly": "@aws-cdk/aws-s3tables-alpha",
|
|
4966
|
+
"datatype": true,
|
|
4967
|
+
"docs": {
|
|
4968
|
+
"stability": "experimental",
|
|
4969
|
+
"summary": "Contains details about a schema field.",
|
|
4970
|
+
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as s3tables_alpha from '@aws-cdk/aws-s3tables-alpha';\nconst schemaFieldProperty: s3tables_alpha.SchemaFieldProperty = {\n name: 'name',\n type: 'type',\n\n // the properties below are optional\n required: false,\n};",
|
|
4971
|
+
"custom": {
|
|
4972
|
+
"exampleMetadata": "fixture=_generated"
|
|
4973
|
+
}
|
|
4974
|
+
},
|
|
4975
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.SchemaFieldProperty",
|
|
4976
|
+
"kind": "interface",
|
|
4977
|
+
"locationInModule": {
|
|
4978
|
+
"filename": "lib/table.ts",
|
|
4979
|
+
"line": 166
|
|
4980
|
+
},
|
|
4981
|
+
"name": "SchemaFieldProperty",
|
|
4982
|
+
"properties": [
|
|
4983
|
+
{
|
|
4984
|
+
"abstract": true,
|
|
4985
|
+
"docs": {
|
|
4986
|
+
"stability": "experimental",
|
|
4987
|
+
"summary": "The name of the field."
|
|
4988
|
+
},
|
|
4989
|
+
"immutable": true,
|
|
4990
|
+
"locationInModule": {
|
|
4991
|
+
"filename": "lib/table.ts",
|
|
4992
|
+
"line": 170
|
|
4993
|
+
},
|
|
4994
|
+
"name": "name",
|
|
4995
|
+
"type": {
|
|
4996
|
+
"primitive": "string"
|
|
4997
|
+
}
|
|
4998
|
+
},
|
|
4999
|
+
{
|
|
5000
|
+
"abstract": true,
|
|
5001
|
+
"docs": {
|
|
5002
|
+
"remarks": "S3 Tables supports all Apache Iceberg primitive types. For more information, see the [Apache Iceberg documentation](https://docs.aws.amazon.com/https://iceberg.apache.org/spec/#primitive-types).",
|
|
5003
|
+
"stability": "experimental",
|
|
5004
|
+
"summary": "The field type."
|
|
5005
|
+
},
|
|
5006
|
+
"immutable": true,
|
|
5007
|
+
"locationInModule": {
|
|
5008
|
+
"filename": "lib/table.ts",
|
|
5009
|
+
"line": 186
|
|
5010
|
+
},
|
|
5011
|
+
"name": "type",
|
|
5012
|
+
"type": {
|
|
5013
|
+
"primitive": "string"
|
|
5014
|
+
}
|
|
5015
|
+
},
|
|
5016
|
+
{
|
|
5017
|
+
"abstract": true,
|
|
5018
|
+
"docs": {
|
|
5019
|
+
"default": "false",
|
|
5020
|
+
"remarks": "By default, this is `false` and null values are allowed in the field. If this is `true`, the field does not allow null values.",
|
|
5021
|
+
"stability": "experimental",
|
|
5022
|
+
"summary": "A Boolean value that specifies whether values are required for each row in this field."
|
|
5023
|
+
},
|
|
5024
|
+
"immutable": true,
|
|
5025
|
+
"locationInModule": {
|
|
5026
|
+
"filename": "lib/table.ts",
|
|
5027
|
+
"line": 179
|
|
5028
|
+
},
|
|
5029
|
+
"name": "required",
|
|
5030
|
+
"optional": true,
|
|
5031
|
+
"type": {
|
|
5032
|
+
"primitive": "boolean"
|
|
5033
|
+
}
|
|
5034
|
+
}
|
|
5035
|
+
],
|
|
5036
|
+
"symbolId": "lib/table:SchemaFieldProperty"
|
|
5037
|
+
},
|
|
5038
|
+
"@aws-cdk/aws-s3tables-alpha.SnapshotManagementProperty": {
|
|
5039
|
+
"assembly": "@aws-cdk/aws-s3tables-alpha",
|
|
5040
|
+
"datatype": true,
|
|
5041
|
+
"docs": {
|
|
5042
|
+
"default": "- No snapshot management settings",
|
|
5043
|
+
"remarks": "A snapshot is expired when it exceeds MinSnapshotsToKeep and MaxSnapshotAgeHours.",
|
|
5044
|
+
"stability": "experimental",
|
|
5045
|
+
"summary": "Contains details about the snapshot management settings for an Iceberg table.",
|
|
5046
|
+
"example": "// Build a table\nconst sampleTable = new Table(scope, 'ExampleTable', {\n tableName: 'example_table',\n namespace: namespace,\n openTableFormat: OpenTableFormat.ICEBERG,\n withoutMetadata: true,\n});\n\n// Build a table with an Iceberg Schema\nconst sampleTableWithSchema = new Table(scope, 'ExampleSchemaTable', {\n tableName: 'example_table_with_schema',\n namespace: namespace,\n openTableFormat: OpenTableFormat.ICEBERG,\n icebergMetadata: {\n icebergSchema: {\n schemaFieldList: [\n {\n name: 'id',\n type: 'int',\n required: true,\n },\n {\n name: 'name',\n type: 'string',\n },\n ],\n },\n },\n compaction: {\n status: Status.ENABLED,\n targetFileSizeMb: 128,\n },\n snapshotManagement: {\n status: Status.ENABLED,\n maxSnapshotAgeHours: 48,\n minSnapshotsToKeep: 5,\n },\n});",
|
|
5047
|
+
"custom": {
|
|
5048
|
+
"exampleMetadata": "infused"
|
|
5049
|
+
}
|
|
5050
|
+
},
|
|
5051
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.SnapshotManagementProperty",
|
|
5052
|
+
"kind": "interface",
|
|
5053
|
+
"locationInModule": {
|
|
5054
|
+
"filename": "lib/table.ts",
|
|
5055
|
+
"line": 196
|
|
5056
|
+
},
|
|
5057
|
+
"name": "SnapshotManagementProperty",
|
|
5058
|
+
"properties": [
|
|
5059
|
+
{
|
|
5060
|
+
"abstract": true,
|
|
5061
|
+
"docs": {
|
|
5062
|
+
"default": "- No maximum age",
|
|
5063
|
+
"stability": "experimental",
|
|
5064
|
+
"summary": "The maximum age of a snapshot before it can be expired."
|
|
5065
|
+
},
|
|
5066
|
+
"immutable": true,
|
|
5067
|
+
"locationInModule": {
|
|
5068
|
+
"filename": "lib/table.ts",
|
|
5069
|
+
"line": 202
|
|
5070
|
+
},
|
|
5071
|
+
"name": "maxSnapshotAgeHours",
|
|
5072
|
+
"optional": true,
|
|
5073
|
+
"type": {
|
|
5074
|
+
"primitive": "number"
|
|
5075
|
+
}
|
|
5076
|
+
},
|
|
5077
|
+
{
|
|
5078
|
+
"abstract": true,
|
|
5079
|
+
"docs": {
|
|
5080
|
+
"default": "- No minimum number",
|
|
5081
|
+
"stability": "experimental",
|
|
5082
|
+
"summary": "The minimum number of snapshots to keep."
|
|
5083
|
+
},
|
|
5084
|
+
"immutable": true,
|
|
5085
|
+
"locationInModule": {
|
|
5086
|
+
"filename": "lib/table.ts",
|
|
5087
|
+
"line": 209
|
|
5088
|
+
},
|
|
5089
|
+
"name": "minSnapshotsToKeep",
|
|
5090
|
+
"optional": true,
|
|
5091
|
+
"type": {
|
|
5092
|
+
"primitive": "number"
|
|
5093
|
+
}
|
|
5094
|
+
},
|
|
5095
|
+
{
|
|
5096
|
+
"abstract": true,
|
|
5097
|
+
"docs": {
|
|
5098
|
+
"default": "- Not specified",
|
|
5099
|
+
"stability": "experimental",
|
|
5100
|
+
"summary": "Indicates whether the SnapshotManagement maintenance action is enabled."
|
|
5101
|
+
},
|
|
5102
|
+
"immutable": true,
|
|
5103
|
+
"locationInModule": {
|
|
5104
|
+
"filename": "lib/table.ts",
|
|
5105
|
+
"line": 216
|
|
5106
|
+
},
|
|
5107
|
+
"name": "status",
|
|
5108
|
+
"optional": true,
|
|
5109
|
+
"type": {
|
|
5110
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.Status"
|
|
5111
|
+
}
|
|
5112
|
+
}
|
|
5113
|
+
],
|
|
5114
|
+
"symbolId": "lib/table:SnapshotManagementProperty"
|
|
5115
|
+
},
|
|
5116
|
+
"@aws-cdk/aws-s3tables-alpha.Status": {
|
|
5117
|
+
"assembly": "@aws-cdk/aws-s3tables-alpha",
|
|
5118
|
+
"docs": {
|
|
5119
|
+
"stability": "experimental",
|
|
5120
|
+
"summary": "Status values for maintenance actions.",
|
|
5121
|
+
"example": "// Build a table\nconst sampleTable = new Table(scope, 'ExampleTable', {\n tableName: 'example_table',\n namespace: namespace,\n openTableFormat: OpenTableFormat.ICEBERG,\n withoutMetadata: true,\n});\n\n// Build a table with an Iceberg Schema\nconst sampleTableWithSchema = new Table(scope, 'ExampleSchemaTable', {\n tableName: 'example_table_with_schema',\n namespace: namespace,\n openTableFormat: OpenTableFormat.ICEBERG,\n icebergMetadata: {\n icebergSchema: {\n schemaFieldList: [\n {\n name: 'id',\n type: 'int',\n required: true,\n },\n {\n name: 'name',\n type: 'string',\n },\n ],\n },\n },\n compaction: {\n status: Status.ENABLED,\n targetFileSizeMb: 128,\n },\n snapshotManagement: {\n status: Status.ENABLED,\n maxSnapshotAgeHours: 48,\n minSnapshotsToKeep: 5,\n },\n});",
|
|
5122
|
+
"custom": {
|
|
5123
|
+
"exampleMetadata": "infused"
|
|
5124
|
+
}
|
|
5125
|
+
},
|
|
5126
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.Status",
|
|
5127
|
+
"kind": "enum",
|
|
5128
|
+
"locationInModule": {
|
|
5129
|
+
"filename": "lib/table.ts",
|
|
5130
|
+
"line": 129
|
|
5131
|
+
},
|
|
5132
|
+
"members": [
|
|
5133
|
+
{
|
|
5134
|
+
"docs": {
|
|
5135
|
+
"stability": "experimental",
|
|
5136
|
+
"summary": "Enable the maintenance action."
|
|
5137
|
+
},
|
|
5138
|
+
"name": "ENABLED"
|
|
5139
|
+
},
|
|
5140
|
+
{
|
|
5141
|
+
"docs": {
|
|
5142
|
+
"stability": "experimental",
|
|
5143
|
+
"summary": "Disable the maintenance action."
|
|
5144
|
+
},
|
|
5145
|
+
"name": "DISABLED"
|
|
5146
|
+
}
|
|
5147
|
+
],
|
|
5148
|
+
"name": "Status",
|
|
5149
|
+
"symbolId": "lib/table:Status"
|
|
5150
|
+
},
|
|
5151
|
+
"@aws-cdk/aws-s3tables-alpha.Table": {
|
|
5152
|
+
"assembly": "@aws-cdk/aws-s3tables-alpha",
|
|
5153
|
+
"base": "aws-cdk-lib.Resource",
|
|
5154
|
+
"docs": {
|
|
5155
|
+
"stability": "experimental",
|
|
5156
|
+
"summary": "An S3 Table with helpers.",
|
|
5157
|
+
"example": "// Build a table\nconst sampleTable = new Table(scope, 'ExampleTable', {\n tableName: 'example_table',\n namespace: namespace,\n openTableFormat: OpenTableFormat.ICEBERG,\n withoutMetadata: true,\n});\n\n// Build a table with an Iceberg Schema\nconst sampleTableWithSchema = new Table(scope, 'ExampleSchemaTable', {\n tableName: 'example_table_with_schema',\n namespace: namespace,\n openTableFormat: OpenTableFormat.ICEBERG,\n icebergMetadata: {\n icebergSchema: {\n schemaFieldList: [\n {\n name: 'id',\n type: 'int',\n required: true,\n },\n {\n name: 'name',\n type: 'string',\n },\n ],\n },\n },\n compaction: {\n status: Status.ENABLED,\n targetFileSizeMb: 128,\n },\n snapshotManagement: {\n status: Status.ENABLED,\n maxSnapshotAgeHours: 48,\n minSnapshotsToKeep: 5,\n },\n});",
|
|
5158
|
+
"custom": {
|
|
5159
|
+
"exampleMetadata": "infused"
|
|
5160
|
+
}
|
|
5161
|
+
},
|
|
5162
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.Table",
|
|
5163
|
+
"initializer": {
|
|
5164
|
+
"docs": {
|
|
5165
|
+
"stability": "experimental"
|
|
5166
|
+
},
|
|
5167
|
+
"locationInModule": {
|
|
5168
|
+
"filename": "lib/table.ts",
|
|
5169
|
+
"line": 353
|
|
5170
|
+
},
|
|
5171
|
+
"parameters": [
|
|
5172
|
+
{
|
|
5173
|
+
"name": "scope",
|
|
5174
|
+
"type": {
|
|
5175
|
+
"fqn": "constructs.Construct"
|
|
5176
|
+
}
|
|
5177
|
+
},
|
|
5178
|
+
{
|
|
5179
|
+
"name": "id",
|
|
5180
|
+
"type": {
|
|
5181
|
+
"primitive": "string"
|
|
5182
|
+
}
|
|
5183
|
+
},
|
|
5184
|
+
{
|
|
5185
|
+
"name": "props",
|
|
4169
5186
|
"type": {
|
|
4170
|
-
"fqn": "aws-cdk-
|
|
5187
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.TableProps"
|
|
4171
5188
|
}
|
|
4172
5189
|
}
|
|
4173
|
-
|
|
5190
|
+
]
|
|
5191
|
+
},
|
|
5192
|
+
"interfaces": [
|
|
5193
|
+
"@aws-cdk/aws-s3tables-alpha.ITable"
|
|
5194
|
+
],
|
|
5195
|
+
"kind": "class",
|
|
5196
|
+
"locationInModule": {
|
|
5197
|
+
"filename": "lib/table.ts",
|
|
5198
|
+
"line": 240
|
|
5199
|
+
},
|
|
5200
|
+
"methods": [
|
|
4174
5201
|
{
|
|
4175
|
-
"abstract": true,
|
|
4176
5202
|
"docs": {
|
|
4177
|
-
"remarks": "If encryption is used, permission to use the key to encrypt/decrypt the contents\nof the bucket will also be granted to the same principal.",
|
|
4178
5203
|
"stability": "experimental",
|
|
4179
|
-
"summary": "
|
|
5204
|
+
"summary": "Defines a Table construct that represents an external table."
|
|
4180
5205
|
},
|
|
4181
5206
|
"locationInModule": {
|
|
4182
|
-
"filename": "lib/table
|
|
4183
|
-
"line":
|
|
5207
|
+
"filename": "lib/table.ts",
|
|
5208
|
+
"line": 252
|
|
4184
5209
|
},
|
|
4185
|
-
"name": "
|
|
5210
|
+
"name": "fromTableAttributes",
|
|
4186
5211
|
"parameters": [
|
|
4187
5212
|
{
|
|
4188
5213
|
"docs": {
|
|
4189
|
-
"summary": "The
|
|
5214
|
+
"summary": "The parent creating construct (usually `this`)."
|
|
4190
5215
|
},
|
|
4191
|
-
"name": "
|
|
5216
|
+
"name": "scope",
|
|
4192
5217
|
"type": {
|
|
4193
|
-
"fqn": "
|
|
5218
|
+
"fqn": "constructs.Construct"
|
|
4194
5219
|
}
|
|
4195
5220
|
},
|
|
4196
5221
|
{
|
|
4197
5222
|
"docs": {
|
|
4198
|
-
"summary": "
|
|
5223
|
+
"summary": "The construct's name."
|
|
4199
5224
|
},
|
|
4200
|
-
"name": "
|
|
5225
|
+
"name": "id",
|
|
4201
5226
|
"type": {
|
|
4202
5227
|
"primitive": "string"
|
|
4203
5228
|
}
|
|
5229
|
+
},
|
|
5230
|
+
{
|
|
5231
|
+
"docs": {
|
|
5232
|
+
"summary": "A `TableAttributes` object containing the table name and ARN."
|
|
5233
|
+
},
|
|
5234
|
+
"name": "attrs",
|
|
5235
|
+
"type": {
|
|
5236
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.TableAttributes"
|
|
5237
|
+
}
|
|
4204
5238
|
}
|
|
4205
5239
|
],
|
|
4206
5240
|
"returns": {
|
|
4207
5241
|
"type": {
|
|
4208
|
-
"fqn": "aws-cdk-
|
|
5242
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.ITable"
|
|
4209
5243
|
}
|
|
4210
|
-
}
|
|
5244
|
+
},
|
|
5245
|
+
"static": true
|
|
4211
5246
|
},
|
|
4212
5247
|
{
|
|
4213
|
-
"abstract": true,
|
|
4214
5248
|
"docs": {
|
|
4215
|
-
"
|
|
5249
|
+
"custom": {
|
|
5250
|
+
"throws": "UnscopedValidationError if any naming errors are detected"
|
|
5251
|
+
},
|
|
4216
5252
|
"stability": "experimental",
|
|
4217
|
-
"summary": "
|
|
5253
|
+
"summary": "See https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-naming.html."
|
|
4218
5254
|
},
|
|
4219
5255
|
"locationInModule": {
|
|
4220
|
-
"filename": "lib/table
|
|
4221
|
-
"line":
|
|
5256
|
+
"filename": "lib/table.ts",
|
|
5257
|
+
"line": 284
|
|
4222
5258
|
},
|
|
4223
|
-
"name": "
|
|
5259
|
+
"name": "validateTableName",
|
|
4224
5260
|
"parameters": [
|
|
4225
5261
|
{
|
|
4226
5262
|
"docs": {
|
|
4227
|
-
"summary": "
|
|
4228
|
-
},
|
|
4229
|
-
"name": "identity",
|
|
4230
|
-
"type": {
|
|
4231
|
-
"fqn": "aws-cdk-lib.aws_iam.IGrantable"
|
|
4232
|
-
}
|
|
4233
|
-
},
|
|
4234
|
-
{
|
|
4235
|
-
"docs": {
|
|
4236
|
-
"summary": "Allow the permissions to all tables using '*' or to single table by its unique ID."
|
|
5263
|
+
"summary": "Name of the table."
|
|
4237
5264
|
},
|
|
4238
|
-
"name": "
|
|
5265
|
+
"name": "tableName",
|
|
4239
5266
|
"type": {
|
|
4240
5267
|
"primitive": "string"
|
|
4241
5268
|
}
|
|
4242
5269
|
}
|
|
4243
5270
|
],
|
|
4244
|
-
"
|
|
4245
|
-
"type": {
|
|
4246
|
-
"fqn": "aws-cdk-lib.aws_iam.Grant"
|
|
4247
|
-
}
|
|
4248
|
-
}
|
|
5271
|
+
"static": true
|
|
4249
5272
|
}
|
|
4250
5273
|
],
|
|
4251
|
-
"name": "
|
|
5274
|
+
"name": "Table",
|
|
4252
5275
|
"properties": [
|
|
4253
5276
|
{
|
|
4254
|
-
"
|
|
5277
|
+
"const": true,
|
|
4255
5278
|
"docs": {
|
|
4256
|
-
"custom": {
|
|
4257
|
-
"attribute": "true"
|
|
4258
|
-
},
|
|
4259
5279
|
"stability": "experimental",
|
|
4260
|
-
"summary": "
|
|
5280
|
+
"summary": "Uniquely identifies this class."
|
|
4261
5281
|
},
|
|
4262
5282
|
"immutable": true,
|
|
4263
5283
|
"locationInModule": {
|
|
4264
|
-
"filename": "lib/table
|
|
4265
|
-
"line":
|
|
5284
|
+
"filename": "lib/table.ts",
|
|
5285
|
+
"line": 243
|
|
4266
5286
|
},
|
|
4267
|
-
"name": "
|
|
5287
|
+
"name": "PROPERTY_INJECTION_ID",
|
|
5288
|
+
"static": true,
|
|
4268
5289
|
"type": {
|
|
4269
5290
|
"primitive": "string"
|
|
4270
5291
|
}
|
|
4271
5292
|
},
|
|
4272
5293
|
{
|
|
4273
|
-
"abstract": true,
|
|
4274
5294
|
"docs": {
|
|
4275
|
-
"custom": {
|
|
4276
|
-
"attribute": "true"
|
|
4277
|
-
},
|
|
4278
5295
|
"stability": "experimental",
|
|
4279
|
-
"summary": "The
|
|
5296
|
+
"summary": "The namespace containing this table."
|
|
4280
5297
|
},
|
|
4281
5298
|
"immutable": true,
|
|
4282
5299
|
"locationInModule": {
|
|
4283
|
-
"filename": "lib/table
|
|
4284
|
-
"line":
|
|
5300
|
+
"filename": "lib/table.ts",
|
|
5301
|
+
"line": 351
|
|
4285
5302
|
},
|
|
4286
|
-
"name": "
|
|
5303
|
+
"name": "namespace",
|
|
4287
5304
|
"type": {
|
|
4288
|
-
"
|
|
5305
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.INamespace"
|
|
4289
5306
|
}
|
|
4290
5307
|
},
|
|
4291
5308
|
{
|
|
4292
|
-
"abstract": true,
|
|
4293
5309
|
"docs": {
|
|
4294
|
-
"custom": {
|
|
4295
|
-
"attribute": "true"
|
|
4296
|
-
},
|
|
4297
5310
|
"stability": "experimental",
|
|
4298
|
-
"summary": "The
|
|
5311
|
+
"summary": "The unique Amazon Resource Name (arn) of this table."
|
|
4299
5312
|
},
|
|
4300
5313
|
"immutable": true,
|
|
4301
5314
|
"locationInModule": {
|
|
4302
|
-
"filename": "lib/table
|
|
4303
|
-
"line":
|
|
5315
|
+
"filename": "lib/table.ts",
|
|
5316
|
+
"line": 335
|
|
4304
5317
|
},
|
|
4305
|
-
"name": "
|
|
4306
|
-
"
|
|
5318
|
+
"name": "tableArn",
|
|
5319
|
+
"overrides": "@aws-cdk/aws-s3tables-alpha.ITable",
|
|
4307
5320
|
"type": {
|
|
4308
5321
|
"primitive": "string"
|
|
4309
5322
|
}
|
|
4310
5323
|
},
|
|
5324
|
+
{
|
|
5325
|
+
"docs": {
|
|
5326
|
+
"stability": "experimental",
|
|
5327
|
+
"summary": "The name of this table."
|
|
5328
|
+
},
|
|
5329
|
+
"immutable": true,
|
|
5330
|
+
"locationInModule": {
|
|
5331
|
+
"filename": "lib/table.ts",
|
|
5332
|
+
"line": 346
|
|
5333
|
+
},
|
|
5334
|
+
"name": "tableName",
|
|
5335
|
+
"overrides": "@aws-cdk/aws-s3tables-alpha.ITable",
|
|
5336
|
+
"type": {
|
|
5337
|
+
"primitive": "string"
|
|
5338
|
+
}
|
|
5339
|
+
}
|
|
5340
|
+
],
|
|
5341
|
+
"symbolId": "lib/table:Table"
|
|
5342
|
+
},
|
|
5343
|
+
"@aws-cdk/aws-s3tables-alpha.TableAttributes": {
|
|
5344
|
+
"assembly": "@aws-cdk/aws-s3tables-alpha",
|
|
5345
|
+
"datatype": true,
|
|
5346
|
+
"docs": {
|
|
5347
|
+
"remarks": "The tableName, region, and account can be provided explicitly\nor will be inferred from the tableArn",
|
|
5348
|
+
"stability": "experimental",
|
|
5349
|
+
"summary": "A reference to a table outside this stack.",
|
|
5350
|
+
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as s3tables_alpha from '@aws-cdk/aws-s3tables-alpha';\nconst tableAttributes: s3tables_alpha.TableAttributes = {\n tableArn: 'tableArn',\n tableName: 'tableName',\n};",
|
|
5351
|
+
"custom": {
|
|
5352
|
+
"exampleMetadata": "fixture=_generated"
|
|
5353
|
+
}
|
|
5354
|
+
},
|
|
5355
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.TableAttributes",
|
|
5356
|
+
"kind": "interface",
|
|
5357
|
+
"locationInModule": {
|
|
5358
|
+
"filename": "lib/table.ts",
|
|
5359
|
+
"line": 225
|
|
5360
|
+
},
|
|
5361
|
+
"name": "TableAttributes",
|
|
5362
|
+
"properties": [
|
|
4311
5363
|
{
|
|
4312
5364
|
"abstract": true,
|
|
4313
5365
|
"docs": {
|
|
4314
5366
|
"stability": "experimental",
|
|
4315
|
-
"summary": "
|
|
5367
|
+
"summary": "The table's ARN."
|
|
4316
5368
|
},
|
|
4317
5369
|
"immutable": true,
|
|
4318
5370
|
"locationInModule": {
|
|
4319
|
-
"filename": "lib/table
|
|
4320
|
-
"line":
|
|
5371
|
+
"filename": "lib/table.ts",
|
|
5372
|
+
"line": 234
|
|
4321
5373
|
},
|
|
4322
|
-
"name": "
|
|
4323
|
-
"optional": true,
|
|
5374
|
+
"name": "tableArn",
|
|
4324
5375
|
"type": {
|
|
4325
|
-
"
|
|
5376
|
+
"primitive": "string"
|
|
4326
5377
|
}
|
|
4327
5378
|
},
|
|
4328
5379
|
{
|
|
4329
5380
|
"abstract": true,
|
|
4330
5381
|
"docs": {
|
|
4331
|
-
"custom": {
|
|
4332
|
-
"attribute": "true"
|
|
4333
|
-
},
|
|
4334
5382
|
"stability": "experimental",
|
|
4335
|
-
"summary": "
|
|
5383
|
+
"summary": "Name of this table."
|
|
4336
5384
|
},
|
|
4337
5385
|
"immutable": true,
|
|
4338
5386
|
"locationInModule": {
|
|
4339
|
-
"filename": "lib/table
|
|
4340
|
-
"line":
|
|
5387
|
+
"filename": "lib/table.ts",
|
|
5388
|
+
"line": 229
|
|
4341
5389
|
},
|
|
4342
|
-
"name": "
|
|
4343
|
-
"optional": true,
|
|
5390
|
+
"name": "tableName",
|
|
4344
5391
|
"type": {
|
|
4345
5392
|
"primitive": "string"
|
|
4346
5393
|
}
|
|
4347
5394
|
}
|
|
4348
5395
|
],
|
|
4349
|
-
"symbolId": "lib/table
|
|
5396
|
+
"symbolId": "lib/table:TableAttributes"
|
|
4350
5397
|
},
|
|
4351
5398
|
"@aws-cdk/aws-s3tables-alpha.TableBucket": {
|
|
4352
5399
|
"assembly": "@aws-cdk/aws-s3tables-alpha",
|
|
@@ -5230,6 +6277,169 @@
|
|
|
5230
6277
|
],
|
|
5231
6278
|
"symbolId": "lib/table-bucket:TableBucketProps"
|
|
5232
6279
|
},
|
|
6280
|
+
"@aws-cdk/aws-s3tables-alpha.TableProps": {
|
|
6281
|
+
"assembly": "@aws-cdk/aws-s3tables-alpha",
|
|
6282
|
+
"datatype": true,
|
|
6283
|
+
"docs": {
|
|
6284
|
+
"stability": "experimental",
|
|
6285
|
+
"summary": "Properties for creating a new S3 Table.",
|
|
6286
|
+
"example": "// Build a table\nconst sampleTable = new Table(scope, 'ExampleTable', {\n tableName: 'example_table',\n namespace: namespace,\n openTableFormat: OpenTableFormat.ICEBERG,\n withoutMetadata: true,\n});\n\n// Build a table with an Iceberg Schema\nconst sampleTableWithSchema = new Table(scope, 'ExampleSchemaTable', {\n tableName: 'example_table_with_schema',\n namespace: namespace,\n openTableFormat: OpenTableFormat.ICEBERG,\n icebergMetadata: {\n icebergSchema: {\n schemaFieldList: [\n {\n name: 'id',\n type: 'int',\n required: true,\n },\n {\n name: 'name',\n type: 'string',\n },\n ],\n },\n },\n compaction: {\n status: Status.ENABLED,\n targetFileSizeMb: 128,\n },\n snapshotManagement: {\n status: Status.ENABLED,\n maxSnapshotAgeHours: 48,\n minSnapshotsToKeep: 5,\n },\n});",
|
|
6287
|
+
"custom": {
|
|
6288
|
+
"exampleMetadata": "infused"
|
|
6289
|
+
}
|
|
6290
|
+
},
|
|
6291
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.TableProps",
|
|
6292
|
+
"kind": "interface",
|
|
6293
|
+
"locationInModule": {
|
|
6294
|
+
"filename": "lib/table.ts",
|
|
6295
|
+
"line": 55
|
|
6296
|
+
},
|
|
6297
|
+
"name": "TableProps",
|
|
6298
|
+
"properties": [
|
|
6299
|
+
{
|
|
6300
|
+
"abstract": true,
|
|
6301
|
+
"docs": {
|
|
6302
|
+
"stability": "experimental",
|
|
6303
|
+
"summary": "The namespace under which this table is created."
|
|
6304
|
+
},
|
|
6305
|
+
"immutable": true,
|
|
6306
|
+
"locationInModule": {
|
|
6307
|
+
"filename": "lib/table.ts",
|
|
6308
|
+
"line": 63
|
|
6309
|
+
},
|
|
6310
|
+
"name": "namespace",
|
|
6311
|
+
"type": {
|
|
6312
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.INamespace"
|
|
6313
|
+
}
|
|
6314
|
+
},
|
|
6315
|
+
{
|
|
6316
|
+
"abstract": true,
|
|
6317
|
+
"docs": {
|
|
6318
|
+
"remarks": "Currently, the only supported value is OpenTableFormat.ICEBERG.",
|
|
6319
|
+
"stability": "experimental",
|
|
6320
|
+
"summary": "Format of this table."
|
|
6321
|
+
},
|
|
6322
|
+
"immutable": true,
|
|
6323
|
+
"locationInModule": {
|
|
6324
|
+
"filename": "lib/table.ts",
|
|
6325
|
+
"line": 67
|
|
6326
|
+
},
|
|
6327
|
+
"name": "openTableFormat",
|
|
6328
|
+
"type": {
|
|
6329
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.OpenTableFormat"
|
|
6330
|
+
}
|
|
6331
|
+
},
|
|
6332
|
+
{
|
|
6333
|
+
"abstract": true,
|
|
6334
|
+
"docs": {
|
|
6335
|
+
"stability": "experimental",
|
|
6336
|
+
"summary": "Name of this table, unique within the namespace."
|
|
6337
|
+
},
|
|
6338
|
+
"immutable": true,
|
|
6339
|
+
"locationInModule": {
|
|
6340
|
+
"filename": "lib/table.ts",
|
|
6341
|
+
"line": 59
|
|
6342
|
+
},
|
|
6343
|
+
"name": "tableName",
|
|
6344
|
+
"type": {
|
|
6345
|
+
"primitive": "string"
|
|
6346
|
+
}
|
|
6347
|
+
},
|
|
6348
|
+
{
|
|
6349
|
+
"abstract": true,
|
|
6350
|
+
"docs": {
|
|
6351
|
+
"default": "Amazon S3 selects the best compaction strategy based on your table sort order.",
|
|
6352
|
+
"see": "https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-maintenance.html",
|
|
6353
|
+
"stability": "experimental",
|
|
6354
|
+
"summary": "Settings governing the Compaction maintenance action."
|
|
6355
|
+
},
|
|
6356
|
+
"immutable": true,
|
|
6357
|
+
"locationInModule": {
|
|
6358
|
+
"filename": "lib/table.ts",
|
|
6359
|
+
"line": 73
|
|
6360
|
+
},
|
|
6361
|
+
"name": "compaction",
|
|
6362
|
+
"optional": true,
|
|
6363
|
+
"type": {
|
|
6364
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.CompactionProperty"
|
|
6365
|
+
}
|
|
6366
|
+
},
|
|
6367
|
+
{
|
|
6368
|
+
"abstract": true,
|
|
6369
|
+
"docs": {
|
|
6370
|
+
"default": "table is created without any metadata",
|
|
6371
|
+
"stability": "experimental",
|
|
6372
|
+
"summary": "Contains details about the metadata for an Iceberg table."
|
|
6373
|
+
},
|
|
6374
|
+
"immutable": true,
|
|
6375
|
+
"locationInModule": {
|
|
6376
|
+
"filename": "lib/table.ts",
|
|
6377
|
+
"line": 78
|
|
6378
|
+
},
|
|
6379
|
+
"name": "icebergMetadata",
|
|
6380
|
+
"optional": true,
|
|
6381
|
+
"type": {
|
|
6382
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.IcebergMetadataProperty"
|
|
6383
|
+
}
|
|
6384
|
+
},
|
|
6385
|
+
{
|
|
6386
|
+
"abstract": true,
|
|
6387
|
+
"docs": {
|
|
6388
|
+
"default": "RETAIN",
|
|
6389
|
+
"stability": "experimental",
|
|
6390
|
+
"summary": "Controls what happens to this table it it stoped being managed by cloudformation."
|
|
6391
|
+
},
|
|
6392
|
+
"immutable": true,
|
|
6393
|
+
"locationInModule": {
|
|
6394
|
+
"filename": "lib/table.ts",
|
|
6395
|
+
"line": 89
|
|
6396
|
+
},
|
|
6397
|
+
"name": "removalPolicy",
|
|
6398
|
+
"optional": true,
|
|
6399
|
+
"type": {
|
|
6400
|
+
"fqn": "aws-cdk-lib.RemovalPolicy"
|
|
6401
|
+
}
|
|
6402
|
+
},
|
|
6403
|
+
{
|
|
6404
|
+
"abstract": true,
|
|
6405
|
+
"docs": {
|
|
6406
|
+
"default": "enabled: MinimumSnapshots is 1 by default and MaximumSnapshotAge is 120 hours by default.",
|
|
6407
|
+
"stability": "experimental",
|
|
6408
|
+
"summary": "Contains details about the snapshot management settings for an Iceberg table."
|
|
6409
|
+
},
|
|
6410
|
+
"immutable": true,
|
|
6411
|
+
"locationInModule": {
|
|
6412
|
+
"filename": "lib/table.ts",
|
|
6413
|
+
"line": 83
|
|
6414
|
+
},
|
|
6415
|
+
"name": "snapshotManagement",
|
|
6416
|
+
"optional": true,
|
|
6417
|
+
"type": {
|
|
6418
|
+
"fqn": "@aws-cdk/aws-s3tables-alpha.SnapshotManagementProperty"
|
|
6419
|
+
}
|
|
6420
|
+
},
|
|
6421
|
+
{
|
|
6422
|
+
"abstract": true,
|
|
6423
|
+
"docs": {
|
|
6424
|
+
"default": "false",
|
|
6425
|
+
"remarks": "This property is mutually exclusive to 'IcebergMetadata'.",
|
|
6426
|
+
"stability": "experimental",
|
|
6427
|
+
"summary": "If true, indicates that you don't want to specify a schema for the table."
|
|
6428
|
+
},
|
|
6429
|
+
"immutable": true,
|
|
6430
|
+
"locationInModule": {
|
|
6431
|
+
"filename": "lib/table.ts",
|
|
6432
|
+
"line": 97
|
|
6433
|
+
},
|
|
6434
|
+
"name": "withoutMetadata",
|
|
6435
|
+
"optional": true,
|
|
6436
|
+
"type": {
|
|
6437
|
+
"primitive": "boolean"
|
|
6438
|
+
}
|
|
6439
|
+
}
|
|
6440
|
+
],
|
|
6441
|
+
"symbolId": "lib/table:TableProps"
|
|
6442
|
+
},
|
|
5233
6443
|
"@aws-cdk/aws-s3tables-alpha.UnreferencedFileRemoval": {
|
|
5234
6444
|
"assembly": "@aws-cdk/aws-s3tables-alpha",
|
|
5235
6445
|
"datatype": true,
|
|
@@ -5348,6 +6558,6 @@
|
|
|
5348
6558
|
"symbolId": "lib/table-bucket:UnreferencedFileRemovalStatus"
|
|
5349
6559
|
}
|
|
5350
6560
|
},
|
|
5351
|
-
"version": "2.
|
|
6561
|
+
"version": "2.209.0-alpha.0",
|
|
5352
6562
|
"fingerprint": "**********"
|
|
5353
6563
|
}
|