Show / Hide Table of Contents

Namespace Amazon.CDK.AWS.Logs

Classes

AddKeyEntryProperty

This object defines one key that will be added with the addKeys processor.

AddKeysProperty

This processor adds new key-value pairs to the log event.

BaseProcessorProps

Base properties for all processor types.

CfnAccountPolicy

Creates or updates an account-level data protection policy or subscription filter policy that applies to all log groups or a subset of log groups in the account.

CfnAccountPolicyProps

Properties for defining a CfnAccountPolicy.

CfnDelivery

This structure contains information about one delivery in your account.

CfnDeliveryDestination

This structure contains information about one delivery destination in your account.

CfnDeliveryDestination.DestinationPolicyProperty
CfnDeliveryDestinationProps

Properties for defining a CfnDeliveryDestination.

CfnDeliveryProps

Properties for defining a CfnDelivery.

CfnDeliverySource

Creates or updates one delivery source in your account.

CfnDeliverySourceProps

Properties for defining a CfnDeliverySource.

CfnDestination

The AWS::Logs::Destination resource specifies a CloudWatch Logs destination.

CfnDestinationProps

Properties for defining a CfnDestination.

CfnIntegration

Creates an integration between CloudWatch Logs and another service in this account.

CfnIntegration.OpenSearchResourceConfigProperty

This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service.

CfnIntegration.ResourceConfigProperty

This structure contains configuration details about an integration between CloudWatch Logs and another entity.

CfnIntegrationProps

Properties for defining a CfnIntegration.

CfnLogAnomalyDetector

Creates or updates an anomaly detector that regularly scans one or more log groups and look for patterns and anomalies in the logs.

CfnLogAnomalyDetectorProps

Properties for defining a CfnLogAnomalyDetector.

CfnLogGroup

The AWS::Logs::LogGroup resource specifies a log group.

CfnLogGroupProps

Properties for defining a CfnLogGroup.

CfnLogStream

The AWS::Logs::LogStream resource specifies an Amazon CloudWatch Logs log stream in a specific log group.

CfnLogStreamProps

Properties for defining a CfnLogStream.

CfnMetricFilter

The AWS::Logs::MetricFilter resource specifies a metric filter that describes how CloudWatch Logs extracts information from logs and transforms it into Amazon CloudWatch metrics.

CfnMetricFilter.DimensionProperty

Specifies the CloudWatch metric dimensions to publish with this metric.

CfnMetricFilter.MetricTransformationProperty

MetricTransformation is a property of the AWS::Logs::MetricFilter resource that describes how to transform log streams into a CloudWatch metric.

CfnMetricFilterProps

Properties for defining a CfnMetricFilter.

CfnQueryDefinition

Creates a query definition for CloudWatch Logs Insights.

CfnQueryDefinitionProps

Properties for defining a CfnQueryDefinition.

CfnResourcePolicy

Creates or updates a resource policy that allows other AWS services to put log events to this account.

CfnResourcePolicyProps

Properties for defining a CfnResourcePolicy.

CfnSubscriptionFilter

The AWS::Logs::SubscriptionFilter resource specifies a subscription filter and associates it with the specified log group.

CfnSubscriptionFilterProps

Properties for defining a CfnSubscriptionFilter.

CfnTransformer

Creates or updates a log transformer for a single log group.

CfnTransformer.AddKeyEntryProperty

This object defines one key that will be added with the addKeys processor.

CfnTransformer.AddKeysProperty

This processor adds new key-value pairs to the log event.

CfnTransformer.CopyValueEntryProperty

This object defines one value to be copied with the copyValue processor.

CfnTransformer.CopyValueProperty

This processor copies values within a log event.

CfnTransformer.CsvProperty

The CSV processor parses comma-separated values (CSV) from the log events into columns.

CfnTransformer.DateTimeConverterProperty

This processor converts a datetime string into a format that you specify.

CfnTransformer.DeleteKeysProperty

This processor deletes entries from a log event. These entries are key-value pairs.

CfnTransformer.GrokProperty

This processor uses pattern matching to parse and structure unstructured data.

CfnTransformer.ListToMapProperty

This processor takes a list of objects that contain key fields, and converts them into a map of target keys.

CfnTransformer.LowerCaseStringProperty

This processor converts a string to lowercase.

