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á.
AWS SDKs referência de configurações e ferramentas
SDKs forneça um idioma específico para APIs . Serviços da AWS Eles cuidam de parte do trabalho pesado necessário para fazer chamadas de API com sucesso, incluindo autenticação, comportamento de repetição e muito mais. Para fazer isso, eles SDKs têm estratégias flexíveis para obter credenciais para usar em suas solicitações, manter as configurações a serem usadas com cada serviço e obter valores a serem usados nas configurações globais.
Você pode encontrar informações detalhadas sobre ajustes de configuração nas seguintes seções:
-
AWS SDKs e ferramentas: provedores de credenciais padronizados— Provedores de credenciais comuns padronizados em vários. SDKs
-
AWS SDKs e ferramentas, recursos padronizados— Recursos comuns padronizados em vários SDKs.
Criar clientes de serviço
Para acessar programaticamente Serviços da AWS, SDKs use um cliente class/object para cada um. AWS service (Serviço da AWS) Por exemplo, se seu aplicativo precisa acessar a Amazon EC2, seu aplicativo cria um objeto EC2 cliente da Amazon para interagir com esse serviço. Em seguida, você usa o cliente de serviço para fazer solicitações para esse AWS service (Serviço da AWS). Na maioria das vezes SDKs, um objeto de cliente de serviço é imutável, então você deve criar um novo cliente para cada serviço para o qual você faz solicitações e para fazer solicitações ao mesmo serviço usando uma configuração diferente.
Precedência de configurações
As configurações globais definem recursos, provedores de credenciais e outras funcionalidades que são suportadas pela maioria SDKs e têm um amplo impacto em todas Serviços da AWS as áreas. Todos SDKs têm uma série de lugares (ou fontes) que eles verificam para encontrar um valor para as configurações globais. A seguir está a configuração da precedência de pesquisa:
-
Qualquer configuração explícita definida no código ou no próprio cliente de serviço tem precedência sobre qualquer outra coisa.
-
Algumas configurações podem ser definidas por operação e podem ser alteradas conforme necessário para cada operação que você invocar. Para o AWS CLI ou Ferramentas da AWS para PowerShell, eles assumem a forma de parâmetros por operação que você insere na linha de comando. Para um SDK, as atribuições explícitas podem assumir a forma de um parâmetro que você define ao instanciar um AWS service (Serviço da AWS) cliente ou objeto de configuração ou, às vezes, ao chamar uma API individual.
-
-
Java/Kotlin apenas: a propriedade do sistema de JVM para a configuração é verificada. Se estiver definida esse valor será usado para configurar o cliente.
-
A variável de ambiente está marcada. Se estiver definida esse valor será usado para configurar o cliente.
-
O SDK verifica a configuração no arquivo compartilhado
credentials. Se estiver definida, o cliente a usará. -
O arquivo compartilhado
configpara a configuração. Se a configuração estiver presente, o SDK a usará.-
A variável de ambiente
AWS_PROFILEou a propriedade do sistema de JVMaws.profilepodem ser usadas para personalizar o perfil que o SDK carrega.
-
-
Qualquer valor padrão fornecido pelo próprio código-fonte do SDK é usado por último.
nota
Algumas ferramentas SDKs e ferramentas podem ser verificadas em uma ordem diferente. Além disso, algumas SDKs ferramentas oferecem suporte a outros métodos de armazenamento e recuperação de parâmetros. Por exemplo, o AWS SDK for .NET suporta uma fonte adicional chamada SDK Store. Para obter mais informações sobre provedores exclusivos de um SDK ou ferramenta, consulte o guia específico do SDK ou da ferramenta que você está usando.
A ordem determina quais métodos têm precedência e substituem outros. Por exemplo, se você configurar um perfil no arquivo config compartilhado, ele só será encontrado e usado depois que o SDK ou a ferramenta verificarem primeiro os outros lugares. Isso significa que, se você colocar uma configuração no arquivo credentials, ela será usada em vez de uma encontrada no arquivo config. Se você configurar uma variável de ambiente com uma configuração e um valor, ela substituirá essa configuração nos arquivos credentials e config. E, finalmente, uma configuração na operação individual (parâmetro da API ou parâmetro da linha de comando da AWS CLI
) ou no código substituiria todos os outros valores desse comando.
Entender as páginas de configurações deste guia
As páginas na seção Referência de configurações deste guia detalham as configurações disponíveis que podem ser definidas por vários mecanismos. As tabelas a seguir listam as configurações do arquivo de configuração e credencial, as variáveis de ambiente e (para Java e Kotlin SDKs) as configurações da JVM que podem ser usadas fora do seu código para configurar o recurso. Cada tópico vinculado em cada lista leva você à página de configurações correspondente.
Cada provedor ou atributo de credenciais tem uma página na qual são listadas as configurações usadas para definir essa funcionalidade. Para cada configuração, geralmente você pode definir o valor adicionando a configuração a um arquivo de configuração ou definindo uma variável de ambiente ou (para Java e Kotlin apenas) definindo uma propriedade do sistema de JVM. Cada configuração lista todos os métodos compatíveis de definição do valor em um bloco acima dos detalhes da descrição. Embora a precedência varie, a funcionalidade resultante é a mesma, independentemente de como é definida.
A descrição incluirá o valor padrão, se houver, que entrará em vigor se você não fizer nada. Ela também define o que é um valor válido para essa configuração.
Por exemplo, vejamos uma configuração da página do atributo Compactação de solicitações.
As informações do exemplo de configuração disable_request_compression documentam o seguinte:
-
Há três maneiras equivalentes de controlar a compactação de solicitações fora da base de código. Você também pode:
-
Defini-la no arquivo de configuração usando
disable_request_compression -
Defini-la como uma variável de ambiente usando
AWS_DISABLE_REQUEST_COMPRESSION -
Ou, se você estiver usando o SDK do Java ou Kotlin, defina-a como uma propriedade do sistema de JVM usando
aws.disableRequestCompression
nota
Pode haver também uma maneira de configurar a mesma funcionalidade diretamente no código, mas esta referência não trata disso, pois ela é específica para cada SDK. Se você quiser definir a configuração no código em si, consulte o guia específico do SDK ou a referência de API.
-
-
Se você não fizer nada, o valor padrão será
false. -
Os únicos valores válidos para essa configuração booleana são
trueefalse.
Na parte inferior da página de cada recurso, há uma tabela de ferramentas AWS SDKs e Support by.
Essa tabela mostra se o SDK é compatível com as configurações listadas na página. A coluna Supported indica o nível de compatibilidade com os seguintes valores:
-
Yes: as configurações são totalmente compatíveis com o SDK conforme escrito. -
Partial: algumas das configurações são compatíveis ou o comportamento se desvia da descrição. ParaPartial, uma nota adicional indica o desvio. -
No: nenhuma das configurações é compatível. Isso não significa que a mesma funcionalidade pode ser alcançada em código, indica apenas que as configurações externas listadas não são compatíveis.
Lista de configurações de arquivo Config
As configurações listadas na tabela a seguir podem ser atribuídas no AWS config arquivo compartilhado. Eles são globais e afetam a todos Serviços da AWS. SDKs e as ferramentas também podem oferecer suporte a configurações e variáveis de ambiente exclusivas. Para ver as configurações e as variáveis de ambiente compatíveis apenas com um SDK ou uma ferramenta individual, consulte o guia específica do SDK ou da ferramenta.
Lista de configurações de arquivo Credentials
As configurações listadas na tabela a seguir podem ser atribuídas no AWS credentials arquivo compartilhado. Eles são globais e afetam a todos Serviços da AWS. SDKs e as ferramentas também podem oferecer suporte a configurações e variáveis de ambiente exclusivas. Para ver as configurações e as variáveis de ambiente compatíveis apenas com um SDK ou uma ferramenta individual, consulte o guia específica do SDK ou da ferramenta.
| Nome da configuração | Detalhes |
|---|---|
aws_access_key_id
|
AWS teclas de acesso |
aws_secret_access_key
|
AWS teclas de acesso |
aws_session_token
|
AWS teclas de acesso |
Lista de variáveis de ambiente
As variáveis de ambiente suportadas pela maioria SDKs estão listadas na tabela a seguir. Eles são globais e afetam a todos Serviços da AWS. SDKs e as ferramentas também podem oferecer suporte a configurações e variáveis de ambiente exclusivas. Para ver as configurações e as variáveis de ambiente compatíveis apenas com um SDK ou uma ferramenta individual, consulte o guia específica do SDK ou da ferramenta.
Lista de propriedades de sistema de JVM
Você pode usar as seguintes propriedades do sistema JVM para o AWS SDK for Java e o AWS SDK para Kotlin (visando a JVM). Consulte Como definir as propriedades do sistema em JVM para obter instruções sobre como definir as propriedades de sistema de JVM.
