Merge pull request #120 from aliyun/tanhehe/add_fun_log_spec

add log spec
alibaba · Dec 29, 2018 · 37d43cd · 37d43cd
2 parents 3b8f659 + e50698d
commit 37d43cd
Show file tree

Hide file tree

Showing 3 changed files with 77 additions and 8 deletions.
diff --git a/docs/specs/2018-04-03-zh-cn.md b/docs/specs/2018-04-03-zh-cn.md
@@ -66,11 +66,11 @@ Resources:
   - [Aliyun::Serverless::Function](#aliyunserverlessfunction)
 - [Aliyun::Serverless::CustomDomain](#aliyunserverlesscustomdomain)
 - [Aliyun::Serverless::Api](#aliyunserverlessapi)
-- [Aliyun:Serverless::TableStore](#aliyunserverlesstablestore)
+- [Aliyun::Serverless::TableStore](#aliyunserverlesstablestore)
   - [Aliyun:Serverless::TableStore::Table](#aliyunserverlesstablestoretable)
-- [Aliyun:Serverless::Log](#aliyunserverlesslog)
-  - [Aliyun:Serverless::Log::Logstore](#aliyunserverlessloglogstore)
-- [Aliyun:Serverless::MNSTopic](#aliyunserverlessmnstopic)
+- [Aliyun::Serverless::Log](#aliyunserverlesslog)
+  - [Aliyun::Serverless::Log::Logstore](#aliyunserverlessloglogstore)
+- [Aliyun::Serverless::MNSTopic](#aliyunserverlessmnstopic)
 
 #### Aliyun::Serverless::Service
 
@@ -206,6 +206,40 @@ mytablestore: # tablestore name
               Type: STRING
 ```
 
+#### Aliyun::Serverless::Log
+
+`Aliyun::Serverless::Log` 资源创建日志服务的 [项目（Project）](https://help.aliyun.com/document_detail/48873.html)。
+
+##### 属性
+属性名称 | 类型 | 描述
+---|:---:|---
+Description | `string` | **必填。** 实例注释。
+
+##### Aliyun::Serverless::Log::Logstore
+
+`Aliyun::Serverless::Log::Logstore` 资源用于创建项目（Project）下的 [日志库（Logstore）](https://help.aliyun.com/document_detail/48874.html)。
+
+###### 属性
+
+属性名称 | 类型 | 描述
+---|:---:|---
+TTL | `integer` | 数据的保存时间，单位为天，范围 1~3600。
+shardCount | `integer` | Shard 个数，单位为个，范围为 1~100。
+
+#### 示例：Aliyun::Serverless::Log
+
+```yaml
+test-log-project:
+  Type: 'Aliyun::Serverless::Log'
+  Properties:
+    Description: 'just test log'
+  test-log-store:
+    Type: 'Aliyun::Serverless::Log::Logstore'
+    Properties:
+      TTL: 10
+      ShardCount: 1
+```
+
 #### Aliyun::Serverless::MNSTopic
 
 创建消息服务 MNS 中的 topic

diff --git a/docs/specs/2018-04-03.md b/docs/specs/2018-04-03.md
@@ -66,9 +66,9 @@ All property names in Aliyun Fun are **case sensitive**.
 - [Aliyun::Serverless::CustomDomain](#aliyunserverlesscustomdomain)
 - [Aliyun::Serverless::Api](#aliyunserverlessapi)
 - [Aliyun::Serverless::TableStore](#aliyunserverlesstablestore)
-  - [Aliyun:Serverless::TableStore::Table](#aliyunserverlesstablestoretable)
-- [Aliyun:Serverless::Log](#aliyunserverlesslog)
-  - [Aliyun:Serverless::Log::Logstore](#aliyunserverlessloglogstore)
+  - [Aliyun::Serverless::TableStore::Table](#aliyunserverlesstablestoretable)
+- [Aliyun::Serverless::Log](#aliyunserverlesslog)
+  - [Aliyun::Serverless::Log::Logstore](#aliyunserverlessloglogstore)
 
 #### Aliyun::Serverless::Service
 
@@ -202,6 +202,41 @@ mytablestore: # tablestore name
               Type: STRING
 ```
 
+#### Aliyun::Serverless::Log
+
+`Aliyun::Serverless::Log` resource creates a instance of [Project](https://www.alibabacloud.com/help/doc-detail/48873.htm).
+
+##### Properties
+
+Property Name | Type | Description
+---|:---:|---
+Description | `string` | **Required。** Description of the project.
+
+##### Aliyun::Serverless::Log::Logstore
+
+`Aliyun::Serverless::Log::Logstore` resource creates a instance of [Logstore](https://www.alibabacloud.com/help/doc-detail/48874.htm).
+
+###### Properties
+
+Property Name | Type | Description
+---|:---:|---
+TTL | `integer` | Data storage time in days, which is in the value range of 1 to 3600.
+shardCount | `integer` | The number of shards in this Logstore, which is in the range of 1 to 100.
+
+#### Example：Aliyun::Serverless::Log
+
+```yaml
+test-log-project:
+  Type: 'Aliyun::Serverless::Log'
+  Properties:
+    Description: 'just test log'
+  test-log-store:
+    Type: 'Aliyun::Serverless::Log::Logstore'
+    Properties:
+      TTL: 10
+      ShardCount: 1
+```
+
 ### Event source types
 
 - [Timer](#Timer)

diff --git a/examples/sls_demo/template.yml b/examples/sls_demo/template.yml
@@ -28,7 +28,7 @@ Resources:
   log-com-m:
     Type: 'Aliyun::Serverless::Log'
     Properties:
-      Description: 'just python  log'
+      Description: 'just python log'
     log-com-m:
       Type: 'Aliyun::Serverless::Log::Logstore'
       Properties: