AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

AWS::Logs::LogGroup

AWS::Logs::LogGroup 资源将创建 Amazon CloudWatch Logs 日志组,此日志组定义了日志流的常用属性,如日志流的保留和访问控制规则。每个日志流必须属于一个日志组。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

Copy
{ "Type" : "AWS::Logs::LogGroup", "Properties" : { "LogGroupName" : String, "RetentionInDays" : Integer } }

YAML

Copy
Type: "AWS::Logs::LogGroup" Properties: LogGroupName: String RetentionInDays: Integer

属性

LogGroupName

日志组的名称。如果不指定名称,则 AWS CloudFormation 会生成一个唯一物理 ID 并将该 ID 用作日志组。有关更多信息,请参阅 名称类型

重要

如果指定一个名称,您将无法执行需要替换此资源的更新。您可以执行不需要或者只需要部分中断的更新。如果必须替换资源,请指定新名称。

必需:否

Type: String

更新要求替换

RetentionInDays

日志事件在 CloudWatch Logs 中保留的天数。当日志事件到期时,CloudWatch Logs 自动将其删除。关于有效的值,请参阅 Amazon CloudWatch Logs API Reference 中的 PutRetentionPolicy

Required: No

Type: Integer

更新要求无需中断

返回值

Ref

当该资源的逻辑 ID 提供给 Ref内部函数时,Ref 将返回资源名称。

有关使用 Ref 功能的更多信息,请参阅参考

Fn::GetAtt

Fn::GetAtt 返回一个此类型指定属性的值。以下为可用属性和示例返回值。

Arn

CloudWatch Logs 日志组的 Amazon 资源名称 (ARN),如 arn:aws:logs:us-east-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:*

有关使用 Fn::GetAtt 的更多信息,请参见 Fn::GetAtt

示例

下述示例创建一个将事件保留 7 天的 CloudWatch Logs 日志组。

JSON

Copy
"myLogGroup": { "Type": "AWS::Logs::LogGroup", "Properties": { "RetentionInDays": 7 } }

YAML

Copy
myLogGroup: Type: "AWS::Logs::LogGroup" Properties: RetentionInDays: 7

附加信息

有关其他示例模板,请参阅 Amazon CloudWatch Logs 模板代码段