@aws-cdk/aws-glue-alpha 2.9.0-alpha.0 → 2.13.0-alpha.0

package/lib/table.d.ts

@@ -7,171 +7,123 @@ import { DataFormat } from './data-format';
 import { IDatabase } from './database';
 import { Column } from './schema';
 /**
- * (experimental) Properties of a Partition Index.
- *
- * @experimental
+ * Properties of a Partition Index.
  */
 export interface PartitionIndex {
     /**
-     * (experimental) The name of the partition index.
+     * The name of the partition index.
      *
      * @default - a name will be generated for you.
-     * @experimental
      */
     readonly indexName?: string;
     /**
-     * (experimental) The partition key names that comprise the partition index.
-     *
-     * The names must correspond to a name in the
+     * The partition key names that comprise the partition
+     * index. The names must correspond to a name in the
      * table's partition keys.
-     *
-     * @experimental
      */
     readonly keyNames: string[];
 }
-/**
- * @experimental
- */
 export interface ITable extends IResource {
     /**
-     * @experimental
-     * @attribute true
+     * @attribute
      */
     readonly tableArn: string;
     /**
-     * @experimental
-     * @attribute true
+     * @attribute
      */
     readonly tableName: string;
 }
 /**
- * (experimental) Encryption options for a Table.
+ * Encryption options for a Table.
  *
  * @see https://docs.aws.amazon.com/athena/latest/ug/encryption.html
- * @experimental
  */
 export declare enum TableEncryption {
-    /**
-     * @experimental
-     */
     UNENCRYPTED = "Unencrypted",
     /**
-     * (experimental) Server side encryption (SSE) with an Amazon S3-managed key.
+     * Server side encryption (SSE) with an Amazon S3-managed key.
      *
      * @see https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html
-     * @experimental
      */
     S3_MANAGED = "SSE-S3",
     /**
-     * (experimental) Server-side encryption (SSE) with an AWS KMS key managed by the account owner.
+     * Server-side encryption (SSE) with an AWS KMS key managed by the account owner.
      *
      * @see https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html
-     * @experimental
      */
     KMS = "SSE-KMS",
     /**
-     * (experimental) Server-side encryption (SSE) with an AWS KMS key managed by the KMS service.
-     *
-     * @experimental
+     * Server-side encryption (SSE) with an AWS KMS key managed by the KMS service.
      */
     KMS_MANAGED = "SSE-KMS-MANAGED",
     /**
-     * (experimental) Client-side encryption (CSE) with an AWS KMS key managed by the account owner.
+     * Client-side encryption (CSE) with an AWS KMS key managed by the account owner.
      *
      * @see https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html
-     * @experimental
      */
     CLIENT_SIDE_KMS = "CSE-KMS"
 }
-/**
- * @experimental
- */
 export interface TableAttributes {
-    /**
-     * @experimental
-     */
     readonly tableArn: string;
-    /**
-     * @experimental
-     */
     readonly tableName: string;
 }
