AWS Tools for PowerShell V4 がメンテナンスモードになりました。

[AWS Tools for PowerShell V5](https://docs.aws.amazon.com/powershell/v5/userguide/) に移行することをお勧めします。移行方法の詳細と情報については、[メンテナンスモードのお知らせ](https://aws.amazon.com/blogs/developer/aws-tools-for-powershell-v4-maintenance-mode-announcement/)を参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# コマンドレットでの ClientConfig パラメータの使用
<a name="pstools-clientconfig"></a>

`ClientConfig` パラメータを使用すると、サービスに接続するときに、特定の構成設定を指定できます。このパラメータに指定できるプロパティのほとんどは、AWS のサービスの API に継承された [https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Runtime/TClientConfig.html](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Runtime/TClientConfig.html) クラスで定義されています。単純な継承の例については、[https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Keyspaces/TKeyspacesConfig.html](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Keyspaces/TKeyspacesConfig.html) クラスを参照してください。さらに、一部のサービスでは、そのサービスにのみ適切な追加プロパティが定義されています。定義されているその他のプロパティの例については、[https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/S3/TS3Config.html](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/S3/TS3Config.html) クラス、特に `ForcePathStyle` プロパティを参照してください。

## `ClientConfig` パラメータの使用
<a name="clientconfig-operation"></a>

`ClientConfig` パラメータを使用するには、コマンドラインで `ClientConfig` オブジェクトとして指定するか、PowerShell スプラッティングを使用してパラメータ値のコレクションをコマンドに単位として渡します。次の例に、これらの方法を示します。この例では、`AWS.Tools.S3` モジュールがインストールおよびインポートされ、適切なアクセス許可を持つ `[default]` 認証情報プロファイルがあることを前提としています。

******`ClientConfig` オブジェクトの定義**

```
$s3Config = New-Object -TypeName Amazon.S3.AmazonS3Config
$s3Config.ForcePathStyle = $true
$s3Config.Timeout = [TimeSpan]::FromMilliseconds(150000)
Get-S3Object -BucketName <BUCKET_NAME> -ClientConfig $s3Config
```

**PowerShell スプラッティングの使用による `ClientConfig` プロパティの追加**

```
$params=@{
    ClientConfig=@{
        ForcePathStyle=$true
        Timeout=[TimeSpan]::FromMilliseconds(150000)
    }
    BucketName="<BUCKET_NAME>"
}

Get-S3Object @params
```

## 未定義プロパティの使用
<a name="clientconfig-undefined"></a>

PowerShell スプラッティングを使用するときに、存在しない `ClientConfig` プロパティを指定した場合、AWS Tools for PowerShell は実行時までエラーを検出せず、実行時には例外を返します。上記の例を修正すると、次のようになります。

```
$params=@{
    ClientConfig=@{
        ForcePathStyle=$true
        UndefinedProperty="Value"
        Timeout=[TimeSpan]::FromMilliseconds(150000)
    }
    BucketName="<BUCKET_NAME>"
}

Get-S3Object @params
```

この例では、以下のような例外が生成されます。

```
Cannot bind parameter 'ClientConfig'. Cannot create object of type "Amazon.S3.AmazonS3Config". The UndefinedProperty property was not found for the Amazon.S3.AmazonS3Config object.
```

## AWS リージョン の指定
<a name="clientconfig-region"></a>

`ClientConfig` パラメータを使用して、コマンドに対する AWS リージョンを設定します。[リージョン] は `RegionEndpoint` プロパティを通じて設定されます。AWS Tools for PowerShell は、使用する [リージョン] を次の優先順位に従って計算します。

1. `-Region` パラメータ

1. `ClientConfig` パラメータで渡された [リージョン]

1. PowerShell のセッション状態

1. 共有 AWS `config` ファイル

1. 環境変数

1. Amazon EC2 インスタンスメタデータ (有効になっている場合)。