feat: Added new DocumentDBCluster service

Author: Marco Franceschi

src/services/docdbCluster/data.ts

@@ -0,0 +1,135 @@
+import CloudGraph from '@cloudgraph/sdk'
+import DOCDB, {
+  DBCluster,
+  TagListMessage,
+  DescribeDBClustersMessage,
+  DBClusterMessage,
+  DBSubnetGroup,
+  DBSubnetGroupMessage,
+} from 'aws-sdk/clients/docdb'
+import { AWSError } from 'aws-sdk/lib/error'
+import groupBy from 'lodash/groupBy'
+import isEmpty from 'lodash/isEmpty'
+import { Config } from 'aws-sdk/lib/config'
+import awsLoggerText from '../../properties/logger'
+import { TagMap, AwsTag } from '../../types'
+import { convertAwsTagsToTagMap } from '../../utils/format'
+import AwsErrorLog from '../../utils/errorLog'
+import { initTestEndpoint } from '../../utils'
+
+const lt = { ...awsLoggerText }
+const { logger } = CloudGraph
+const serviceName = 'DOC DB cluster'
+const errorLog = new AwsErrorLog(serviceName)
+const endpoint = initTestEndpoint(serviceName)
+
+const listClustersForRegion = async (docdb: DOCDB): Promise<DBCluster[]> =>
+  new Promise<DBCluster[]>(resolve => {
+    const clusterList: DBCluster[] = []
+    const descClustersOpts: DescribeDBClustersMessage = {}
+    const listAllClusters = (token?: string): void => {
+      if (token) {
+        descClustersOpts.Marker = token
+      }
+      try {
+        docdb.describeDBClusters(
+          descClustersOpts,
+          (err: AWSError, data: DBClusterMessage) => {
+            const { Marker, DBClusters = [] } = data || {}
+            if (err) {
+              errorLog.generateAwsErrorLog({
+                functionName: 'docdb:describeDBClusters',
+                err,
+              })
+            }
+
+            clusterList.push(...DBClusters)
+
+            if (Marker) {
+              listAllClusters(Marker)
+            } else {
+              resolve(clusterList)
+            }
+          }
+        )
+      } catch (error) {
+        resolve([])
+      }
+    }
+    listAllClusters()
+  })
+
+const describeDBSubnetGroups = async (
+  docdb: DOCDB,
+  DBSubnetGroupName: string
+): Promise<DBSubnetGroup[]> =>
+  new Promise(resolve => {
+    try {
+      docdb.describeDBSubnetGroups(
+        { DBSubnetGroupName },
+        (err: AWSError, data: DBSubnetGroupMessage) => {
+          if (err) {
+            errorLog.generateAwsErrorLog({
+              functionName: 'docdb:describeDBSubnetGroups',
+              err,
+            })
+            return resolve([])
+          }
+          if (!isEmpty(data)) {
+            resolve(data.DBSubnetGroups)
+          }
+        }
+      )
+    } catch (error) {
+      resolve([])
+    }
+  })
+
+export interface RawAwsDocDBCluster extends DBCluster {
+  DbSubnetGroups: DBSubnetGroup[]
+  Tags?: TagMap
+  region: string
+}
+
+export default async ({
+  regions,
+  config,
+}: {
+  regions: string
+  config: Config
+}): Promise<{ [property: string]: RawAwsDocDBCluster[] }> =>
+  new Promise(async resolve => {
+    const docDBData: RawAwsDocDBCluster[] = []
+    const regionPromises = []
+
+    // Get all the clusters for the region
+    regions.split(',').map(region => {
+      const regionPromise = new Promise<void>(async resolveRegion => {
+        const docdb = new DOCDB({ ...config, region, endpoint })
+        const clusters = await listClustersForRegion(docdb)
+
+        if (!isEmpty(clusters)) {
+          docDBData.push(
+            ...(await Promise.all(
+              clusters.map(async cluster => ({
+                ...cluster,
+                DbSubnetGroups: await describeDBSubnetGroups(
+                  docdb,
+                  cluster.DBSubnetGroup
+                ),
+                region,
+              }))
+            ))
+          )
+        }
+        resolveRegion()
+      })
+      regionPromises.push(regionPromise)
+    })
+
+    await Promise.all(regionPromises)
+    logger.debug(lt.fetchedDocdbClusters(docDBData.length))
+    errorLog.reset()
+
+    resolve(groupBy(docDBData, 'region'))
+  })

src/services/docdbCluster/format.ts

