@aws-cdk/aws-glue-alpha 2.117.0-alpha.0 → 2.118.0-alpha.0

package/.jsii

@@ -8,7 +8,7 @@
     "url": "https://aws.amazon.com"
   },
   "dependencies": {
-    "aws-cdk-lib": "^2.117.0",
+    "aws-cdk-lib": "^2.118.0",
     "constructs": "^10.0.0"
   },
   "dependencyClosure": {
@@ -3658,7 +3658,7 @@
   },
   "name": "@aws-cdk/aws-glue-alpha",
   "readme": {
-    "markdown": "# AWS Glue Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)\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\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n\n## Job\n\nA `Job` encapsulates a script that connects to data sources, processes them, and then writes output to a data target.\n\nThere are 3 types of jobs supported by AWS Glue: Spark ETL, Spark Streaming, and Python Shell jobs.\n\nThe `glue.JobExecutable` allows you to specify the type of job, the language to use and the code assets required by the job.\n\n`glue.Code` allows you to refer to the different code assets required by the job, either from an existing S3 location or from a local file path.\n\n`glue.ExecutionClass` allows you to specify `FLEX` or `STANDARD`. `FLEX` is appropriate for non-urgent jobs such as pre-production jobs, testing, and one-time data loads.\n\n### Spark Jobs\n\nThese jobs run in an Apache Spark environment managed by AWS Glue.\n\n#### ETL Jobs\n\nAn ETL job processes data in batches using Apache Spark.\n\n```ts\ndeclare const bucket: s3.Bucket;\nnew glue.Job(this, 'ScalaSparkEtlJob', {\n  executable: glue.JobExecutable.scalaEtl({\n    glueVersion: glue.GlueVersion.V4_0,\n    script: glue.Code.fromBucket(bucket, 'src/com/example/HelloWorld.scala'),\n    className: 'com.example.HelloWorld',\n    extraJars: [glue.Code.fromBucket(bucket, 'jars/HelloWorld.jar')],\n  }),\n  workerType: glue.WorkerType.G_8X,\n  description: 'an example Scala ETL job',\n});\n```\n\n#### Streaming Jobs\n\nA Streaming job is similar to an ETL job, except that it performs ETL on data streams. It uses the Apache Spark Structured Streaming framework. Some Spark job features are not available to streaming ETL jobs.\n\n```ts\nnew glue.Job(this, 'PythonSparkStreamingJob', {\n  executable: glue.JobExecutable.pythonStreaming({\n    glueVersion: glue.GlueVersion.V4_0,\n    pythonVersion: glue.PythonVersion.THREE,\n    script: glue.Code.fromAsset(path.join(__dirname, 'job-script/hello_world.py')),\n  }),\n  description: 'an example Python Streaming job',\n});\n```\n\n### Python Shell Jobs\n\nA Python shell job runs Python scripts as a shell and supports a Python version that depends on the AWS Glue version you are using.\nThis can be used to schedule and run tasks that don't require an Apache Spark environment. Currently, three flavors are supported:\n\n* PythonVersion.TWO (2.7; EOL)\n* PythonVersion.THREE (3.6)\n* PythonVersion.THREE_NINE (3.9)\n\n```ts\ndeclare const bucket: s3.Bucket;\nnew glue.Job(this, 'PythonShellJob', {\n  executable: glue.JobExecutable.pythonShell({\n    glueVersion: glue.GlueVersion.V1_0,\n    pythonVersion: glue.PythonVersion.THREE,\n    script: glue.Code.fromBucket(bucket, 'script.py'),\n  }),\n  description: 'an example Python Shell job',\n});\n```\n\n### Ray Jobs\n\nThese jobs run in a Ray environment managed by AWS Glue.\n\n```ts\nnew glue.Job(this, 'RayJob', {\n  executable: glue.JobExecutable.pythonRay({\n    glueVersion: glue.GlueVersion.V4_0,\n    pythonVersion: glue.PythonVersion.THREE_NINE,\n    runtime: glue.Runtime.RAY_TWO_FOUR,\n    script: glue.Code.fromAsset(path.join(__dirname, 'job-script/hello_world.py')),\n  }),\n  workerType: glue.WorkerType.Z_2X,\n  workerCount: 2,\n  description: 'an example Ray job'\n});\n```\n\n### Enable Spark UI\n\nEnable Spark UI setting the `sparkUI` property.\n\n```ts\nnew glue.Job(this, 'EnableSparkUI', {\n  jobName: 'EtlJobWithSparkUIPrefix',\n  sparkUI: {\n    enabled: true,\n  },\n  executable: glue.JobExecutable.pythonEtl({\n    glueVersion: glue.GlueVersion.V3_0,\n    pythonVersion: glue.PythonVersion.THREE,\n    script: glue.Code.fromAsset(path.join(__dirname, 'job-script/hello_world.py')),\n  }),\n});\n```\n\nThe `sparkUI` property also allows the specification of an s3 bucket and a bucket prefix.\n\nSee [documentation](https://docs.aws.amazon.com/glue/latest/dg/add-job.html) for more information on adding jobs in Glue.\n\n## Connection\n\nA `Connection` allows Glue jobs, crawlers and development endpoints to access certain types of data stores. For example, to create a network connection to connect to a data source within a VPC:\n\n```ts\ndeclare const securityGroup: ec2.SecurityGroup;\ndeclare const subnet: ec2.Subnet;\nnew glue.Connection(this, 'MyConnection', {\n  type: glue.ConnectionType.NETWORK,\n  // The security groups granting AWS Glue inbound access to the data source within the VPC\n  securityGroups: [securityGroup],\n  // The VPC subnet which contains the data source\n  subnet,\n});\n```\n\nFor RDS `Connection` by JDBC, it is recommended to manage credentials using AWS Secrets Manager. To use Secret, specify `SECRET_ID` in `properties` like the following code. Note that in this case, the subnet must have a route to the AWS Secrets Manager VPC endpoint or to the AWS Secrets Manager endpoint through a NAT gateway.\n\n```ts\ndeclare const securityGroup: ec2.SecurityGroup;\ndeclare const subnet: ec2.Subnet;\ndeclare const db: rds.DatabaseCluster;\nnew glue.Connection(this, \"RdsConnection\", {\n  type: glue.ConnectionType.JDBC,\n  securityGroups: [securityGroup],\n  subnet,\n  properties: {\n    JDBC_CONNECTION_URL: `jdbc:mysql://${db.clusterEndpoint.socketAddress}/databasename`,\n    JDBC_ENFORCE_SSL: \"false\",\n    SECRET_ID: db.secret!.secretName,\n  },\n});\n```\n\nIf you need to use a connection type that doesn't exist as a static member on `ConnectionType`, you can instantiate a `ConnectionType` object, e.g: `new glue.ConnectionType('NEW_TYPE')`.\n\nSee [Adding a Connection to Your Data Store](https://docs.aws.amazon.com/glue/latest/dg/populate-add-connection.html) and [Connection Structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-connections.html#aws-glue-api-catalog-connections-Connection) documentation for more information on the supported data stores and their configurations.\n\n## SecurityConfiguration\n\nA `SecurityConfiguration` is a set of security properties that can be used by AWS Glue to encrypt data at rest.\n\n```ts\nnew glue.SecurityConfiguration(this, 'MySecurityConfiguration', {\n  cloudWatchEncryption: {\n    mode: glue.CloudWatchEncryptionMode.KMS,\n  },\n  jobBookmarksEncryption: {\n    mode: glue.JobBookmarksEncryptionMode.CLIENT_SIDE_KMS,\n  },\n  s3Encryption: {\n    mode: glue.S3EncryptionMode.KMS,\n  },\n});\n```\n\nBy default, a shared KMS key is created for use with the encryption configurations that require one. You can also supply your own key for each encryption config, for example, for CloudWatch encryption:\n\n```ts\ndeclare const key: kms.Key;\nnew glue.SecurityConfiguration(this, 'MySecurityConfiguration', {\n  cloudWatchEncryption: {\n    mode: glue.CloudWatchEncryptionMode.KMS,\n    kmsKey: key,\n  },\n});\n```\n\nSee [documentation](https://docs.aws.amazon.com/glue/latest/dg/encryption-security-configuration.html) for more info for Glue encrypting data written by Crawlers, Jobs, and Development Endpoints.\n\n## Database\n\nA `Database` is a logical grouping of `Tables` in the Glue Catalog.\n\n```ts\nnew glue.Database(this, 'MyDatabase');\n```\n\n## Table\n\nA Glue table describes a table of data in S3: its structure (column names and types), location of data (S3 objects with a common prefix in a S3 bucket), and format for the files (Json, Avro, Parquet, etc.):\n\n```ts\ndeclare const myDatabase: glue.Database;\nnew glue.S3Table(this, 'MyTable', {\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }, {\n    name: 'col2',\n    type: glue.Schema.array(glue.Schema.STRING),\n    comment: 'col2 is an array of strings' // comment is optional\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\nBy default, a S3 bucket will be created to store the table's data but you can manually pass the `bucket` and `s3Prefix`:\n\n```ts\ndeclare const myBucket: s3.Bucket;\ndeclare const myDatabase: glue.Database;\nnew glue.S3Table(this, 'MyTable', {\n  bucket: myBucket,\n  s3Prefix: 'my-table/',\n  // ...\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\nGlue tables can be configured to contain user-defined properties, to describe the physical storage of table data, through the `storageParameters` property:\n\n```ts\ndeclare const myDatabase: glue.Database;\nnew glue.S3Table(this, 'MyTable', {\n  storageParameters: [\n    glue.StorageParameter.skipHeaderLineCount(1),\n    glue.StorageParameter.compressionType(glue.CompressionType.GZIP),\n    glue.StorageParameter.custom('separatorChar', ',')\n  ],\n  // ...\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\n### Partition Keys\n\nTo improve query performance, a table can specify `partitionKeys` on which data is stored and queried separately. For example, you might partition a table by `year` and `month` to optimize queries based on a time window:\n\n```ts\ndeclare const myDatabase: glue.Database;\nnew glue.S3Table(this, 'MyTable', {\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  partitionKeys: [{\n    name: 'year',\n    type: glue.Schema.SMALL_INT,\n  }, {\n    name: 'month',\n    type: glue.Schema.SMALL_INT,\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\n### Partition Indexes\n\nAnother way to improve query performance is to specify partition indexes. If no partition indexes are\npresent on the table, AWS Glue loads all partitions of the table and filters the loaded partitions using\nthe query expression. The query takes more time to run as the number of partitions increase. With an\nindex, the query will try to fetch a subset of the partitions instead of loading all partitions of the\ntable.\n\nThe keys of a partition index must be a subset of the partition keys of the table. You can have a\nmaximum of 3 partition indexes per table. To specify a partition index, you can use the `partitionIndexes`\nproperty:\n\n```ts\ndeclare const myDatabase: glue.Database;\nnew glue.S3Table(this, 'MyTable', {\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  partitionKeys: [{\n    name: 'year',\n    type: glue.Schema.SMALL_INT,\n  }, {\n    name: 'month',\n    type: glue.Schema.SMALL_INT,\n  }],\n  partitionIndexes: [{\n    indexName: 'my-index', // optional\n    keyNames: ['year'],\n  }], // supply up to 3 indexes\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\nAlternatively, you can call the `addPartitionIndex()` function on a table:\n\n```ts\ndeclare const myTable: glue.Table;\nmyTable.addPartitionIndex({\n  indexName: 'my-index',\n  keyNames: ['year'],\n});\n```\n\n### Partition Filtering\n\nIf you have a table with a large number of partitions that grows over time, consider using AWS Glue partition indexing and filtering.\n\n```ts\ndeclare const myDatabase: glue.Database;\nnew glue.S3Table(this, 'MyTable', {\n    database: myDatabase,\n    columns: [{\n        name: 'col1',\n        type: glue.Schema.STRING,\n    }],\n    partitionKeys: [{\n        name: 'year',\n        type: glue.Schema.SMALL_INT,\n    }, {\n        name: 'month',\n        type: glue.Schema.SMALL_INT,\n    }],\n    dataFormat: glue.DataFormat.JSON,\n    enablePartitionFiltering: true,\n});\n```\n\n### Glue Connections\n\nGlue connections allow external data connections to third party databases and data warehouses. However, these connections can also be assigned to Glue Tables, allowing you to query external data sources using the Glue Data Catalog.\n\nWhereas `S3Table` will point to (and if needed, create) a bucket to store the tables' data, `ExternalTable` will point to an existing table in a data source. For example, to create a table in Glue that points to a table in Redshift:\n\n```ts\ndeclare const myConnection: glue.Connection;\ndeclare const myDatabase: glue.Database;\nnew glue.ExternalTable(this, 'MyTable', {\n  connection: myConnection,\n  externalDataLocation: 'default_db_public_example', // A table in Redshift\n  // ...\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\n## [Encryption](https://docs.aws.amazon.com/athena/latest/ug/encryption.html)\n\nYou can enable encryption on a Table's data:\n\n* [S3Managed](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) - (default) Server side encryption (`SSE-S3`) with an Amazon S3-managed key.\n\n```ts\ndeclare const myDatabase: glue.Database;\nnew glue.S3Table(this, 'MyTable', {\n  encryption: glue.TableEncryption.S3_MANAGED,\n  // ...\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\n* [Kms](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) - Server-side encryption (`SSE-KMS`) with an AWS KMS Key managed by the account owner.\n\n```ts\ndeclare const myDatabase: glue.Database;\n// KMS key is created automatically\nnew glue.S3Table(this, 'MyTable', {\n  encryption: glue.TableEncryption.KMS,\n  // ...\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n\n// with an explicit KMS key\nnew glue.S3Table(this, 'MyTable', {\n  encryption: glue.TableEncryption.KMS,\n  encryptionKey: new kms.Key(this, 'MyKey'),\n  // ...\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\n* [KmsManaged](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) - Server-side encryption (`SSE-KMS`), like `Kms`, except with an AWS KMS Key managed by the AWS Key Management Service.\n\n```ts\ndeclare const myDatabase: glue.Database;\nnew glue.S3Table(this, 'MyTable', {\n  encryption: glue.TableEncryption.KMS_MANAGED,\n  // ...\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\n* [ClientSideKms](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html#client-side-encryption-kms-managed-master-key-intro) - Client-side encryption (`CSE-KMS`) with an AWS KMS Key managed by the account owner.\n\n```ts\ndeclare const myDatabase: glue.Database;\n// KMS key is created automatically\nnew glue.S3Table(this, 'MyTable', {\n  encryption: glue.TableEncryption.CLIENT_SIDE_KMS,\n  // ...\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n\n// with an explicit KMS key\nnew glue.S3Table(this, 'MyTable', {\n  encryption: glue.TableEncryption.CLIENT_SIDE_KMS,\n  encryptionKey: new kms.Key(this, 'MyKey'),\n  // ...\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\n*Note: you cannot provide a `Bucket` when creating the `S3Table` if you wish to use server-side encryption (`KMS`, `KMS_MANAGED` or `S3_MANAGED`)*.\n\n## Types\n\nA table's schema is a collection of columns, each of which have a `name` and a `type`. Types are recursive structures, consisting of primitive and complex types:\n\n```ts\ndeclare const myDatabase: glue.Database;\nnew glue.S3Table(this, 'MyTable', {\n  columns: [{\n    name: 'primitive_column',\n    type: glue.Schema.STRING,\n  }, {\n    name: 'array_column',\n    type: glue.Schema.array(glue.Schema.INTEGER),\n    comment: 'array<integer>',\n  }, {\n    name: 'map_column',\n    type: glue.Schema.map(\n      glue.Schema.STRING,\n      glue.Schema.TIMESTAMP),\n    comment: 'map<string,string>',\n  }, {\n    name: 'struct_column',\n    type: glue.Schema.struct([{\n      name: 'nested_column',\n      type: glue.Schema.DATE,\n      comment: 'nested comment',\n    }]),\n    comment: \"struct<nested_column:date COMMENT 'nested comment'>\",\n  }],\n  // ...\n  database: myDatabase,\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\n### Primitives\n\n#### Numeric\n\n| Name      \t| Type     \t| Comments                                                                                                          |\n|-----------\t|----------\t|------------------------------------------------------------------------------------------------------------------\t|\n| FLOAT     \t| Constant \t| A 32-bit single-precision floating point number                                                                   |\n| INTEGER   \t| Constant \t| A 32-bit signed value in two's complement format, with a minimum value of -2^31 and a maximum value of 2^31-1 \t|\n| DOUBLE    \t| Constant \t| A 64-bit double-precision floating point number                                                                   |\n| BIG_INT   \t| Constant \t| A 64-bit signed INTEGER in two’s complement format, with a minimum value of -2^63 and a maximum value of 2^63 -1  |\n| SMALL_INT \t| Constant \t| A 16-bit signed INTEGER in two’s complement format, with a minimum value of -2^15 and a maximum value of 2^15-1   |\n| TINY_INT  \t| Constant \t| A 8-bit signed INTEGER in two’s complement format, with a minimum value of -2^7 and a maximum value of 2^7-1      |\n\n#### Date and time\n\n| Name      \t| Type     \t| Comments                                                                                                                                                                \t|\n|-----------\t|----------\t|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------\t|\n| DATE      \t| Constant \t| A date in UNIX format, such as YYYY-MM-DD.                                                                                                                              \t|\n| TIMESTAMP \t| Constant \t| Date and time instant in the UNiX format, such as yyyy-mm-dd hh:mm:ss[.f...]. For example, TIMESTAMP '2008-09-15 03:04:05.324'. This format uses the session time zone. \t|\n\n#### String\n\n| Name                                       \t| Type     \t| Comments                                                                                                                                                                                          \t|\n|--------------------------------------------\t|----------\t|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\t|\n| STRING                                     \t| Constant \t| A string literal enclosed in single or double quotes                                                                                                                                              \t|\n| decimal(precision: number, scale?: number) \t| Function \t| `precision` is the total number of digits. `scale` (optional) is the number of digits in fractional part with a default of 0. For example, use these type definitions: decimal(11,5), decimal(15) \t|\n| char(length: number)                       \t| Function \t| Fixed length character data, with a specified length between 1 and 255, such as char(10)                                                                                                          \t|\n| varchar(length: number)                    \t| Function \t| Variable length character data, with a specified length between 1 and 65535, such as varchar(10)                                                                                                  \t|\n\n#### Miscellaneous\n\n| Name    \t| Type     \t| Comments                      \t|\n|---------\t|----------\t|-------------------------------\t|\n| BOOLEAN \t| Constant \t| Values are `true` and `false` \t|\n| BINARY  \t| Constant \t| Value is in binary            \t|\n\n### Complex\n\n| Name                                \t| Type     \t| Comments                                                          \t|\n|-------------------------------------\t|----------\t|-------------------------------------------------------------------\t|\n| array(itemType: Type)               \t| Function \t| An array of some other type                                       \t|\n| map(keyType: Type, valueType: Type) \t| Function \t| A map of some primitive key type to any value type                \t|\n| struct(collumns: Column[])          \t| Function \t| Nested structure containing individually named and typed collumns \t|\n\n## Data Quality Ruleset\n\nA `DataQualityRuleset` specifies a data quality ruleset with DQDL rules applied to a specified AWS Glue table. For example, to create a data quality ruleset for a given table:\n\n```ts\nnew glue.DataQualityRuleset(this, 'MyDataQualityRuleset', {\n  clientToken: 'client_token',\n  description: 'description',\n  rulesetName: 'ruleset_name',\n  rulesetDqdl: 'ruleset_dqdl',\n  tags: {\n    key1: 'value1',\n    key2: 'value2',\n  },\n  targetTable: new glue.DataQualityTargetTable('database_name', 'table_name'),\n});\n```\n\nFor more information, see [AWS Glue Data Quality](https://docs.aws.amazon.com/glue/latest/dg/glue-data-quality.html).\n"
+    "markdown": "# AWS Glue Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)\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\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n\n## Job\n\nA `Job` encapsulates a script that connects to data sources, processes them, and then writes output to a data target.\n\nThere are 3 types of jobs supported by AWS Glue: Spark ETL, Spark Streaming, and Python Shell jobs.\n\nThe `glue.JobExecutable` allows you to specify the type of job, the language to use and the code assets required by the job.\n\n`glue.Code` allows you to refer to the different code assets required by the job, either from an existing S3 location or from a local file path.\n\n`glue.ExecutionClass` allows you to specify `FLEX` or `STANDARD`. `FLEX` is appropriate for non-urgent jobs such as pre-production jobs, testing, and one-time data loads.\n\n### Spark Jobs\n\nThese jobs run in an Apache Spark environment managed by AWS Glue.\n\n#### ETL Jobs\n\nAn ETL job processes data in batches using Apache Spark.\n\n```ts\ndeclare const bucket: s3.Bucket;\nnew glue.Job(this, 'ScalaSparkEtlJob', {\n  executable: glue.JobExecutable.scalaEtl({\n    glueVersion: glue.GlueVersion.V4_0,\n    script: glue.Code.fromBucket(bucket, 'src/com/example/HelloWorld.scala'),\n    className: 'com.example.HelloWorld',\n    extraJars: [glue.Code.fromBucket(bucket, 'jars/HelloWorld.jar')],\n  }),\n  workerType: glue.WorkerType.G_8X,\n  description: 'an example Scala ETL job',\n});\n```\n\n#### Streaming Jobs\n\nA Streaming job is similar to an ETL job, except that it performs ETL on data streams. It uses the Apache Spark Structured Streaming framework. Some Spark job features are not available to streaming ETL jobs.\n\n```ts\nnew glue.Job(this, 'PythonSparkStreamingJob', {\n  executable: glue.JobExecutable.pythonStreaming({\n    glueVersion: glue.GlueVersion.V4_0,\n    pythonVersion: glue.PythonVersion.THREE,\n    script: glue.Code.fromAsset(path.join(__dirname, 'job-script/hello_world.py')),\n  }),\n  description: 'an example Python Streaming job',\n});\n```\n\n### Python Shell Jobs\n\nA Python shell job runs Python scripts as a shell and supports a Python version that depends on the AWS Glue version you are using.\nThis can be used to schedule and run tasks that don't require an Apache Spark environment. Currently, three flavors are supported:\n\n* PythonVersion.TWO (2.7; EOL)\n* PythonVersion.THREE (3.6)\n* PythonVersion.THREE_NINE (3.9)\n\n```ts\ndeclare const bucket: s3.Bucket;\nnew glue.Job(this, 'PythonShellJob', {\n  executable: glue.JobExecutable.pythonShell({\n    glueVersion: glue.GlueVersion.V1_0,\n    pythonVersion: glue.PythonVersion.THREE,\n    script: glue.Code.fromBucket(bucket, 'script.py'),\n  }),\n  description: 'an example Python Shell job',\n});\n```\n\n### Ray Jobs\n\nThese jobs run in a Ray environment managed by AWS Glue.\n\n```ts\nnew glue.Job(this, 'RayJob', {\n  executable: glue.JobExecutable.pythonRay({\n    glueVersion: glue.GlueVersion.V4_0,\n    pythonVersion: glue.PythonVersion.THREE_NINE,\n    runtime: glue.Runtime.RAY_TWO_FOUR,\n    script: glue.Code.fromAsset(path.join(__dirname, 'job-script/hello_world.py')),\n  }),\n  workerType: glue.WorkerType.Z_2X,\n  workerCount: 2,\n  description: 'an example Ray job'\n});\n```\n\n### Enable Spark UI\n\nEnable Spark UI setting the `sparkUI` property.\n\n```ts\nnew glue.Job(this, 'EnableSparkUI', {\n  jobName: 'EtlJobWithSparkUIPrefix',\n  sparkUI: {\n    enabled: true,\n  },\n  executable: glue.JobExecutable.pythonEtl({\n    glueVersion: glue.GlueVersion.V3_0,\n    pythonVersion: glue.PythonVersion.THREE,\n    script: glue.Code.fromAsset(path.join(__dirname, 'job-script/hello_world.py')),\n  }),\n});\n```\n\nThe `sparkUI` property also allows the specification of an s3 bucket and a bucket prefix.\n\nSee [documentation](https://docs.aws.amazon.com/glue/latest/dg/add-job.html) for more information on adding jobs in Glue.\n\n## Connection\n\nA `Connection` allows Glue jobs, crawlers and development endpoints to access certain types of data stores. For example, to create a network connection to connect to a data source within a VPC:\n\n```ts\ndeclare const securityGroup: ec2.SecurityGroup;\ndeclare const subnet: ec2.Subnet;\nnew glue.Connection(this, 'MyConnection', {\n  type: glue.ConnectionType.NETWORK,\n  // The security groups granting AWS Glue inbound access to the data source within the VPC\n  securityGroups: [securityGroup],\n  // The VPC subnet which contains the data source\n  subnet,\n});\n```\n\nFor RDS `Connection` by JDBC, it is recommended to manage credentials using AWS Secrets Manager. To use Secret, specify `SECRET_ID` in `properties` like the following code. Note that in this case, the subnet must have a route to the AWS Secrets Manager VPC endpoint or to the AWS Secrets Manager endpoint through a NAT gateway.\n\n```ts\ndeclare const securityGroup: ec2.SecurityGroup;\ndeclare const subnet: ec2.Subnet;\ndeclare const db: rds.DatabaseCluster;\nnew glue.Connection(this, \"RdsConnection\", {\n  type: glue.ConnectionType.JDBC,\n  securityGroups: [securityGroup],\n  subnet,\n  properties: {\n    JDBC_CONNECTION_URL: `jdbc:mysql://${db.clusterEndpoint.socketAddress}/databasename`,\n    JDBC_ENFORCE_SSL: \"false\",\n    SECRET_ID: db.secret!.secretName,\n  },\n});\n```\n\nIf you need to use a connection type that doesn't exist as a static member on `ConnectionType`, you can instantiate a `ConnectionType` object, e.g: `new glue.ConnectionType('NEW_TYPE')`.\n\nSee [Adding a Connection to Your Data Store](https://docs.aws.amazon.com/glue/latest/dg/populate-add-connection.html) and [Connection Structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-connections.html#aws-glue-api-catalog-connections-Connection) documentation for more information on the supported data stores and their configurations.\n\n## SecurityConfiguration\n\nA `SecurityConfiguration` is a set of security properties that can be used by AWS Glue to encrypt data at rest.\n\n```ts\nnew glue.SecurityConfiguration(this, 'MySecurityConfiguration', {\n  cloudWatchEncryption: {\n    mode: glue.CloudWatchEncryptionMode.KMS,\n  },\n  jobBookmarksEncryption: {\n    mode: glue.JobBookmarksEncryptionMode.CLIENT_SIDE_KMS,\n  },\n  s3Encryption: {\n    mode: glue.S3EncryptionMode.KMS,\n  },\n});\n```\n\nBy default, a shared KMS key is created for use with the encryption configurations that require one. You can also supply your own key for each encryption config, for example, for CloudWatch encryption:\n\n```ts\ndeclare const key: kms.Key;\nnew glue.SecurityConfiguration(this, 'MySecurityConfiguration', {\n  cloudWatchEncryption: {\n    mode: glue.CloudWatchEncryptionMode.KMS,\n    kmsKey: key,\n  },\n});\n```\n\nSee [documentation](https://docs.aws.amazon.com/glue/latest/dg/encryption-security-configuration.html) for more info for Glue encrypting data written by Crawlers, Jobs, and Development Endpoints.\n\n## Database\n\nA `Database` is a logical grouping of `Tables` in the Glue Catalog.\n\n```ts\nnew glue.Database(this, 'MyDatabase', {\n  databaseName: 'my_database',\n  description: 'my_database_description',\n});\n```\n\n## Table\n\nA Glue table describes a table of data in S3: its structure (column names and types), location of data (S3 objects with a common prefix in a S3 bucket), and format for the files (Json, Avro, Parquet, etc.):\n\n```ts\ndeclare const myDatabase: glue.Database;\nnew glue.S3Table(this, 'MyTable', {\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }, {\n    name: 'col2',\n    type: glue.Schema.array(glue.Schema.STRING),\n    comment: 'col2 is an array of strings' // comment is optional\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\nBy default, a S3 bucket will be created to store the table's data but you can manually pass the `bucket` and `s3Prefix`:\n\n```ts\ndeclare const myBucket: s3.Bucket;\ndeclare const myDatabase: glue.Database;\nnew glue.S3Table(this, 'MyTable', {\n  bucket: myBucket,\n  s3Prefix: 'my-table/',\n  // ...\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\nGlue tables can be configured to contain user-defined properties, to describe the physical storage of table data, through the `storageParameters` property:\n\n```ts\ndeclare const myDatabase: glue.Database;\nnew glue.S3Table(this, 'MyTable', {\n  storageParameters: [\n    glue.StorageParameter.skipHeaderLineCount(1),\n    glue.StorageParameter.compressionType(glue.CompressionType.GZIP),\n    glue.StorageParameter.custom('separatorChar', ',')\n  ],\n  // ...\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\nGlue tables can also be configured to contain user-defined table properties through the [`parameters`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-parameters) property:\n\n```ts\ndeclare const myDatabase: glue.Database;\nnew glue.S3Table(this, 'MyTable', {\n  parameters: {\n    key1: 'val1',\n    key2: 'val2',\n  },\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\n### Partition Keys\n\nTo improve query performance, a table can specify `partitionKeys` on which data is stored and queried separately. For example, you might partition a table by `year` and `month` to optimize queries based on a time window:\n\n```ts\ndeclare const myDatabase: glue.Database;\nnew glue.S3Table(this, 'MyTable', {\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  partitionKeys: [{\n    name: 'year',\n    type: glue.Schema.SMALL_INT,\n  }, {\n    name: 'month',\n    type: glue.Schema.SMALL_INT,\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\n### Partition Indexes\n\nAnother way to improve query performance is to specify partition indexes. If no partition indexes are\npresent on the table, AWS Glue loads all partitions of the table and filters the loaded partitions using\nthe query expression. The query takes more time to run as the number of partitions increase. With an\nindex, the query will try to fetch a subset of the partitions instead of loading all partitions of the\ntable.\n\nThe keys of a partition index must be a subset of the partition keys of the table. You can have a\nmaximum of 3 partition indexes per table. To specify a partition index, you can use the `partitionIndexes`\nproperty:\n\n```ts\ndeclare const myDatabase: glue.Database;\nnew glue.S3Table(this, 'MyTable', {\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  partitionKeys: [{\n    name: 'year',\n    type: glue.Schema.SMALL_INT,\n  }, {\n    name: 'month',\n    type: glue.Schema.SMALL_INT,\n  }],\n  partitionIndexes: [{\n    indexName: 'my-index', // optional\n    keyNames: ['year'],\n  }], // supply up to 3 indexes\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\nAlternatively, you can call the `addPartitionIndex()` function on a table:\n\n```ts\ndeclare const myTable: glue.Table;\nmyTable.addPartitionIndex({\n  indexName: 'my-index',\n  keyNames: ['year'],\n});\n```\n\n### Partition Filtering\n\nIf you have a table with a large number of partitions that grows over time, consider using AWS Glue partition indexing and filtering.\n\n```ts\ndeclare const myDatabase: glue.Database;\nnew glue.S3Table(this, 'MyTable', {\n    database: myDatabase,\n    columns: [{\n        name: 'col1',\n        type: glue.Schema.STRING,\n    }],\n    partitionKeys: [{\n        name: 'year',\n        type: glue.Schema.SMALL_INT,\n    }, {\n        name: 'month',\n        type: glue.Schema.SMALL_INT,\n    }],\n    dataFormat: glue.DataFormat.JSON,\n    enablePartitionFiltering: true,\n});\n```\n\n### Glue Connections\n\nGlue connections allow external data connections to third party databases and data warehouses. However, these connections can also be assigned to Glue Tables, allowing you to query external data sources using the Glue Data Catalog.\n\nWhereas `S3Table` will point to (and if needed, create) a bucket to store the tables' data, `ExternalTable` will point to an existing table in a data source. For example, to create a table in Glue that points to a table in Redshift:\n\n```ts\ndeclare const myConnection: glue.Connection;\ndeclare const myDatabase: glue.Database;\nnew glue.ExternalTable(this, 'MyTable', {\n  connection: myConnection,\n  externalDataLocation: 'default_db_public_example', // A table in Redshift\n  // ...\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\n## [Encryption](https://docs.aws.amazon.com/athena/latest/ug/encryption.html)\n\nYou can enable encryption on a Table's data:\n\n* [S3Managed](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) - (default) Server side encryption (`SSE-S3`) with an Amazon S3-managed key.\n\n```ts\ndeclare const myDatabase: glue.Database;\nnew glue.S3Table(this, 'MyTable', {\n  encryption: glue.TableEncryption.S3_MANAGED,\n  // ...\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\n* [Kms](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) - Server-side encryption (`SSE-KMS`) with an AWS KMS Key managed by the account owner.\n\n```ts\ndeclare const myDatabase: glue.Database;\n// KMS key is created automatically\nnew glue.S3Table(this, 'MyTable', {\n  encryption: glue.TableEncryption.KMS,\n  // ...\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n\n// with an explicit KMS key\nnew glue.S3Table(this, 'MyTable', {\n  encryption: glue.TableEncryption.KMS,\n  encryptionKey: new kms.Key(this, 'MyKey'),\n  // ...\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\n* [KmsManaged](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) - Server-side encryption (`SSE-KMS`), like `Kms`, except with an AWS KMS Key managed by the AWS Key Management Service.\n\n```ts\ndeclare const myDatabase: glue.Database;\nnew glue.S3Table(this, 'MyTable', {\n  encryption: glue.TableEncryption.KMS_MANAGED,\n  // ...\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\n* [ClientSideKms](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html#client-side-encryption-kms-managed-master-key-intro) - Client-side encryption (`CSE-KMS`) with an AWS KMS Key managed by the account owner.\n\n```ts\ndeclare const myDatabase: glue.Database;\n// KMS key is created automatically\nnew glue.S3Table(this, 'MyTable', {\n  encryption: glue.TableEncryption.CLIENT_SIDE_KMS,\n  // ...\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n\n// with an explicit KMS key\nnew glue.S3Table(this, 'MyTable', {\n  encryption: glue.TableEncryption.CLIENT_SIDE_KMS,\n  encryptionKey: new kms.Key(this, 'MyKey'),\n  // ...\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\n*Note: you cannot provide a `Bucket` when creating the `S3Table` if you wish to use server-side encryption (`KMS`, `KMS_MANAGED` or `S3_MANAGED`)*.\n\n## Types\n\nA table's schema is a collection of columns, each of which have a `name` and a `type`. Types are recursive structures, consisting of primitive and complex types:\n\n```ts\ndeclare const myDatabase: glue.Database;\nnew glue.S3Table(this, 'MyTable', {\n  columns: [{\n    name: 'primitive_column',\n    type: glue.Schema.STRING,\n  }, {\n    name: 'array_column',\n    type: glue.Schema.array(glue.Schema.INTEGER),\n    comment: 'array<integer>',\n  }, {\n    name: 'map_column',\n    type: glue.Schema.map(\n      glue.Schema.STRING,\n      glue.Schema.TIMESTAMP),\n    comment: 'map<string,string>',\n  }, {\n    name: 'struct_column',\n    type: glue.Schema.struct([{\n      name: 'nested_column',\n      type: glue.Schema.DATE,\n      comment: 'nested comment',\n    }]),\n    comment: \"struct<nested_column:date COMMENT 'nested comment'>\",\n  }],\n  // ...\n  database: myDatabase,\n  dataFormat: glue.DataFormat.JSON,\n});\n```\n\n### Primitives\n\n#### Numeric\n\n| Name      \t| Type     \t| Comments                                                                                                          |\n|-----------\t|----------\t|------------------------------------------------------------------------------------------------------------------\t|\n| FLOAT     \t| Constant \t| A 32-bit single-precision floating point number                                                                   |\n| INTEGER   \t| Constant \t| A 32-bit signed value in two's complement format, with a minimum value of -2^31 and a maximum value of 2^31-1 \t|\n| DOUBLE    \t| Constant \t| A 64-bit double-precision floating point number                                                                   |\n| BIG_INT   \t| Constant \t| A 64-bit signed INTEGER in two’s complement format, with a minimum value of -2^63 and a maximum value of 2^63 -1  |\n| SMALL_INT \t| Constant \t| A 16-bit signed INTEGER in two’s complement format, with a minimum value of -2^15 and a maximum value of 2^15-1   |\n| TINY_INT  \t| Constant \t| A 8-bit signed INTEGER in two’s complement format, with a minimum value of -2^7 and a maximum value of 2^7-1      |\n\n#### Date and time\n\n| Name      \t| Type     \t| Comments                                                                                                                                                                \t|\n|-----------\t|----------\t|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------\t|\n| DATE      \t| Constant \t| A date in UNIX format, such as YYYY-MM-DD.                                                                                                                              \t|\n| TIMESTAMP \t| Constant \t| Date and time instant in the UNiX format, such as yyyy-mm-dd hh:mm:ss[.f...]. For example, TIMESTAMP '2008-09-15 03:04:05.324'. This format uses the session time zone. \t|\n\n#### String\n\n| Name                                       \t| Type     \t| Comments                                                                                                                                                                                          \t|\n|--------------------------------------------\t|----------\t|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\t|\n| STRING                                     \t| Constant \t| A string literal enclosed in single or double quotes                                                                                                                                              \t|\n| decimal(precision: number, scale?: number) \t| Function \t| `precision` is the total number of digits. `scale` (optional) is the number of digits in fractional part with a default of 0. For example, use these type definitions: decimal(11,5), decimal(15) \t|\n| char(length: number)                       \t| Function \t| Fixed length character data, with a specified length between 1 and 255, such as char(10)                                                                                                          \t|\n| varchar(length: number)                    \t| Function \t| Variable length character data, with a specified length between 1 and 65535, such as varchar(10)                                                                                                  \t|\n\n#### Miscellaneous\n\n| Name    \t| Type     \t| Comments                      \t|\n|---------\t|----------\t|-------------------------------\t|\n| BOOLEAN \t| Constant \t| Values are `true` and `false` \t|\n| BINARY  \t| Constant \t| Value is in binary            \t|\n\n### Complex\n\n| Name                                \t| Type     \t| Comments                                                          \t|\n|-------------------------------------\t|----------\t|-------------------------------------------------------------------\t|\n| array(itemType: Type)               \t| Function \t| An array of some other type                                       \t|\n| map(keyType: Type, valueType: Type) \t| Function \t| A map of some primitive key type to any value type                \t|\n| struct(collumns: Column[])          \t| Function \t| Nested structure containing individually named and typed collumns \t|\n\n## Data Quality Ruleset\n\nA `DataQualityRuleset` specifies a data quality ruleset with DQDL rules applied to a specified AWS Glue table. For example, to create a data quality ruleset for a given table:\n\n```ts\nnew glue.DataQualityRuleset(this, 'MyDataQualityRuleset', {\n  clientToken: 'client_token',\n  description: 'description',\n  rulesetName: 'ruleset_name',\n  rulesetDqdl: 'ruleset_dqdl',\n  tags: {\n    key1: 'value1',\n    key2: 'value2',\n  },\n  targetTable: new glue.DataQualityTargetTable('database_name', 'table_name'),\n});\n```\n\nFor more information, see [AWS Glue Data Quality](https://docs.aws.amazon.com/glue/latest/dg/glue-data-quality.html).\n"
   },
   "repository": {
     "directory": "packages/@aws-cdk/aws-glue-alpha",
@@ -5750,7 +5750,7 @@
         },
         "locationInModule": {
           "filename": "lib/database.ts",
-          "line": 91
+          "line": 98
         },
         "parameters": [
           {
@@ -5780,7 +5780,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "lib/database.ts",
-        "line": 51
+        "line": 58
       },
       "methods": [
         {
@@ -5789,7 +5789,7 @@
           },
           "locationInModule": {
             "filename": "lib/database.ts",
-            "line": 53
+            "line": 60
           },
           "name": "fromDatabaseArn",
           "parameters": [
@@ -5830,7 +5830,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/database.ts",
-            "line": 69
+            "line": 76
           },
           "name": "catalogArn",
           "overrides": "@aws-cdk/aws-glue-alpha.IDatabase",
@@ -5846,7 +5846,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/database.ts",
-            "line": 74
+            "line": 81
           },
           "name": "catalogId",
           "overrides": "@aws-cdk/aws-glue-alpha.IDatabase",
@@ -5862,7 +5862,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/database.ts",
-            "line": 79
+            "line": 86
           },
           "name": "databaseArn",
           "overrides": "@aws-cdk/aws-glue-alpha.IDatabase",
