# mulesoft Amazon Secrets Manager Properties Provider (amazon-secrets-manager-properties-provider-connector) - Full Documentation

<!-- document id=162763009bed5609d71ea5168c131c88d45df43dbca0d9cee80d72d26df1f50c url=/mulesoft/current/ja-jp/amazon-secrets-manager-properties-provider-connector/1.0/index.md -->

# Amazon Secrets Manager Properties Provider 1.0

Amazon Secrets Manager Properties Provider は、Mule アプリケーションを実行する前に、Amazon Secrets Manager クラウドサービスからシークレットを取得できるようにする設定です。

互換性と修正された問題については、「Amazon Secrets Manager Properties Provider リリースノート」を参照してください。

## [](#始める前に)始める前に

このプロパティプロバイダーを使用するには、以下に精通している必要があります。

- AWS Secrets Manager Region (AWS Secrets Manager)
- Anypoint Connector
- Mule Runtime Engine (Mule)
- Mule フローの要素とグローバル要素
- Anypoint Studio を使用した Mule アプリケーションの作成方法

アプリケーションを作成する前に、以下が必要です。

- Mule Enterprise Edition
- AWS シークレットにアクセスするためのログイン情報
- Anypoint Platform
- Anypoint Studio バージョン 7.3.5 以降

## [](#properties-provider-の一般的なユースケース)Properties Provider の一般的なユースケース

AWS Secrets Manager Properties Provider では、次の作業を行うことができます。

- Mule アプリケーション用 AWS Secrets Manager から値を設定する。
- ソースまたは操作の一部として SaaS アプリケーションのシークレットを取得する。
- 取得するシークレットの名前を指定する。
- AWS SDK IAM、デフォルトのプロバイダーチェーン、または基本認証の使用可能なオプションを使用して AWS を認証する。
- AWS サーバーを指定したり、ビジネスユニットに適したサーバーに接続するリージョンを指定したりする。
- AWS に接続しているときに発生したエラーについて通知を受け取る。
- AWS からシークレットを取得しているときに発生したエラーについて通知を受け取る。

## [](#関連情報)関連情報

