As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
Usar o parâmetro ClientConfig em cmdlets
O parâmetro ClientConfig
pode ser usado para especificar determinadas configurações quando você se conecta a um serviço. A maioria das propriedades possíveis desse parâmetro é definida na classe Amazon.Runtime.ClientConfig
, que é herdada nas APIs para serviços da AWS. Para obter um exemplo de herança simples, veja a classe Amazon.Keyspaces.AmazonKeyspacesConfig
. Além disso, alguns serviços definem propriedades adicionais que são apropriadas somente para esse serviço. Para ver um exemplo de propriedades adicionais que foram definidas, consulte a classe Amazon.S3.AmazonS3Config
, especificamente a propriedade ForcePathStyle
.
Usar o parâmetro ClientConfig
Para usar o parâmetro ClientConfig
, você pode especificá-lo na linha de comando como um objeto ClientConfig
ou usar o nivelamento do PowerShell para transmitir uma coleção de valores de parâmetros para um comando como uma unidade. Esses métodos são mostrados nos exemplos a seguir. Os exemplos pressupõem que o módulo AWS.Tools.S3
tenha sido instalado e importado e que você tenha um perfil de credenciais [default]
com as permissões apropriadas.
Definir um objeto ClientConfig
$s3Config = New-Object -TypeName Amazon.S3.AmazonS3Config $s3Config.ForcePathStyle = $true $s3Config.Timeout = [TimeSpan]::FromMilliseconds(150000) Get-S3Object -BucketName <BUCKET_NAME> -ClientConfig $s3Config
Adicionar propriedades ClientConfig
usando o nivelamento do PowerShell
$params=@{ ClientConfig=@{ ForcePathStyle=$true Timeout=[TimeSpan]::FromMilliseconds(150000) } BucketName="<BUCKET_NAME>" } Get-S3Object @params
Usar uma propriedade indefinida
Ao usar o nivelamento do PowerShell, se você especificar uma propriedade ClientConfig
que não existe, o AWS Tools for PowerShell só detectará o erro no tempo de execução, quando retornará uma exceção. Modificação do exemplo acima:
$params=@{ ClientConfig=@{ ForcePathStyle=$true UndefinedProperty="Value" Timeout=[TimeSpan]::FromMilliseconds(150000) } BucketName="<BUCKET_NAME>" } Get-S3Object @params
Esse exemplo gerará uma exceção semelhante à seguinte:
Cannot bind parameter 'ClientConfig'. Cannot create object of type "Amazon.S3.AmazonS3Config". The UndefinedProperty property was not found for the Amazon.S3.AmazonS3Config object.
Especificar a Região da AWS
É possível usar o parâmetro ClientConfig
a fim de definir a Região da AWS para o comando. A região é definida por meio da propriedade RegionEndpoint
. O AWS Tools for PowerShell calcula a região a ser usada de acordo com a seguinte precedência:
-
O parâmetro
-Region
-
A região transmitida no parâmetro
ClientConfig
-
O estado da sessão do PowerShell
-
O arquivo
config
da AWS compartilhado -
As variáveis de ambiente
-
Os metadados da instância do Amazon EC2, se habilitados.