CfnTransformer.MoveKeyEntryProperty

This object defines one key that will be moved with the moveKey processor.

CfnTransformer.MoveKeysProperty

This processor moves a key from one field to another. The original key is deleted.

CfnTransformer.ParseCloudfrontProperty

This processor parses CloudFront vended logs, extract fields, and convert them into JSON format.

CfnTransformer.ParseJSONProperty

This processor parses log events that are in JSON format.

CfnTransformer.ParseKeyValueProperty

This processor parses a specified field in the original log event into key-value pairs.

CfnTransformer.ParsePostgresProperty

Use this processor to parse RDS for PostgreSQL vended logs, extract fields, and and convert them into a JSON format.

CfnTransformer.ParseRoute53Property

Use this processor to parse Route 53 vended logs, extract fields, and and convert them into a JSON format.

CfnTransformer.ParseToOCSFProperty

This processor converts logs into Open Cybersecurity Schema Framework (OCSF) events.

CfnTransformer.ParseVPCProperty

Use this processor to parse Amazon VPC vended logs, extract fields, and and convert them into a JSON format.

CfnTransformer.ParseWAFProperty

Use this processor to parse AWS WAF vended logs, extract fields, and and convert them into a JSON format.

CfnTransformer.ProcessorProperty

This structure contains the information about one processor in a log transformer.

CfnTransformer.RenameKeyEntryProperty

This object defines one key that will be renamed with the renameKey processor.

CfnTransformer.RenameKeysProperty

Use this processor to rename keys in a log event.

CfnTransformer.SplitStringEntryProperty

This object defines one log field that will be split with the splitString processor.

CfnTransformer.SplitStringProperty

Use this processor to split a field into an array of strings using a delimiting character.

CfnTransformer.SubstituteStringEntryProperty

This object defines one log field key that will be replaced using the substituteString processor.

CfnTransformer.SubstituteStringProperty

This processor matches a key’s value against a regular expression and replaces all matches with a replacement string.

CfnTransformer.TrimStringProperty

Use this processor to remove leading and trailing whitespace.

CfnTransformer.TypeConverterEntryProperty

This object defines one value type that will be converted using the typeConverter processor.

CfnTransformer.TypeConverterProperty

Use this processor to convert a value type associated with the specified key to the specified type.

CfnTransformer.UpperCaseStringProperty

This processor converts a string field to uppercase.

CfnTransformerProps

Properties for defining a CfnTransformer.

ColumnRestriction
CopyValueEntryProperty

This object defines one value to be copied with the copyValue processor.

CopyValueProperty

Copy Value processor, copies values from source to target for each entry.

CrossAccountDestination

A new CloudWatch Logs Destination for use in cross-account scenarios.

CrossAccountDestinationProps

Properties for a CrossAccountDestination.

CsvProperty

The CSV processor parses comma-separated values (CSV) from the log events into columns.

CustomDataIdentifier

A custom data identifier.

DataConverterProcessor

Processor for data conversion operations.

DataConverterProps

Properties for creating data converter processors.

DataIdentifier

A data protection identifier.

DataProtectionPolicy

Creates a data protection policy for CloudWatch Logs log groups.

DataProtectionPolicyProps

Properties for creating a data protection policy.

DateTimeConverterProperty

This processor converts a datetime string into a format that you specify.

FieldIndexPolicy

Creates a field index policy for CloudWatch Logs log groups.

FieldIndexPolicyProps

Properties for creating field index policies.

FilterPattern

A collection of static methods to generate appropriate ILogPatterns.

GrokProperty

This processor uses pattern matching to parse and structure unstructured data.

JsonMutatorProcessor

Processor for JSON mutation operations.

JsonMutatorProps

Properties for creating JSON mutator processors.

JsonPattern

Base class for patterns that only match JSON log events.

ListToMapProperty

This processor takes a list of objects that contain key fields, and converts them into a map of target keys.

LogGroup

Define a CloudWatch Log Group.

LogGroupProps

Properties for a LogGroup.

LogRetention

Creates a custom resource to control the retention policy of a CloudWatch Logs log group.

LogRetentionProps

Construction properties for a LogRetention.

LogRetentionRetryOptions

Retry options for all AWS API calls.

LogStream

Define a Log Stream in a Log Group.

LogStreamProps

Properties for a LogStream.

LogSubscriptionDestinationConfig

Properties returned by a Subscription destination.

MetricFilter

A filter that extracts information from CloudWatch Logs and emits to CloudWatch Metrics.

MetricFilterOptions

Properties for a MetricFilter created from a LogGroup.

MetricFilterProps

Properties for a MetricFilter.

MoveKeyEntryProperty

This object defines one key that will be moved with the moveKey processor.

MoveKeysProperty

This processor moves a key from one field to another.

ParseJSONProperty

This processor parses log events that are in JSON format.

ParseKeyValueProperty

This processor parses a specified field in the original log event into key-value pairs.

ParseToOCSFProperty

Processor to parse events from CloudTrail, Route53Resolver, VPCFlow, EKSAudit and AWSWAF into OCSF V1.1 format.

ParserProcessor

Parser processor for common data formats.

ParserProcessorProps

Properties for creating configurable parser processors.

ProcessorDeleteKeysProperty

This processor adds new key-value pairs to the log event.

QueryDefinition

Define a query definition for CloudWatch Logs Insights.

QueryDefinitionProps

Properties for a QueryDefinition.

QueryString

Define a QueryString.

QueryStringProps

Properties for a QueryString.

RenameKeyEntryProperty

This object defines one key that will be renamed with the renameKey processor.

RenameKeysProperty

Use this processor to rename keys in a log event.

ResourcePolicy

Resource Policy for CloudWatch Log Groups.

ResourcePolicyProps

Properties to define Cloudwatch log group resource policy.

SpaceDelimitedTextPattern

Space delimited text pattern.

SplitStringEntryProperty

This object defines one log field that will be split with the splitString processor.

SplitStringProperty

Use this processor to split a field into an array of strings using a delimiting character.

StreamOptions

Properties for a new LogStream created from a LogGroup.

StringMutatorProcessor

Processor for string mutation operations.

StringMutatorProps

Properties for creating string mutator processors.

SubscriptionFilter

A new Subscription on a CloudWatch log group.

SubscriptionFilterOptions

Properties for a new SubscriptionFilter created from a LogGroup.

SubscriptionFilterProps

Properties for a SubscriptionFilter.

SubstituteStringEntryProperty

This object defines one log field key that will be replaced using the substituteString processor.

SubstituteStringProperty

This processor matches a key's value against a regular expression and replaces all matches with a replacement string.

Transformer

Represent the L2 construct for the AWS::Logs::Transformer CloudFormation resource.

TransformerOptions

Properties for Transformer created from LogGroup.

TransformerProps

The Resource properties for AWS::Logs::Transformer resource.

TypeConverterEntryProperty

This object defines one value type that will be converted using the typeConverter processor.

TypeConverterProperty

Use this processor to convert a value type associated with the specified key to the specified type.

VendedLogParser

Parser processor for AWS vended logs.

VendedLogParserProps

Properties for creating AWS vended log parsers.

Interfaces

CfnDeliveryDestination.IDestinationPolicyProperty
CfnIntegration.IOpenSearchResourceConfigProperty

This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service.

CfnIntegration.IResourceConfigProperty

This structure contains configuration details about an integration between CloudWatch Logs and another entity.

CfnMetricFilter.IDimensionProperty

Specifies the CloudWatch metric dimensions to publish with this metric.

CfnMetricFilter.IMetricTransformationProperty

MetricTransformation is a property of the AWS::Logs::MetricFilter resource that describes how to transform log streams into a CloudWatch metric.

CfnTransformer.IAddKeyEntryProperty

This object defines one key that will be added with the addKeys processor.

CfnTransformer.IAddKeysProperty

This processor adds new key-value pairs to the log event.

CfnTransformer.ICopyValueEntryProperty

This object defines one value to be copied with the copyValue processor.

CfnTransformer.ICopyValueProperty

This processor copies values within a log event.

CfnTransformer.ICsvProperty

The CSV processor parses comma-separated values (CSV) from the log events into columns.

CfnTransformer.IDateTimeConverterProperty

This processor converts a datetime string into a format that you specify.

CfnTransformer.IDeleteKeysProperty

This processor deletes entries from a log event. These entries are key-value pairs.

CfnTransformer.IGrokProperty

This processor uses pattern matching to parse and structure unstructured data.

CfnTransformer.IListToMapProperty

