@awboost/cfn-resource-types 0.1.158 → 0.1.159

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.
@@ -5,144 +5,307 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
5
5
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html}
6
6
  */
7
7
  export type GlueCrawlerProperties = {
8
+ /**
9
+ * A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.
10
+ */
8
11
  Classifiers?: string[];
12
+ /**
13
+ * Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior.
14
+ */
9
15
  Configuration?: string;
16
+ /**
17
+ * The name of the SecurityConfiguration structure to be used by this crawler.
18
+ */
10
19
  CrawlerSecurityConfiguration?: string;
20
+ /**
21
+ * The name of the database in which the crawler's output is stored.
22
+ */
11
23
  DatabaseName?: string;
24
+ /**
25
+ * A description of the crawler.
26
+ */
12
27
  Description?: string;
28
+ /**
29
+ * Specifies AWS Lake Formation configuration settings for the crawler
30
+ */
13
31
  LakeFormationConfiguration?: LakeFormationConfiguration;
32
+ /**
33
+ * The name of the crawler.
34
+ */
14
35
  Name?: string;
36
+ /**
37
+ * When crawling an Amazon S3 data source after the first crawl is complete, specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. For more information, see Incremental Crawls in AWS Glue in the developer guide.
38
+ */
15
39
  RecrawlPolicy?: RecrawlPolicy;
40
+ /**
41
+ * The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.
42
+ */
16
43
  Role: string;
44
+ /**
45
+ * A scheduling object using a cron statement to schedule an event.
46
+ */
17
47
  Schedule?: Schedule;
48
+ /**
49
+ * The policy that specifies update and delete behaviors for the crawler. The policy tells the crawler what to do in the event that it detects a change in a table that already exists in the customer's database at the time of the crawl. The SchemaChangePolicy does not affect whether or how new tables and partitions are added. New tables and partitions are always created regardless of the SchemaChangePolicy on a crawler. The SchemaChangePolicy consists of two components, UpdateBehavior and DeleteBehavior.
50
+ */
18
51
  SchemaChangePolicy?: SchemaChangePolicy;
52
+ /**
53
+ * The prefix added to the names of tables that are created.
54
+ */
19
55
  TablePrefix?: string;
56
+ /**
57
+ * The tags to use with this crawler.
58
+ */
20
59
  Tags?: Record<string, any>;
60
+ /**
61
+ * Specifies data stores to crawl.
62
+ */
21
63
  Targets: Targets;
22
64
  };
23
- /**
24
- * Attribute type definition for `AWS::Glue::Crawler`.
25
- * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#aws-resource-glue-crawler-return-values}
26
- */
27
- export type GlueCrawlerAttributes = {
28
- Id: string;
29
- };
30
65
  /**
31
66
  * Type definition for `AWS::Glue::Crawler.CatalogTarget`.
67
+ * Specifies an AWS Glue Data Catalog target.
32
68
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-catalogtarget.html}
33
69
  */
34
70
  export type CatalogTarget = {
71
+ /**
72
+ * The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog connection type paired with a NETWORK Connection type.
73
+ */
35
74
  ConnectionName?: string;
75
+ /**
76
+ * The name of the database to be synchronized.
77
+ */
36
78
  DatabaseName?: string;
79
+ /**
80
+ * A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
81
+ */
37
82
  DlqEventQueueArn?: string;
83
+ /**
84
+ * A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
85
+ */
38
86
  EventQueueArn?: string;
87
+ /**
88
+ * A list of the tables to be synchronized.
89
+ */
39
90
  Tables?: string[];
40
91
  };
41
92
  /**
42
93
  * Type definition for `AWS::Glue::Crawler.DeltaTarget`.
94
+ * Specifies a Delta data store to crawl one or more Delta tables.
43
95
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-deltatarget.html}
44
96
  */
