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.
You can currently query the following attributes and connections on an AWS Cloudwatch Log
query {
queryawsCloudwatchLog {
id
arn
region
creationTime
retentionInDays
metricFilterCount
storedBytes
kmsKeyId
metricFilters {
id
filterName
filterPattern
creationTime
logGroupName
metricTransformations {
metricName
metricNamespace
metricValue
defaultValue
unit
}
}
cloudtrail {
arn
}
cloudwatch {
arn
}
kms {
arn
}
}
}
Get data for a single AWS Cloudwatch Log that you know the ARNfor:
query {
getawsCloudwatchLog(arn: "arn:aws:ec2:us-east-1:111122223333:log-group:/aws/lambda/lambda-name:*") {
arn
}
}
Get data for all of the Cloudwatch Logs in a certain AWS account:
query {
queryawsCloudwatchLog(filter: { accountId: { eq: "12345" } }) {
arn
}
}
Get data for all of the Cloudwatch Logs that are NOT in a certain AWS account:
query {
queryawsCloudwatchLog(filter: { not: { accountId: { eq: "12345" } } }) {
arn
}
}
Get data for all of the Cloudwatch Logs that have a connected cloudtrail:
query {
queryawsCloudwatchLog(filter: { has: cloudtrail }) {
arn
}
}
Use multiple filter selectors, (i.e. has, and, not, or) to get data for all of the Cloudwatch Logs that have cloudtrail instances AND cloudwatch instances connected to them OR that do not have kms instances connected to them. Note that you can use has, and, not, or completely independently of each other:
query {
queryawsCloudwatchLog(
filter: {
has: cloudtrail
and: { has: cloudwatch }
or: { not: { has: kms } }
}
) {
arn
}
}
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 Cloudwatch Logs in us regions:
query {
queryawsCloudwatchLog(filter: { region: { regexp: "/.*us-*/" } }) {
arn
}
}
You can order the results you get back either asc or desc depending on your preference:
query {
queryawsCloudwatchLog(order: { desc: region }) {
arn
}
}
Only select and return the first two Cloudwatch Logs that are found:
query {
queryawsCloudwatchLog(first: 2, order: { desc: region }) {
arn
}
}
Only select and return the first two Cloudwatch Logs that are found, but offset by one so Cloudwatch Logs two & three are returned:
query {
queryawsCloudwatchLog(first: 2, order: { desc: region }, offset: 1) {
arn
}
}
Count the number Cloudwatch Logs across all scanned AWS accounts:
query {
aggregateawsCloudwatchLog {
count
}
}
Count the number of Cloudwatch Logs in a single account. Note that you can apply all of the same filters that are listed above to aggregate queries:
query {
aggregateawsCloudwatchLog(filter: { accountId: { eq: "12345" } }) {
count
}
}
Find all of the Cloudwatch Logs that are in the us-east-1 region across all your accounts:
query {
queryawsCloudwatchLog(filter: { region: { eq: "us-east-1" } }) {
arn
}
}
Putting it all together; get all data for all Cloudwatch Logs 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 cloudwatch logs but if you want to it's easy to go from say, cloudwatchLogs -> cloudwatch-> sns ...etc:
query {
queryawsCloudwatchLog {
id
arn
region
creationTime
retentionInDays
metricFilterCount
storedBytes
kmsKeyId
metricFilters {
id
filterName
filterPattern
creationTime
logGroupName
metricTransformations {
metricName
metricNamespace
metricValue
defaultValue
unit
}
}
cloudtrail {
id
arn
accountId
cgId
region
name
s3BucketName
s3KeyPrefix
includeGlobalServiceEvents
isMultiRegionTrail
homeRegion
logFileValidationEnabled
cloudWatchLogsLogGroupArn
cloudWatchLogsRoleArn
kmsKeyId
hasInsightSelectors
hasCustomEventSelectors
isOrganizationTrail
status {
isLogging
latestDeliveryTime
latestNotificationTime
startLoggingTime
latestDigestDeliveryTime
latestDeliveryAttemptTime
latestNotificationAttemptTime
latestDeliveryAttemptSucceeded
latestCloudWatchLogsDeliveryTime
timeLoggingStarted
timeLoggingStopped
}
eventSelectors {
id
readWriteType
includeManagementEvents
}
tags {
id
key
value
}
s3 {
arn
}
sns {
arn
}
kms {
arn
}
cloudwatchLog {
arn
}
}
cloudwatch {
id
accountId
arn
region
metric
namespace
description
actionsEnabled
actions
comparisonOperator
statistic
threshold
period
evaluationPeriods
dimensions {
id
name
value
}
tags {
id
key
value
}
cloudwatchLog {
arn
}
sns {
arn
}
}
kms {
id
accountId
arn
region
description
keyRotationEnabled
usage
policy {
id
version
statement {
id
action
condition {
id
operator
key
value
}
effect
principal{
id
}
resource
}
}
enabled
keyState
customerMasterKeySpec
creationDate
keyManager
origin
deletionDate
validTo
tags {
id
key
value
}
lambda {
arn
}
cloudtrail {
arn
}
redshiftCluster {
arn
}
sns {
arn
}
eksCluster {
arn
}
}
}
}
