CfnLogGroupProps Struct
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 { aws_logs as logs } from 'aws-cdk-lib';
declare const dataProtectionPolicy: any;
declare const fieldIndexPolicies: any;
declare const resourcePolicyDocument: any;
const cfnLogGroupProps: logs.CfnLogGroupProps = {
bearerTokenAuthenticationEnabled: false,
dataProtectionPolicy: dataProtectionPolicy,
deletionProtectionEnabled: false,
fieldIndexPolicies: [fieldIndexPolicies],
kmsKeyId: 'kmsKeyId',
logGroupClass: 'logGroupClass',
logGroupName: 'logGroupName',
resourcePolicyDocument: resourcePolicyDocument,
retentionInDays: 123,
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
bearerTokenAuthenticationEnabledoptionalboolean | IResolvablebearer_token_authentication_enabledoptionaltyping.Union[bool, IResolvable]bearerTokenAuthenticationEnabledoptionalBooleanBearerTokenAuthenticationEnabledoptionalboolBearerTokenAuthenticationEnabledoptionalinterface{}= false#When enabled, bearer token authentication is allowed on operations until it is explicitly disabled.
dataProtectionPolicyoptionalanydata_protection_policyoptionalAnydataProtectionPolicyoptionalObjectDataProtectionPolicyoptionalobjectDataProtectionPolicyoptionalinterface{}#notes
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.
deletionProtectionEnabledoptionalboolean | IResolvabledeletion_protection_enabledoptionaltyping.Union[bool, IResolvable]deletionProtectionEnabledoptionalBooleanDeletionProtectionEnabledoptionalboolDeletionProtectionEnabledoptionalinterface{}= false#When enabled, deletion protection blocks all deletion operations until it is explicitly disabled.
fieldIndexPoliciesoptionalany[] | IResolvablefield_index_policiesoptionaltyping.Union[typing.List[Any], IResolvable]fieldIndexPoliciesoptionalList<Object>FieldIndexPoliciesoptionalobject[]FieldIndexPoliciesoptionalinterface{}#notes
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.
kmsKeyIdoptionalstring | IKeyRefkms_key_idoptionaltyping.Union[str, IKeyRef]kmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptionalinterface{}#notes
To associate an AWS 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 . For more information, see Encrypt log data in CloudWatch Logs using AWS Key Management Service
logGroupClassoptionalstringlog_group_classoptionalstrlogGroupClassoptionalStringLogGroupClassoptionalstringLogGroupClassoptional*string= "STANDARD"#notes
- The
Standardlog class supports all CloudWatch Logs features. - The
Infrequent Accesslog class supports a subset of CloudWatch Logs features and incurs lower costs.
For details about the features supported by each class, see Log classes
logGroupNameoptionalstring | IFunctionReflog_group_nameoptionaltyping.Union[str, IFunctionRef]logGroupNameoptionalStringLogGroupNameoptionalstringLogGroupNameoptionalinterface{}#If you don't specify a name, AWS CloudFormation generates a unique ID for the log group.
resourcePolicyDocumentoptionalanyresource_policy_documentoptionalAnyresourcePolicyDocumentoptionalObjectResourcePolicyDocumentoptionalobjectResourcePolicyDocumentoptionalinterface{}#A LogGroup can have 1 resource policy.
retentionInDaysoptionalnumberretention_in_daysoptionalint | floatretentionInDaysoptionalNumberRetentionInDaysoptionaldoubleRetentionInDaysoptional*float64#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.