Configuration Recorder

16min
Note: if you are running CloudGraph locally you can view the interactive, automatically generated documentation in either GraphQL Playground or Altair by clicking the docs button on the right-hand side of the screen. After reading the below information we highly suggest you use one of these tools to test your queries as they will autocomplete fields for you and let you know if your queries are valid before you even submit them.
Overview
You can currently query the following attributes and connections on an AWS Configuration Recorder
GraphQL
|
query {
  queryawsConfigurationRecorder {
    id
    accountId
    arn
    region
    name
    roleARN
    recordingGroup {
      allSupported
      includeGlobalResourceTypes
      resourceTypes
    }
    status {
      name
      lastStatus
      recording
      lastStatusChangeTime
      lastStartTime
      lastStopTime
    }
    iamRole {
      arn
      # Other fields and connections here...
    }
  }
}
query {
  queryawsConfigurationRecorder {
    id
    accountId
    arn
    region
    name
    roleARN
    recordingGroup {
      allSupported
      includeGlobalResourceTypes
      resourceTypes
    }
    status {
      name
      lastStatus
      recording
      lastStatusChangeTime
      lastStartTime
      lastStopTime
    }
    iamRole {
      arn
      # Other fields and connections here...
    }
  }
}
﻿
Filtering
Get data for a single AWS Configuration Recorder that you know the ID or arn for:
GraphQL
|
query {
  getawsConfigurationRecorder(id: "12345") {
    arn
    # Other fields and connections here...
  }
}
query {
  getawsConfigurationRecorder(id: "12345") {
    arn
    # Other fields and connections here...
  }
}
﻿
GraphQL
|
query {
  getawsConfigurationRecorder(arn: "arn:aws:ec2:us-east-1:111122223333:configuration-recorder/11122223333f466ec") {
    arn
    # Other fields and connections here...
  }
}
query {
  getawsConfigurationRecorder(arn: "arn:aws:ec2:us-east-1:111122223333:configuration-recorder/11122223333f466ec") {
    arn
    # Other fields and connections here...
  }
}
﻿
Get data for all of the Configuration Recorders in a certain AWS account:
GraphQL
|
query {
  queryawsConfigurationRecorder(filter: { accountId: { eq: "12345" } }) {
    arn
    # Other fields and connections here...
  }
}

# Note that in addition to "accountId" you can
# Filter based on any of the following attributes:

# id
# arn
# region
# name
# roleARN

# And the following Dgraph filters can also be applied:

# has
# and
# or
# not
# regexp (regular expressions)
query {
  queryawsConfigurationRecorder(filter: { accountId: { eq: "12345" } }) {
    arn
    # Other fields and connections here...
  }
}

# Note that in addition to "accountId" you can
# Filter based on any of the following attributes:

# id
# arn
# region
# name
# roleARN

# And the following Dgraph filters can also be applied:

# has
# and
# or
# not
# regexp (regular expressions)
﻿
Get data for all of the Configuration Recorders that are NOT in a certain AWS account:
GraphQL
|
query {
  queryawsConfigurationRecorder(filter: { not: { accountId: { eq: "12345" } } }) {
    arn
    # Other fields and connections here...
  }
}
query {
  queryawsConfigurationRecorder(filter: { not: { accountId: { eq: "12345" } } }) {
    arn
    # Other fields and connections here...
  }
}
﻿
Advanced Filtering
Get data for all of the Configuration Recorders that have a connected iamRole:
GraphQL
|
query {
  queryawsConfigurationRecorder(filter: { has: iamRole }) {
    arn
    # Other fields and connections here...
  }
}

# Note that in addition to "iamRole" you can filter
# Using "has" based on any of the following attributes:

# id
# accountId
# arn
# region
# name
# roleARN
# recordingGroup
# status
query {
  queryawsConfigurationRecorder(filter: { has: iamRole }) {
    arn
    # Other fields and connections here...
  }
}

# Note that in addition to "iamRole" you can filter
# Using "has" based on any of the following attributes:

# id
# accountId
# arn
# region
# name
# roleARN
# recordingGroup
# status
﻿
You may also filter using a regex when filtering on a string field like, region if you want to look for a value that matches say, us- to get all Configuration Recorders in us regions:
GraphQL
|
query {
  queryawsConfigurationRecorder(filter: { region: { regexp: "/.*us-*/" } }) {
    arn
    # Other fields and connections here...
  }
}
query {
  queryawsConfigurationRecorder(filter: { region: { regexp: "/.*us-*/" } }) {
    arn
    # Other fields and connections here...
  }
}
﻿
Ordering
You can order the results you get back either asc or desc depending on your preference:
GraphQL
|
query {
  queryawsConfigurationRecorder(order: { desc: region }) {
    arn
    # Other fields and connections here...
  }
}

# Note that in addition to "region" you can filter
# Using "asc" or "desc" based on any of the following attributes:

# id
# accountId
# arn
# name
# roleARN
query {
  queryawsConfigurationRecorder(order: { desc: region }) {
    arn
    # Other fields and connections here...
  }
}

# Note that in addition to "region" you can filter
# Using "asc" or "desc" based on any of the following attributes:

# id
# accountId
# arn
# name
# roleARN
﻿
Only select and return the first two Configuration Recorders that are found:
GraphQL
|
query {
  queryawsConfigurationRecorder(first: 2, order: { desc: region }) {
    arn
    # Other fields and connections here...
  }
}
query {
  queryawsConfigurationRecorder(first: 2, order: { desc: region }) {
    arn
    # Other fields and connections here...
  }
}
﻿
Only select and return the first two Configuration Recorders that are found, but offset by one so Configuration Recorders two & three are returned:
GraphQL
|
query {
  queryawsConfigurationRecorder(first: 2, order: { desc: region }, offset: 1) {
    arn
    # Other fields and connections here...
  }
}
query {
  queryawsConfigurationRecorder(first: 2, order: { desc: region }, offset: 1) {
    arn
    # Other fields and connections here...
  }
}
﻿
Aggregation
Count the number Configuration Recorders across all scanned AWS accounts:
GraphQL
|
query {
  aggregateawsConfigurationRecorder {
    count
    # Other fields and connections here...
  }
}

# Note that in addition to "count" you can request the
# Following min and max values based on attributes of your Configuration Recorder:

# idMin
# idMax
# accountIdMin
# accountIdMax
# arnMin
# arnMax
# regionMin
# regionMax
# nameMin
# nameMax
# roleARNMin
# roleARNMax
query {
  aggregateawsConfigurationRecorder {
    count
    # Other fields and connections here...
  }
}

# Note that in addition to "count" you can request the
# Following min and max values based on attributes of your Configuration Recorder:

# idMin
# idMax
# accountIdMin
# accountIdMax
# arnMin
# arnMax
# regionMin
# regionMax
# nameMin
# nameMax
# roleARNMin
# roleARNMax
﻿
Count the number of Configuration Recorders in a single account. Note that you can apply all of the same filters that are listed above to aggregate queries:
GraphQL
|
query {
  aggregateawsConfigurationRecorder(filter: { accountId: { eq: "12345" } }) {
    count
    # Other fields and connections here...
  }
}
query {
  aggregateawsConfigurationRecorder(filter: { accountId: { eq: "12345" } }) {
    count
    # Other fields and connections here...
  }
}
﻿
Examples
Find all of the Configuration Recorders that are in the us-east-1 region across all your accounts:
GraphQL
|
query {
  queryawsConfigurationRecorder(filter: { region: { eq: "us-east-1" } }) {
    arn
    # Other fields and connections here...
  }
}
query {
  queryawsConfigurationRecorder(filter: { region: { eq: "us-east-1" } }) {
    arn
    # Other fields and connections here...
  }
}
﻿
Kitchen Sink
Putting it all together; get all data for all Configuration Recorders across all regions for all scanned AWS accounts in a single query. For the purposes of this example we will only get direct children of the configuration recorders but if you want to it's easy to go from say, configurationRecorder -> iamRole -> iamPolicy ...etc:
GraphQL
|
query { 
  queryawsConfigurationRecorder {
    id
    accountId
    arn
    region
    name
    roleARN
    recordingGroup {
      allSupported
      includeGlobalResourceTypes
      resourceTypes
    }
    status {
      name
      lastStatus
      recording
      lastStatusChangeTime
      lastStartTime
      lastStopTime
    }
    iamRole {
      id
    	accountId
    	arn
      name
      path
      assumeRolePolicy {
        id
        version
        statement {
          id
          action
          condition {
            id
            operator
            key
            value
          }
          effect
          principal {
            id
            key
            value
          }
          resource
        }
      }
      description
      createdAt
      maxSessionDuration
      tags {
        id
        key
        value
      }
      inlinePolicies
      iamAttachedPolicies {
        arn
        # Other fields and connections here...
      }
      eksCluster {
        arn
        # Other fields and connections here...
      }
      ecsService {
        arn
        # Other fields and connections here...
      }
      flowLogs {
        id
        # Other fields and connections here...
      }
      cloudFormationStack {
        arn
        # Other fields and connections here...
      }
      configurationRecorder {
        arn
        # Other fields and connections here...
      }
    }
  }
}
query { 
  queryawsConfigurationRecorder {
    id
    accountId
    arn
    region
    name
    roleARN
    recordingGroup {
      allSupported
      includeGlobalResourceTypes
      resourceTypes
    }
    status {
      name
      lastStatus
      recording
      lastStatusChangeTime
      lastStartTime
      lastStopTime
    }
    iamRole {
      id
    	accountId
    	arn
      name
      path
      assumeRolePolicy {
        id
        version
        statement {
          id
          action
          condition {
            id
            operator
            key
            value
          }
          effect
          principal {
            id
            key
            value
          }
          resource
        }
      }
      description
      createdAt
      maxSessionDuration
      tags {
        id
        key
        value
      }
      inlinePolicies
      iamAttachedPolicies {
        arn
        # Other fields and connections here...
      }
      eksCluster {
        arn
        # Other fields and connections here...
      }
      ecsService {
        arn
        # Other fields and connections here...
      }
      flowLogs {
        id
        # Other fields and connections here...
      }
      cloudFormationStack {
        arn
        # Other fields and connections here...
      }
      configurationRecorder {
        arn
        # Other fields and connections here...
      }
    }
  }
}
﻿
References
﻿Dgraph documentation on querying﻿
﻿AWS Config documentation﻿
﻿AWS Configuration Recorder documentation﻿
Updated 03 Mar 2023
Did this page help you?
TABLE OF CONTENTS