Riferimento alle impostazioni - AWS SDKs e strumenti

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Riferimento alle impostazioni

SDKs forniscono specifiche per la lingua APIs . Servizi AWS Si occupano di alcune delle attività più complesse necessarie per effettuare correttamente le chiamate API, tra cui l'autenticazione, il comportamento dei tentativi e altro ancora. A tale scopo, SDKs dispongono di strategie flessibili per ottenere le credenziali da utilizzare per le richieste, mantenere le impostazioni da utilizzare con ciascun servizio e ottenere valori da utilizzare per le impostazioni globali.

È possibile trovare informazioni dettagliate sulle impostazioni di configurazione nelle seguenti sezioni:

Creazione di clienti di servizio

Per accedere a livello di codice Servizi AWS, SDKs utilizzate una classe/oggetto client per ciascuno. Servizio AWS Ad esempio, se la tua applicazione deve accedere ad Amazon EC2, crea un oggetto EC2 client Amazon per interfacciarsi con quel servizio. Quindi utilizzi il client del servizio per effettuare richieste in merito Servizio AWS. Nella maggior parte dei casi SDKs, un oggetto client di servizio è immutabile, quindi è necessario creare un nuovo client per ogni servizio a cui si effettuano richieste e per effettuare richieste allo stesso servizio utilizzando una configurazione diversa.

Precedenza delle impostazioni

Le impostazioni globali configurano funzionalità, fornitori di credenziali e altre funzionalità che sono supportate dalla maggior parte SDKs e hanno un ampio impatto su tutti. Servizi AWS Tutte SDKs hanno una serie di luoghi (o fonti) che controllano per trovare un valore per le impostazioni globali. Quanto segue è l'impostazione della priorità di ricerca:

  1. Qualsiasi impostazione esplicita impostata nel codice o su un client di servizio stesso ha la precedenza su qualsiasi altra cosa.

    • Alcune impostazioni possono essere impostate in base all'operazione e possono essere modificate secondo necessità per ogni operazione richiamata. Per l' AWS CLI operazione AWS Strumenti per PowerShell, queste assumono la forma di parametri specifici per operazione che vengono immessi nella riga di comando. Per un SDK, le assegnazioni esplicite possono assumere la forma di un parametro impostato quando si crea un'istanza di un Servizio AWS client o di un oggetto di configurazione o, a volte, quando si chiama una singola API.

  2. Solo Java/Kotlin: la proprietà del sistema JVM per l'impostazione è verificata. Se è impostato, quel valore viene utilizzato per configurare il client.

  3. La variabile di ambiente è selezionata. Se è impostato, quel valore viene utilizzato per configurare il client.

  4. L'SDK verifica l'impostazione nel credentials file condiviso. Se è impostato, il client lo utilizza.

  5. Il config file condiviso per l'impostazione. Se l'impostazione è presente, l'SDK la utilizza.

    • La variabile di AWS_PROFILE ambiente o la proprietà di sistema aws.profile JVM possono essere utilizzate per specificare il profilo caricato dall'SDK.

  6. Qualsiasi valore predefinito fornito dal codice sorgente SDK stesso viene utilizzato per ultimo.

Nota

Alcuni SDKs strumenti potrebbero eseguire il controllo in un ordine diverso. Inoltre, alcuni SDKs strumenti supportano altri metodi di memorizzazione e recupero dei parametri. Ad esempio, AWS SDK for .NET supporta una fonte aggiuntiva denominata SDK Store. Per ulteriori informazioni sui provider esclusivi di un SDK o di uno strumento, consulta la guida specifica per l'SDK o lo strumento che stai utilizzando.

L'ordine determina quali metodi hanno la precedenza e sostituiscono gli altri. Ad esempio, se configuri un profilo nel config file condiviso, questo viene trovato e utilizzato solo dopo che l'SDK o lo strumento hanno prima verificato le altre posizioni. Ciò significa che se inserisci un'impostazione nel credentials file, questa viene utilizzata al posto di quella trovata nel config file. Se si configura una variabile di ambiente con un'impostazione e un valore, questa avrà la precedenza su tale impostazione credentials sia nei config file che. Infine, un'impostazione sulla singola operazione (parametro della AWS CLI riga di comando o parametro API) o nel codice sovrascriverebbe tutti gli altri valori di quell'unico comando.

Pagine delle impostazioni

