LogRetention

class aws_cdk.aws_logs.LogRetention(scope, id, *, log_group_name, retention, log_group_region=None, log_retention_retry_options=None, role=None)

Bases: aws_cdk.core.Construct

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

The log group is created if it doesn’t already exist. The policy is removed when retentionDays is undefined or equal to Infinity. Log group can be created in the region that is different from stack region by specifying logGroupRegion

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iam as iam
import aws_cdk.aws_logs as logs
import aws_cdk.core as cdk

# role: iam.Role

log_retention = logs.LogRetention(self, "MyLogRetention",
    log_group_name="logGroupName",
    retention=logs.RetentionDays.ONE_DAY,

    # the properties below are optional
    log_group_region="logGroupRegion",
    log_retention_retry_options=logs.LogRetentionRetryOptions(
        base=cdk.Duration.minutes(30),
        max_retries=123
    ),
    role=role
)
Parameters
  • scope (Construct) –

  • id (str) –

  • log_group_name (str) – The log group name.

  • retention (RetentionDays) – The number of days log events are kept in CloudWatch Logs.

  • log_group_region (Optional[str]) – The region where the log group should be created. Default: - same region as the stack

  • log_retention_retry_options (Union[LogRetentionRetryOptions, Dict[str, Any], None]) – Retry options for all AWS API calls. Default: - AWS SDK default retry options

  • role (Optional[IRole]) – The IAM role for the Lambda function associated with the custom resource. Default: - A new role is created

Methods

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

log_group_arn

The ARN of the LogGroup.

Return type

str

node

The construct tree node associated with this construct.

Return type

ConstructNode

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool