Referência de configurações - AWS SDKs e ferramentas

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

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 as definições de configuração nas seções a seguir:

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 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:

  1. 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 um SDK, as atribuições explícitas podem assumir a forma de um parâmetro definido ao instanciar um AWS service (Serviço da AWS) cliente ou objeto de configuração ou, às vezes, ao chamar uma API individual.

  2. Somente Java/Kotlin: a propriedade do sistema JVM para a configuração é verificada. Se estiver definido, esse valor é usado para configurar o cliente.

  3. A variável de ambiente está marcada. Se estiver definido, esse valor é usado para configurar o cliente.

  4. O SDK verifica a configuração no credentials arquivo compartilhado. Se estiver definido, o cliente o usará.

  5. O config arquivo compartilhado da configuração. Se a configuração estiver presente, o SDK a usará.

    • A variável de AWS_PROFILE ambiente ou a propriedade do sistema aws.profile JVM pode ser usada para especificar qual perfil o SDK carrega.

  6. 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.

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 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 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 do sistema JVM. 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 o SDK Java ou Kotlin, defina-o como uma propriedade do sistema JVM usando aws.disableRequestCompression

    nota

    Também pode haver uma maneira de configurar a mesma funcionalidade diretamente em seu código, mas essa referência não cobre isso, pois é exclusiva para cada SDK. Se você quiser definir sua configuração no próprio código, consulte o guia específico do SDK ou a referência da 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 true e. false

Na parte inferior da página de cada recurso, há uma AWS SDKs tabela de compatibilidade com.

Esta tabela mostra se seu SDK é compatível com 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 SDK conforme 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 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 suportadas somente por um SDK ou ferramenta individual, consulte esse SDK ou guia de ferramentas específico.

Nome da configuração Detalhes
account_id_endpoint_mode Endpoints baseados em contas
api_versions Definições gerais de configuração
aws_access_key_id AWS chaves de acesso
aws_account_id Endpoints baseados em contas
aws_secret_access_key AWS chaves de acesso
aws_session_token AWS chaves de acesso
ca_bundle Definições gerais de configuração
credential_process Provedor de credenciais de processo
credential_source Assuma a função de provedor de credenciais
defaults_mode Padrões de configuração inteligente
disable_request_compression Compactação de solicitações
duration_seconds Assuma a função de provedor de credenciais
ec2_metadata_service_endpoint Provedor de credenciais IMDS
ec2_metadata_service_endpoint_mode Provedor de credenciais IMDS
ec2_metadata_v1_disabled Provedor de credenciais IMDS
endpoint_discovery_enabled Descoberta de endpoint
endpoint_url Endpoints específicos de serviço
external_id Assuma a função de provedor de credenciais
ignore_configured_endpoint_urls Endpoints específicos de serviço
max_attempts Comportamento de repetição
metadata_service_num_attempts Metadados da EC2 instância Amazon
metadata_service_timeout Metadados da EC2 instância Amazon
mfa_serial Assuma a função de provedor de credenciais
output Definições gerais de configuração
parameter_validation Definições gerais de configuração
region Região da AWS
request_checksum_calculation Proteções de integridade de dados para o Amazon S3
request_min_compression_size_bytes Compactação de solicitações
response_checksum_validation Proteções de integridade de dados para o Amazon S3
retry_mode Comportamento de repetição
role_arn Assuma a função de provedor de credenciais
role_session_name Assuma a função de provedor de credenciais
s3_disable_multiregion_access_points Pontos de acesso de várias regiões do Amazon S3
s3_use_arn_region Pontos de acesso Amazon S3
sdk_ua_app_id ID do aplicativo
source_profile Assuma a função de provedor de credenciais
sso_account_id Provedor de credenciais do IAM Identity Center
sso_region Provedor de credenciais do IAM Identity Center
sso_registration_scopes Provedor de credenciais do IAM Identity Center
sso_role_name Provedor de credenciais do IAM Identity Center
sso_start_url Provedor de credenciais do IAM Identity Center
sts_regional_endpoints AWS STS Endpoints regionais
use_dualstack_endpoint Endpoints de pilha dupla e FIPS
use_fips_endpoint Endpoints de pilha dupla e FIPS
web_identity_token_file Assuma a função de provedor de credenciais

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 suportadas somente por um SDK ou ferramenta individual, consulte esse SDK ou guia de ferramentas específico.

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 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 suportadas somente por um SDK ou ferramenta individual, consulte esse SDK ou guia de ferramentas específico.

Nome da configuração Detalhes
AWS_ACCESS_KEY_ID AWS chaves de acesso
AWS_ACCOUNT_ID Endpoints baseados em contas
AWS_ACCOUNT_ID_ENDPOINT_MODE Endpoints baseados em contas
AWS_CA_BUNDLE Definições gerais de configuração
AWS_CONFIG_FILE Localização dos arquivos config e credentials compartilhados
AWS_CONTAINER_AUTHORIZATION_TOKEN Provedor de credenciais de contêiner
AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE Provedor de credenciais de contêiner
AWS_CONTAINER_CREDENTIALS_FULL_URI Provedor de credenciais de contêiner
AWS_CONTAINER_CREDENTIALS_RELATIVE_URI Provedor de credenciais de contêiner
AWS_DEFAULTS_MODE Padrões de configuração inteligente
AWS_DISABLE_REQUEST_COMPRESSION Compactação de solicitações
AWS_EC2_METADATA_DISABLED Provedor de credenciais IMDS
AWS_EC2_METADATA_SERVICE_ENDPOINT Provedor de credenciais IMDS
AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE Provedor de credenciais IMDS
AWS_EC2_METADATA_V1_DISABLED Provedor de credenciais IMDS
AWS_ENABLE_ENDPOINT_DISCOVERY Descoberta de endpoint
AWS_ENDPOINT_URL Endpoints específicos de serviço
AWS_ENDPOINT_URL_<SERVICE> Endpoints específicos de serviço
AWS_IGNORE_CONFIGURED_ENDPOINT_URLS Endpoints específicos de serviço
AWS_MAX_ATTEMPTS Comportamento de repetição
AWS_METADATA_SERVICE_NUM_ATTEMPTS Metadados da EC2 instância Amazon
AWS_METADATA_SERVICE_TIMEOUT Metadados da EC2 instância Amazon
AWS_PROFILE Arquivos config e credentials compartilhados
AWS_REGION Região da AWS
AWS_REQUEST_CHECKSUM_CALCULATION Proteções de integridade de dados para o Amazon S3
AWS_REQUEST_MIN_COMPRESSION_SIZE_BYTES Compactação de solicitações
AWS_RESPONSE_CHECKSUM_VALIDATION Proteções de integridade de dados para o Amazon S3
AWS_RETRY_MODE Comportamento de repetição
AWS_ROLE_ARN Assuma a função de provedor de credenciais
AWS_ROLE_SESSION_NAME Assuma a função de provedor de credenciais
AWS_S3_DISABLE_MULTIREGION_ACCESS_POINTS Pontos de acesso de várias regiões do Amazon S3
AWS_S3_USE_ARN_REGION Pontos de acesso Amazon S3
AWS_SDK_UA_APP_ID ID do aplicativo
AWS_SECRET_ACCESS_KEY AWS chaves de acesso
AWS_SESSION_TOKEN AWS chaves de acesso
AWS_SHARED_CREDENTIALS_FILE Localização dos arquivos config e credentials compartilhados
AWS_STS_REGIONAL_ENDPOINTS AWS STS Endpoints regionais
AWS_USE_DUALSTACK_ENDPOINT Endpoints de pilha dupla e FIPS
AWS_USE_FIPS_ENDPOINT Endpoints de pilha dupla e FIPS
AWS_WEB_IDENTITY_TOKEN_FILE Assuma a função de provedor de credenciais

Lista de propriedades do sistema 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 JVM para obter instruções sobre como definir as propriedades do sistema JVM.

Nome da configuração Detalhes
aws.accessKeyId AWS chaves de acesso
aws.accountId Endpoints baseados em contas
aws.accountIdEndpointMode Endpoints baseados em contas
aws.configFile Localização dos arquivos config e credentials compartilhados
aws.defaultsMode Padrões de configuração inteligente
aws.disableEc2MetadataV1 Provedor de credenciais IMDS
aws.disableRequestCompression Compactação de solicitações
aws.ec2MetadataServiceEndpoint Provedor de credenciais IMDS
aws.ec2MetadataServiceEndpointMode Provedor de credenciais IMDS
aws.endpointDiscoveryEnabled Descoberta de endpoint
aws.endpointUrl Endpoints específicos de serviço
aws.endpointUrl<ServiceName> Endpoints específicos de serviço
aws.ignoreConfiguredEndpointUrls Endpoints específicos de serviço
aws.maxAttempts Comportamento de repetição
aws.profile Arquivos config e credentials compartilhados
aws.region Região da AWS
aws.requestChecksumCalculation Proteções de integridade de dados para o Amazon S3
aws.requestMinCompressionSizeBytes Compactação de solicitações
aws.responseChecksumValidation Proteções de integridade de dados para o Amazon S3
aws.retryMode Comportamento de repetição
aws.roleArn Assuma a função de provedor de credenciais
aws.roleSessionName Assuma a função de provedor de credenciais
aws.s3DisableMultiRegionAccessPoints Pontos de acesso de várias regiões do Amazon S3
aws.s3UseArnRegion Pontos de acesso Amazon S3
aws.secretAccessKey AWS chaves de acesso
aws.sessionToken AWS chaves de acesso
aws.sharedCredentialsFile Localização dos arquivos config e credentials compartilhados
aws.useDualstackEndpoint Endpoints de pilha dupla e FIPS
aws.useFipsEndpoint Endpoints de pilha dupla e FIPS
aws.userAgentAppId ID do aplicativo
aws.webIdentityTokenFile Assuma a função de provedor de credenciais