@@ -0,0 +1,86 @@
+import { RawAwsDocDBCluster } from './data'
+import { AwsDocdbCluster } from '../../types/generated'
+import { formatTagsFromMap } from '../../utils/format'
+
+export default ({
+  service,
+  account,
+  region,
+}: {
+  service: RawAwsDocDBCluster
+  account: string
+  region: string
+}): AwsDocdbCluster => {
+  const {
+    AvailabilityZones = [],
+    BackupRetentionPeriod: backupRetentionPeriod,
+    DBClusterIdentifier: dBClusterIdentifier,
+    DBClusterParameterGroup: dBClusterParameterGroup,
+    DBSubnetGroup: dBSubnetGroup,
+    Status: status,
+    PercentProgress: percentProgress,
+    EarliestRestorableTime: earliestRestorableTime,
+    Endpoint: endpoint,
+    ReaderEndpoint: readerEndpoint,
+    MultiAZ: multiAZ,
+    Engine: engine,
+    EngineVersion: engineVersion,
+    LatestRestorableTime: latestRestorableTime,
+    Port: port,
+    MasterUsername: masterUsername,
+    PreferredBackupWindow: preferredBackupWindow,
+    PreferredMaintenanceWindow: preferredMaintenanceWindow,
+    ReplicationSourceIdentifier: replicationSourceIdentifier,
+    ReadReplicaIdentifiers: readReplicaIdentifiers,
+    DBClusterMembers = [],
+    VpcSecurityGroups = [],
+    HostedZoneId: hostedZoneId,
+    StorageEncrypted: storageEncrypted,
+    KmsKeyId: kmsKeyId,
+    DbClusterResourceId: dbClusterResourceId,
+    DBClusterArn: arn,
+    CloneGroupId: cloneGroupId,
+    ClusterCreateTime: clusterCreateTime,
+    DeletionProtection: deletionProtection,
+  } = service
+
+  const availabilityZones = AvailabilityZones.map(az => az)
+  const dBClusterMembers = DBClusterMembers.map(dbinstance => dbinstance.DBInstanceIdentifier)
+  const vpcSecurityGroups = VpcSecurityGroups.map(vpcsg => vpcsg.VpcSecurityGroupId)
+
+  return {
+    id: arn,
+    accountId: account,
+    arn,
+    region,
+    availabilityZones,
+    backupRetentionPeriod,
+    dBClusterIdentifier,
+    dBClusterParameterGroup,
+    dBSubnetGroup,
+    status,
+    percentProgress,
+    earliestRestorableTime: earliestRestorableTime?.toISOString(),
+    endpoint,
+    readerEndpoint,
+    multiAZ,
+    engine,
+    engineVersion,
+    latestRestorableTime: latestRestorableTime?.toISOString(),
+    port,
+    masterUsername,
+    preferredBackupWindow,
+    preferredMaintenanceWindow,
+    replicationSourceIdentifier,
+    readReplicaIdentifiers,
+    dBClusterMembers,
+    vpcSecurityGroups,
+    hostedZoneId,
+    storageEncrypted,
+    kmsKeyId,
+    dbClusterResourceId,
+    cloneGroupId,
+    clusterCreateTime: clusterCreateTime?.toISOString(),
+    deletionProtection,
+  }
+}

src/services/docdbCluster/index.ts

@@ -0,0 +1,13 @@
+import { Service } from '@cloudgraph/sdk'
+import BaseService from '../base'
+import format from './format'
+import getData from './data'
+import mutation from './mutation'
+
+export default class DOCDBCluster extends BaseService implements Service {
+  format = format.bind(this)
+
+  getData = getData.bind(this)
+
+  mutation = mutation
+}

src/services/docdbCluster/mutation.ts

@@ -0,0 +1,5 @@
+export default `mutation($input: [AddawsDocdbClusterInput!]!) {
+  addawsDocdbCluster(input: $input, upsert: true) {
+    numUids
+  }
+}`

src/services/docdbCluster/schema.graphql

@@ -0,0 +1,37 @@
+type awsDocdbCluster implements awsBaseService @key(fields: "arn") {
+    availabilityZones: [String] @search(by: [hash, regexp])
+    backupRetentionPeriod: Int @search
+    dBClusterIdentifier: String @search(by: [hash, regexp])
+    dBClusterParameterGroup: String @search(by: [hash, regexp])
+    dBSubnetGroup: String @search(by: [hash, regexp])
+    status: String @search(by: [hash, regexp])
+    percentProgress: String @search(by: [hash, regexp])
+    earliestRestorableTime: DateTime @search(by: [day])
+    endpoint: String @search(by: [hash, regexp])
+    readerEndpoint: String @search(by: [hash, regexp])
+    multiAZ: Boolean @search
+    engine: String @search(by: [hash, regexp])
+    engineVersion: String @search(by: [hash, regexp])
+    latestRestorableTime: DateTime @search(by: [day])
+    port: Int @search
+    masterUsername: String @search(by: [hash, regexp])
+    preferredBackupWindow: String @search(by: [hash, regexp])
+    preferredMaintenanceWindow: String @search(by: [hash, regexp])
+    replicationSourceIdentifier: String @search(by: [hash, regexp])
+    readReplicaIdentifiers: [String] @search(by: [hash, regexp])
+    dBClusterMembers: [String] @search(by: [hash, regexp])
+    vpcSecurityGroups: [String] @search(by: [hash, regexp])
+    hostedZoneId: String @search(by: [hash, regexp])
+    storageEncrypted: Boolean @search
+    kmsKeyId: String @search(by: [hash, regexp])
+    dbClusterResourceId: String @search(by: [hash, regexp])
+    dBClusterArn: String @search(by: [hash, regexp])
+    cloneGroupId: String @search(by: [hash, regexp])
+    clusterCreateTime: DateTime @search(by: [day])
+    nabledCloudwatchLogsExports: [String] @search(by: [hash, regexp])
+    deletionProtection: Boolean @search
+}
+
+
+
+

src/types/generated.ts

@@ -159,9 +159,9 @@ export type AwsAccount = AwsOptionalService & {
   cloudtrail?: Maybe<Array<Maybe<AwsCloudtrail>>>;
   cloudwatch?: Maybe<Array<Maybe<AwsCloudwatch>>>;
   cloudwatchLogs?: Maybe<Array<Maybe<AwsCloudwatchLog>>>;
+  codeCommitRepository?: Maybe<Array<Maybe<AwsCodeCommitRepository>>>;
   codePipelineWebhooks?: Maybe<Array<Maybe<AwsCodePipelineWebhook>>>;
   codePipelines?: Maybe<Array<Maybe<AwsCodePipeline>>>;
-  codeCommitRepository?: Maybe<Array<Maybe<AwsCodeCommitRepository>>>;
   codebuilds?: Maybe<Array<Maybe<AwsCodebuild>>>;
   cognitoIdentityPool?: Maybe<Array<Maybe<AwsCognitoIdentityPool>>>;
   cognitoUserPool?: Maybe<Array<Maybe<AwsCognitoUserPool>>>;
@@ -170,6 +170,7 @@ export type AwsAccount = AwsOptionalService & {
   configurationRules?: Maybe<Array<Maybe<AwsConfigurationRule>>>;
   customerGateway?: Maybe<Array<Maybe<AwsCustomerGateway>>>;
   dmsReplicationInstances?: Maybe<Array<Maybe<AwsDmsReplicationInstance>>>;
+  docdbCluster?: Maybe<Array<Maybe<AwsDocdbCluster>>>;
   dynamodb?: Maybe<Array<Maybe<AwsDynamoDbTable>>>;
   ebs?: Maybe<Array<Maybe<AwsEbs>>>;
   ec2Instances?: Maybe<Array<Maybe<AwsEc2>>>;
@@ -1478,6 +1479,40 @@ export type AwsDmsReplicationInstance = AwsBaseService & {
   vpcSecurityGroups?: Maybe<Array<Maybe<AwsDmsReplicationInstanceVpcSecurityGroups>>>;
 };
 
+export type AwsDocdbCluster = AwsBaseService & {
+  availabilityZones?: Maybe<Array<Maybe<Scalars['String']>>>;
+  backupRetentionPeriod?: Maybe<Scalars['Int']>;
+  cloneGroupId?: Maybe<Scalars['String']>;
+  clusterCreateTime?: Maybe<Scalars['DateTime']>;
+  dBClusterArn?: Maybe<Scalars['String']>;
+  dBClusterIdentifier?: Maybe<Scalars['String']>;
+  dBClusterMembers?: Maybe<Array<Maybe<Scalars['String']>>>;
+  dBClusterParameterGroup?: Maybe<Scalars['String']>;
+  dBSubnetGroup?: Maybe<Scalars['String']>;
+  dbClusterResourceId?: Maybe<Scalars['String']>;
+  deletionProtection?: Maybe<Scalars['Boolean']>;
+  earliestRestorableTime?: Maybe<Scalars['DateTime']>;
+  endpoint?: Maybe<Scalars['String']>;
+  engine?: Maybe<Scalars['String']>;
+  engineVersion?: Maybe<Scalars['String']>;
+  hostedZoneId?: Maybe<Scalars['String']>;
+  kmsKeyId?: Maybe<Scalars['String']>;
+  latestRestorableTime?: Maybe<Scalars['DateTime']>;
+  masterUsername?: Maybe<Scalars['String']>;
+  multiAZ?: Maybe<Scalars['Boolean']>;
+  nabledCloudwatchLogsExports?: Maybe<Array<Maybe<Scalars['String']>>>;
+  percentProgress?: Maybe<Scalars['String']>;
+  port?: Maybe<Scalars['Int']>;
+  preferredBackupWindow?: Maybe<Scalars['String']>;
+  preferredMaintenanceWindow?: Maybe<Scalars['String']>;
+  readReplicaIdentifiers?: Maybe<Array<Maybe<Scalars['String']>>>;
+  readerEndpoint?: Maybe<Scalars['String']>;
+  replicationSourceIdentifier?: Maybe<Scalars['String']>;
+  status?: Maybe<Scalars['String']>;
+  storageEncrypted?: Maybe<Scalars['Boolean']>;
+  vpcSecurityGroups?: Maybe<Array<Maybe<Scalars['String']>>>;
+};
+
 export type AwsDynamoDbTable = AwsBaseService & {
   appSync?: Maybe<Array<Maybe<AwsAppSync>>>;
   attributes?: Maybe<Array<Maybe<AwsDynamoDbTableAttributes>>>;