CloudWatchLogGroup

class aws_cdk.aws_events_targets.CloudWatchLogGroup(log_group, *, event=None, install_latest_aws_sdk=None, log_event=None, dead_letter_queue=None, max_event_age=None, retry_attempts=None)

Bases: object

Use an AWS CloudWatch LogGroup as an event rule target.

ExampleMetadata:

infused

Example:

import aws_cdk.aws_logs as logs
# log_group: logs.LogGroup
# rule: events.Rule


rule.add_target(targets.CloudWatchLogGroup(log_group,
    log_event=targets.LogGroupTargetInput.from_object(
        message=JSON.stringify({
            "CustomField": "CustomValue"
        })
    )
))
Parameters:

  • log_group (ILogGroup) –

  • event (Optional[RuleTargetInput]) – (deprecated) The event to send to the CloudWatch LogGroup. This will be the event logged into the CloudWatch LogGroup Default: - the entire EventBridge event

  • install_latest_aws_sdk (Optional[bool]) – Whether the custom resource created wll default to install latest AWS SDK. Default: - install latest AWS SDK

  • log_event (Optional[LogGroupTargetInput]) – The event to send to the CloudWatch LogGroup. This will be the event logged into the CloudWatch LogGroup Default: - the entire EventBridge event

  • dead_letter_queue (Optional[IQueue]) – The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue. The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue. Default: - no dead-letter queue

  • max_event_age (Optional[Duration]) – The maximum age of a request that Lambda sends to a function for processing. Minimum value of 60. Maximum value of 86400. Default: Duration.hours(24)

  • retry_attempts (Union[int, float, None]) – The maximum number of times to retry when the function returns an error. Minimum value of 0. Maximum value of 185. Default: 185

Methods

bind(_rule, _id=None)

Returns a RuleTarget that can be used to log an event into a CloudWatch LogGroup.

Parameters:

  • _rule (IRule) –

  • _id (Optional[str]) –

Return type:

RuleTargetConfig