CloudKitect Database Instance component.

Default Configuration

Allocated Storage: 100 GB Backup Retention: 35 days Log Retention: 7 years Max Storage Autoscaling: 10000 GB Removal Policy: Retain in Production Monitoring Interval: 60 sec

Default Alarms

  1. Free storage space alerts
    • Risk Level: High
    • Well Architected Pillar: Reliability
  2. CPU Utilization alert
    • Risk Level: High
    • Well Architected Pillar: Reliability, Performance, Operational Excellence

Note that the default alarm uses the CcAlarm construct, which sets up an alarm action to notify the SNS Topic AlarmEventsTopic by default.

Examples

Default Usage

new CcDatabaseInstance(this, "LogicalId", {});

Custom Configuration

new CcDatabaseInstance(this, "LogicalId", {
allocatedStorage: 100
});

Compliance

It addresses the following compliance requirements

  1. Databases are protected from accidental deletion in production
    • Risk Level: Medium
    • Compliance: NIST4
    • Well Architected Pillar: Operational Excellence
  2. Auto minor version updates
    • Risk Level: Medium
    • Compliance: APRA, MAS, NIST4
    • Well Architected Pillar: Operational Excellence
  3. Copy tags to snapshots
    • Risk Level: High
    • Compliance: NA
    • Well Architected Pillar: Operational Excellence
  4. Instance storage autoscaling
    • Risk Level: High
    • Compliance: NA
    • Well Architected Pillar: Performance, Reliability
  5. Encrypted snapshots
    • Risk Level: Medium
    • Compliance: APRA, MAS
    • Well Architected Pillar: Security
  6. Performance insights
    • Risk Level: Low
    • Compliance: NA
    • Well Architected Pillar: Reliability, Performance, Operational Excellence
  7. Auto minor version update
    • Risk Level: Medium
    • Compliance: APRA, MAS, NIST4
    • Well Architected Pillar: Security
  8. Auto backup
    • Risk Level: High
    • Compliance: NIST4
    • Well Architected Pillar: Reliability
  9. Do not user default ports
    • Risk Level: Low
    • Compliance: PCI, APRA, NIST4
    • Well Architected Pillar: Security
  10. Storage encryption enabled
    • Risk Level: High
    • Compliance: PCI, HIPAA, GDPR, ARPA, MAS, NIST4
    • Well Architected Pillar: Security
  11. Instance not publicly available
    • Risk Level: High
    • Compliance: PCI, HIPAA, GDPR, ARPA, MAS, NIST4
    • Well Architected Pillar: Security
  12. Backup retention period
    • Risk Level: Medium
    • Compliance: NIST4
    • Well Architected Pillar: Reliability
  13. Use general purpose SSD
    • Risk Level: Low
    • Compliance: NA
    • Well Architected Pillar: Cost Optimization
  14. Use MultiAZ
    • Risk Level: Medium
    • Compliance: NIST4
    • Well Architected Pillar: Reliability

Compliance Check Report

Hierarchy

  • DatabaseInstance
    • CcDatabaseInstance

Constructors

Properties

alarms: Alarms = ...

All the default alarms configured for the CloudKitect Database Instance.

credSecretName: string
dbSecret: DatabaseSecret
port: number

Methods

  • Returns void

  • Returns void

  • Parameters

    • scope: Construct

    Returns string

  • Parameters

    • id: string

    Returns string

Generated using TypeDoc