Le pagine all'interno della sezione di riferimento alle Impostazioni di questa guida descrivono in dettaglio le impostazioni disponibili che possono essere configurate tramite vari meccanismi. Le tabelle che seguono elencano le impostazioni dei file di configurazione e credenziali, le variabili di ambiente e (per Java e Kotlin SDKs) le impostazioni JVM che possono essere utilizzate al di fuori del codice per configurare la funzionalità. Ogni argomento collegato in ogni elenco porta alla pagina delle impostazioni corrispondente.

Ogni provider di credenziali o funzionalità dispone di una pagina in cui sono elencate le impostazioni utilizzate per configurare tale funzionalità. Per ogni impostazione, è spesso possibile impostare il valore aggiungendo l'impostazione a un file di configurazione o impostando una variabile di ambiente oppure (solo per Java e Kotlin) impostando una proprietà di sistema JVM. Ogni impostazione elenca tutti i metodi supportati per impostare il valore in un blocco sopra i dettagli della descrizione. Sebbene la precedenza vari, la funzionalità risultante è la stessa indipendentemente da come viene impostata.

La descrizione includerà l'eventuale valore predefinito che avrà effetto se non si esegue alcuna operazione. Definisce inoltre il valore valido per quell'impostazione.

Ad esempio, diamo un'occhiata a un'impostazione dalla pagina delle Richiesta di compressione funzionalità.

Le informazioni dell'impostazione di disable_request_compression esempio comunicano quanto segue:

  • Esistono tre modi equivalenti per controllare la compressione delle richieste al di fuori del codebase. Puoi eseguire una delle seguenti operazioni:

    • Impostalo nel tuo file di configurazione usando disable_request_compression

    • Impostala come variabile di ambiente usando AWS_DISABLE_REQUEST_COMPRESSION

    • Oppure, se stai usando Java o Kotlin SDK, impostalo come proprietà di sistema JVM usando aws.disableRequestCompression

    Nota

    Potrebbe esserci anche un modo per configurare la stessa funzionalità direttamente nel codice, ma questo riferimento non copre questo aspetto poiché è unico per ogni SDK. Se desideri impostare la configurazione nel codice stesso, consulta la guida SDK o il riferimento API specifico.

  • Se non fai nulla, il valore predefinito sarà. false

  • Gli unici valori validi per questa impostazione booleana sono true e. false

Nella parte inferiore di ogni pagina di funzionalità è presente una tabella di compatibilità con AWS SDKs.

Questa tabella mostra se l'SDK supporta le impostazioni elencate nella pagina. La Supported colonna indica il livello di supporto con i seguenti valori:

  • Yes— Le impostazioni sono completamente supportate dall'SDK così come scritto.

  • Partial— Alcune impostazioni sono supportate o il comportamento si discosta dalla descrizione. InfattiPartial, una nota aggiuntiva indica la deviazione.

  • No— Nessuna delle impostazioni è supportata. Ciò non afferma se sia possibile ottenere la stessa funzionalità nel codice; indica solo che le impostazioni di configurazione esterne elencate non sono supportate.

Configelenco delle impostazioni dei file

Le impostazioni elencate nella tabella seguente possono essere assegnate nel AWS config file condiviso. Sono globali e riguardano tutti Servizi AWS. SDKs e gli strumenti possono anche supportare impostazioni e variabili di ambiente uniche. Per visualizzare le impostazioni e le variabili di ambiente supportate solo da un singolo SDK o strumento, consulta l'SDK o la guida agli strumenti specifici.