45
97
  export type DeltaTarget = {
98
+ /**
99
+ * The name of the connection to use to connect to the Delta table target.
100
+ */
46
101
  ConnectionName?: string;
102
+ /**
103
+ * Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly.
104
+ */
47
105
  CreateNativeDeltaTable?: boolean;
48
106
  DeltaTables?: string[];
107
+ /**
108
+ * Specifies whether to write the manifest files to the Delta table path.
109
+ */
49
110
  WriteManifest?: boolean;
50
111
  };
51
112
  /**
52
113
  * Type definition for `AWS::Glue::Crawler.DynamoDBTarget`.
114
+ * Specifies an Amazon DynamoDB table to crawl.
53
115
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-dynamodbtarget.html}
54
116
  */
55
117
  export type DynamoDBTarget = {
118
+ /**
119
+ * The name of the DynamoDB table to crawl.
120
+ */
56
121
  Path?: string;
57
122
  };
58
123
  /**
59
124
  * Type definition for `AWS::Glue::Crawler.IcebergTarget`.
125
+ * Specifies Apache Iceberg data store targets.
60
126
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-icebergtarget.html}
61
127
  */
62
128
  export type IcebergTarget = {
129
+ /**
130
+ * The name of the connection to use to connect to the Iceberg target.
131
+ */
63
132
  ConnectionName?: string;
133
+ /**
134
+ * A list of global patterns used to exclude from the crawl.
135
+ */
64
136
  Exclusions?: string[];
137
+ /**
138
+ * The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in your Amazon S3 path. Used to limit the crawler run time.
139
+ */
65
140
  MaximumTraversalDepth?: number;
141
+ /**
142
+ * One or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix .
143
+ */
66
144
  Paths?: string[];
67
145
  };
68
146
  /**
69
147
  * Type definition for `AWS::Glue::Crawler.JdbcTarget`.
148
+ * Specifies a JDBC data store to crawl.
70
149
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html}
71
150
  */
72
151
  export type JdbcTarget = {
152
+ /**
153
+ * The name of the connection to use to connect to the JDBC target.
154
+ */
73
155
  ConnectionName?: string;
156
+ /**
157
+ * Specify a value of RAWTYPES or COMMENTS to enable additional metadata in table responses. RAWTYPES provides the native-level datatype. COMMENTS provides comments associated with a column or table in the database.
158
+
159
+ If you do not need additional metadata, keep the field empty.
160
+ */
74
161
  EnableAdditionalMetadata?: string[];
162
+ /**
163
+ * A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
164
+ */
75
165
  Exclusions?: string[];
166
+ /**
167
+ * The path of the JDBC target.
168
+ */
76
169
  Path?: string;
77
170
  };
78
171
  /**
79
172
  * Type definition for `AWS::Glue::Crawler.LakeFormationConfiguration`.
173
+ * Specifies AWS Lake Formation configuration settings for the crawler
80
174
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-lakeformationconfiguration.html}
81
175
  */
82
176
  export type LakeFormationConfiguration = {
177
+ /**
178
+ * Required for cross account crawls. For same account crawls as the target data, this can be left as null.
179
+ */
83
180
  AccountId?: string;
181
+ /**
182
+ * Specifies whether to use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.
183
+ */
84
184
  UseLakeFormationCredentials?: boolean;
85
185
  };
86
186
  /**
87
187
  * Type definition for `AWS::Glue::Crawler.MongoDBTarget`.
188
+ * Specifies an Amazon DocumentDB or MongoDB data store to crawl.
88
189
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-mongodbtarget.html}
89
190
  */
90
191
  export type MongoDBTarget = {
192
+ /**
193
+ * The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
194
+ */
91
195
  ConnectionName?: string;
196
+ /**
197
+ * The path of the Amazon DocumentDB or MongoDB target (database/collection).
198
+ */
92
199
  Path?: string;
93
200
  };
94
201
  /**
95
202
  * Type definition for `AWS::Glue::Crawler.RecrawlPolicy`.
203
+ * When crawling an Amazon S3 data source after the first crawl is complete, specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. For more information, see Incremental Crawls in AWS Glue in the developer guide.
96
204
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-recrawlpolicy.html}
97
205
  */
