Package 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.113.0 (build fc68b25)",
           date="2025-09-02T11:25:35.331Z")
@Stability(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.*;
 Object dataProtectionPolicy;
 Object fieldIndexPolicies;
 Object resourcePolicyDocument;
 CfnLogGroupProps cfnLogGroupProps = CfnLogGroupProps.builder()
         .dataProtectionPolicy(dataProtectionPolicy)
         .fieldIndexPolicies(List.of(fieldIndexPolicies))
         .kmsKeyId("kmsKeyId")
         .logGroupClass("logGroupClass")
         .logGroupName("logGroupName")
         .resourcePolicyDocument(resourcePolicyDocument)
         .retentionInDays(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnLogGroupProps.Builder	builder()
default Object	getDataProtectionPolicy()	Creates a data protection policy and assigns it to the log group.
default Object	getFieldIndexPolicies()	Creates or updates a field index policy for the specified log group.
default String	getKmsKeyId()	The Amazon Resource Name (ARN) of the AWS KMS key to use when encrypting log data.
default String	getLogGroupClass()	Specifies the log group class for this log group.
default String	getLogGroupName()	The name of the log group.
default Object	getResourcePolicyDocument()	Creates or updates a resource policy for the specified log group that allows other services to put log events to this account.
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 Details

getDataProtectionPolicy

@Stability(Stable)
@Nullable
default Object getDataProtectionPolicy()

Creates a data protection policy and assigns it to the log group.

A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. When a user who does not have permission to view masked data views a log event that includes masked data, the sensitive data is replaced by asterisks.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-dataprotectionpolicy

getFieldIndexPolicies

@Stability(Stable)
@Nullable
default Object getFieldIndexPolicies()

Creates or updates a field index policy for the specified log group.

Only log groups in the Standard log class support field index policies. For more information about log classes, see Log classes .

You can use field index policies to create field indexes on fields found in log events in the log group. Creating field indexes lowers the costs for CloudWatch Logs Insights queries that reference those field indexes, because these queries attempt to skip the processing of log events that are known to not match the indexed field. Good fields to index are fields that you often need to query for and fields that have high cardinality of values Common examples of indexes include request ID, session ID, userID, and instance IDs. For more information, see Create field indexes to improve query performance and reduce costs .

Currently, this array supports only one field index policy object.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-fieldindexpolicies

getKmsKeyId

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-kmskeyid

getLogGroupClass

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

Specifies the log group class for this log group. There are two classes:.

• The Standard log class supports all CloudWatch Logs features.
• The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

For details about the features supported by each class, see Log classes

Default: - "STANDARD"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-loggroupclass

getLogGroupName

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-loggroupname

getResourcePolicyDocument

@Stability(Stable)
@Nullable
default Object getResourcePolicyDocument()

Creates or updates a resource policy for the specified log group that allows other services to put log events to this account.

A LogGroup can have 1 resource policy.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-resourcepolicydocument

getRetentionInDays

@Stability(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, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.

To set a log group so that its log events do not expire, do not specify this property.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-retentionindays

getTags

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

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

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-tags

builder

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

Returns:

a CfnLogGroupProps.Builder of CfnLogGroupProps