software.amazon.awscdk.services.logs

Interface CfnLogGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLogGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.697Z")
 @Stability(value=Stable)
public interface CfnLogGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnLogGroup`.

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.logs.*;
 CfnLogGroupProps cfnLogGroupProps = CfnLogGroupProps.builder()
         .kmsKeyId("kmsKeyId")
         .logGroupName("logGroupName")
         .retentionInDays(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnLogGroupProps.Builder A builder for CfnLogGroupProps
static class	CfnLogGroupProps.Jsii$Proxy An implementation for CfnLogGroupProps

Method Summary

Modifier and Type	Method and Description
static CfnLogGroupProps.Builder	builder()
default String	getKmsKeyId() The Amazon Resource Name (ARN) of the AWS KMS key to use when encrypting log data.
default String	getLogGroupName() The name of the log group.
default Number	getRetentionInDays() The number of days to retain the log events in the specified log group.
default List<CfnTag>	getTags() An array of key-value pairs to apply to the log group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getKmsKeyId

@Stability(value=Stable)
 @Nullable
default String getKmsKeyId()

The Amazon Resource Name (ARN) of the AWS KMS key to use when encrypting log data.

To associate an AWS KMS key with the log group, specify the ARN of that KMS key here. If you do so, ingested data is encrypted using this key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs . This enables CloudWatch Logs to decrypt this data whenever it is requested.

If you attempt to associate a KMS key with the log group but the KMS key doesn't exist or is deactivated, you will receive an InvalidParameterException error.

Log group data is always encrypted in CloudWatch Logs . If you omit this key, the encryption does not use AWS KMS . For more information, see Encrypt log data in CloudWatch Logs using AWS Key Management Service

getLogGroupName

@Stability(value=Stable)
 @Nullable
default String getLogGroupName()

The name of the log group.

If you don't specify a name, AWS CloudFormation generates a unique ID for the log group.

getRetentionInDays

@Stability(value=Stable)
 @Nullable
default Number getRetentionInDays()

The number of days to retain the log events in the specified log group.

Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, and 3653.

To set a log group to never have log events expire, use DeleteRetentionPolicy .

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to the log group.

For more information, see Tag .

builder

@Stability(value=Stable)
static CfnLogGroupProps.Builder builder()

Returns:

a CfnLogGroupProps.Builder of CfnLogGroupProps