98
206
  export type RecrawlPolicy = {
207
+ /**
208
+ * Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. A value of CRAWL_EVERYTHING specifies crawling the entire dataset again. A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run. A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.
209
+ */
99
210
  RecrawlBehavior?: string;
100
211
  };
101
212
  /**
102
213
  * Type definition for `AWS::Glue::Crawler.S3Target`.
214
+ * Specifies a data store in Amazon Simple Storage Service (Amazon S3).
103
215
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html}
104
216
  */
105
217
  export type S3Target = {
218
+ /**
219
+ * The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
220
+ */
106
221
  ConnectionName?: string;
222
+ /**
223
+ * A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
224
+ */
107
225
  DlqEventQueueArn?: string;
226
+ /**
227
+ * A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
228
+ */
108
229
  EventQueueArn?: string;
230
+ /**
231
+ * A list of glob patterns used to exclude from the crawl.
232
+ */
109
233
  Exclusions?: string[];
234
+ /**
235
+ * The path to the Amazon S3 target.
236
+ */
110
237
  Path?: string;
238
+ /**
239
+ * Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
240
+ */
111
241
  SampleSize?: number;
112
242
  };
113
243
  /**
114
244
  * Type definition for `AWS::Glue::Crawler.Schedule`.
245
+ * A scheduling object using a cron statement to schedule an event.
115
246
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schedule.html}
116
247
  */
117
248
  export type Schedule = {
249
+ /**
250
+ * A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *).
251
+ */
118
252
  ScheduleExpression?: string;
119
253
  };
120
254
  /**
121
255
  * Type definition for `AWS::Glue::Crawler.SchemaChangePolicy`.
256
+ * The policy that specifies update and delete behaviors for the crawler. The policy tells the crawler what to do in the event that it detects a change in a table that already exists in the customer's database at the time of the crawl. The SchemaChangePolicy does not affect whether or how new tables and partitions are added. New tables and partitions are always created regardless of the SchemaChangePolicy on a crawler. The SchemaChangePolicy consists of two components, UpdateBehavior and DeleteBehavior.
122
257
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schemachangepolicy.html}
123
258
  */
124
259
  export type SchemaChangePolicy = {
260
+ /**
261
+ * The deletion behavior when the crawler finds a deleted object. A value of LOG specifies that if a table or partition is found to no longer exist, do not delete it, only log that it was found to no longer exist. A value of DELETE_FROM_DATABASE specifies that if a table or partition is found to have been removed, delete it from the database. A value of DEPRECATE_IN_DATABASE specifies that if a table has been found to no longer exist, to add a property to the table that says 'DEPRECATED' and includes a timestamp with the time of deprecation.
262
+ */
125
263
  DeleteBehavior?: string;
264
+ /**
265
+ * The update behavior when the crawler finds a changed schema. A value of LOG specifies that if a table or a partition already exists, and a change is detected, do not update it, only log that a change was detected. Add new tables and new partitions (including on existing tables). A value of UPDATE_IN_DATABASE specifies that if a table or partition already exists, and a change is detected, update it. Add new tables and partitions.
266
+ */
126
267
  UpdateBehavior?: string;
127
268
  };
128
269
  /**
129
270
  * Type definition for `AWS::Glue::Crawler.Targets`.
271
+ * Specifies data stores to crawl.
130
272
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html}
131
273
  */
132
274
  export type Targets = {
275
+ /**
276
+ * Specifies AWS Glue Data Catalog targets.
277
+ */
133
278
  CatalogTargets?: CatalogTarget[];
279
+ /**
280
+ * Specifies an array of Delta data store targets.
281
+ */
134
282
  DeltaTargets?: DeltaTarget[];
283
+ /**
284
+ * Specifies Amazon DynamoDB targets.
285
+ */
135
286
  DynamoDBTargets?: DynamoDBTarget[];
287
+ /**
288
+ * Specifies Apache Iceberg data store targets.
289
+ */
136
290
  IcebergTargets?: IcebergTarget[];
291
+ /**
292
+ * Specifies JDBC targets.
293
+ */
137
294
  JdbcTargets?: JdbcTarget[];
295
+ /**
296
+ * A list of Mongo DB targets.
297
+ */
138
298
  MongoDBTargets?: MongoDBTarget[];
299
+ /**
300
+ * Specifies Amazon Simple Storage Service (Amazon S3) targets.
301
+ */
139
302
  S3Targets?: S3Target[];
140
303
  };
