AwsDocumentDatabaseClusterCapabilityArgs

interface AwsDocumentDatabaseClusterCapabilityArgs {
cluster: AwsDocumentDatabaseClusterArgs;
parameterGroup?: undefined;
}

Cluster capability for AwsDocumentDatabase.

Example

CODE

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

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

Properties

`cluster: AwsDocumentDatabaseClusterArgs`

Managed private DocumentDB cluster configuration.

`parameterGroup: undefined`

Unavailable when the cluster capability is selected.