Class CfnLogGroupProps
Properties for defining a CfnLogGroup
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Logs
Assembly: Amazon.CDK.AWS.Logs.dll
Syntax (csharp)
public class CfnLogGroupProps : Object, ICfnLogGroupProps
Syntax (vb)
Public Class CfnLogGroupProps
Inherits Object
Implements ICfnLogGroupProps
Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Logs;
var dataProtectionPolicy;
var cfnLogGroupProps = new CfnLogGroupProps {
DataProtectionPolicy = dataProtectionPolicy,
KmsKeyId = "kmsKeyId",
LogGroupName = "logGroupName",
RetentionInDays = 123,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Constructors
CfnLogGroupProps() |
Properties
DataProtectionPolicy | Creates a data protection policy and assigns it to the log group. |
KmsKeyId | The Amazon Resource Name (ARN) of the AWS KMS key to use when encrypting log data. |
LogGroupName | The name of the log group. |
RetentionInDays | The number of days to retain the log events in the specified log group. |
Tags | An array of key-value pairs to apply to the log group. |
Constructors
CfnLogGroupProps()
public CfnLogGroupProps()
Properties
DataProtectionPolicy
Creates a data protection policy and assigns it to the log group.
public object DataProtectionPolicy { get; set; }
Property Value
System.Object
Remarks
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.
For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking .
KmsKeyId
The Amazon Resource Name (ARN) of the AWS KMS key to use when encrypting log data.
public string KmsKeyId { get; set; }
Property Value
System.String
Remarks
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
LogGroupName
The name of the log group.
public string LogGroupName { get; set; }
Property Value
System.String
Remarks
If you don't specify a name, AWS CloudFormation generates a unique ID for the log group.
RetentionInDays
The number of days to retain the log events in the specified log group.
public Nullable<double> RetentionInDays { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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, use DeleteRetentionPolicy .
Tags
An array of key-value pairs to apply to the log group.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
For more information, see Tag .