CfnLogGroupProps¶
-
class
aws_cdk.aws_logs.
CfnLogGroupProps
(*, kms_key_id=None, log_group_name=None, retention_in_days=None, tags=None)¶ Bases:
object
Properties for defining a
CfnLogGroup
.- Parameters
kms_key_id (
Optional
[str
]) – 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 anInvalidParameterException
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 Servicelog_group_name (
Optional
[str
]) – The name of the log group. If you don’t specify a name, AWS CloudFormation generates a unique ID for the log group.retention_in_days (
Union
[int
,float
,None
]) – 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 .tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – An array of key-value pairs to apply to the log group. For more information, see Tag .
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_logs as logs cfn_log_group_props = logs.CfnLogGroupProps( kms_key_id="kmsKeyId", log_group_name="logGroupName", retention_in_days=123, tags=[CfnTag( key="key", value="value" )] )
Attributes
-
kms_key_id
¶ 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
- Link
- Return type
Optional
[str
]
-
log_group_name
¶ The name of the log group.
If you don’t specify a name, AWS CloudFormation generates a unique ID for the log group.
- Link
- Return type
Optional
[str
]
-
retention_in_days
¶ 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 .
- Link
- Return type
Union
[int
,float
,None
]