-/**
- * @experimental
- */
 export interface TableProps {
     /**
-     * (experimental) Name of the table.
-     *
-     * @experimental
+     * Name of the table.
      */
     readonly tableName: string;
     /**
-     * (experimental) Description of the table.
+     * Description of the table.
      *
      * @default generated
-     * @experimental
      */
     readonly description?: string;
     /**
-     * (experimental) Database in which to store the table.
-     *
-     * @experimental
+     * Database in which to store the table.
      */
     readonly database: IDatabase;
     /**
-     * (experimental) S3 bucket in which to store data.
+     * S3 bucket in which to store data.
      *
      * @default one is created for you
-     * @experimental
      */
     readonly bucket?: s3.IBucket;
     /**
-     * (experimental) S3 prefix under which table objects are stored.
+     * S3 prefix under which table objects are stored.
      *
      * @default - No prefix. The data will be stored under the root of the bucket.
-     * @experimental
      */
     readonly s3Prefix?: string;
     /**
-     * (experimental) Columns of the table.
-     *
-     * @experimental
+     * Columns of the table.
      */
     readonly columns: Column[];
     /**
-     * (experimental) Partition columns of the table.
+     * Partition columns of the table.
      *
      * @default table is not partitioned
-     * @experimental
      */
     readonly partitionKeys?: Column[];
     /**
-     * (experimental) Partition indexes on the table.
-     *
-     * A maximum of 3 indexes
+     * Partition indexes on the table. A maximum of 3 indexes
      * are allowed on a table. Keys in the index must be part
      * of the table's partition keys.
      *
      * @default table has no partition indexes
-     * @experimental
      */
     readonly partitionIndexes?: PartitionIndex[];
     /**
-     * (experimental) Storage type of the table's data.
-     *
-     * @experimental
+     * Storage type of the table's data.
      */
     readonly dataFormat: DataFormat;
     /**
-     * (experimental) Indicates whether the table's data is compressed or not.
+     * Indicates whether the table's data is compressed or not.
      *
      * @default false
-     * @experimental
      */
     readonly compressed?: boolean;
     /**
-     * (experimental) The kind of encryption to secure the data with.
+     * The kind of encryption to secure the data with.
      *
      * You can only provide this option if you are not explicitly passing in a bucket.
      *
@@ -179,117 +131,82 @@ export interface TableProps {
      * If you choose `CSE-KMS`, you *must* provide an un-managed KMS key with `encryptionKey`.
      *
      * @default Unencrypted
-     * @experimental
      */
     readonly encryption?: TableEncryption;
     /**
-     * (experimental) External KMS key to use for bucket encryption.
+     * External KMS key to use for bucket encryption.
      *
      * The `encryption` property must be `SSE-KMS` or `CSE-KMS`.
      *
      * @default key is managed by KMS.
-     * @experimental
      */
     readonly encryptionKey?: kms.IKey;
     /**
-     * (experimental) Indicates whether the table data is stored in subdirectories.
+     * Indicates whether the table data is stored in subdirectories.
      *
      * @default false
-     * @experimental
      */
     readonly storedAsSubDirectories?: boolean;
 }
 /**
- * (experimental) A Glue table.
- *
- * @experimental
+ * A Glue table.
  */
 export declare class Table extends Resource implements ITable {
-    /**
-     * @experimental
-     */
     static fromTableArn(scope: Construct, id: string, tableArn: string): ITable;
     /**
-     * (experimental) Creates a Table construct that represents an external table.
+     * Creates a Table construct that represents an external table.
      *
      * @param scope The scope creating construct (usually `this`).
      * @param id The construct's id.
-     * @param attrs Import attributes.
-     * @experimental
+     * @param attrs Import attributes
      */
     static fromTableAttributes(scope: Construct, id: string, attrs: TableAttributes): ITable;
     /**
-     * (experimental) Database this table belongs to.
-     *
-     * @experimental
+     * Database this table belongs to.
      */
     readonly database: IDatabase;
     /**
-     * (experimental) Indicates whether the table's data is compressed or not.
-     *
-     * @experimental
+     * Indicates whether the table's data is compressed or not.
      */
     readonly compressed: boolean;
     /**
-     * (experimental) The type of encryption enabled for the table.
-     *
-     * @experimental
+     * The type of encryption enabled for the table.
      */
     readonly encryption: TableEncryption;
     /**
-     * (experimental) The KMS key used to secure the data if `encryption` is set to `CSE-KMS` or `SSE-KMS`.
-     *
-     * Otherwise, `undefined`.
-     *
-     * @experimental
+     * The KMS key used to secure the data if `encryption` is set to `CSE-KMS` or `SSE-KMS`. Otherwise, `undefined`.
      */
     readonly encryptionKey?: kms.IKey;
     /**
-     * (experimental) S3 bucket in which the table's data resides.
-     *
-     * @experimental
+     * S3 bucket in which the table's data resides.
      */
     readonly bucket: s3.IBucket;
     /**
-     * (experimental) S3 Key Prefix under which this table's files are stored in S3.
-     *
-     * @experimental
+     * S3 Key Prefix under which this table's files are stored in S3.
      */
     readonly s3Prefix: string;
     /**
-     * (experimental) Name of this table.
-     *
-     * @experimental
+     * Name of this table.
      */
     readonly tableName: string;
     /**
-     * (experimental) ARN of this table.
-     *
-     * @experimental
+     * ARN of this table.
      */
     readonly tableArn: string;
     /**
-     * (experimental) Format of this table's data files.
-     *
-     * @experimental
+     * Format of this table's data files.
      */
     readonly dataFormat: DataFormat;
     /**
-     * (experimental) This table's columns.
-     *
-     * @experimental
+     * This table's columns.
      */
     readonly columns: Column[];
     /**
-     * (experimental) This table's partition keys if the table is partitioned.
-     *
-     * @experimental
+     * This table's partition keys if the table is partitioned.
      */
     readonly partitionKeys?: Column[];
     /**
-     * (experimental) This table's partition indexes.
-     *
-     * @experimental
+     * This table's partition indexes.
      */
     readonly partitionIndexes?: PartitionIndex[];
     /**
@@ -298,56 +215,42 @@ export declare class Table extends Resource implements ITable {
      * each time a new partition index is created.
      */
     private partitionIndexCustomResources;
-    /**
-     * @experimental
-     */
     constructor(scope: Construct, id: string, props: TableProps);
     /**
-     * (experimental) Add a partition index to the table.
-     *
-     * You can have a maximum of 3 partition
+     * Add a partition index to the table. You can have a maximum of 3 partition
      * indexes to a table. Partition index keys must be a subset of the table's
      * partition keys.
      *
      * @see https://docs.aws.amazon.com/glue/latest/dg/partition-indexes.html
-     * @experimental
      */
     addPartitionIndex(index: PartitionIndex): void;
     private generateIndexName;
     private validatePartitionIndex;
     /**
-     * (experimental) Grant read permissions to the table and the underlying data stored in S3 to an IAM principal.
+     * Grant read permissions to the table and the underlying data stored in S3 to an IAM principal.
      *
-     * @param grantee the principal.
-     * @experimental
+     * @param grantee the principal
      */
     grantRead(grantee: iam.IGrantable): iam.Grant;
     /**
-     * (experimental) Grant write permissions to the table and the underlying data stored in S3 to an IAM principal.
+     * Grant write permissions to the table and the underlying data stored in S3 to an IAM principal.
      *
-     * @param grantee the principal.
-     * @experimental
+     * @param grantee the principal
      */
     grantWrite(grantee: iam.IGrantable): iam.Grant;
     /**
-     * (experimental) Grant read and write permissions to the table and the underlying data stored in S3 to an IAM principal.
+     * Grant read and write permissions to the table and the underlying data stored in S3 to an IAM principal.
      *
-     * @param grantee the principal.
-     * @experimental
+     * @param grantee the principal
      */
     grantReadWrite(grantee: iam.IGrantable): iam.Grant;
     /**
-     * (experimental) Grant the given identity custom permissions.
-     *
-     * @experimental
+     * Grant the given identity custom permissions.
      */
     grant(grantee: iam.IGrantable, actions: string[]): iam.Grant;
     /**
-     * (experimental) Grant the given identity custom permissions to ALL underlying resources of the table.
-     *
+     * Grant the given identity custom permissions to ALL underlying resources of the table.
      * Permissions will be granted to the catalog, the database, and the table.
-     *
-     * @experimental
      */
     grantToUnderlyingResources(grantee: iam.IGrantable, actions: string[]): iam.Grant;
     private getS3PrefixForGrant;