AWS::Logs::LogGroup
The AWS::Logs::LogGroup
resource specifies a log group. A log group defines common properties for log streams,
such as their retention and access control rules. Each log stream must belong to one
log group.
You can create up to 1,000,000 log groups per Region per account. You must use the following guidelines when naming a log group:
-
Log group names must be unique within a Region for an AWS account.
-
Log group names can be between 1 and 512 characters long.
-
Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Logs::LogGroup", "Properties" : { "KmsKeyId" :
String
, "LogGroupName" :String
, "RetentionInDays" :Integer
} }
YAML
Type: AWS::Logs::LogGroup Properties: KmsKeyId:
String
LogGroupName:String
RetentionInDays:Integer
Properties
KmsKeyId
-
The Amazon Resource Name (ARN) of the CMK to use when encrypting log data.
Required: No
Type: String
Maximum:
256
Update requires: No interruption
LogGroupName
-
The name of the log group. If you don't specify a name, AWS CloudFormation generates a unique ID for the log group.
Required: No
Type: String
Minimum:
1
Maximum:
512
Pattern:
[\.\-_/#A-Za-z0-9]+
Update requires: Replacement
RetentionInDays
-
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, and 3653.
If you omit
retentionInDays
in aPutRetentionPolicy
operation, the events in the log group are always retained and never expire.Required: No
Type: Integer
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the resource name.
For more information about using the Ref
function, see Ref.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following
are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt.
Examples
Create a Log Group
The following example creates a log group that retains events for 7 days.
JSON
"myLogGroup": { "Type": "AWS::Logs::LogGroup", "Properties": { "RetentionInDays": 7 } }
YAML
myLogGroup: Type: AWS::Logs::LogGroup Properties: RetentionInDays: 7