This processor takes a list of objects that contain key fields, and converts them into a map of target keys.

CfnTransformer.ILowerCaseStringProperty

This processor converts a string to lowercase.

CfnTransformer.IMoveKeyEntryProperty

This object defines one key that will be moved with the moveKey processor.

CfnTransformer.IMoveKeysProperty

This processor moves a key from one field to another. The original key is deleted.

CfnTransformer.IParseCloudfrontProperty

This processor parses CloudFront vended logs, extract fields, and convert them into JSON format.

CfnTransformer.IParseJSONProperty

This processor parses log events that are in JSON format.

CfnTransformer.IParseKeyValueProperty

This processor parses a specified field in the original log event into key-value pairs.

CfnTransformer.IParsePostgresProperty

Use this processor to parse RDS for PostgreSQL vended logs, extract fields, and and convert them into a JSON format.

CfnTransformer.IParseRoute53Property

Use this processor to parse Route 53 vended logs, extract fields, and and convert them into a JSON format.

CfnTransformer.IParseToOCSFProperty

This processor converts logs into Open Cybersecurity Schema Framework (OCSF) events.

CfnTransformer.IParseVPCProperty

Use this processor to parse Amazon VPC vended logs, extract fields, and and convert them into a JSON format.

CfnTransformer.IParseWAFProperty

Use this processor to parse AWS WAF vended logs, extract fields, and and convert them into a JSON format.

CfnTransformer.IProcessorProperty

This structure contains the information about one processor in a log transformer.

CfnTransformer.IRenameKeyEntryProperty

This object defines one key that will be renamed with the renameKey processor.

CfnTransformer.IRenameKeysProperty

Use this processor to rename keys in a log event.

CfnTransformer.ISplitStringEntryProperty

This object defines one log field that will be split with the splitString processor.

CfnTransformer.ISplitStringProperty

Use this processor to split a field into an array of strings using a delimiting character.

CfnTransformer.ISubstituteStringEntryProperty

This object defines one log field key that will be replaced using the substituteString processor.

CfnTransformer.ISubstituteStringProperty

This processor matches a key’s value against a regular expression and replaces all matches with a replacement string.

CfnTransformer.ITrimStringProperty

Use this processor to remove leading and trailing whitespace.

CfnTransformer.ITypeConverterEntryProperty

This object defines one value type that will be converted using the typeConverter processor.

CfnTransformer.ITypeConverterProperty

Use this processor to convert a value type associated with the specified key to the specified type.

CfnTransformer.IUpperCaseStringProperty

This processor converts a string field to uppercase.

IAddKeyEntryProperty

This object defines one key that will be added with the addKeys processor.

IAddKeysProperty

This processor adds new key-value pairs to the log event.

IBaseProcessorProps

Base properties for all processor types.

ICfnAccountPolicyProps

Properties for defining a CfnAccountPolicy.

ICfnDeliveryDestinationProps

Properties for defining a CfnDeliveryDestination.

ICfnDeliveryProps

Properties for defining a CfnDelivery.

ICfnDeliverySourceProps

Properties for defining a CfnDeliverySource.

ICfnDestinationProps

Properties for defining a CfnDestination.

ICfnIntegrationProps

Properties for defining a CfnIntegration.

ICfnLogAnomalyDetectorProps

Properties for defining a CfnLogAnomalyDetector.

ICfnLogGroupProps

Properties for defining a CfnLogGroup.

ICfnLogStreamProps

Properties for defining a CfnLogStream.

ICfnMetricFilterProps

Properties for defining a CfnMetricFilter.

ICfnQueryDefinitionProps

Properties for defining a CfnQueryDefinition.

ICfnResourcePolicyProps

Properties for defining a CfnResourcePolicy.

ICfnSubscriptionFilterProps

Properties for defining a CfnSubscriptionFilter.

ICfnTransformerProps

Properties for defining a CfnTransformer.

IColumnRestriction
ICopyValueEntryProperty

This object defines one value to be copied with the copyValue processor.

ICopyValueProperty

Copy Value processor, copies values from source to target for each entry.

ICrossAccountDestinationProps

Properties for a CrossAccountDestination.

ICsvProperty

The CSV processor parses comma-separated values (CSV) from the log events into columns.

IDataConverterProps

Properties for creating data converter processors.

IDataProtectionPolicyProps

Properties for creating a data protection policy.

IDateTimeConverterProperty

This processor converts a datetime string into a format that you specify.

IFieldIndexPolicyProps

Properties for creating field index policies.

IFilterPattern

Interface for objects that can render themselves to log patterns.

IGrokProperty

This processor uses pattern matching to parse and structure unstructured data.

IJsonMutatorProps

Properties for creating JSON mutator processors.

IListToMapProperty

This processor takes a list of objects that contain key fields, and converts them into a map of target keys.

ILogGroup
ILogGroupProps

Properties for a LogGroup.

ILogRetentionProps

Construction properties for a LogRetention.

ILogRetentionRetryOptions

Retry options for all AWS API calls.

ILogStream
ILogStreamProps

Properties for a LogStream.

ILogSubscriptionDestination

Interface for classes that can be the destination of a log Subscription.

ILogSubscriptionDestinationConfig

Properties returned by a Subscription destination.

IMetricFilterOptions

Properties for a MetricFilter created from a LogGroup.

IMetricFilterProps

Properties for a MetricFilter.

IMoveKeyEntryProperty

This object defines one key that will be moved with the moveKey processor.

IMoveKeysProperty

This processor moves a key from one field to another.

IParseJSONProperty

This processor parses log events that are in JSON format.

IParseKeyValueProperty

This processor parses a specified field in the original log event into key-value pairs.

IParseToOCSFProperty

Processor to parse events from CloudTrail, Route53Resolver, VPCFlow, EKSAudit and AWSWAF into OCSF V1.1 format.

IParserProcessorProps

Properties for creating configurable parser processors.

IProcessor

Interface representing a single processor in a CloudWatch Logs transformer.

IProcessorDeleteKeysProperty

This processor adds new key-value pairs to the log event.

IQueryDefinitionProps

Properties for a QueryDefinition.

IQueryStringProps

Properties for a QueryString.

IRenameKeyEntryProperty

This object defines one key that will be renamed with the renameKey processor.

IRenameKeysProperty

Use this processor to rename keys in a log event.

IResourcePolicyProps

Properties to define Cloudwatch log group resource policy.

ISplitStringEntryProperty

This object defines one log field that will be split with the splitString processor.

ISplitStringProperty

Use this processor to split a field into an array of strings using a delimiting character.

IStreamOptions

Properties for a new LogStream created from a LogGroup.

IStringMutatorProps

Properties for creating string mutator processors.

ISubscriptionFilterOptions

Properties for a new SubscriptionFilter created from a LogGroup.

ISubscriptionFilterProps

Properties for a SubscriptionFilter.

ISubstituteStringEntryProperty

This object defines one log field key that will be replaced using the substituteString processor.

ISubstituteStringProperty

This processor matches a key's value against a regular expression and replaces all matches with a replacement string.

ITransformerOptions

Properties for Transformer created from LogGroup.

ITransformerProps

The Resource properties for AWS::Logs::Transformer resource.

ITypeConverterEntryProperty

This object defines one value type that will be converted using the typeConverter processor.

ITypeConverterProperty

Use this processor to convert a value type associated with the specified key to the specified type.

IVendedLogParserProps

Properties for creating AWS vended log parsers.

Enums

DataConverterType

Types of data conversion operations.

DateTimeFormat

Standard datetime formats for the DateTimeConverter processor.

DelimiterCharacter

Valid delimiter characters for CSV processor.

Distribution

The method used to distribute log data to the destination.

JsonMutatorType

Types of JSON mutation operations.

KeyValueDelimiter

Valid key-value delimiters for ParseKeyValue processor.

KeyValuePairDelimiter

Valid field delimiters for ParseKeyValue processor.

LogGroupClass

Class of Log Group.

OCSFSourceType

Types of event sources supported to convert to OCSF format.

OCSFVersion

OCSF Schema versions supported by transformers.

ParserProcessorType

Types of configurable parser processors.

QuoteCharacter

Valid quote characters for CSV processor.

RetentionDays

How long, in days, the log contents will be retained.

StringMutatorType

Types of string mutation operations.

TypeConverterType

Valid data types for type conversion in the TypeConverter processor.

VendedLogType

Types of AWS vended logs with built-in parsers.

Back to top Generated by DocFX