AwsDocumentDatabaseClusterArgs

interface AwsDocumentDatabaseClusterArgs {
applyImmediately?: boolean;
availabilityZones: [string, string, string];
backupRetentionPeriod?: Input<number>;
backupWindow?: Input<string>;
dbSubnetGroup: Input<string> | SubnetGroup;
decommission?: AwsDocumentDatabaseDecommissionArgs;
engineVersion: string;
exportedLogs?: 'profiler'[];
identity: string;
instances: Record<string, AwsDocumentDatabaseInstanceArgs>;
kmsKey?: AwsKmsKeyInput;
maintenanceWindow?: Input<string>;
masterUsername?: Input<string>;
parameterGroup: AwsDocumentDatabase;
securityGroups: (Input<string> | SecurityGroup)[];
storageType?: 'standard' | 'iopt1';
tags?: AwsDocumentDatabaseTags;
}

Inputs for the managed DocumentDB cluster capability.

Example

CODE

import { AwsDocumentDatabase, type AwsDocumentDatabaseClusterArgs } from '@jobcloud/aws-documentdb';

const ordersTuning = new AwsDocumentDatabase({ parameterGroup: { name: 'ordersTuning', family: 'docdb5.0' } });
const cluster: AwsDocumentDatabaseClusterArgs = {
  identity: 'orders', engineVersion: '5.0.0', dbSubnetGroup: 'shared-documentdb', securityGroups: ['sg-123'],
  parameterGroup: ordersTuning, availabilityZones: ['eu-west-1a', 'eu-west-1b', 'eu-west-1c'],
  instances: { '01': { instanceClass: 'db.r6g.large' } },
};

Properties

`applyImmediately: boolean`

Applies eligible changes immediately. Defaults to true.

`availabilityZones: [string, string, string]`

Exactly three availability zones, preventing provider-generated drift.

`backupRetentionPeriod: Input<number>`

Automated-backup retention period. Defaults to 7 days in prd, otherwise 1 day.

`backupWindow: Input<string>`

Backup window. Defaults to 00:00-01:00.

`dbSubnetGroup: Input<string> | SubnetGroup`

Shared RDS/DocumentDB subnet group resource or its name.

`decommission: AwsDocumentDatabaseDecommissionArgs`

Explicitly permits a later component removal.

`engineVersion: string`

Exact DocumentDB engine version.

`exportedLogs: 'profiler'[]`

Optional additive profiler-log export. Audit logging is always enabled.

`identity: string`

Stable logical-only synchronous identity for the component URN.

`instances: Record<string, AwsDocumentDatabaseInstanceArgs>`

Stable keyed instances. Keys must be two-digit indices, such as 01 and 02.

`kmsKey: AwsKmsKeyInput`

Optional customer-managed storage-encryption KMS key.

`maintenanceWindow: Input<string>`

Maintenance window. Defaults to Thursday in prd, Tuesday otherwise.

`masterUsername: Input<string>`

Master username. Defaults to root; AWS Secrets Manager manages the password.

`parameterGroup: AwsDocumentDatabase`

Safe parameter-group capability reference from another AwsDocumentDatabase instance.

`securityGroups: (Input<string> | SecurityGroup)[]`

Security groups permitted to connect to the private cluster.

`storageType: 'standard' | 'iopt1'`

Storage type. Defaults to standard.

`tags: AwsDocumentDatabaseTags`

Additional tags. The Name tag is reserved.