- [Amazon Secrets Manager Properties Provider の例](https://docs.mulesoft.com/jp/amazon-secrets-manager-properties-provider-connector/1.0/amazon-secrets-manager-examples)
- [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [Exchange を使用したコネクタ、テンプレート、およびサンプルの検出](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange)
- [Amazon Secrets Manager Properties Provider リファレンス](https://docs.mulesoft.com/jp/amazon-secrets-manager-properties-provider-connector/1.0/amazon-secrets-manager-properties-provider-reference)
- [MuleSoft ヘルプセンター](https://help.mulesoft.com)

<!-- document id=87fbe71b632ac9c49b1a5b0bb1f8641888272dadc7a8021ebf71e24109960a2d url=/mulesoft/current/ja-jp/amazon-secrets-manager-properties-provider-connector/1.0/amazon-secrets-manager-properties-provider-reference.md -->

# Amazon Secrets Manager Properties Provider 1.0 リファレンス

Amazon Secrets Manager Properties Provider は、Mule アプリケーションを実行する前に、Amazon Secrets Manager クラウドサービスからシークレットを取得できるようにする設定です。

## [](#Config)設定

Amazon Secrets Manager Properties Provider のデフォルト設定。

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Name (名前)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>この設定の名前。コネクタはこの名前の設定を参照します。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Expiration Policy (有効期限ポリシー)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p><a href="#ExpirationPolicy">Expiration Policy (有効期限ポリシー)</a></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。インスタンスが期限切れとみなされた瞬間にインスタンスが期限切れになるという意味ではありません。必要に応じて、インスタンスがパージされます。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>AWS Secrets Manager Region (AWS Secrets Manager リージョン)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>AWS Secrets Manager リージョン (​<code>us-east-2</code>​ など)。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>AWS アクセスキー</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>AWS アクセスキー ID。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>AWS Secret Key (AWS シークレットキー)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>AWS シークレットキー ID。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Role ARN (ロール ARN)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>クロスアカウントアクセスを取得するためのロールを一意に識別します。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
</tbody>
</table>

## [](#種別)種別

### [](#ExpirationPolicy)Expiration Policy (有効期限ポリシー)

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-middle">項目</th>
<th class="tableblock halign-left valign-middle">型</th>
<th class="tableblock halign-left valign-middle">説明</th>
<th class="tableblock halign-left valign-middle">デフォルト値</th>
<th class="tableblock halign-left valign-middle">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Max Idle Time (最大アイドル時間)</p></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">動的設定インスタンスがアイドル状態を続けられる最大時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。</p></td>
<td class="tableblock halign-left valign-middle"></td>
<td class="tableblock halign-left valign-middle"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Time Unit (時間単位)</p></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>Enumeration (列挙)。次のいずれかになります。</p>
</div>
<div class="ulist">
<ul>
<li>
<p>NANOSECONDS (ナノ秒)</p>
</li>
<li>
<p>MICROSECONDS (マイクロ秒)</p>
</li>
<li>
<p>MILLISECONDS (ミリ秒)</p>
</li>
<li>
<p>SECONDS (秒)</p>
</li>
<li>
<p>MINUTES (分)</p>
</li>
<li>
<p>HOURS (時間)</p>
</li>
<li>
<p>DAYS (日)</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">​<strong>[Max Idle Time (最大アイドル時間)]</strong>​ 項目の時間単位。</p></td>
<td class="tableblock halign-left valign-middle"></td>
<td class="tableblock halign-left valign-middle"></td>
</tr>
</tbody>
</table>

## [](#制限事項)制限事項

Amazon Secrets Manager Properties Provider では、プロパティプロバイダーの設定でのプロパティファイルの使用はサポートされていません。

## [](#関連情報)関連情報

- [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)
- [MuleSoft ヘルプセンター](https://help.mulesoft.com)

<!-- document id=5d9ec2ac7fe4948dbba3b9b99fd749fca675908396df07e53e7278a17d3fd5e8 url=/mulesoft/current/ja-jp/amazon-secrets-manager-properties-provider-connector/1.0/amazon-secrets-manager-examples.md -->

# Amazon Secrets Manager Properties Provider の例

次の例を使用して、Amazon Secrets Manager クラウドサービスからシークレットを取得するように Amazon Secrets Manager Properties Provider を設定できます。

## [](#aws-接続種別を設定する)AWS 接続種別を設定する

Anypoint Connector は、設定で Amazon Secrets Manager Properties Provider を使用できます。次の例は、Anypoint Studio の ​**\[AWS Secrets Manager Properties Override Config (AWS Secrets Manager Properties の上書き設定)\]**​ で AWS 接続種別を設定する方法を示しています。

1. Studio で、​**\[Global Elements (グローバル要素)\]**​ タブに移動します。
2. **\[Create (作成)\]**​ をクリックします。
3. **\[Choose Global Type (グローバル種別の選択)\]**​ ウィンドウで、「​`AWS Secrets Manager`​」と入力します。
4. **\[AWS Secrets Manager Properties Override Config (AWS Secrets Manager Properties の上書き設定)\]**​ を選択します。
5. **\[OK\]**​ をクリックします。
6. **\[Global Element Properties (グローバル要素のプロパティ)\]**​ ウィンドウで、次の項目を設定できます。

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>AWS Secrets Manager Region (AWS Secrets Manager リージョン)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>AWS Secrets Manager リージョン (​<code>us-east-2</code>​ など)。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>x</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>AWS アクセスキー</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>AWS アクセスキー ID。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>AWS Secret Key (AWS シークレットキー)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>AWS シークレットキー ID。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Role ARN (ロール ARN)</strong></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>クロスアカウントアクセスを取得するためのロールを一意に識別します。</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
<td class="tableblock halign-left valign-top"><div class="content"></div></td>
</tr>
</tbody>
</table>

![Anypoint Studio の \[Global Element Properties (グローバル要素のプロパティ)\] ウィンドウの Amazon Secrets Manager Properties Provider の例](_images/amazon-secrets-manager-properties.png)

**設定 XML**​ エディターでは、設定は次のように記述されます。

```xml
<aws-secrets-manager-properties-override:config name="AWS_Secrets_Manager_Properties_Override_Config" doc:name="AWS Secrets Manager Properties Override Config" >
		<aws-secrets-manager-properties-override:basic-connection region="us-east-1" />
		<aws-secrets-manager-properties-override:role-connection roleARN="arn:aws:iam::480410955647:role/AmazonSSMRoleForAutomationAssumeQuickSetup" />
	</aws-secrets-manager-properties-override:config>
```

ログイン情報を指定しない場合、デフォルトの AWS 接続は、 [「デフォルトの認証情報プロバイダーチェーン - AWS SDK for Java 2.x」](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials-chain.html)​に従います。

## [](#json-文字列を使用して-aws-secrets-manager-を設定する)JSON 文字列を使用して AWS Secrets Manager を設定する

次の例は、シークレットマネージャーキーを作成する JSON 文字列を使用して、Amazon S3 Connector の Amazon Secrets Manager Properties Provider を設定する方法を示しています。

`accessKey`​ と ​`secretKey`​ が含まれる JSON ファイルに基づいて、以下の作業を行います。

aws secretsmanager create-secret --name aws-credentials   --secret-string '{"accessKey":"ACCESSKEY", "secretKey":"SECRET"}'

1. **\[Amazon S3 Configuration (Amazon S3 設定)\]**​ グローバル要素プロパティウィンドウで、​**\[fx\]**​ を選択して式の値を設定します。
2. **\[Access Key (アクセスキー)\]**​ を ​`${aws-secrets::aws-credentials}.accessKey`​ に設定します。
3. **\[Secret Key (シークレットキー)\]**​ を ​`${aws-secrets::aws-credentials}.secretKey`​ に設定します。

![JSON 式を使用した Amazon S3 Connector の Amazon Secrets Manager Properties Provider 設定の例](/mulesoft/current/ja-jp/amazon-secrets-manager-properties-provider-connector/1.0/_images/aws-sm-json-1.png)

**設定 XML**​ エディターでは、設定は次のように記述されます。

```xml
<s3:config name="Amazon_S3_Configuration" doc:name="Amazon S3 Configuration">
		<s3:connection accessKey="#[${aws-secrets::aws-credentials}.accessKey]" secretKey="#[${aws-secrets::aws-credentials}.secretKey]" />
	</s3:config>
```

## [](#aws-secrets-manager-を文字列として設定する)AWS Secrets Manager を文字列として設定する

次の例は、Amazon S3 Connector の文字列としてシークレットマネージャーキーを設定する方法を示しています。

次の文字列に基づいて、以下の作業を行います。

aws secretsmanager create-secret --name accessKey  --secret-string "ACCESSKEY"
aws secretsmanager create-secret --name secretKey  --secret-string "SECRET"

**\[Amazon S3 Configuration (Amazon S3 設定)\]**​ グローバル要素プロパティウィンドウで、

1. **\[Access Key (アクセスキー)\]**​ を ​`${aws-secrets::accessKey}`​ に設定します。
2. **\[Secret Key (シークレットキー)\]**​ を ​`${aws-secrets::secretKey}`​ に設定します。

![文字列値を使用した Amazon S3 Connector の Amazon Secrets Manager Properties Provider 設定の例](/mulesoft/current/ja-jp/amazon-secrets-manager-properties-provider-connector/1.0/_images/aws-sm-json-2.png)

**設定 XML**​ エディターでは、設定は次のように記述されます。

```xml
<s3:config name="Amazon_S3_Configuration" doc:name="Amazon S3 Configuration" >
		<s3:connection accessKey="${aws-secrets::accessKey}" secretKey="${aws-secrets::secretKey}" />
	</s3:config>
```

シークレットマネージャーに保存される値には ​`$`​ 特殊文字を使用しないでください。​`$`​ 文字を使用する必要がある場合は、変数をリテラルモードで使用して、それを文字列として扱います。その後、値全体を JSON に変換し、必要な情報を抽出できます。

## [](#関連情報)関連情報

[MuleSoft ヘルプセンター](https://help.mulesoft.com)