-
Notifications
You must be signed in to change notification settings - Fork 155
/
catalogTable.ts
290 lines (284 loc) · 14.5 KB
/
catalogTable.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
import * as pulumi from "@pulumi/pulumi";
import * as utilities from "../utilities";
/**
* Provides a Glue Catalog Table Resource. You can refer to the [Glue Developer Guide](http://docs.aws.amazon.com/glue/latest/dg/populate-data-catalog.html) for a full explanation of the Glue Data Catalog functionality.
*
* ## Example Usage
*
* ### Basic Table
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const awsGlueCatalogTable = new aws.glue.CatalogTable("aws_glue_catalog_table", {
* databaseName: "MyCatalogDatabase",
* });
* ```
*
* ### Parquet Table for Athena
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const awsGlueCatalogTable = new aws.glue.CatalogTable("aws_glue_catalog_table", {
* databaseName: "MyCatalogDatabase",
* parameters: {
* EXTERNAL: "TRUE",
* "parquet.compression": "SNAPPY",
* },
* storageDescriptor: {
* columns: [
* {
* name: "my_string",
* type: "string",
* },
* {
* name: "my_double",
* type: "double",
* },
* {
* comment: "",
* name: "my_date",
* type: "date",
* },
* {
* comment: "",
* name: "my_bigint",
* type: "bigint",
* },
* {
* comment: "",
* name: "my_struct",
* type: "struct<my_nested_string:string>",
* },
* ],
* inputFormat: "org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat",
* location: "s3://my-bucket/event-streams/my-stream",
* outputFormat: "org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat",
* serDeInfo: {
* name: "my-stream",
* parameters: {
* "serialization.format": 1,
* },
* serializationLibrary: "org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe",
* },
* },
* tableType: "EXTERNAL_TABLE",
* });
* ```
*/
export class CatalogTable extends pulumi.CustomResource {
/**
* Get an existing CatalogTable resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
*/
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CatalogTableState, opts?: pulumi.CustomResourceOptions): CatalogTable {
return new CatalogTable(name, <any>state, { ...opts, id: id });
}
/**
* ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name.
*/
public readonly catalogId!: pulumi.Output<string>;
/**
* Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
*/
public readonly databaseName!: pulumi.Output<string>;
/**
* Description of the table.
*/
public readonly description!: pulumi.Output<string | undefined>;
/**
* Name of the SerDe.
*/
public readonly name!: pulumi.Output<string>;
/**
* Owner of the table.
*/
public readonly owner!: pulumi.Output<string | undefined>;
/**
* A map of initialization parameters for the SerDe, in key-value form.
*/
public readonly parameters!: pulumi.Output<{[key: string]: string} | undefined>;
/**
* A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
*/
public readonly partitionKeys!: pulumi.Output<{ comment?: string, name: string, type?: string }[] | undefined>;
/**
* Retention time for this table.
*/
public readonly retention!: pulumi.Output<number | undefined>;
/**
* A storage descriptor object containing information about the physical storage of this table. You can refer to the [Glue Developer Guide](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-tables.html#aws-glue-api-catalog-tables-StorageDescriptor) for a full explanation of this object.
*/
public readonly storageDescriptor!: pulumi.Output<{ bucketColumns?: string[], columns?: { comment?: string, name: string, type?: string }[], compressed?: boolean, inputFormat?: string, location?: string, numberOfBuckets?: number, outputFormat?: string, parameters?: {[key: string]: string}, serDeInfo?: { name?: string, parameters?: {[key: string]: string}, serializationLibrary?: string }, skewedInfo?: { skewedColumnNames?: string[], skewedColumnValueLocationMaps?: {[key: string]: string}, skewedColumnValues?: string[] }, sortColumns?: { column: string, sortOrder: number }[], storedAsSubDirectories?: boolean } | undefined>;
/**
* The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).
*/
public readonly tableType!: pulumi.Output<string | undefined>;
/**
* If the table is a view, the expanded text of the view; otherwise null.
*/
public readonly viewExpandedText!: pulumi.Output<string | undefined>;
/**
* If the table is a view, the original text of the view; otherwise null.
*/
public readonly viewOriginalText!: pulumi.Output<string | undefined>;
/**
* Create a CatalogTable resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: CatalogTableArgs, opts?: pulumi.CustomResourceOptions)
constructor(name: string, argsOrState?: CatalogTableArgs | CatalogTableState, opts?: pulumi.CustomResourceOptions) {
let inputs: pulumi.Inputs = {};
if (opts && opts.id) {
const state = argsOrState as CatalogTableState | undefined;
inputs["catalogId"] = state ? state.catalogId : undefined;
inputs["databaseName"] = state ? state.databaseName : undefined;
inputs["description"] = state ? state.description : undefined;
inputs["name"] = state ? state.name : undefined;
inputs["owner"] = state ? state.owner : undefined;
inputs["parameters"] = state ? state.parameters : undefined;
inputs["partitionKeys"] = state ? state.partitionKeys : undefined;
inputs["retention"] = state ? state.retention : undefined;
inputs["storageDescriptor"] = state ? state.storageDescriptor : undefined;
inputs["tableType"] = state ? state.tableType : undefined;
inputs["viewExpandedText"] = state ? state.viewExpandedText : undefined;
inputs["viewOriginalText"] = state ? state.viewOriginalText : undefined;
} else {
const args = argsOrState as CatalogTableArgs | undefined;
if (!args || args.databaseName === undefined) {
throw new Error("Missing required property 'databaseName'");
}
inputs["catalogId"] = args ? args.catalogId : undefined;
inputs["databaseName"] = args ? args.databaseName : undefined;
inputs["description"] = args ? args.description : undefined;
inputs["name"] = args ? args.name : undefined;
inputs["owner"] = args ? args.owner : undefined;
inputs["parameters"] = args ? args.parameters : undefined;
inputs["partitionKeys"] = args ? args.partitionKeys : undefined;
inputs["retention"] = args ? args.retention : undefined;
inputs["storageDescriptor"] = args ? args.storageDescriptor : undefined;
inputs["tableType"] = args ? args.tableType : undefined;
inputs["viewExpandedText"] = args ? args.viewExpandedText : undefined;
inputs["viewOriginalText"] = args ? args.viewOriginalText : undefined;
}
super("aws:glue/catalogTable:CatalogTable", name, inputs, opts);
}
}
/**
* Input properties used for looking up and filtering CatalogTable resources.
*/
export interface CatalogTableState {
/**
* ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name.
*/
readonly catalogId?: pulumi.Input<string>;
/**
* Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
*/
readonly databaseName?: pulumi.Input<string>;
/**
* Description of the table.
*/
readonly description?: pulumi.Input<string>;
/**
* Name of the SerDe.
*/
readonly name?: pulumi.Input<string>;
/**
* Owner of the table.
*/
readonly owner?: pulumi.Input<string>;
/**
* A map of initialization parameters for the SerDe, in key-value form.
*/
readonly parameters?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
/**
* A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
*/
readonly partitionKeys?: pulumi.Input<pulumi.Input<{ comment?: pulumi.Input<string>, name: pulumi.Input<string>, type?: pulumi.Input<string> }>[]>;
/**
* Retention time for this table.
*/
readonly retention?: pulumi.Input<number>;
/**
* A storage descriptor object containing information about the physical storage of this table. You can refer to the [Glue Developer Guide](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-tables.html#aws-glue-api-catalog-tables-StorageDescriptor) for a full explanation of this object.
*/
readonly storageDescriptor?: pulumi.Input<{ bucketColumns?: pulumi.Input<pulumi.Input<string>[]>, columns?: pulumi.Input<pulumi.Input<{ comment?: pulumi.Input<string>, name: pulumi.Input<string>, type?: pulumi.Input<string> }>[]>, compressed?: pulumi.Input<boolean>, inputFormat?: pulumi.Input<string>, location?: pulumi.Input<string>, numberOfBuckets?: pulumi.Input<number>, outputFormat?: pulumi.Input<string>, parameters?: pulumi.Input<{[key: string]: pulumi.Input<string>}>, serDeInfo?: pulumi.Input<{ name?: pulumi.Input<string>, parameters?: pulumi.Input<{[key: string]: pulumi.Input<string>}>, serializationLibrary?: pulumi.Input<string> }>, skewedInfo?: pulumi.Input<{ skewedColumnNames?: pulumi.Input<pulumi.Input<string>[]>, skewedColumnValueLocationMaps?: pulumi.Input<{[key: string]: pulumi.Input<string>}>, skewedColumnValues?: pulumi.Input<pulumi.Input<string>[]> }>, sortColumns?: pulumi.Input<pulumi.Input<{ column: pulumi.Input<string>, sortOrder: pulumi.Input<number> }>[]>, storedAsSubDirectories?: pulumi.Input<boolean> }>;
/**
* The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).
*/
readonly tableType?: pulumi.Input<string>;
/**
* If the table is a view, the expanded text of the view; otherwise null.
*/
readonly viewExpandedText?: pulumi.Input<string>;
/**
* If the table is a view, the original text of the view; otherwise null.
*/
readonly viewOriginalText?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a CatalogTable resource.
*/
export interface CatalogTableArgs {
/**
* ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name.
*/
readonly catalogId?: pulumi.Input<string>;
/**
* Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.
*/
readonly databaseName: pulumi.Input<string>;
/**
* Description of the table.
*/
readonly description?: pulumi.Input<string>;
/**
* Name of the SerDe.
*/
readonly name?: pulumi.Input<string>;
/**
* Owner of the table.
*/
readonly owner?: pulumi.Input<string>;
/**
* A map of initialization parameters for the SerDe, in key-value form.
*/
readonly parameters?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
/**
* A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
*/
readonly partitionKeys?: pulumi.Input<pulumi.Input<{ comment?: pulumi.Input<string>, name: pulumi.Input<string>, type?: pulumi.Input<string> }>[]>;
/**
* Retention time for this table.
*/
readonly retention?: pulumi.Input<number>;
/**
* A storage descriptor object containing information about the physical storage of this table. You can refer to the [Glue Developer Guide](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-tables.html#aws-glue-api-catalog-tables-StorageDescriptor) for a full explanation of this object.
*/
readonly storageDescriptor?: pulumi.Input<{ bucketColumns?: pulumi.Input<pulumi.Input<string>[]>, columns?: pulumi.Input<pulumi.Input<{ comment?: pulumi.Input<string>, name: pulumi.Input<string>, type?: pulumi.Input<string> }>[]>, compressed?: pulumi.Input<boolean>, inputFormat?: pulumi.Input<string>, location?: pulumi.Input<string>, numberOfBuckets?: pulumi.Input<number>, outputFormat?: pulumi.Input<string>, parameters?: pulumi.Input<{[key: string]: pulumi.Input<string>}>, serDeInfo?: pulumi.Input<{ name?: pulumi.Input<string>, parameters?: pulumi.Input<{[key: string]: pulumi.Input<string>}>, serializationLibrary?: pulumi.Input<string> }>, skewedInfo?: pulumi.Input<{ skewedColumnNames?: pulumi.Input<pulumi.Input<string>[]>, skewedColumnValueLocationMaps?: pulumi.Input<{[key: string]: pulumi.Input<string>}>, skewedColumnValues?: pulumi.Input<pulumi.Input<string>[]> }>, sortColumns?: pulumi.Input<pulumi.Input<{ column: pulumi.Input<string>, sortOrder: pulumi.Input<number> }>[]>, storedAsSubDirectories?: pulumi.Input<boolean> }>;
/**
* The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).
*/
readonly tableType?: pulumi.Input<string>;
/**
* If the table is a view, the expanded text of the view; otherwise null.
*/
readonly viewExpandedText?: pulumi.Input<string>;
/**
* If the table is a view, the original text of the view; otherwise null.
*/
readonly viewOriginalText?: pulumi.Input<string>;
}