@@ -5878,7 +5878,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/database.ts",
-            "line": 84
+            "line": 91
           },
           "name": "databaseName",
           "overrides": "@aws-cdk/aws-glue-alpha.IDatabase",
@@ -5894,7 +5894,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/database.ts",
-            "line": 89
+            "line": 96
           },
           "name": "locationUri",
           "optional": true,
@@ -5910,9 +5910,9 @@
       "datatype": true,
       "docs": {
         "stability": "experimental",
-        "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as glue_alpha from '@aws-cdk/aws-glue-alpha';\nconst databaseProps: glue_alpha.DatabaseProps = {\n  databaseName: 'databaseName',\n  locationUri: 'locationUri',\n};",
+        "example": "new glue.Database(this, 'MyDatabase', {\n  databaseName: 'my_database',\n  description: 'my_database_description',\n});",
         "custom": {
-          "exampleMetadata": "fixture=_generated"
+          "exampleMetadata": "infused"
         }
       },
       "fqn": "@aws-cdk/aws-glue-alpha.DatabaseProps",
@@ -5941,6 +5941,24 @@
             "primitive": "string"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- no database description",
+            "stability": "experimental",
+            "summary": "A description of the database."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "lib/database.ts",
+            "line": 52
+          },
+          "name": "description",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -6050,7 +6068,7 @@
           },
           "locationInModule": {
             "filename": "lib/external-table.ts",
-            "line": 117
+            "line": 118
           },
           "name": "grantRead",
           "overrides": "@aws-cdk/aws-glue-alpha.TableBase",
