Verwenden des ClientConfig-Parameters in Cmdlets - AWS Tools for PowerShell

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Verwenden des ClientConfig-Parameters in Cmdlets

Mit dem ClientConfig-Parameter können bestimmte Konfigurationseinstellungen angegeben werden, wenn Sie eine Verbindung zu einem Service herstellen. Die meisten möglichen Eigenschaften dieses Parameters sind in der Amazon.Runtime.ClientConfig-Klasse definiert, die an die APIs für AWS-Services vererbt wird. Ein Beispiel für einfache Vererbung finden Sie in der Amazon.Keyspaces.AmazonKeyspacesConfig-Klasse. Darüber hinaus definieren einige Services zusätzliche Eigenschaften, die nur für diesen Service geeignet sind. Ein Beispiel für zusätzliche Eigenschaften, die definiert wurden, finden Sie in der Amazon.S3.AmazonS3Config-Klasse, insbesondere in der ForcePathStyle-Eigenschaft.

Verwenden des ClientConfig-Parameters

Wenn Sie den ClientConfig-Parameter verwenden möchten, können Sie ihn in der Befehlszeile als ClientConfig-Objekt angeben oder PowerShell-Splatting verwenden, um eine Sammlung von Parameterwerten als Einheit an einen Befehl zu übergeben. Diese Methoden werden im folgenden Beispiel verdeutlicht. In den Beispielen wird davon ausgegangen, dass das AWS.Tools.S3-Modul installiert und importiert wurde und dass Sie über ein [default]-Anmeldeinformationsprofil mit entsprechenden Berechtigungen verfügen.

Definieren eines ClientConfig-Objekts

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

Hinzufügen von ClientConfig-Eigenschaften mithilfe von PowerShell-Splatting

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

Verwenden einer undefinierten Eigenschaft

Wenn Sie PowerShell-Splatting verwenden und eine ClientConfig-Eigenschaft angeben, die nicht existiert, erkennt AWS Tools for PowerShell den Fehler erst zur Laufzeit und gibt dann eine Ausnahme zurück. Ändern des obigen Beispiels:

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

In diesem Beispiel wird eine Ausnahme in etwa wie folgt erstellt:

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

Angeben der AWS-Region

Mit dem ClientConfig-Parameter können Sie die AWS-Region für den Befehl festlegen. Die Region wird über die RegionEndpoint-Eigenschaft festgelegt. AWS Tools for PowerShell berechnet die zu verwendende Region gemäß der folgenden Rangfolge:

  1. Der -Region-Parameter

  2. Die Region, die im ClientConfig-Parameter übergeben wurde

  3. Der Status der PowerShance-Sitzung

  4. Die geteilte config-Datei von AWS

  5. Die Umgebungsvariablen

  6. Die Instance-Metadaten von Amazon-EC2, sofern aktiviert.