Impostazioni dei file di configurazione e credenziali in AWS CLI

Esegui questo comando per impostare e visualizzare rapidamente le credenziali, la regione e il formato di output. L'esempio seguente illustra i valori di esempio.

$ aws configure
AWS Access Key ID [None]: AKIAIOSFODNN7EXAMPLE
AWS Secret Access Key [None]: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
Default region name [None]: us-west-2
Default output format [None]: json

Puoi impostare le credenziali o le impostazioni di configurazione utilizzando aws configure set. Specifica il profilo che intendi visualizzare o modificare con l'impostazione --profile.

Ad esempio, il comando seguente configura l'impostazione region nel profilo denominato integ.

$ aws configure set region us-west-2 --profile integ

Per rimuovere un'impostazione, elimina manualmente l'impostazione nei credentials file config e in un editor di testo.

Puoi recuperare le credenziali o le impostazioni di configurazione impostate utilizzando aws configure get. Specifica il profilo che intendi visualizzare o modificare con l'impostazione --profile.

Ad esempio, il comando seguente recupera l'impostazione region nel profilo denominato integ.

$ aws configure get region --profile integ
us-west-2

Se l'output è vuoto, l'impostazione non è configurata esplicitamente e viene utilizzato il valore predefinito.

Per elencare i dati di configurazione, utilizzare il aws configure list comando. Questo comando elenca le informazioni di configurazione del profilo, della chiave di accesso, della chiave segreta e della regione utilizzate per il profilo specificato. Per ogni elemento di configurazione, mostra il valore, dove è stato recuperato il valore di configurazione e il nome della variabile di configurazione.

Ad esempio, se fornite il Regione AWS in una variabile di ambiente, questo comando mostra il nome dell'area che avete configurato, che questo valore proviene da una variabile di ambiente e il nome della variabile di ambiente.

Per i metodi di credenziali temporanei come roles e IAM Identity Center, questo comando visualizza la chiave di accesso temporaneamente memorizzata nella cache e viene visualizzata la chiave di accesso segreta.

$ aws configure list
      Name                    Value             Type    Location
      ----                    -----             ----    --------
   profile                <not set>             None    None
access_key     ****************ABCD  shared-credentials-file    
secret_key     ****************ABCD  shared-credentials-file    
    region                us-west-2             env    AWS_DEFAULT_REGION

Alcuni AWS servizi mantengono più API versioni per supportare la compatibilità con le versioni precedenti. Per impostazione predefinita, AWS CLI i comandi utilizzano l'ultima API versione disponibile. È possibile specificare una API versione da utilizzare per un profilo includendo l'api_versionsimpostazione nel config file.

Si tratta di un'impostazione «annidata» seguita da una o più righe rientrate, ciascuna delle quali identifica un AWS servizio e la API versione da utilizzare. Consulta la documentazione di ogni servizio per capire quali API versioni sono disponibili.

L'esempio seguente mostra come specificare una API versione per due AWS servizi. Queste API versioni vengono utilizzate solo per i comandi eseguiti con il profilo che contiene queste impostazioni.

api_versions =
    ec2 = 2015-03-01
    cloudfront = 2015-09-017

Questa impostazione non dispone di una variabile di ambiente o di un parametro della riga di comando equivalente.

Speciifica la chiave di AWS accesso utilizzata come parte delle credenziali per autenticare la richiesta di comando. Sebbene tale impostazione possa essere archiviata nel file config, ti consigliamo di archiviarla nel file credentials.

Può essere sostituita dalla variabile di ambiente AWS_ACCESS_KEY_ID. Non è possibile specificare l'ID chiave di accesso come un'opzione della riga di comando.

aws_access_key_id = AKIAIOSFODNN7EXAMPLE

Speciifica la chiave AWS segreta utilizzata come parte delle credenziali per autenticare la richiesta di comando. Sebbene tale impostazione possa essere archiviata nel file config, ti consigliamo di archiviarla nel file credentials.

Può essere sostituita dalla variabile di ambiente AWS_SECRET_ACCESS_KEY. Non è possibile specificare la chiave di accesso segreta come un'opzione della riga di comando.

aws_secret_access_key = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Specifica un token di sessione. AWS È richiesto un token di sessione solo se si specificano manualmente credenziali di sicurezza temporanee. Sebbene tale impostazione possa essere archiviata nel file config, ti consigliamo di archiviarla nel file credentials.

Può essere sostituita dalla variabile di ambiente AWS_SESSION_TOKEN. Non è possibile specificare il token di sessione come un'opzione della riga di comando.

aws_session_token = AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/LTo6UDdyJwOOvEVPvLXCrrrUtdnniCEXAMPLE/IvU1dYUg2RVAJBanLiHb4IgRmpRV3zrkuWJOgQs8IZZaIv2BXIa2R4Olgk

Speciifica un pacchetto di certificati CA (un file con .pem estensione) utilizzato per verificare i certificati. SSL

Può essere sostituita dalla variabile di ambiente AWS_CA_BUNDLE o dall'opzione della riga di comando --ca-bundle.

ca_bundle = dev/apps/ca-certs/cabundle-2019mar05.pem

Speciifica se i AWS CLI tentativi di seguire i URL collegamenti nei parametri della riga di comando che iniziano con http:// o. https:// Se abilitato, il contenuto recuperato viene utilizzato come valore del parametro anziché. URL

Questa voce non dispone di una variabile di ambiente o di un'opzione della riga di comando equivalente.

cli_follow_urlparam = false

Disabilitato per impostazione predefinita. Questa impostazione abilita la cronologia dei comandi per. AWS CLI Dopo aver abilitato questa impostazione, AWS CLI registra la cronologia dei aws comandi.

cli_history = enabled

È possibile elencare la cronologia utilizzando il aws history list comando e utilizzare il risultato command_ids del aws history show comando per i dettagli. Per ulteriori informazioni, aws historyconsulta la guida AWS CLI di riferimento.

Specifica il formato dei valori di timestamp inclusi nell'output. Puoi specificare uno dei seguenti valori:

Questa voce non dispone di una variabile di ambiente o di un'opzione della riga di comando equivalente.

cli_timestamp_format = iso8601

Speciifica un comando esterno da eseguire per generare o recuperare le AWS CLI credenziali di autenticazione da utilizzare per questo comando. Il comando deve restituire le credenziali in un formato specifico. Per ulteriori informazioni sull'utilizzo di questa impostazione, consulta Acquisizione di credenziali con un processo esterno in AWS CLI.

Questa voce non dispone di una variabile di ambiente o di un'opzione della riga di comando equivalente.

credential_process = /opt/bin/awscreds-retriever --username susan

Utilizzato all'interno di EC2 istanze o contenitori Amazon per specificare dove AWS CLI trovare le credenziali da utilizzare per assumere il ruolo specificato con il role_arn parametro. Non è possibile specificare sia source_profile sia credential_source nello stesso profilo.

Questo parametro può avere uno dei seguenti tre valori:

credential_source = Ec2InstanceMetadata

Specifica la durata massima della sessione del ruolo, in secondi. Questo valore può variare da 900 secondi (15 minuti) fino alla durata massima della sessione per il ruolo (massimo 43200 minuti). Si tratta di un parametro facoltativo e, per impostazione predefinita, il valore è impostato su 3600 secondi.

Speciifica l'endpoint utilizzato per tutte le richieste di servizio. Se questa impostazione viene utilizzata nella servicessezione del config file, l'endpoint viene utilizzato solo per il servizio specificato.

L'esempio seguente utilizza l'endpoint globale http://localhost:1234 e un endpoint specifico del servizio di per Amazon http://localhost:4567 S3.

[profile dev]
endpoint_url = http://localhost:1234
services = s3-specific

[services s3-specific]
s3 = 
  endpoint_url = http://localhost:4567

Le impostazioni di configurazione degli endpoint si trovano in più posizioni, ad esempio le variabili di sistema o di ambiente utente, i file di AWS configurazione locali o sono dichiarate esplicitamente nella riga di comando come parametro. Le impostazioni di configurazione AWS CLI degli endpoint hanno la precedenza nell'ordine seguente:

Se abilitato, AWS CLI ignora tutte le configurazioni personalizzate degli endpoint specificate nel file. config I valori validi sono true e false.

ignore_configure_endpoint_urls = true

Le impostazioni di configurazione degli endpoint si trovano in più posizioni, ad esempio le variabili di sistema o di ambiente utente, i file di AWS configurazione locali o sono dichiarate esplicitamente nella riga di comando come parametro. Le impostazioni di configurazione AWS CLI degli endpoint hanno la precedenza nell'ordine seguente:

Specifica un identificatore univoco che viene utilizzato da terze parti per assumere un ruolo negli account dei relativi clienti. Questo è mappato al parametro ExternalId nell'operazione AssumeRole. Questo parametro è necessario solo se la policy di attendibilità per il ruolo specifica un valore per ExternalId. Per ulteriori informazioni, consulta Come utilizzare un ID esterno per concedere l'accesso alle AWS risorse a terzi nella Guida per l'IAMutente.

Specificate il valore massimo di tentativi utilizzato dal gestore dei tentativi, in AWS CLI base al quale la chiamata iniziale viene conteggiata ai fini del max_attempts valore fornito.

È possibile sovrascrivere questo valore utilizzando la variabile di ambiente. AWS_MAX_ATTEMPTS

max_attempts = 3

Il numero di identificazione di un MFA dispositivo da utilizzare quando si assume un ruolo. Questo è obbligatorio solo se la politica di fiducia del ruolo assunto include una condizione che richiede MFA l'autenticazione. Il valore può essere un numero di serie per un dispositivo hardware (comeGAHT12345678) o un Amazon Resource Name (ARN) per un MFA dispositivo virtuale (comearn:aws:iam::123456789012:mfa/user).

Specifica il formato di output predefinito per i comandi richiesti utilizzando questo profilo. Puoi specificare uno qualsiasi dei valori seguenti:

Può essere sostituita dalla variabile di ambiente AWS_DEFAULT_OUTPUT o dall'opzione della riga di comando --output.

output = table

Speciifica se il AWS CLI client tenta di convalidare i parametri prima di inviarli all'endpoint del servizio. AWS

Questa voce non dispone di una variabile di ambiente o di un'opzione della riga di comando equivalente.

parameter_validation = false

Speciifica a chi Regione AWS inviare le richieste per i comandi richiesti utilizzando questo profilo.

Puoi sovrascrivere questo valore utilizzando la variabile di ambiente o AWS_DEFAULT_REGION l'opzione della riga di comando. --region

region = us-west-2

Specificate la modalità di riprova utilizzata. AWS CLI Sono disponibili tre modalità di riprova: legacy (predefinita), standard e adattiva. Per ulteriori informazioni sui tentativi, consultare AWS CLI nuovi tentativi nel AWS CLI.

È possibile sovrascrivere questo valore utilizzando la AWS_RETRY_MODE variabile di ambiente.

retry_mode = standard

Speciifica l'Amazon Resource Name (ARN) di un IAM ruolo che desideri utilizzare per eseguire i AWS CLI comandi. Puoi anche specificare uno dei seguenti parametri per identificare le credenziali che dispongono dell'autorizzazione per assumere questo ruolo:

role_arn = arn:aws:iam::123456789012:role/role-name

La variabile di ambiente AWS_ROLE_ARNsostituisce questa impostazione.

Per ulteriori informazioni sull'utilizzo delle identità Web, vedere. Assunzione di un ruolo con un'identità Web

Specifica il nome da associare alla sessione del ruolo. Questo valore viene fornito al RoleSessionName parametro quando AWS CLI chiama l'AssumeRoleoperazione e diventa parte del ruolo assunto userARN: arn:aws:sts::123456789012:assumed-role/role_name/role_session_name. Si tratta di un parametro facoltativo. Se non fornisci questo valore, viene automaticamente generato un nome della sessione. Questo nome viene visualizzato nei log di AWS CloudTrail per le voci associate a questa sessione.

role_session_name = maria_garcia_role

La variabile di ambiente ha la AWS_ROLE_SESSION_NAMEprecedenza su questa impostazione.

Per ulteriori informazioni sull'utilizzo delle identità Web, vedere. Assunzione di un ruolo con un'identità Web

Speciifica la configurazione del servizio da utilizzare per il profilo.

[profile dev-s3-specific-and-global]
endpoint_url = http://localhost:1234
services = s3-specific

[services s3-specific]
s3 = 
  endpoint_url = http://localhost:4567

Per ulteriori informazioni sulla services sezione, vedereTipo di sezione: services.

La variabile di ambiente ha la AWS_ROLE_SESSION_NAMEprecedenza su questa impostazione.

Per ulteriori informazioni sull'utilizzo delle identità Web, vedere. Assunzione di un ruolo con un'identità Web

Una singola Account AWS può essere utilizzata da più applicazioni del cliente a cui effettuare Servizi AWS chiamate. L'ID dell'applicazione identifica quale applicazione di origine ha effettuato una serie di chiamate utilizzando un Servizio AWS. AWS SDKse i servizi non utilizzano o interpretano questo valore se non per riemergere nelle comunicazioni con i clienti. Ad esempio, questo valore può essere incluso nelle e-mail operative per identificare in modo univoco quale delle applicazioni è associata alla notifica.

L'ID dell'applicazione è una stringa con una lunghezza massima di 50 caratteri. Sono consentite lettere, numeri e i seguenti caratteri speciali: Per ! $ % & * + - . , ^ _ ` | ~ impostazione predefinita, non viene assegnato alcun valore.

sdk_ua_app_id = prod1

Questa impostazione può essere sovrascritta utilizzando la variabile di ambiente AWS_SDK_UA_APP_ID. Non è possibile impostare questo valore come parametro della riga di comando.

Specifica un profilo denominato con credenziali a lungo termine che l' AWS CLI può utilizzare per assumere un ruolo specificato con il parametro role_arn. Non è possibile specificare sia source_profile sia credential_source nello stesso profilo.

source_profile = production-profile

Specifica in che modo AWS CLI determina l'endpoint del AWS servizio utilizzato AWS CLI dal client per parlare con AWS Security Token Service ()AWS STS. Il valore predefinito per la AWS CLI versione 1 è. legacy

È possibile specificare uno dei due valori:

Questa impostazione può essere sovrascritta utilizzando la variabile di ambiente AWS_STS_REGIONAL_ENDPOINTS. Non è possibile impostare questo valore come parametro della riga di comando.

Abilita l'uso di endpoint dual-stack per inviare richieste. AWS Per ulteriori informazioni sugli endpoint dual-stack, che supportano sia il traffico che il IPv6 traffico, consulta Using IPv4 Using Amazon S3 dual-stack endpoint nella Amazon Simple Storage Service User Guide. Gli endpoint dual-stack sono disponibili per alcuni servizi in alcune regioni. Se non esiste un endpoint dual-stack per il servizio o se la richiesta ha esito negativo. Regione AWS Questa opzione è disabilitata per impostazione predefinita.

Questa impostazione e l'impostazione use_accelerate_endpoint si escludono a vicenda.

Le impostazioni di configurazione degli endpoint si trovano in più posizioni, ad esempio nelle variabili di sistema o di ambiente utente, nei file di AWS configurazione locali o sono dichiarate esplicitamente nella riga di comando come parametro. Le impostazioni di configurazione AWS CLI degli endpoint hanno la precedenza nell'ordine seguente:

Alcuni AWS servizi offrono endpoint che supportano il Federal Information Processing Standard (FIPS) 140-2, in altri. Regioni AWS Se il AWS servizio supportaFIPS, questa impostazione specifica l'FIPSendpoint da utilizzare. AWS CLI A differenza degli AWS endpoint standard, gli FIPS endpoint utilizzano una libreria TLS software conforme a 140-2. FIPS Questi endpoint potrebbero essere necessari ad aziende che interagiscono con il governo degli Stati Uniti.

Se questa impostazione è abilitata, ma non esiste un FIPS endpoint per il servizio in uso Regione AWS, il comando potrebbe avere esito negativo. AWS In questo caso, specifica manualmente l'endpoint da utilizzare nel comando utilizzando l'--endpoint-urlopzione o utilizza endpoint specifici del servizio.

Per ulteriori informazioni sulla specificazione degli endpoint in base al servizio, FIPS consulta Endpoints by Service Regione AWS. FIPS

Le impostazioni di configurazione degli endpoint si trovano in più posizioni, ad esempio le variabili di sistema o di ambiente utente, i file di AWS configurazione locali o sono dichiarate esplicitamente nella riga di comando come parametro. Le impostazioni di configurazione AWS CLI degli endpoint hanno la precedenza nell'ordine seguente:

Speciifica il percorso di un file che contiene un token di accesso OAuth 2.0 o un token ID OpenID Connect fornito da un provider di identità. L' AWS CLI carica il contenuto di questo file e lo passa come argomento WebIdentityToken all'operazione AssumeRoleWithWebIdentity.

La variabile di ambiente ha la precedenza AWS_WEB_IDENTITY_TOKEN_FILE su questa impostazione.

Per ulteriori informazioni sull'utilizzo delle identità Web, vedere. Assunzione di un ruolo con un'identità Web

Speciifica se il AWS CLI client utilizza pacchetti TCP keep-alive.

Questa voce non dispone di una variabile di ambiente o di un'opzione della riga di comando equivalente.

tcp_keepalive = false

Specifica quale stile di indirizzamento utilizzare. Questo controlla se il nome del bucket è nel nome host o fa parte di. URL I valori validi sonopath, virtual e auto. Il valore predefinito è auto.

Esistono due stili di creazione di un endpoint Amazon S3. Il primo è denominato virtual e include il nome del bucket come parte del nome host. Ad esempio: https://bucketname.s3.amazonaws.com. In alternativa, con lo path stile, si tratta il nome del bucket come se fosse un percorso inURI; ad esempio,. https://s3.amazonaws.com/bucketname Il valore predefinito in CLI è useauto, che tenta di utilizzare lo virtual stile dove possibile, ma ricorre allo path stile quando necessario. Ad esempio, se il nome del bucket non è DNS compatibile, il nome del bucket non può far parte del nome host e deve essere nel percorso. Conauto, CLI rileverà questa condizione e passerà automaticamente path allo stile per te. Se imposti lo stile di indirizzamento supath, devi quindi assicurarti che la AWS regione che hai configurato AWS CLI corrisponda alla regione del tuo bucket.

Specifica se SHA256 firmare i payload sigv4. Per impostazione predefinita, questa opzione è disabilitata per i caricamenti in streaming (UploadParte) durante l'utilizzo. PutObject HTTPS Per impostazione predefinita, è impostato su false per i caricamenti in streaming (UploadPartePutObject), ma solo se ContentMD5 è presente a (viene generato per impostazione predefinita) e l'endpoint lo utilizza. HTTPS

Se impostato su true, le richieste S3 ricevono un'ulteriore convalida del contenuto sotto forma di un SHA256 checksum calcolato automaticamente e incluso nella firma della richiesta. Se impostata su false, il checksum non viene calcolato. Può essere utile disabilitare questa impostazione per ridurre il sovraccarico in termini di prestazioni dovuto al calcolo del checksum.

Usa l'endpoint Amazon S3 Accelerate per tutti i s3 comandi. s3api Il valore predefinito è false. Questa impostazione e l'impostazione use_dualstack_endpoint si escludono a vicenda.

Se impostato su true, AWS CLI indirizza tutte le richieste Amazon S3 S3 Accelerate all'endpoint a. s3-accelerate.amazonaws.com Per usare questo endpoint, dovrai abilitare l'utilizzo di S3 Accelerate per il bucket. Tutte le richieste vengono inviate utilizzando lo stile virtuale di indirizzamento al bucket: my-bucket.s3-accelerate.amazonaws.com. Le richieste ListBuckets, CreateBucket e DeleteBucket non verranno inviate all'endpoint di accelerazione S3 in quanto tale endpoint non supporta queste operazioni. Questo comportamento può essere configurato anche se il parametro --endpoint-url è impostato su https://s3-accelerate.amazonaws.com o http://s3-accelerate.amazonaws.com per qualsiasi comando s3 o s3api.

Speciifica la larghezza di banda massima che può essere consumata per caricare e scaricare dati da e verso Amazon S3. Il valore predefinito è senza limiti.

Ciò limita la larghezza di banda massima che i comandi S3 possono utilizzare per trasferire dati da e verso Amazon S3. Tale valore viene applicato solo ai caricamenti e ai download, non alle operazioni di copia o eliminazione. Il valore viene espresso in byte al secondo. Il valore può essere specificato come segue:

In generale, ti consigliamo di provare in primo luogo a ridurre il consumo di larghezza di banda riducendo max_concurrent_requests. Se ciò non è sufficiente per limitare il consumo di larghezza di banda in modo appropriato alle tue esigenze, puoi utilizzare l'impostazione max_bandwidth per limitarlo ulteriormente. Ciò accade perché max_concurrent_requests controlla il numero di thread attualmente in esecuzione. Se invece prima si abbassa max_bandwidth ma si lascia un'impostazione max_concurrent_requests alta, ciò può comportare che i thread debbano attendere inutilmente. Ciò può portare a un consumo eccessivo di risorse e a timeout di connessione.

Specifica il numero massimo di richieste simultanee. Il valore predefinito è 10.

I comandi di trasferimento aws s3 sono a più thread. In qualsiasi momento, possono essere eseguite più richieste Amazon S3. Ad esempio, quando usi il comando aws s3 cp localdir s3://bucket/ --recursive per caricare file in un bucket S3, AWS CLI possono caricare i file localdir/file1 e in localdir/file3 parallelo. localdir/file2 L'impostazione max_concurrent_requests specifica il numero massimo di operazioni di trasferimento che possono essere eseguite nello stesso momento.

Potrebbe essere necessario modificare questo valore per vari motivi:

Specifica il numero massimo di attività nella coda. Il valore predefinito è 1000.

AWS CLI Internamente utilizza un modello in cui mette in coda le attività di Amazon S3 che vengono poi eseguite da consumatori il cui numero è limitato a. max_concurrent_requests Un'attività è generalmente associata a una singola operazione di Amazon S3. Un'attività potrebbe ad esempio essere PutObjectTask, GetObjectTask o UploadPartTask. La velocità con cui le attività vengono aggiunte alla coda può essere molto maggiore rispetto a quella con cui i consumatori terminano le attività. Per evitare la crescita illimitata, esiste un limite specifico per la dimensione della coda delle attività. Questa impostazione consente di modificare il valore del numero massimo.

In generale, non è necessario modificare questa impostazione, Questa impostazione corrisponde anche al numero di attività di cui AWS CLI è a conoscenza e che devono essere eseguite. Ciò significa che per impostazione predefinita AWS CLI possono visualizzare solo 1000 attività future. L'aumento di questo valore significa che AWS CLI può conoscere più rapidamente il numero totale di attività necessarie, supponendo che la velocità di attesa sia superiore alla velocità di completamento delle attività. Il compromesso è che un valore max_queue_size maggiore richiede più memoria.

Speciifica la dimensione del blocco AWS CLI utilizzata per i trasferimenti multiparte di singoli file. Il valore predefinito è 8 MB, con un minimo di 5 MB.

Quando un trasferimento di file supera ilmultipart_threshold, AWS CLI divide il file in blocchi di questa dimensione. Questo valore può essere specificato utilizzando la stessa sintassi di multipart_threshold, come numero di byte sotto forma di intero o utilizzando una dimensione e un suffisso.

Speciifica la soglia di dimensione AWS CLI utilizzata per i trasferimenti multiparte di singoli file. Il valore predefinito è 8 MB.

Quando si carica, si scarica o si copia un file, i comandi di Amazon S3 passano a operazioni in più parti se il file supera tale dimensione. Puoi specificare questo valore in uno dei due modi seguenti: