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á.
Referência de configurações
SDKsforneça um idioma específico paraAPIs. Serviços da AWS Eles cuidam de parte do trabalho pesado necessário para fazer API chamadas 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 as definições de configuração nas seções a seguir:
-
AWS SDKse ferramentas: provedores de credenciais padronizados— Provedores de credenciais comuns padronizados em vários. SDKs
-
AWS SDKse ferramentas, recursos padronizados— Recursos comuns padronizados em váriosSDKs.
Criar clientes de serviço
Para acessar programaticamente Serviços da AWS, SDKs use uma classe/objeto cliente para cada um. AWS service (Serviço da AWS) Por exemplo, se seu aplicativo precisa acessar a AmazonEC2, 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 vezesSDKs, 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 AWS Tools for PowerShell, eles assumem a forma de parâmetros por operação que você insere na linha de comando. Para umSDK, 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 um indivíduo. API
-
-
Somente Java/Kotlin: a propriedade do JVM sistema para a configuração é verificada. Se estiver definido, esse valor é usado para configurar o cliente.
-
A variável de ambiente está marcada. Se estiver definido, esse valor é usado para configurar o cliente.
-
O SDK verifica a configuração no
credentials
arquivo compartilhado. Se estiver definido, o cliente o usará. -
O
config
arquivo compartilhado para a configuração. Se a configuração estiver presente, eles a SDK usarão.-
A variável de
AWS_PROFILE
ambiente ou a propriedadeaws.profile
JVM do sistema podem ser usadas para especificar qual perfil será SDK carregado.
-
-
Qualquer valor padrão fornecido pelo próprio SDK código-fonte é 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, ele AWS SDK for .NET suporta uma fonte adicional chamada SDKStore. Para obter mais informações sobre provedores que são exclusivos de uma ferramenta SDK or, consulte o guia específico da ferramenta SDK or 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 config
arquivo compartilhado, ele só será encontrado e usado depois que a ferramenta SDK ou verificar 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 ou API parâmetro AWS CLI
da linha de comando) ou no código substituiria todos os outros valores desse comando.
Páginas de configurações
As páginas na seção de referência de configurações deste guia detalham as configurações disponíveis que podem ser definidas por meio de 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 KotlinSDKs) as JVM configurações 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 recurso de credenciais tem uma página na qual as configurações usadas para definir essa funcionalidade são listadas. 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 (somente para Java e Kotlin) definindo uma propriedade JVM do sistema. Cada configuração lista todos os métodos compatíveis para definir o valor em um bloco acima dos detalhes da descrição. Embora a precedência varie, a funcionalidade resultante é a mesma, independentemente de como você a define.
A descrição incluirá o valor padrão, se houver, que entrará em vigor se você não fizer nada. Ele também define o que é um valor válido para essa configuração.
Por exemplo, vamos ver uma configuração na página de Compactação de solicitações recursos.
As informações da configuração de disable_request_compression
exemplo comunicam o seguinte:
-
Há três maneiras equivalentes de controlar a compactação de solicitações fora da sua base de código. Você também pode:
-
Defina-o em seu arquivo de configuração usando
disable_request_compression
-
Defina-o como uma variável de ambiente usando
AWS_DISABLE_REQUEST_COMPRESSION
-
Ou, se você estiver usando Java ou KotlinSDK, defina-o como uma propriedade JVM do sistema usando
aws.disableRequestCompression
nota
Também pode haver uma maneira de configurar a mesma funcionalidade diretamente em seu código, mas esta referência não cobre isso, pois é exclusiva de cada umaSDK. Se você quiser definir sua configuração no próprio código, consulte seu SDK guia ou API referência específica.
-
-
Se você não fizer nada, o valor padrão será
false
. -
Os únicos valores válidos para essa configuração booleana são
true
e.false
Na parte inferior da página de cada recurso, há uma AWS SDKs tabela de compatibilidade com.
Esta tabela mostra se você SDK suporta as configurações listadas na página. A Supported
coluna indica o nível de suporte com os seguintes valores:
-
Yes
— As configurações são totalmente suportadas pelo texto SDK escrito. -
Partial
— Algumas das configurações são suportadas ou o comportamento se desvia da descrição. PoisPartial
, uma nota adicional indica o desvio. -
No
— Nenhuma das configurações é suportada. Isso não afirma se a mesma funcionalidade pode ser obtida no código; apenas indica que as configurações externas listadas não são suportadas.
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 os Serviços da AWS. SDKse 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 suportadas somente por um indivíduo SDK ou ferramenta, consulte esse guia específico SDK ou de ferramentas.
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 os Serviços da AWS. SDKse 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 suportadas somente por um indivíduo SDK ou ferramenta, consulte esse guia específico SDK ou de ferramentas.
Nome da configuração | Detalhes |
---|---|
aws_access_key_id
|
AWS chaves de acesso |
aws_secret_access_key
|
AWS chaves de acesso |
aws_session_token
|
AWS chaves 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 os Serviços da AWS. SDKse 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 suportadas somente por um indivíduo SDK ou ferramenta, consulte esse guia específico SDK ou de ferramentas.
JVMlista de propriedades do sistema
Você pode usar as seguintes propriedades JVM do sistema para o AWS SDK for Java e o AWS SDK para Kotlin (visando oJVM). Consulte Como definir as propriedades do sistema JVM para obter instruções sobre como definir as propriedades JVM do sistema.