-
Notifications
You must be signed in to change notification settings - Fork 155
/
cluster.ts
592 lines (584 loc) · 29 KB
/
cluster.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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
// *** 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 inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
import * as utilities from "../utilities";
/**
* Manages a DocumentDB Cluster.
*
* Changes to a DocumentDB Cluster can occur when you manually change a
* parameter, such as `port`, and are reflected in the next maintenance
* window. Because of this, this provider may report a difference in its planning
* phase because a modification has not yet taken place. You can use the
* `applyImmediately` flag to instruct the service to apply the change immediately
* (see documentation below).
*
* > **Note:** using `applyImmediately` can result in a brief downtime as the server reboots.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const docdb = new aws.docdb.Cluster("docdb", {
* clusterIdentifier: "my-docdb-cluster",
* engine: "docdb",
* masterUsername: "foo",
* masterPassword: "mustbeeightchars",
* backupRetentionPeriod: 5,
* preferredBackupWindow: "07:00-09:00",
* skipFinalSnapshot: true,
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import DocumentDB Clusters using the `cluster_identifier`. For example:
*
* ```sh
* $ pulumi import aws:docdb/cluster:Cluster docdb_cluster docdb-prod-cluster
* ```
*/
export class Cluster extends pulumi.CustomResource {
/**
* Get an existing Cluster 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.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterState, opts?: pulumi.CustomResourceOptions): Cluster {
return new Cluster(name, <any>state, { ...opts, id: id });
}
/** @internal */
public static readonly __pulumiType = 'aws:docdb/cluster:Cluster';
/**
* Returns true if the given object is an instance of Cluster. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
public static isInstance(obj: any): obj is Cluster {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Cluster.__pulumiType;
}
/**
* A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
*/
public readonly allowMajorVersionUpgrade!: pulumi.Output<boolean | undefined>;
/**
* Specifies whether any cluster modifications
* are applied immediately, or during the next maintenance window. Default is
* `false`.
*/
public readonly applyImmediately!: pulumi.Output<boolean | undefined>;
/**
* Amazon Resource Name (ARN) of cluster
*/
public /*out*/ readonly arn!: pulumi.Output<string>;
/**
* A list of EC2 Availability Zones that
* instances in the DB cluster can be created in.
*/
public readonly availabilityZones!: pulumi.Output<string[]>;
/**
* The days to retain backups for. Default `1`
*/
public readonly backupRetentionPeriod!: pulumi.Output<number | undefined>;
/**
* The cluster identifier. If omitted, the provider will assign a random, unique identifier.
*/
public readonly clusterIdentifier!: pulumi.Output<string>;
/**
* Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `clusterIdentifier`.
*/
public readonly clusterIdentifierPrefix!: pulumi.Output<string>;
/**
* List of DocumentDB Instances that are a part of this cluster
*/
public readonly clusterMembers!: pulumi.Output<string[]>;
/**
* The DocumentDB Cluster Resource ID
*/
public /*out*/ readonly clusterResourceId!: pulumi.Output<string>;
/**
* A cluster parameter group to associate with the cluster.
*/
public readonly dbClusterParameterGroupName!: pulumi.Output<string>;
/**
* A DB subnet group to associate with this DB instance.
*/
public readonly dbSubnetGroupName!: pulumi.Output<string>;
/**
* A boolean value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. Defaults to `false`.
*/
public readonly deletionProtection!: pulumi.Output<boolean | undefined>;
/**
* List of log types to export to cloudwatch. If omitted, no logs will be exported.
* The following log types are supported: `audit`, `profiler`.
*/
public readonly enabledCloudwatchLogsExports!: pulumi.Output<string[] | undefined>;
/**
* The DNS address of the DocumentDB instance
*/
public /*out*/ readonly endpoint!: pulumi.Output<string>;
/**
* The name of the database engine to be used for this DB cluster. Defaults to `docdb`. Valid values: `docdb`.
*/
public readonly engine!: pulumi.Output<string | undefined>;
/**
* The database engine version. Updating this argument results in an outage.
*/
public readonly engineVersion!: pulumi.Output<string>;
/**
* The name of your final DB snapshot
* when this DB cluster is deleted. If omitted, no final snapshot will be
* made.
*/
public readonly finalSnapshotIdentifier!: pulumi.Output<string | undefined>;
/**
* The global cluster identifier specified on `aws.docdb.GlobalCluster`.
*/
public readonly globalClusterIdentifier!: pulumi.Output<string | undefined>;
/**
* The Route53 Hosted Zone ID of the endpoint
*/
public /*out*/ readonly hostedZoneId!: pulumi.Output<string>;
/**
* The ARN for the KMS encryption key. When specifying `kmsKeyId`, `storageEncrypted` needs to be set to true.
*/
public readonly kmsKeyId!: pulumi.Output<string>;
/**
* Password for the master DB user. Note that this may
* show up in logs, and it will be stored in the state file. Please refer to the DocumentDB Naming Constraints.
*/
public readonly masterPassword!: pulumi.Output<string | undefined>;
/**
* Username for the master DB user.
*/
public readonly masterUsername!: pulumi.Output<string>;
/**
* The port on which the DB accepts connections
*/
public readonly port!: pulumi.Output<number | undefined>;
/**
* The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC
* Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00
*/
public readonly preferredBackupWindow!: pulumi.Output<string>;
/**
* The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
*/
public readonly preferredMaintenanceWindow!: pulumi.Output<string>;
/**
* A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
*/
public /*out*/ readonly readerEndpoint!: pulumi.Output<string>;
/**
* A configuration block for restoring a DB instance to an arbitrary point in time. Requires the `identifier` argument to be set with the name of the new DB instance to be created. See Restore To Point In Time below for details.
*/
public readonly restoreToPointInTime!: pulumi.Output<outputs.docdb.ClusterRestoreToPointInTime | undefined>;
/**
* Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from `finalSnapshotIdentifier`. Default is `false`.
*/
public readonly skipFinalSnapshot!: pulumi.Output<boolean | undefined>;
/**
* Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Automated snapshots **should not** be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
*/
public readonly snapshotIdentifier!: pulumi.Output<string | undefined>;
/**
* Specifies whether the DB cluster is encrypted. The default is `false`.
*/
public readonly storageEncrypted!: pulumi.Output<boolean | undefined>;
/**
* The storage type to associate with the DB cluster. Valid values: `standard`, `iopt1`.
*/
public readonly storageType!: pulumi.Output<string | undefined>;
/**
* A map of tags to assign to the DB cluster. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
public readonly tags!: pulumi.Output<{[key: string]: string} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*
* @deprecated Please use `tags` instead.
*/
public /*out*/ readonly tagsAll!: pulumi.Output<{[key: string]: string}>;
/**
* List of VPC security groups to associate
* with the Cluster
*/
public readonly vpcSecurityGroupIds!: pulumi.Output<string[]>;
/**
* Create a Cluster 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?: ClusterArgs, opts?: pulumi.CustomResourceOptions)
constructor(name: string, argsOrState?: ClusterArgs | ClusterState, opts?: pulumi.CustomResourceOptions) {
let resourceInputs: pulumi.Inputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState as ClusterState | undefined;
resourceInputs["allowMajorVersionUpgrade"] = state ? state.allowMajorVersionUpgrade : undefined;
resourceInputs["applyImmediately"] = state ? state.applyImmediately : undefined;
resourceInputs["arn"] = state ? state.arn : undefined;
resourceInputs["availabilityZones"] = state ? state.availabilityZones : undefined;
resourceInputs["backupRetentionPeriod"] = state ? state.backupRetentionPeriod : undefined;
resourceInputs["clusterIdentifier"] = state ? state.clusterIdentifier : undefined;
resourceInputs["clusterIdentifierPrefix"] = state ? state.clusterIdentifierPrefix : undefined;
resourceInputs["clusterMembers"] = state ? state.clusterMembers : undefined;
resourceInputs["clusterResourceId"] = state ? state.clusterResourceId : undefined;
resourceInputs["dbClusterParameterGroupName"] = state ? state.dbClusterParameterGroupName : undefined;
resourceInputs["dbSubnetGroupName"] = state ? state.dbSubnetGroupName : undefined;
resourceInputs["deletionProtection"] = state ? state.deletionProtection : undefined;
resourceInputs["enabledCloudwatchLogsExports"] = state ? state.enabledCloudwatchLogsExports : undefined;
resourceInputs["endpoint"] = state ? state.endpoint : undefined;
resourceInputs["engine"] = state ? state.engine : undefined;
resourceInputs["engineVersion"] = state ? state.engineVersion : undefined;
resourceInputs["finalSnapshotIdentifier"] = state ? state.finalSnapshotIdentifier : undefined;
resourceInputs["globalClusterIdentifier"] = state ? state.globalClusterIdentifier : undefined;
resourceInputs["hostedZoneId"] = state ? state.hostedZoneId : undefined;
resourceInputs["kmsKeyId"] = state ? state.kmsKeyId : undefined;
resourceInputs["masterPassword"] = state ? state.masterPassword : undefined;
resourceInputs["masterUsername"] = state ? state.masterUsername : undefined;
resourceInputs["port"] = state ? state.port : undefined;
resourceInputs["preferredBackupWindow"] = state ? state.preferredBackupWindow : undefined;
resourceInputs["preferredMaintenanceWindow"] = state ? state.preferredMaintenanceWindow : undefined;
resourceInputs["readerEndpoint"] = state ? state.readerEndpoint : undefined;
resourceInputs["restoreToPointInTime"] = state ? state.restoreToPointInTime : undefined;
resourceInputs["skipFinalSnapshot"] = state ? state.skipFinalSnapshot : undefined;
resourceInputs["snapshotIdentifier"] = state ? state.snapshotIdentifier : undefined;
resourceInputs["storageEncrypted"] = state ? state.storageEncrypted : undefined;
resourceInputs["storageType"] = state ? state.storageType : undefined;
resourceInputs["tags"] = state ? state.tags : undefined;
resourceInputs["tagsAll"] = state ? state.tagsAll : undefined;
resourceInputs["vpcSecurityGroupIds"] = state ? state.vpcSecurityGroupIds : undefined;
} else {
const args = argsOrState as ClusterArgs | undefined;
resourceInputs["allowMajorVersionUpgrade"] = args ? args.allowMajorVersionUpgrade : undefined;
resourceInputs["applyImmediately"] = args ? args.applyImmediately : undefined;
resourceInputs["availabilityZones"] = args ? args.availabilityZones : undefined;
resourceInputs["backupRetentionPeriod"] = args ? args.backupRetentionPeriod : undefined;
resourceInputs["clusterIdentifier"] = args ? args.clusterIdentifier : undefined;
resourceInputs["clusterIdentifierPrefix"] = args ? args.clusterIdentifierPrefix : undefined;
resourceInputs["clusterMembers"] = args ? args.clusterMembers : undefined;
resourceInputs["dbClusterParameterGroupName"] = args ? args.dbClusterParameterGroupName : undefined;
resourceInputs["dbSubnetGroupName"] = args ? args.dbSubnetGroupName : undefined;
resourceInputs["deletionProtection"] = args ? args.deletionProtection : undefined;
resourceInputs["enabledCloudwatchLogsExports"] = args ? args.enabledCloudwatchLogsExports : undefined;
resourceInputs["engine"] = args ? args.engine : undefined;
resourceInputs["engineVersion"] = args ? args.engineVersion : undefined;
resourceInputs["finalSnapshotIdentifier"] = args ? args.finalSnapshotIdentifier : undefined;
resourceInputs["globalClusterIdentifier"] = args ? args.globalClusterIdentifier : undefined;
resourceInputs["kmsKeyId"] = args ? args.kmsKeyId : undefined;
resourceInputs["masterPassword"] = args?.masterPassword ? pulumi.secret(args.masterPassword) : undefined;
resourceInputs["masterUsername"] = args ? args.masterUsername : undefined;
resourceInputs["port"] = args ? args.port : undefined;
resourceInputs["preferredBackupWindow"] = args ? args.preferredBackupWindow : undefined;
resourceInputs["preferredMaintenanceWindow"] = args ? args.preferredMaintenanceWindow : undefined;
resourceInputs["restoreToPointInTime"] = args ? args.restoreToPointInTime : undefined;
resourceInputs["skipFinalSnapshot"] = args ? args.skipFinalSnapshot : undefined;
resourceInputs["snapshotIdentifier"] = args ? args.snapshotIdentifier : undefined;
resourceInputs["storageEncrypted"] = args ? args.storageEncrypted : undefined;
resourceInputs["storageType"] = args ? args.storageType : undefined;
resourceInputs["tags"] = args ? args.tags : undefined;
resourceInputs["vpcSecurityGroupIds"] = args ? args.vpcSecurityGroupIds : undefined;
resourceInputs["arn"] = undefined /*out*/;
resourceInputs["clusterResourceId"] = undefined /*out*/;
resourceInputs["endpoint"] = undefined /*out*/;
resourceInputs["hostedZoneId"] = undefined /*out*/;
resourceInputs["readerEndpoint"] = undefined /*out*/;
resourceInputs["tagsAll"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const secretOpts = { additionalSecretOutputs: ["masterPassword"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(Cluster.__pulumiType, name, resourceInputs, opts);
}
}
/**
* Input properties used for looking up and filtering Cluster resources.
*/
export interface ClusterState {
/**
* A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
*/
allowMajorVersionUpgrade?: pulumi.Input<boolean>;
/**
* Specifies whether any cluster modifications
* are applied immediately, or during the next maintenance window. Default is
* `false`.
*/
applyImmediately?: pulumi.Input<boolean>;
/**
* Amazon Resource Name (ARN) of cluster
*/
arn?: pulumi.Input<string>;
/**
* A list of EC2 Availability Zones that
* instances in the DB cluster can be created in.
*/
availabilityZones?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The days to retain backups for. Default `1`
*/
backupRetentionPeriod?: pulumi.Input<number>;
/**
* The cluster identifier. If omitted, the provider will assign a random, unique identifier.
*/
clusterIdentifier?: pulumi.Input<string>;
/**
* Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `clusterIdentifier`.
*/
clusterIdentifierPrefix?: pulumi.Input<string>;
/**
* List of DocumentDB Instances that are a part of this cluster
*/
clusterMembers?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The DocumentDB Cluster Resource ID
*/
clusterResourceId?: pulumi.Input<string>;
/**
* A cluster parameter group to associate with the cluster.
*/
dbClusterParameterGroupName?: pulumi.Input<string>;
/**
* A DB subnet group to associate with this DB instance.
*/
dbSubnetGroupName?: pulumi.Input<string>;
/**
* A boolean value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. Defaults to `false`.
*/
deletionProtection?: pulumi.Input<boolean>;
/**
* List of log types to export to cloudwatch. If omitted, no logs will be exported.
* The following log types are supported: `audit`, `profiler`.
*/
enabledCloudwatchLogsExports?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The DNS address of the DocumentDB instance
*/
endpoint?: pulumi.Input<string>;
/**
* The name of the database engine to be used for this DB cluster. Defaults to `docdb`. Valid values: `docdb`.
*/
engine?: pulumi.Input<string>;
/**
* The database engine version. Updating this argument results in an outage.
*/
engineVersion?: pulumi.Input<string>;
/**
* The name of your final DB snapshot
* when this DB cluster is deleted. If omitted, no final snapshot will be
* made.
*/
finalSnapshotIdentifier?: pulumi.Input<string>;
/**
* The global cluster identifier specified on `aws.docdb.GlobalCluster`.
*/
globalClusterIdentifier?: pulumi.Input<string>;
/**
* The Route53 Hosted Zone ID of the endpoint
*/
hostedZoneId?: pulumi.Input<string>;
/**
* The ARN for the KMS encryption key. When specifying `kmsKeyId`, `storageEncrypted` needs to be set to true.
*/
kmsKeyId?: pulumi.Input<string>;
/**
* Password for the master DB user. Note that this may
* show up in logs, and it will be stored in the state file. Please refer to the DocumentDB Naming Constraints.
*/
masterPassword?: pulumi.Input<string>;
/**
* Username for the master DB user.
*/
masterUsername?: pulumi.Input<string>;
/**
* The port on which the DB accepts connections
*/
port?: pulumi.Input<number>;
/**
* The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC
* Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00
*/
preferredBackupWindow?: pulumi.Input<string>;
/**
* The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
*/
preferredMaintenanceWindow?: pulumi.Input<string>;
/**
* A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas
*/
readerEndpoint?: pulumi.Input<string>;
/**
* A configuration block for restoring a DB instance to an arbitrary point in time. Requires the `identifier` argument to be set with the name of the new DB instance to be created. See Restore To Point In Time below for details.
*/
restoreToPointInTime?: pulumi.Input<inputs.docdb.ClusterRestoreToPointInTime>;
/**
* Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from `finalSnapshotIdentifier`. Default is `false`.
*/
skipFinalSnapshot?: pulumi.Input<boolean>;
/**
* Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Automated snapshots **should not** be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
*/
snapshotIdentifier?: pulumi.Input<string>;
/**
* Specifies whether the DB cluster is encrypted. The default is `false`.
*/
storageEncrypted?: pulumi.Input<boolean>;
/**
* The storage type to associate with the DB cluster. Valid values: `standard`, `iopt1`.
*/
storageType?: pulumi.Input<string>;
/**
* A map of tags to assign to the DB cluster. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*
* @deprecated Please use `tags` instead.
*/
tagsAll?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
/**
* List of VPC security groups to associate
* with the Cluster
*/
vpcSecurityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a Cluster resource.
*/
export interface ClusterArgs {
/**
* A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
*/
allowMajorVersionUpgrade?: pulumi.Input<boolean>;
/**
* Specifies whether any cluster modifications
* are applied immediately, or during the next maintenance window. Default is
* `false`.
*/
applyImmediately?: pulumi.Input<boolean>;
/**
* A list of EC2 Availability Zones that
* instances in the DB cluster can be created in.
*/
availabilityZones?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The days to retain backups for. Default `1`
*/
backupRetentionPeriod?: pulumi.Input<number>;
/**
* The cluster identifier. If omitted, the provider will assign a random, unique identifier.
*/
clusterIdentifier?: pulumi.Input<string>;
/**
* Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `clusterIdentifier`.
*/
clusterIdentifierPrefix?: pulumi.Input<string>;
/**
* List of DocumentDB Instances that are a part of this cluster
*/
clusterMembers?: pulumi.Input<pulumi.Input<string>[]>;
/**
* A cluster parameter group to associate with the cluster.
*/
dbClusterParameterGroupName?: pulumi.Input<string>;
/**
* A DB subnet group to associate with this DB instance.
*/
dbSubnetGroupName?: pulumi.Input<string>;
/**
* A boolean value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. Defaults to `false`.
*/
deletionProtection?: pulumi.Input<boolean>;
/**
* List of log types to export to cloudwatch. If omitted, no logs will be exported.
* The following log types are supported: `audit`, `profiler`.
*/
enabledCloudwatchLogsExports?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name of the database engine to be used for this DB cluster. Defaults to `docdb`. Valid values: `docdb`.
*/
engine?: pulumi.Input<string>;
/**
* The database engine version. Updating this argument results in an outage.
*/
engineVersion?: pulumi.Input<string>;
/**
* The name of your final DB snapshot
* when this DB cluster is deleted. If omitted, no final snapshot will be
* made.
*/
finalSnapshotIdentifier?: pulumi.Input<string>;
/**
* The global cluster identifier specified on `aws.docdb.GlobalCluster`.
*/
globalClusterIdentifier?: pulumi.Input<string>;
/**
* The ARN for the KMS encryption key. When specifying `kmsKeyId`, `storageEncrypted` needs to be set to true.
*/
kmsKeyId?: pulumi.Input<string>;
/**
* Password for the master DB user. Note that this may
* show up in logs, and it will be stored in the state file. Please refer to the DocumentDB Naming Constraints.
*/
masterPassword?: pulumi.Input<string>;
/**
* Username for the master DB user.
*/
masterUsername?: pulumi.Input<string>;
/**
* The port on which the DB accepts connections
*/
port?: pulumi.Input<number>;
/**
* The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC
* Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00
*/
preferredBackupWindow?: pulumi.Input<string>;
/**
* The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
*/
preferredMaintenanceWindow?: pulumi.Input<string>;
/**
* A configuration block for restoring a DB instance to an arbitrary point in time. Requires the `identifier` argument to be set with the name of the new DB instance to be created. See Restore To Point In Time below for details.
*/
restoreToPointInTime?: pulumi.Input<inputs.docdb.ClusterRestoreToPointInTime>;
/**
* Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from `finalSnapshotIdentifier`. Default is `false`.
*/
skipFinalSnapshot?: pulumi.Input<boolean>;
/**
* Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Automated snapshots **should not** be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
*/
snapshotIdentifier?: pulumi.Input<string>;
/**
* Specifies whether the DB cluster is encrypted. The default is `false`.
*/
storageEncrypted?: pulumi.Input<boolean>;
/**
* The storage type to associate with the DB cluster. Valid values: `standard`, `iopt1`.
*/
storageType?: pulumi.Input<string>;
/**
* A map of tags to assign to the DB cluster. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
/**
* List of VPC security groups to associate
* with the Cluster
*/
vpcSecurityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;
}