LogRetention¶
-
class
aws_cdk.aws_lambda.
LogRetention
(scope, id, *, log_group_name, retention, log_group_region=None, log_retention_retry_options=None, role=None)¶ Bases:
aws_cdk.aws_logs.LogRetention
(deprecated) 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
isundefined
or equal toInfinity
.- Deprecated
use
LogRetention
from ‘- Stability
deprecated
- Aws-cdk
/aws-logs’ instead
- 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_lambda as lambda_ import aws_cdk.aws_logs as logs import aws_cdk.core as cdk # role: iam.Role log_retention = lambda_.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 stacklog_retention_retry_options (
Optional
[LogRetentionRetryOptions
]) – Retry options for all AWS API calls. Default: - AWS SDK default retry optionsrole (
Optional
[IRole
]) – The IAM role for the Lambda function associated with the custom resource. Default: - A new role is created
- Stability
deprecated
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
Static Methods
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool