Package software.amazon.awscdk.services.logs

Interface LogRetentionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LogRetentionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:09.595Z")
@Stability(Stable)
public interface LogRetentionProps
extends software.amazon.jsii.JsiiSerializable

Construction properties for a LogRetention.

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;
 LogRetentionProps logRetentionProps = LogRetentionProps.builder()
         .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	Interface	Description
static final class	LogRetentionProps.Builder	A builder for LogRetentionProps
static final class	LogRetentionProps.Jsii$Proxy	An implementation for LogRetentionProps

Method Summary

Modifier and Type	Method	Description
static LogRetentionProps.Builder	builder()
String	getLogGroupName()	The log group name.
default String	getLogGroupRegion()	The region where the log group should be created.
default LogRetentionRetryOptions	getLogRetentionRetryOptions()	Retry options for all AWS API calls.
default RemovalPolicy	getRemovalPolicy()	The removalPolicy for the log group when the stack is deleted.
RetentionDays	getRetention()	The number of days log events are kept in CloudWatch Logs.
default IRole	getRole()	The IAM role for the Lambda function associated with the custom resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLogGroupName

@Stability(Stable)
@NotNull
String getLogGroupName()

The log group name.

getRetention

@Stability(Stable)
@NotNull
RetentionDays getRetention()

The number of days log events are kept in CloudWatch Logs.

getLogGroupRegion

@Stability(Stable)
@Nullable
default String getLogGroupRegion()

The region where the log group should be created.

Default: - same region as the stack

getLogRetentionRetryOptions

@Stability(Stable)
@Nullable
default LogRetentionRetryOptions getLogRetentionRetryOptions()

Retry options for all AWS API calls.

Default: - AWS SDK default retry options

getRemovalPolicy

@Stability(Stable)
@Nullable
default RemovalPolicy getRemovalPolicy()

The removalPolicy for the log group when the stack is deleted.

Default: RemovalPolicy.RETAIN

getRole

@Stability(Stable)
@Nullable
default IRole getRole()

The IAM role for the Lambda function associated with the custom resource.

Default: - A new role is created

builder

@Stability(Stable)
static LogRetentionProps.Builder builder()

Returns:

a LogRetentionProps.Builder of LogRetentionProps