@@ -6078,7 +6096,7 @@
           },
           "locationInModule": {
             "filename": "lib/external-table.ts",
-            "line": 137
+            "line": 138
           },
           "name": "grantReadWrite",
           "overrides": "@aws-cdk/aws-glue-alpha.TableBase",
@@ -6106,7 +6124,7 @@
           },
           "locationInModule": {
             "filename": "lib/external-table.ts",
-            "line": 127
+            "line": 128
           },
           "name": "grantWrite",
           "overrides": "@aws-cdk/aws-glue-alpha.TableBase",
@@ -10087,7 +10105,7 @@
         },
         "stability": "experimental",
         "summary": "A Glue table that targets a S3 dataset.",
-        "example": "declare const myDatabase: glue.Database;\nnew glue.S3Table(this, 'MyTable', {\n  database: myDatabase,\n  columns: [{\n    name: 'col1',\n    type: glue.Schema.STRING,\n  }],\n  partitionKeys: [{\n    name: 'year',\n    type: glue.Schema.SMALL_INT,\n  }, {\n    name: 'month',\n    type: glue.Schema.SMALL_INT,\n  }],\n  partitionIndexes: [{\n    indexName: 'my-index', // optional\n    keyNames: ['year'],\n  }], // supply up to 3 indexes\n  dataFormat: glue.DataFormat.JSON,\n});"
+        "example": "declare const myDatabase: glue.Database;\nnew glue.S3Table(this, 'MyTable', {\n    database: myDatabase,\n    columns: [{\n        name: 'col1',\n        type: glue.Schema.STRING,\n    }],\n    partitionKeys: [{\n        name: 'year',\n        type: glue.Schema.SMALL_INT,\n    }, {\n        name: 'month',\n        type: glue.Schema.SMALL_INT,\n    }],\n    dataFormat: glue.DataFormat.JSON,\n    enablePartitionFiltering: true,\n});"
       },
       "fqn": "@aws-cdk/aws-glue-alpha.S3Table",
       "initializer": {
@@ -10131,7 +10149,7 @@
           },
           "locationInModule": {
             "filename": "lib/s3-table.ts",
-            "line": 220
+            "line": 221
           },
           "name": "generateS3PrefixForGrant",
           "protected": true,
@@ -10148,7 +10166,7 @@
           },
           "locationInModule": {
             "filename": "lib/s3-table.ts",
-            "line": 189
+            "line": 190
           },
           "name": "grantRead",
           "overrides": "@aws-cdk/aws-glue-alpha.TableBase",
@@ -10176,7 +10194,7 @@
           },
           "locationInModule": {
             "filename": "lib/s3-table.ts",
-            "line": 213
+            "line": 214
           },
           "name": "grantReadWrite",
           "overrides": "@aws-cdk/aws-glue-alpha.TableBase",
@@ -10204,7 +10222,7 @@
           },
           "locationInModule": {
             "filename": "lib/s3-table.ts",
-            "line": 201
+            "line": 202
           },
           "name": "grantWrite",
           "overrides": "@aws-cdk/aws-glue-alpha.TableBase",
@@ -12506,7 +12524,7 @@
         },
         "locationInModule": {
           "filename": "lib/table-base.ts",
-          "line": 224
+          "line": 240
         },
         "parameters": [
           {
@@ -12535,7 +12553,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "lib/table-base.ts",
-        "line": 155
+        "line": 165
       },
       "methods": [
         {
@@ -12544,7 +12562,7 @@
           },
           "locationInModule": {
             "filename": "lib/table-base.ts",
-            "line": 157
+            "line": 167
           },
           "name": "fromTableArn",
           "parameters": [
@@ -12581,7 +12599,7 @@
           },
           "locationInModule": {
             "filename": "lib/table-base.ts",
-            "line": 173
+            "line": 183
           },
           "name": "fromTableAttributes",
           "parameters": [
@@ -12629,7 +12647,7 @@
           },
           "locationInModule": {
             "filename": "lib/table-base.ts",
-            "line": 254
+            "line": 271
           },
           "name": "addPartitionIndex",
           "parameters": [
@@ -12648,7 +12666,7 @@
           },
           "locationInModule": {
             "filename": "lib/table-base.ts",
-            "line": 317
+            "line": 334
           },
           "name": "grant",
           "parameters": [
@@ -12683,7 +12701,7 @@
           },
           "locationInModule": {
             "filename": "lib/table-base.ts",
-            "line": 243
+            "line": 260
           },
           "name": "grantRead",
           "parameters": [
@@ -12707,7 +12725,7 @@
           },
           "locationInModule": {
             "filename": "lib/table-base.ts",
-            "line": 245
+            "line": 262
           },
           "name": "grantReadWrite",
           "parameters": [
@@ -12732,7 +12750,7 @@
           },
           "locationInModule": {
             "filename": "lib/table-base.ts",
-            "line": 329
+            "line": 346
           },
           "name": "grantToUnderlyingResources",
           "parameters": [
@@ -12767,7 +12785,7 @@
           },
           "locationInModule": {
             "filename": "lib/table-base.ts",
-            "line": 244
+            "line": 261
           },
           "name": "grantWrite",
           "parameters": [
@@ -12795,7 +12813,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/table-base.ts",
-            "line": 205
+            "line": 215
           },
           "name": "columns",
           "type": {
@@ -12815,7 +12833,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/table-base.ts",
-            "line": 195
+            "line": 205
           },
           "name": "compressed",
           "type": {
@@ -12830,7 +12848,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/table-base.ts",
-            "line": 190
+            "line": 200
           },
           "name": "database",
           "type": {
@@ -12845,13 +12863,35 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/table-base.ts",
-            "line": 200
+            "line": 210
           },
           "name": "dataFormat",
           "type": {
             "fqn": "@aws-cdk/aws-glue-alpha.DataFormat"
           }
         },
+        {
+          "docs": {
+            "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-parameters",
+            "stability": "experimental",
+            "summary": "The tables' properties associated with the table."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "lib/table-base.ts",
+            "line": 231
+          },
+          "name": "parameters",
+          "protected": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "map"
+            }
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -12860,7 +12900,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/table-base.ts",
-            "line": 184
+            "line": 194
           },
           "name": "tableArn",
           "overrides": "@aws-cdk/aws-glue-alpha.ITable",
@@ -12876,7 +12916,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/table-base.ts",
-            "line": 183
+            "line": 193
           },
           "name": "tableName",
           "overrides": "@aws-cdk/aws-glue-alpha.ITable",
@@ -12892,7 +12932,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/table-base.ts",
-            "line": 182
+            "line": 192
           },
           "name": "tableResource",
           "protected": true,
@@ -12908,7 +12948,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/table-base.ts",
-            "line": 185
+            "line": 195
           },
           "name": "partitionIndexes",
           "optional": true,
@@ -12929,7 +12969,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/table-base.ts",
-            "line": 210
+            "line": 220
           },
           "name": "partitionKeys",
           "optional": true,
@@ -12950,7 +12990,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/table-base.ts",
-            "line": 215
+            "line": 225
           },
           "name": "storageParameters",
           "optional": true,
@@ -12971,7 +13011,7 @@
       "datatype": true,
       "docs": {
         "stability": "experimental",
-        "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as glue_alpha from '@aws-cdk/aws-glue-alpha';\n\ndeclare const database: glue_alpha.Database;\ndeclare const dataFormat: glue_alpha.DataFormat;\ndeclare const storageParameter: glue_alpha.StorageParameter;\nconst tableBaseProps: glue_alpha.TableBaseProps = {\n  columns: [{\n    name: 'name',\n    type: {\n      inputString: 'inputString',\n      isPrimitive: false,\n    },\n\n    // the properties below are optional\n    comment: 'comment',\n  }],\n  database: database,\n  dataFormat: dataFormat,\n\n  // the properties below are optional\n  compressed: false,\n  description: 'description',\n  enablePartitionFiltering: false,\n  partitionIndexes: [{\n    keyNames: ['keyNames'],\n\n    // the properties below are optional\n    indexName: 'indexName',\n  }],\n  partitionKeys: [{\n    name: 'name',\n    type: {\n      inputString: 'inputString',\n      isPrimitive: false,\n    },\n\n    // the properties below are optional\n    comment: 'comment',\n  }],\n  storageParameters: [storageParameter],\n  storedAsSubDirectories: false,\n  tableName: 'tableName',\n};",
+        "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as glue_alpha from '@aws-cdk/aws-glue-alpha';\n\ndeclare const database: glue_alpha.Database;\ndeclare const dataFormat: glue_alpha.DataFormat;\ndeclare const storageParameter: glue_alpha.StorageParameter;\nconst tableBaseProps: glue_alpha.TableBaseProps = {\n  columns: [{\n    name: 'name',\n    type: {\n      inputString: 'inputString',\n      isPrimitive: false,\n    },\n\n    // the properties below are optional\n    comment: 'comment',\n  }],\n  database: database,\n  dataFormat: dataFormat,\n\n  // the properties below are optional\n  compressed: false,\n  description: 'description',\n  enablePartitionFiltering: false,\n  parameters: {\n    parametersKey: 'parameters',\n  },\n  partitionIndexes: [{\n    keyNames: ['keyNames'],\n\n    // the properties below are optional\n    indexName: 'indexName',\n  }],\n  partitionKeys: [{\n    name: 'name',\n    type: {\n      inputString: 'inputString',\n      isPrimitive: false,\n    },\n\n    // the properties below are optional\n    comment: 'comment',\n  }],\n  storageParameters: [storageParameter],\n  storedAsSubDirectories: false,\n  tableName: 'tableName',\n};",
         "custom": {
           "exampleMetadata": "fixture=_generated"
         }
@@ -13092,6 +13132,31 @@
             "primitive": "boolean"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- The parameter is not defined",
+            "remarks": "The key/value pairs that are allowed to be submitted are not limited, however their functionality is not guaranteed.",
+            "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-parameters",
+            "stability": "experimental",
+            "summary": "The key/value pairs define properties associated with the table."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "lib/table-base.ts",
+            "line": 159
+          },
+          "name": "parameters",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "map"
+            }
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -13262,7 +13327,7 @@
       "datatype": true,
       "docs": {
         "stability": "experimental",
-        "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as glue_alpha from '@aws-cdk/aws-glue-alpha';\nimport { aws_kms as kms } from 'aws-cdk-lib';\nimport { aws_s3 as s3 } from 'aws-cdk-lib';\n\ndeclare const bucket: s3.Bucket;\ndeclare const database: glue_alpha.Database;\ndeclare const dataFormat: glue_alpha.DataFormat;\ndeclare const key: kms.Key;\ndeclare const storageParameter: glue_alpha.StorageParameter;\nconst tableProps: glue_alpha.TableProps = {\n  columns: [{\n    name: 'name',\n    type: {\n      inputString: 'inputString',\n      isPrimitive: false,\n    },\n\n    // the properties below are optional\n    comment: 'comment',\n  }],\n  database: database,\n  dataFormat: dataFormat,\n\n  // the properties below are optional\n  bucket: bucket,\n  compressed: false,\n  description: 'description',\n  enablePartitionFiltering: false,\n  encryption: glue_alpha.TableEncryption.S3_MANAGED,\n  encryptionKey: key,\n  partitionIndexes: [{\n    keyNames: ['keyNames'],\n\n    // the properties below are optional\n    indexName: 'indexName',\n  }],\n  partitionKeys: [{\n    name: 'name',\n    type: {\n      inputString: 'inputString',\n      isPrimitive: false,\n    },\n\n    // the properties below are optional\n    comment: 'comment',\n  }],\n  s3Prefix: 's3Prefix',\n  storageParameters: [storageParameter],\n  storedAsSubDirectories: false,\n  tableName: 'tableName',\n};",
+        "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as glue_alpha from '@aws-cdk/aws-glue-alpha';\nimport { aws_kms as kms } from 'aws-cdk-lib';\nimport { aws_s3 as s3 } from 'aws-cdk-lib';\n\ndeclare const bucket: s3.Bucket;\ndeclare const database: glue_alpha.Database;\ndeclare const dataFormat: glue_alpha.DataFormat;\ndeclare const key: kms.Key;\ndeclare const storageParameter: glue_alpha.StorageParameter;\nconst tableProps: glue_alpha.TableProps = {\n  columns: [{\n    name: 'name',\n    type: {\n      inputString: 'inputString',\n      isPrimitive: false,\n    },\n\n    // the properties below are optional\n    comment: 'comment',\n  }],\n  database: database,\n  dataFormat: dataFormat,\n\n  // the properties below are optional\n  bucket: bucket,\n  compressed: false,\n  description: 'description',\n  enablePartitionFiltering: false,\n  encryption: glue_alpha.TableEncryption.S3_MANAGED,\n  encryptionKey: key,\n  parameters: {\n    parametersKey: 'parameters',\n  },\n  partitionIndexes: [{\n    keyNames: ['keyNames'],\n\n    // the properties below are optional\n    indexName: 'indexName',\n  }],\n  partitionKeys: [{\n    name: 'name',\n    type: {\n      inputString: 'inputString',\n      isPrimitive: false,\n    },\n\n    // the properties below are optional\n    comment: 'comment',\n  }],\n  s3Prefix: 's3Prefix',\n  storageParameters: [storageParameter],\n  storedAsSubDirectories: false,\n  tableName: 'tableName',\n};",
         "custom": {
           "exampleMetadata": "fixture=_generated"
         }
@@ -13558,6 +13623,6 @@
       "symbolId": "lib/storage-parameter:WriteParallel"
     }
   },