141
304
  /**
142
305
  * Resource Type definition for AWS::Glue::Crawler
143
306
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html}
144
307
  */
145
- export declare class GlueCrawler extends $Resource<"AWS::Glue::Crawler", GlueCrawlerProperties, GlueCrawlerAttributes> {
308
+ export declare class GlueCrawler extends $Resource<"AWS::Glue::Crawler", GlueCrawlerProperties, Record<string, never>> {
146
309
  static readonly Type = "AWS::Glue::Crawler";
147
310
  constructor(logicalId: string, properties: GlueCrawlerProperties, options?: $ResourceOptions);
148
311
  }
@@ -5,7 +5,10 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
5
5
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-directorybucket.html}
6
6
  */
7
7
  export type S3ExpressDirectoryBucketProperties = {
8
- BucketEncryption?: any;
8
+ /**
9
+ * Specifies default encryption for a bucket using server-side encryption with Amazon S3 managed keys (SSE-S3) or AWS KMS keys (SSE-KMS).
10
+ */
11
+ BucketEncryption?: BucketEncryption;
9
12
  /**
10
13
  * Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.
11
14
  * @maxLength `63`
@@ -35,6 +38,44 @@ export type S3ExpressDirectoryBucketAttributes = {
35
38
  */
36
39
  AvailabilityZoneName: string;
37
40
  };
41
+ /**
42
+ * Type definition for `AWS::S3Express::DirectoryBucket.BucketEncryption`.
43
+ * Specifies default encryption for a bucket using server-side encryption with Amazon S3 managed keys (SSE-S3) or AWS KMS keys (SSE-KMS).
44
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-bucketencryption.html}
45
+ */
46
+ export type BucketEncryption = {
47
+ /**
48
+ * Specifies the default server-side-encryption configuration.
49
+ */
50
+ ServerSideEncryptionConfiguration: ServerSideEncryptionRule[];
51
+ };
52
+ /**
53
+ * Type definition for `AWS::S3Express::DirectoryBucket.ServerSideEncryptionByDefault`.
54
+ * Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.
55
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-serversideencryptionbydefault.html}
56
+ */
57
+ export type ServerSideEncryptionByDefault = {
58
+ /**
59
+ * AWS Key Management Service (KMS) customer managed key ID to use for the default encryption. This parameter is allowed only if SSEAlgorithm is set to aws:kms. You can specify this parameter with the key ID or the Amazon Resource Name (ARN) of the KMS key
60
+ */
61
+ KMSMasterKeyID?: string;
62
+ SSEAlgorithm: "aws:kms" | "AES256";
63
+ };
64
+ /**
65
+ * Type definition for `AWS::S3Express::DirectoryBucket.ServerSideEncryptionRule`.
66
+ * Specifies the default server-side encryption configuration.
67
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-serversideencryptionrule.html}
68
+ */
69
+ export type ServerSideEncryptionRule = {
70
+ /**
71
+ * Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Amazon S3 Express One Zone uses an S3 Bucket Key with SSE-KMS and S3 Bucket Key cannot be disabled. It's only allowed to set the BucketKeyEnabled element to true.
72
+ */
73
+ BucketKeyEnabled?: boolean;
74
+ /**
75
+ * Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.
76
+ */
77
+ ServerSideEncryptionByDefault?: ServerSideEncryptionByDefault;
78
+ };
38
79
  /**
39
80
  * Resource Type definition for AWS::S3Express::DirectoryBucket.
40
81
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-directorybucket.html}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awboost/cfn-resource-types",
3
- "version": "0.1.158",
3
+ "version": "0.1.159",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },