From 928e06f5c1c0ce97b9b2a98f741d35c242754f76 Mon Sep 17 00:00:00 2001 From: g-grass <84663924+g-grass@users.noreply.github.com> Date: Wed, 16 Feb 2022 22:50:00 +0900 Subject: [PATCH 1/7] docs(ja): update additional-aws-resources page --- .../developing/additional-aws-resources.ja.md | 33 +++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/site/content/docs/developing/additional-aws-resources.ja.md b/site/content/docs/developing/additional-aws-resources.ja.md index 84f745da359..b924533dfe8 100644 --- a/site/content/docs/developing/additional-aws-resources.ja.md +++ b/site/content/docs/developing/additional-aws-resources.ja.md @@ -117,3 +117,36 @@ Outputs: * `addons/` ディレクトリで定義するポリシーでは[最小限のアクセス権を付与する](https://docs.aws.amazon.com/ja_jp/IAM/latest/UserGuide/best-practices.html#grant-least-privilege) * `addons/` ディレクトリで定義したリソースに対してのみアクセスできるようにポリシーを制限するために [追加セキュリティに対するポリシー条件を使用する](https://docs.aws.amazon.com/ja_jp/IAM/latest/UserGuide/best-practices.html#use-policy-conditions) + + +### `Parameters` セクションのカスタマイズ + +Copilot では、 `App`, `Env` そして `Name` [パラメーター](https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html)がテンプレートに定義されている必要があります。もし、 Service スタック内のリソースを参照する[パラメーター](https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html)を追加したい場合は、 `addons.parameters.yml` ファイルを作成します。 + +```term +. +└── addons/ + ├── template.yml + └── addons.parameters.yml # このファイルをaddons/ディレクトリの下に追加します +``` + +以下のように、 `addons.parameters.yml` にワークロードスタックから参照する[パラメーター](https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html)を定義することができます。 +```yaml +Parameters: + ServiceName: !GetAtt Service.Name +``` +最後に、新しい[パラメーター](https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html)を参照するようにテンプレートファイルを更新してください。 + +```yaml +Parameters: + # AWS Copilotで必要なパラメーター + App: + Type: String + Env: + Type: String + Name: + Type: String + # addons.parameters.ymlで追加したパラメーター + ServiceName: + Type: String +``` \ No newline at end of file From 650a3dbedf862b227023a83c64cd6d77822aa961 Mon Sep 17 00:00:00 2001 From: g-grass <84663924+g-grass@users.noreply.github.com> Date: Tue, 22 Feb 2022 13:05:52 +0900 Subject: [PATCH 2/7] docs(ja): update site/content/docs/developing/additional-aws-resources.ja.md Co-authored-by: Tori Hara --- site/content/docs/developing/additional-aws-resources.ja.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/content/docs/developing/additional-aws-resources.ja.md b/site/content/docs/developing/additional-aws-resources.ja.md index b924533dfe8..277e62b1fc6 100644 --- a/site/content/docs/developing/additional-aws-resources.ja.md +++ b/site/content/docs/developing/additional-aws-resources.ja.md @@ -121,7 +121,7 @@ Outputs: ### `Parameters` セクションのカスタマイズ -Copilot では、 `App`, `Env` そして `Name` [パラメーター](https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html)がテンプレートに定義されている必要があります。もし、 Service スタック内のリソースを参照する[パラメーター](https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html)を追加したい場合は、 `addons.parameters.yml` ファイルを作成します。 +Copilot では、 `App`, `Env` そして `Name` パラメーターがテンプレートに定義されている必要があります。もし、 Service スタック内のリソースを参照するを追加したい場合は、 `addons.parameters.yml` ファイルを作成します。テンプレート内パラメーターのデータ型やデフォルト値の指定方法については、[CloudFormation テンプレートでのパラメーター定義](https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html)に準じます。 ```term . From e19a36347e7932606cba26e4199fe9e61f2bf552 Mon Sep 17 00:00:00 2001 From: g-grass <84663924+g-grass@users.noreply.github.com> Date: Tue, 22 Feb 2022 13:06:43 +0900 Subject: [PATCH 3/7] docs(ja): update site/content/docs/developing/additional-aws-resources.ja.md Co-authored-by: Tori Hara --- site/content/docs/developing/additional-aws-resources.ja.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/content/docs/developing/additional-aws-resources.ja.md b/site/content/docs/developing/additional-aws-resources.ja.md index 277e62b1fc6..82065383bbb 100644 --- a/site/content/docs/developing/additional-aws-resources.ja.md +++ b/site/content/docs/developing/additional-aws-resources.ja.md @@ -127,7 +127,7 @@ Copilot では、 `App`, `Env` そして `Name` パラメーターがテンプ . └── addons/ ├── template.yml - └── addons.parameters.yml # このファイルをaddons/ディレクトリの下に追加します + └── addons.parameters.yml # このファイルを addons/ ディレクトリの下に追加します ``` 以下のように、 `addons.parameters.yml` にワークロードスタックから参照する[パラメーター](https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html)を定義することができます。 From b94d53c646af85909a224d293bdc13ea358a3aae Mon Sep 17 00:00:00 2001 From: g-grass <84663924+g-grass@users.noreply.github.com> Date: Tue, 22 Feb 2022 13:07:09 +0900 Subject: [PATCH 4/7] docs(ja): update site/content/docs/developing/additional-aws-resources.ja.md Co-authored-by: Tori Hara --- site/content/docs/developing/additional-aws-resources.ja.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/content/docs/developing/additional-aws-resources.ja.md b/site/content/docs/developing/additional-aws-resources.ja.md index 82065383bbb..83a8cf33278 100644 --- a/site/content/docs/developing/additional-aws-resources.ja.md +++ b/site/content/docs/developing/additional-aws-resources.ja.md @@ -130,7 +130,7 @@ Copilot では、 `App`, `Env` そして `Name` パラメーターがテンプ └── addons.parameters.yml # このファイルを addons/ ディレクトリの下に追加します ``` -以下のように、 `addons.parameters.yml` にワークロードスタックから参照する[パラメーター](https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html)を定義することができます。 +`addons.parameters.yml` には、Service スタック内の値を参照するパラメーターを例えば以下のように定義できます。 ```yaml Parameters: ServiceName: !GetAtt Service.Name From 061a80d60fb3cb6e362a7d49baa22cad048360f7 Mon Sep 17 00:00:00 2001 From: g-grass <84663924+g-grass@users.noreply.github.com> Date: Tue, 22 Feb 2022 13:07:34 +0900 Subject: [PATCH 5/7] docs(ja): update site/content/docs/developing/additional-aws-resources.ja.md Co-authored-by: Tori Hara --- site/content/docs/developing/additional-aws-resources.ja.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/content/docs/developing/additional-aws-resources.ja.md b/site/content/docs/developing/additional-aws-resources.ja.md index 83a8cf33278..51a6fa5bbc0 100644 --- a/site/content/docs/developing/additional-aws-resources.ja.md +++ b/site/content/docs/developing/additional-aws-resources.ja.md @@ -135,7 +135,7 @@ Copilot では、 `App`, `Env` そして `Name` パラメーターがテンプ Parameters: ServiceName: !GetAtt Service.Name ``` -最後に、新しい[パラメーター](https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html)を参照するようにテンプレートファイルを更新してください。 +最後に、新しいパラメーターを参照するようにテンプレートファイルを更新しましょう。 ```yaml Parameters: From ace4a6e1539ec5658ae26861670e7a98da850c03 Mon Sep 17 00:00:00 2001 From: g-grass <84663924+g-grass@users.noreply.github.com> Date: Tue, 22 Feb 2022 13:07:49 +0900 Subject: [PATCH 6/7] docs(ja): update site/content/docs/developing/additional-aws-resources.ja.md Co-authored-by: Tori Hara --- site/content/docs/developing/additional-aws-resources.ja.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/content/docs/developing/additional-aws-resources.ja.md b/site/content/docs/developing/additional-aws-resources.ja.md index 51a6fa5bbc0..9b3a018b54c 100644 --- a/site/content/docs/developing/additional-aws-resources.ja.md +++ b/site/content/docs/developing/additional-aws-resources.ja.md @@ -139,7 +139,7 @@ Parameters: ```yaml Parameters: - # AWS Copilotで必要なパラメーター + # AWS Copilot で必要なパラメーター App: Type: String Env: From 7a448cb0f8c0c904f7c4769760c2afdb1a7b4c39 Mon Sep 17 00:00:00 2001 From: g-grass <84663924+g-grass@users.noreply.github.com> Date: Tue, 22 Feb 2022 13:07:58 +0900 Subject: [PATCH 7/7] docs(ja): update site/content/docs/developing/additional-aws-resources.ja.md Co-authored-by: Tori Hara --- site/content/docs/developing/additional-aws-resources.ja.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/content/docs/developing/additional-aws-resources.ja.md b/site/content/docs/developing/additional-aws-resources.ja.md index 9b3a018b54c..3a1d20288cc 100644 --- a/site/content/docs/developing/additional-aws-resources.ja.md +++ b/site/content/docs/developing/additional-aws-resources.ja.md @@ -146,7 +146,7 @@ Parameters: Type: String Name: Type: String - # addons.parameters.ymlで追加したパラメーター + # addons.parameters.yml で追加したパラメーター ServiceName: Type: String ``` \ No newline at end of file