Nome dell'impostazione Informazioni
account_id_endpoint_mode Endpoint basati sull'account
api_versions Impostazioni generali di configurazione
aws_access_key_id AWS chiavi di accesso
aws_account_id endpoint basati sull'account
aws_secret_access_key AWS chiavi di accesso
aws_session_token AWS chiavi di accesso
ca_bundle impostazioni generali di configurazione
credential_process Provider di credenziali di processo
credential_source Assumi il ruolo di fornitore di credenziali
defaults_mode Impostazioni predefinite di configurazione intelligente
disable_request_compression Richiedi la compressione
duration_seconds Assumi il ruolo di fornitore di credenziali
ec2_metadata_service_endpoint Fornitore di credenziali IMDS
ec2_metadata_service_endpoint_mode Fornitore di credenziali IMDS
ec2_metadata_v1_disabled Fornitore di credenziali IMDS
endpoint_discovery_enabled Individuazione degli endpoint
endpoint_url Endpoint specifici del servizio
external_id Assumi il ruolo di fornitore di credenziali
ignore_configured_endpoint_urls Endpoint specifici del servizio
max_attempts Comportamento dei nuovi tentativi
metadata_service_num_attempts Metadati delle EC2 istanze Amazon
metadata_service_timeout Metadati delle EC2 istanze Amazon
mfa_serial Assumi il ruolo di fornitore di credenziali
output Impostazioni generali di configurazione
parameter_validation Impostazioni generali di configurazione
region Regione AWS
request_checksum_calculation Protezioni per l'integrità dei dati per Amazon S3
request_min_compression_size_bytes Richiedi la compressione
response_checksum_validation Protezioni per l'integrità dei dati per Amazon S3
retry_mode Comportamento dei nuovi tentativi
role_arn Assumi il ruolo di fornitore di credenziali
role_session_name Assumi il ruolo di fornitore di credenziali
s3_disable_multiregion_access_points Punti di accesso multi-Regione di Amazon S3
s3_use_arn_region Access point Amazon S3
sdk_ua_app_id ID dell'applicazione
source_profile Assumi il ruolo di fornitore di credenziali
sso_account_id Provider di credenziali IAM Identity Center
sso_region Provider di credenziali IAM Identity Center
sso_registration_scopes Provider di credenziali IAM Identity Center
sso_role_name Provider di credenziali IAM Identity Center
sso_start_url Provider di credenziali IAM Identity Center
sts_regional_endpoints AWS STS Endpoint regionali
use_dualstack_endpoint Endpoint dual-stack e FIPS
use_fips_endpoint Endpoint dual-stack e FIPS
web_identity_token_file Assumi il ruolo di fornitore di credenziali

Credentialselenco delle impostazioni dei file

Le impostazioni elencate nella tabella seguente possono essere assegnate nel AWS credentials file condiviso. Sono globali e riguardano tutti Servizi AWS. SDKs e gli strumenti possono anche supportare impostazioni e variabili di ambiente uniche. Per visualizzare le impostazioni e le variabili di ambiente supportate solo da un singolo SDK o strumento, consulta l'SDK o la guida agli strumenti specifici.

Nome dell'impostazione Informazioni
aws_access_key_id AWS chiavi di accesso
aws_secret_access_key AWS chiavi di accesso
aws_session_token AWS chiavi di accesso

elenco delle variabili di ambiente

Le variabili di ambiente supportate dalla maggior parte SDKs sono elencate nella tabella seguente. Sono globali e riguardano tutti Servizi AWS. SDKs e gli strumenti possono anche supportare impostazioni e variabili di ambiente uniche. Per visualizzare le impostazioni e le variabili di ambiente supportate solo da un singolo SDK o strumento, consulta l'SDK o la guida agli strumenti specifici.

