@aws-lite/cloudwatch-logs
Official
aws-liteplugin for CloudWatch Logs
Maintained by: @architect
Install
npm i @aws-lite/cloudwatch-logs
Optionally install types:
npm i -D @aws-lite/cloudwatch-logs-types
Reference
Reference documentation with examples at aws-lite.org
Reference
Reference documentation with examples at aws-lite.org
Methods
DeleteLogGroup
Properties:
logGroupName(string) [required]- Name of the log group
DeleteLogStream
Properties:
logGroupName(string) [required]- Name of the log group
logStreamName(string) [required]- Name of the log stream
DescribeLogGroups
Properties:
accountIdentifiers(array)- List of accounts to search when
includeLinkedAccountsistrue
- List of accounts to search when
logGroupNamePrefix(string)- Prefix to match
logGroupNamePattern(string)- Case-sensitive substring to match
nextToken(string)- Pagination cursor token to be used if
NextTokenwas returned in a previous response
- Pagination cursor token to be used if
limit(number)- Maximum number of items to evaluate and return
includeLinkedAccounts(boolean)- Return log groups in the accounts enumerated by
accountIdentifiers
- Return log groups in the accounts enumerated by
logGroupClass(string)- Log group class setting:
STANDARD(supports all CloudWatch Logs features), orINFREQUENT_ACCESS(feature subset with lower costs) - More details (AWS)
- Log group class setting:
paginate(boolean, string)- Enable automatic result pagination; use this instead of making your own individual pagination requests
DescribeLogStreams
Properties:
descending(boolean)- Return results in descending order (if
true)
- Return results in descending order (if
limit(number)- Maximum number of items to evaluate and return
logGroupIdentifier(string)- Name or ARN of the log group
logGroupName(string)- Name of the log group
logStreamNamePrefix(string)- Prefix to match
nextToken(string)- Pagination cursor token to be used if
NextTokenwas returned in a previous response
- Pagination cursor token to be used if
orderBy(string)- Order results by log stream name (
LogStreamName) or event time (LastEventTime)
- Order results by log stream name (
paginate(boolean, string)- Enable automatic result pagination; use this instead of making your own individual pagination requests
GetLogEvents
Properties:
endTime(number)- End of the time range in epoch milliseconds
limit(number)- Maximum number of items to evaluate and return
logGroupIdentifier(string)- Name or ARN of the log group
logGroupName(string)- Name of the log group
logStreamName(string) [required]- Name of the log stream
nextToken(string)- Pagination cursor token to be used if
NextTokenwas returned in a previous response
- Pagination cursor token to be used if
startFromHead(boolean)- Return earliest log events first (
true)
- Return earliest log events first (
startTime(number)- Start of the time range in epoch milliseconds
unmask(boolean)- Display log event fields with all sensitive data unmasked and visible (
true)
- Display log event fields with all sensitive data unmasked and visible (
paginate(boolean, string)- Enable automatic result pagination; use this instead of making your own individual pagination requests
GetQueryResults
Properties:
queryId(string)- The ID of the query
StartQuery
Properties:
endTime(number)- End of the time range in epoch seconds
limit(number)- Maximum number of items to evaluate and return
logGroupIdentifiers(array)- List of log groups to query.
StartQueryrequires exactly one oflogGroupName,logGroupNamesorlogGroupIdentifiers.
- List of log groups to query.
logGroupName(string)- Name of the log group
logGroupNames(array)- List of log groups to query.
StartQueryrequires exactly one oflogGroupName,logGroupNamesorlogGroupIdentifiers.
- List of log groups to query.
query(string)- The query string to use
startTime(number)- Start of the time range in epoch seconds
Methods yet to be implemented
Please help out by opening a PR!
AssociateKmsKeyCancelExportTaskCreateDeliveryCreateExportTaskCreateLogAnomalyDetectorCreateLogGroupCreateLogStreamDeleteAccountPolicyDeleteDataProtectionPolicyDeleteDeliveryDeleteDeliveryDestinationDeleteDeliveryDestinationPolicyDeleteDeliverySourceDeleteDestinationDeleteLogAnomalyDetectorDeleteMetricFilterDeleteQueryDefinitionDeleteResourcePolicyDeleteRetentionPolicyDeleteSubscriptionFilterDescribeAccountPoliciesDescribeDeliveriesDescribeDeliveryDestinationsDescribeDeliverySourcesDescribeDestinationsDescribeExportTasksDescribeMetricFiltersDescribeQueriesDescribeQueryDefinitionsDescribeResourcePoliciesDescribeSubscriptionFiltersDisassociateKmsKeyFilterLogEventsGetDataProtectionPolicyGetDeliveryGetDeliveryDestinationGetDeliveryDestinationPolicyGetDeliverySourceGetLogAnomalyDetectorGetLogGroupFieldsGetLogRecordListAnomaliesListLogAnomalyDetectorsListTagsForResourceListTagsLogGroupPutAccountPolicyPutDataProtectionPolicyPutDeliveryDestinationPutDeliveryDestinationPolicyPutDeliverySourcePutDestinationPutDestinationPolicyPutLogEventsPutMetricFilterPutQueryDefinitionPutResourcePolicyPutRetentionPolicyPutSubscriptionFilterStartLiveTailStopQueryTagLogGroupTagResourceTestMetricFilterUntagLogGroupUntagResourceUpdateAnomalyUpdateLogAnomalyDetector