雪猫

Serverless Framework に関する Tips

<h1 id="%E5%91%BD%E5%90%8D%E8%A6%8F%E5%89%87">
<a class="header-anchor-link" href="#%E5%91%BD%E5%90%8D%E8%A6%8F%E5%89%87" aria-hidden="true"></a> 命名規則</h1>
<h2 id="service%2C-stage">
<a class="header-anchor-link" href="#service%2C-stage" aria-hidden="true"></a> service, stage</h2>
S3 Bucket など大文字を使用できないケースがあるので <code>service</code> と <code>stage</code> は小文字の kebab-case にしておくのが良さそう。
<div class="code-block-container">
<div class="code-block-filename-container">serverless.yml</div>
<pre class="language-yml"><code class="language-yml">service: example
resources:
 Resources:
 S3Bucket:
 Type: AWS::S3::Bucket
 Properties:
 BucketName: ${self:service}-${sls:stage}
</code></pre>
</div><h2 id="name">
<a class="header-anchor-link" href="#name" aria-hidden="true"></a> Name</h2>
テーブル名などの名前は基本的に <code>${self:service}-${sls:stage}-&lt;用途&gt;</code> の順。
<details><summary>よくない例</summary><div class="details-content">
<ul>
<li><code>${self:service}-&lt;用途&gt;-${sls:stage}</code></li>
<li><code>${sls:stage}-${self:service}-&lt;用途&gt;</code></li>
</ul>
</div></details>
<code>BucketName</code> は公開 URL になるので任意。