feat(services): add new service rds cluster snapshot

Author: tyler-dunkel

src/enums/schemasMap.ts

@@ -78,6 +78,7 @@ export default {
   [services.vpnGateway]: 'awsVpnGateway',
   [services.sqs]: 'awsSqs',
   [services.rdsCluster]: 'awsRdsCluster',
+  [services.rdsClusterSnapshot]: 'awsRdsClusterSnapshot',
   [services.rdsDbInstance]: 'awsRdsDbInstance',
   [services.redshiftCluster]: 'awsRedshiftCluster',
   [services.route53HostedZone]: 'awsRoute53HostedZone',

src/enums/serviceAliases.ts

@@ -50,6 +50,7 @@ export default {
   [services.networkInterface]: 'networkInterfaces',
   [services.organization]: 'organizations',
   [services.rdsCluster]: 'rdsClusters',
+  [services.rdsClusterSnapshot]: 'rdsClusterSnapshots',
   [services.rdsDbInstance]: 'rdsDbInstances',
   [services.redshiftCluster]: 'redshiftClusters',
   [services.route53HostedZone]: 'route53HostedZones',

src/enums/serviceMap.ts

@@ -93,6 +93,7 @@ import DmsReplicationInstance from '../services/dmsReplicationInstance'
 import SageMakerNotebookInstance from '../services/sageMakerNotebookInstance'
 import SystemsManagerInstance from '../services/systemsManagerInstance'
 import SystemsManagerDocument from '../services/systemsManagerDocument'
+import RdsClusterSnapshot from '../services/rdsClusterSnapshot'
 
 /**
  * serviceMap is an object that contains all currently supported services for AWS
@@ -157,6 +158,7 @@ export default {
   [services.vpc]: VPC,
   [services.sqs]: SQS,
   [services.rdsCluster]: RDSCluster,
+  [services.rdsClusterSnapshot]: RdsClusterSnapshot,
   [services.rdsDbInstance]: RDSDbInstance,
   [services.redshiftCluster]: RedshiftCluster,
   [services.route53HostedZone]: Route53HostedZone,

src/enums/services.ts

@@ -68,6 +68,7 @@ export default {
   networkInterface: 'networkInterface',
   organization: 'organization',
   rdsCluster: 'rdsCluster',
+  rdsClusterSnapshot: 'rdsClusterSnapshot',
   rdsDbInstance: 'rdsDbInstance',
   redshiftCluster: 'redshiftCluster',
   route53HostedZone: 'route53HostedZone',

src/services/account/schema.graphql

@@ -70,6 +70,7 @@ type awsAccount @key(fields: "id") {
   networkInterfaces: [awsNetworkInterface]
   organizations: [awsOrganization]
   rdsClusters: [awsRdsCluster]
+  rdsClusterSnapshots: [awsRdsClusterSnapshot]
   rdsDbInstances: [awsRdsDbInstance]
   redshiftClusters: [awsRedshiftCluster]
   route53HostedZones: [awsRoute53HostedZone]

src/services/kms/schema.graphql

@@ -29,4 +29,5 @@ type awsKms @key(fields: "id"){
   elasticSearchDomains: [awsElasticSearchDomain] @hasInverse(field: kms)
   dmsReplicationInstances: [awsDmsReplicationInstance] @hasInverse(field: kms)
   sageMakerNotebookInstances: [awsSageMakerNotebookInstance] @hasInverse(field: kms)
+  rdsClusterSnapshots: [awsRdsClusterSnapshot] @hasInverse(field: kms)
 }

src/services/rdsCluster/connections.ts

@@ -4,6 +4,7 @@ import { SecurityGroup } from 'aws-sdk/clients/ec2'
 import { DBInstance, DBCluster } from 'aws-sdk/clients/rds'
 
 import services from '../../enums/services'
+import { RawAwsRdsClusterSnapshot } from '../rdsClusterSnapshot/data'
 
 export default ({
   service,
@@ -27,7 +28,7 @@ export default ({
   )
 
   /**
-   * Find instances
+   * Find rds db instances
    */
   const instances: {
     name: string
@@ -51,6 +52,30 @@ export default ({
     }
   }
 
+  /**
+   * Find cluster snapshots
+   */
+   const snapshots: {
+    name: string
+    data: { [property: string]: RawAwsRdsClusterSnapshot[] }
+  } = data.find(({ name }) => name === services.rdsClusterSnapshot)
+
+  if (snapshots?.data?.[region]) {
+    const dataInRegion: RawAwsRdsClusterSnapshot[] = snapshots.data[region].filter(
+      ({ DBClusterIdentifier }: RawAwsRdsClusterSnapshot) => DBClusterIdentifier === clusterId
+    )
+    if (!isEmpty(dataInRegion)) {
+      for (const snapshot of dataInRegion) {
+        connections.push({
+          id: snapshot.DBClusterSnapshotIdentifier,
+          resourceType: services.rdsClusterSnapshot,
+          relation: 'child',
+          field: 'snapshots',
+        })
+      }
+    }
+  }
+
   /**
    * Find SecurityGroups
    */

src/services/rdsCluster/schema.graphql

@@ -34,6 +34,7 @@ type awsRdsCluster @key(fields: "arn") {
   globalWriteForwardingRequested: Boolean @search
   tags: [awsRawTag]
   instances: [awsRdsDbInstance] @hasInverse(field: cluster)
+  snapshots: [awsRdsClusterSnapshot] @hasInverse(field: cluster)
   securityGroups: [awsSecurityGroup] @hasInverse(field: rdsCluster)
   appSync: [awsAppSync] @hasInverse(field: rdsCluster)
 }

src/services/rdsClusterSnapshot/connections.ts

@@ -0,0 +1,43 @@
+import { ServiceConnection } from '@cloudgraph/sdk'
+import { isEmpty } from 'lodash'
+import { RawAwsRdsClusterSnapshot } from './data'
+import services from '../../enums/services'
+
+export default ({
+  service,
+  data,
+  region,
+}: {
+  account: string
+  service: RawAwsRdsClusterSnapshot
+  data: { name: string; data: { [property: string]: any[] } }[]
+  region: string
+}): {
+  [property: string]: ServiceConnection[]
+} => {
+  const { DBClusterSnapshotIdentifier, KmsKeyId } = service
+  const connections: ServiceConnection[] = []
+
+  /**
+   * Find KMS
+   */
+  const kmsKeys = data.find(({ name }) => name === services.kms)
+  if (kmsKeys?.data?.[region]) {
+    const kmsKeyInRegion = kmsKeys.data[region].filter(kmsKey => kmsKey.Arn === KmsKeyId)
+    if (!isEmpty(kmsKeyInRegion)) {
+      for (const kms of kmsKeyInRegion) {
+        connections.push({
+          id: kms.KeyId,
+          resourceType: services.kms,
+          relation: 'child',
+          field: 'kms',
+        })
+      }
+    }
+  }
+
+  const result = {
+    [DBClusterSnapshotIdentifier]: connections,
+  }
+  return result
+}

src/services/rdsClusterSnapshot/data.ts

@@ -0,0 +1,71 @@
+import { Config } from 'aws-sdk/lib/config'
+import { groupBy, isEmpty } from 'lodash'
+import RDS from 'aws-sdk/clients/rds'
+import { convertToPromise, fetchAllPaginatedData } from '../../utils/fetchUtils'
+import { initTestEndpoint } from '../../utils'
+import ErrorLog from '../../utils/errorLog'
+import { convertAwsTagsToTagMap } from '../../utils/format'
+import { TagMap, AwsTag } from '../../types'
+
+const serviceName = 'rdsClusterSnapshot'
+const endpoint = initTestEndpoint(serviceName)
+const errorLog = new ErrorLog(serviceName)
+
+export interface RawAwsRdsClusterSnapshot extends RDS.DBClusterSnapshot {
+  region: string
+  attributes: RDS.DBClusterSnapshotAttributeList
+  Tags: TagMap
+}
+
+/**
+ * RdsClusterSnapshot
+ */
+
+export default async ({
+  regions,
+  config,
+}: {
+  regions: string
+  config: Config
+}): Promise<{ [region: string]: RawAwsRdsClusterSnapshot[] }> => {
+  const result: RawAwsRdsClusterSnapshot[] = []
+
+  const activeRegions = regions.split(',')
+
+  for (const region of activeRegions) {
+    const client = new RDS({ ...config, region, endpoint })
+    let rdsClusterSnapshotData: RDS.DBClusterSnapshot[]
+    try {
+      rdsClusterSnapshotData = await fetchAllPaginatedData({
+        getResourcesFn: convertToPromise({
+          sdkContext: client,
+          fnName: 'describeDBClusterSnapshots',
+        }),
+        accessor: '',
+      })
+    } catch (err) {
+      errorLog.generateAwsErrorLog({ functionName: 'describeDBClusterSnapshots', err })
+    }
+
+    if (!isEmpty(rdsClusterSnapshotData)) {
+      for (const snapshot of rdsClusterSnapshotData) {
+        let snapshotAttributes: RDS.DBClusterSnapshotAttributeList
+        try {
+          const attributeResponse = await client
+            .describeDBClusterSnapshotAttributes({
+              DBClusterSnapshotIdentifier: snapshot.DBClusterSnapshotIdentifier,
+            })
+            .promise()
+          snapshotAttributes =
+            attributeResponse?.DBClusterSnapshotAttributesResult?.DBClusterSnapshotAttributes
+        } catch (err) {
+          errorLog.generateAwsErrorLog({ functionName: 'describeDBClusterSnapshotAttributes', err })
+        }
+        result.push({ ...snapshot, Tags: convertAwsTagsToTagMap(snapshot?.TagList as AwsTag[]), attributes: snapshotAttributes, region })
+      }
+    }
+  }
+
+  errorLog.reset()
+  return groupBy(result, 'region')
+}