-  "version": "2.117.0-alpha.0",
+  "version": "2.118.0-alpha.0",
   "fingerprint": "**********"
 }

package/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+   Copyright 2018-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/NOTICE

@@ -1,2 +1,2 @@
 AWS Cloud Development Kit (AWS CDK)
-Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+Copyright 2018-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.

package/README.md

@@ -202,7 +202,10 @@ See [documentation](https://docs.aws.amazon.com/glue/latest/dg/encryption-securi
 A `Database` is a logical grouping of `Tables` in the Glue Catalog.
 
 ```ts
-new glue.Database(this, 'MyDatabase');
+new glue.Database(this, 'MyDatabase', {
+  databaseName: 'my_database',
+  description: 'my_database_description',
+});
 ```
 
 ## Table
@@ -263,6 +266,24 @@ new glue.S3Table(this, 'MyTable', {
 });
 ```
 
+Glue tables can also be configured to contain user-defined table properties through the [`parameters`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-parameters) property:
+
+```ts
+declare const myDatabase: glue.Database;
+new glue.S3Table(this, 'MyTable', {
+  parameters: {
+    key1: 'val1',
+    key2: 'val2',
+  },
+  database: myDatabase,
+  columns: [{
+    name: 'col1',
+    type: glue.Schema.STRING,
+  }],
+  dataFormat: glue.DataFormat.JSON,
+});
+```
+
 ### Partition Keys
 
 To improve query performance, a table can specify `partitionKeys` on which data is stored and queried separately. For example, you might partition a table by `year` and `month` to optimize queries based on a time window: