software.amazon.awscdk.services.logs

Class LogRetention

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.services.logs.LogRetention

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.709Z")
 @Stability(value=Stable)
public class LogRetention
extends software.constructs.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.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.logs.*;
 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())
         .removalPolicy(RemovalPolicy.DESTROY)
         .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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

LogRetention

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

LogRetention

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

LogRetention

@Stability(value=Stable)
public LogRetention(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             LogRetentionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

getLogGroupArn

@Stability(value=Stable)
 @NotNull
public String getLogGroupArn()

The ARN of the LogGroup.