Nome dell'impostazione Informazioni
AWS_ACCESS_KEY_ID AWS chiavi di accesso
AWS_ACCOUNT_ID endpoint basati sull'account
AWS_ACCOUNT_ID_ENDPOINT_MODE Endpoint basati sull'account
AWS_CA_BUNDLE Impostazioni generali di configurazione
AWS_CONFIG_FILE Ubicazione dei file condivisi config e credentials dei file
AWS_CONTAINER_AUTHORIZATION_TOKEN Fornitore di credenziali per contenitori
AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE Fornitore di credenziali per contenitori
AWS_CONTAINER_CREDENTIALS_FULL_URI Fornitore di credenziali per contenitori
AWS_CONTAINER_CREDENTIALS_RELATIVE_URI Fornitore di credenziali per contenitori
AWS_DEFAULTS_MODE Impostazioni predefinite di configurazione intelligenti
AWS_DISABLE_REQUEST_COMPRESSION Richiedi la compressione
AWS_EC2_METADATA_DISABLED Fornitore di credenziali IMDS
AWS_EC2_METADATA_SERVICE_ENDPOINT Fornitore di credenziali IMDS
AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE Fornitore di credenziali IMDS
AWS_EC2_METADATA_V1_DISABLED Fornitore di credenziali IMDS
AWS_ENABLE_ENDPOINT_DISCOVERY Individuazione degli endpoint
AWS_ENDPOINT_URL Endpoint specifici del servizio
AWS_ENDPOINT_URL_<SERVICE> Endpoint specifici del servizio
AWS_IGNORE_CONFIGURED_ENDPOINT_URLS Endpoint specifici del servizio
AWS_MAX_ATTEMPTS Comportamento dei nuovi tentativi
AWS_METADATA_SERVICE_NUM_ATTEMPTS Metadati delle EC2 istanze Amazon
AWS_METADATA_SERVICE_TIMEOUT Metadati delle EC2 istanze Amazon
AWS_PROFILE Condivisi config e file credentials
AWS_REGION Regione AWS
AWS_REQUEST_CHECKSUM_CALCULATION Protezioni per l'integrità dei dati per Amazon S3
AWS_REQUEST_MIN_COMPRESSION_SIZE_BYTES Richiedi la compressione
AWS_RESPONSE_CHECKSUM_VALIDATION Protezioni per l'integrità dei dati per Amazon S3
AWS_RETRY_MODE Comportamento dei nuovi tentativi
AWS_ROLE_ARN Assumi il ruolo di fornitore di credenziali
AWS_ROLE_SESSION_NAME Assumi il ruolo di fornitore di credenziali
AWS_S3_DISABLE_MULTIREGION_ACCESS_POINTS Punti di accesso multi-Regione di Amazon S3
AWS_S3_USE_ARN_REGION Access point Amazon S3
AWS_SDK_UA_APP_ID ID dell'applicazione
AWS_SECRET_ACCESS_KEY AWS chiavi di accesso
AWS_SESSION_TOKEN AWS chiavi di accesso
AWS_SHARED_CREDENTIALS_FILE Ubicazione dei file condivisi config e credentials dei file
AWS_STS_REGIONAL_ENDPOINTS AWS STS Endpoint regionali
AWS_USE_DUALSTACK_ENDPOINT Endpoint dual-stack e FIPS
AWS_USE_FIPS_ENDPOINT Endpoint dual-stack e FIPS
AWS_WEB_IDENTITY_TOKEN_FILE Assumi il ruolo di fornitore di credenziali

Elenco delle proprietà del sistema JVM

È possibile utilizzare le seguenti proprietà del sistema JVM per AWS SDK for Java e SDK AWS for Kotlin (destinate alla JVM). Come impostare le proprietà del sistema JVMPer istruzioni su come impostare le proprietà del sistema JVM, vedere.

Nome dell'impostazione Informazioni
aws.accessKeyId AWS chiavi di accesso
aws.accountId endpoint basati sull'account
aws.accountIdEndpointMode Endpoint basati sull'account
aws.configFile Ubicazione degli elementi condivisi e dei file configcredentials
aws.defaultsMode Impostazioni predefinite di configurazione intelligente
aws.disableEc2MetadataV1 Fornitore di credenziali IMDS
aws.disableRequestCompression Richiedi la compressione
aws.ec2MetadataServiceEndpoint Fornitore di credenziali IMDS
aws.ec2MetadataServiceEndpointMode Fornitore di credenziali IMDS
aws.endpointDiscoveryEnabled Individuazione degli endpoint
aws.endpointUrl Endpoint specifici del servizio
aws.endpointUrl<ServiceName> Endpoint specifici del servizio
aws.ignoreConfiguredEndpointUrls Endpoint specifici del servizio
aws.maxAttempts Comportamento dei nuovi tentativi
aws.profile Condivisi config e file credentials
aws.region Regione AWS
aws.requestChecksumCalculation Protezioni per l'integrità dei dati per Amazon S3
aws.requestMinCompressionSizeBytes Richiedi la compressione
aws.responseChecksumValidation Protezioni per l'integrità dei dati per Amazon S3
aws.retryMode Comportamento dei nuovi tentativi
aws.roleArn Assumi il ruolo di fornitore di credenziali
aws.roleSessionName Assumi il ruolo di fornitore di credenziali
aws.s3DisableMultiRegionAccessPoints Punti di accesso multi-Regione di Amazon S3
aws.s3UseArnRegion Access point Amazon S3
aws.secretAccessKey AWS chiavi di accesso
aws.sessionToken AWS chiavi di accesso
aws.sharedCredentialsFile Ubicazione dei file condivisi config e credentials dei file
aws.useDualstackEndpoint Endpoint dual-stack e FIPS
aws.useFipsEndpoint Endpoint dual-stack e FIPS
aws.userAgentAppId ID dell'applicazione
aws.webIdentityTokenFile Assumi il ruolo di fornitore di credenziali