software.amazon.awscdk.services.logs

Class LogRetention

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.logs.LogRetention

All Implemented Interfaces:

IConstruct, IDependable

Direct Known Subclasses:

LogRetention

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:58.573Z")
public class LogRetention
extends 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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.logs.*;
 import software.amazon.awscdk.core.*;
 Role role;
 LogRetention logRetention = LogRetention.Builder.create(this, "MyLogRetention")
         .logGroupName("logGroupName")
         .retention(RetentionDays.ONE_DAY)
         // the properties below are optional
         .logGroupRegion("logGroupRegion")
         .logRetentionRetryOptions(LogRetentionRetryOptions.builder()
                 .base(Duration.minutes(30))
                 .maxRetries(123)
                 .build())
         .role(role)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogRetention.Builder A fluent builder for LogRetention.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LogRetention(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	LogRetention(software.amazon.jsii.JsiiObjectRef objRef)
	LogRetention(software.constructs.Construct scope, java.lang.String id, LogRetentionProps props)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLogGroupArn() The ARN of the LogGroup.

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LogRetention

protected LogRetention(software.amazon.jsii.JsiiObjectRef objRef)

LogRetention

protected LogRetention(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

LogRetention

public LogRetention(software.constructs.Construct scope,
                    java.lang.String id,
                    LogRetentionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

getLogGroupArn

public java.lang.String getLogGroupArn()

The ARN of the LogGroup.