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à.
Configurazione per l'AWS SDK for PHPVersione 3
Questa guida descrive le opzioni del costruttore client. Queste opzioni possono essere fornite in un costruttore client o fornito alla classe Aws\Sdk
. La vasta gamma di opzioni fornite a uno specifico tipo di client può variare in base a quale client si sta creando. Queste opzioni personalizzate per la configurazione di client sono descritte nella documentazione API di ogni client.
Si noti che alcune opzioni di configurazione controlleranno e utilizzeranno valori predefiniti basati su variabili di ambiente o suAWSfile di configurazione. Per impostazione predefinita, il file di configurazione da controllare sarà .aws/config
nella home directory, comunemente ~/.aws/config
. Tuttavia, è possibile utilizzare la variabile d'ambiente AWS_CONFIG_FILE
per impostare la posizione del file di configurazione predefinito. Questo può essere particolarmente utile se si limita l'accesso ai file a determinate directory con open_basedir
e simili.
Opzioni di configurazione
L'esempio seguente mostra come passare le opzioni a un costruttore client Amazon S3.
use Aws\S3\S3Client; $options = [ 'region' => 'us-west-2', 'version' => '2006-03-01', 'signature_version' => 'v4' ]; $s3Client = new S3Client($options);
Consulta la guida di utilizzo di base per ulteriori informazioni su come costruire client.
api_provider
- Type (Tipo)
-
callable
Un PHP chiamabile che accetta un tipo, servizio e argomento versione e restituisce un array di dati di configurazione corrispondenti. Il valore del tipo può essere api
, waiter
o paginator
.
Per impostazione predefinita, l'SDK usa un'istanza di Aws\Api\FileSystemApiProvider
che carica i file dell'API dalla cartella src/data
dell'SDK.
credenziali
- Type (Tipo)
-
array|Aws\CacheInterface|Aws\Credentials\CredentialsInterface|bool|callable
Passa un oggetto Aws\Credentials\CredentialsInterface
per utilizzare le credenziali di un'istanza specifica.
$credentials = new Aws\Credentials\Credentials('key', 'secret'); $s3 = new Aws\S3\S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'credentials' => $credentials ]);
Se non fornisci un'opzione credentials
, l'SDK tenta di caricare le credenziali dal tuo ambiente nell'ordine seguente:
-
Carica credenziali dalle variabili di ambiente.
-
Carica credenziali da un file .ini delle credenziali.
-
Carica credenziali da un ruolo IAM.
Passa false
per utilizzare credenziali null e non firmare richieste.
$s3 = new Aws\S3\S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'credentials' => false ]);
Passa una funzione di provider di credenziali chiamabile per creare credenziali utilizzando una funzione.
use Aws\Credentials\CredentialProvider; // Only load credentials from environment variables $provider = CredentialProvider::env(); $s3 = new Aws\S3\S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'credentials' => $provider ]);
Trasferisce le credenziali nella cache a un'istanza di Aws\CacheInterface
per memorizzare nella cache i valori restituiti dalla catena di provider predefinita su più processi.
use Aws\Credentials\CredentialProvider; use Aws\DoctrineCacheAdapter; use Doctrine\Common\Cache\ApcuCache; $cache = new DoctrineCacheAdapter(new ApcuCache); $provider = CredentialProvider::defaultProvider(); $cachedProvider = CredentialProvider::cache($provider, $cache); $s3 = new Aws\S3\S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'credentials' => $cachedProvider ]);
Puoi trovare ulteriori informazioni sulla fornitura di credenziali a un client inCredenziali perAWS SDK for PHPVersione 3guida.
Quando vengono utilizzate, le credenziali vengono caricate e convalidate lentamente.
debug
- Type (Tipo)
-
bool|array
Emette le informazioni di debug su ogni trasferimento. Le informazioni di debug contengono informazioni su ogni modifica dello stato di una transazione e vengono preparate e inviate tramite la rete. L'output di debug include anche informazioni sul gestore HTTP specifico utilizzato da un client (ad esempio, debug cURL output).
Imposta su true
per visualizzare le informazioni di debug durante l'invio delle richieste.
$s3 = new Aws\S3\S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'debug' => true ]); // Perform an operation to see the debug output $s3->listBuckets();
In alternativa, puoi fornire un array associativo con le seguenti chiavi.
- logfn (callable)
-
Funzione richiamata con messaggi di log. Per impostazione predefinita, viene utilizzata la funzione
echo
di PHP. - stream_size (int)
-
Quando le dimensioni di un flusso sono maggiori rispetto a questo numero, il flusso di dati non viene registrato. Imposta su
0
per non registrare alcun dato di flusso. - scrub_auth (bool)
-
Imposta su
false
per disabilitare lo scrubbing dei dati di auth dai messaggi registrati (ovvero il tuoAWSl'ID della chiave di accesso e la firma saranno passati allogfn
). - http (bool)
-
Imposta su
false
per disattivare la funzione di "debug" dei gestori HTTP di livello inferiore (ad esempio, verbose cURL output). - auth_headers (array)
-
Imposta su una mappatura chiave-valore di intestazioni che desideri sostituire mappate al valore con cui desideri sostituirle. Questi valori non vengono utilizzati a meno che
scrub_auth
non sia impostato sutrue
. - auth_strings (array)
-
Imposta su una mappatura chiave-valore di espressioni regolari da mappare alle loro sostituzioni. Questi valori sono utilizzati dallo scrubber dei dati di autenticazione se
scrub_auth
è impostato sutrue
.
$s3 = new Aws\S3\S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'debug' => [ 'logfn' => function ($msg) { echo $msg . "\n"; }, 'stream_size' => 0, 'scrub_auth' => true, 'http' => true, 'auth_headers' => [ 'X-My-Secret-Header' => '[REDACTED]', ], 'auth_strings' => [ '/SuperSecret=[A-Za-z0-9]{20}/i' => 'SuperSecret=[REDACTED]', ], ] ]); // Perform an operation to see the debug output $s3->listBuckets();
Questa opzione emette anche le informazioni del gestore HTTP sottostante prodotte dalhttp
opzione di debug. L'output di debug è molto utile durante la diagnostica dei problemi nell'AWS SDK for PHP. Fornisci l'output di debug per un caso di errore isolato all'apertura dei problemi sull'SDK.
stats
- Type (Tipo)
-
bool|array
Associa le statistiche di trasferimento agli errori e ai risultati restituiti dalle operazioni dell'SDK.
Imposta su true
per raccogliere le statistiche di trasferimento sulle richieste inviate.
$s3 = new Aws\S3\S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'stats' => true ]); // Perform an operation $result = $s3->listBuckets(); // Inspect the stats $stats = $result['@metadata']['transferStats'];
In alternativa, puoi fornire un array associativo con le seguenti chiavi.
- retries (bool)
-
Imposta su
true
per abilitare la creazione di report sui nuovi tentativi. Le statistiche sui nuovi tentativi sono raccolte per impostazione predefinita e restituite. - http (bool)
-
Imposta su
true
per abilitare la raccolta di statistiche da adattatori HTTP di livello inferiore (ad esempio, valori restituiti in GuzzleHttpTransferStats). I gestori HTTP devono supportare un'opzione __on_transfer_stats affinché questo abbia effetto. Le statistiche HTTP vengono restituite come un array indicizzato di array associativi; ogni array associativo contiene le statistiche di trasferimento restituite per una richiesta dal gestore HTTP del client. Disabilitato per impostazione predefinita.Se una richiesta è stata tentata nuovamente, ne vengono restituite tutte le statistiche di trasferimento, con
$result['@metadata']['transferStats']['http'][0]
contenenti le statistiche per la prima richiesta,$result['@metadata']['transferStats']['http'][1]
che contengono le statistiche per la seconda richiesta e così via. - timer (bool)
-
Imposta su
true
per abilitare un timer di comando che indica il tempo totale utilizzato, in secondi, per eseguire un'operazione. Disabilitato per impostazione predefinita.
$s3 = new Aws\S3\S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'stats' => [ 'retries' => true, 'timer' => false, 'http' => true, ] ]); // Perform an operation $result = $s3->listBuckets(); // Inspect the HTTP transfer stats $stats = $result['@metadata']['transferStats']['http']; // Inspect the number of retries attempted $stats = $result['@metadata']['transferStats']['retries_attempted']; // Inspect the total backoff delay inserted between retries $stats = $result['@metadata']['transferStats']['total_retry_delay'];
endpoint
- Type (Tipo)
-
string
L'URI completo del servizio Web. È obbligatorio per i servizi, ad esempio MediaConvert, che impiegano endpoint specifici dell'account. Per questi servizi, richiedi questo endpoint utilizzando ildescribeEndpoints
metodo.
Questo è necessario solo quando ci si connette a un endpoint personalizzato (ad esempio, una versione locale di Amazon S3 oAmazon DynamoDB locale).
Ecco un esempio di connessione ad Amazon DynamoDB Local:
$client = new Aws\DynamoDb\DynamoDbClient([ 'version' => '2012-08-10', 'region' => 'us-east-1' 'endpoint' => 'http://localhost:8000' ]);
Consulta ilAWSRegioni ed endpointper un elenco di disponibiliAWSRegioni ed endpoint.
endpoint_provider
- Type (Tipo)
-
callable
Un PHP chiamabile facoltativo che accetta un hash di opzioni, tra cui una chiave "servizio" e "regione". Restituisce NULL
o un hash di dati di endpoint, di cui la chiave "endpoint" è obbligatoria.
Ecco un esempio di come creare un provider di endpoint minimi.
$provider = function (array $params) { if ($params['service'] == 'foo') { return ['endpoint' => $params['region'] . '.example.com']; } // Return null when the provider cannot handle the parameters return null; });
endpoint_discovery
- Type (Tipo)
-
array|Aws\CacheInterface|Aws\EndpointDiscovery\ConfigurationInterface|callable
Il rilevamento endpoint identifica e si connette all'endpoint corretto per un'API di servizio che supporta il rilevamento di endpoint. Per servizi che supportano ma non richiedono il rilevamento di endpoint, abilita endpoint_discovery
durante la creazione client. Se un servizio non supporta il rilevamento di endpoint questa configurazione viene ignorata.
Aws\EndpointDiscovery\ConfigurationInterface
Un provider di configurazione opzionale che abilita la connessione automatica all'endpoint appropriato di un'API di servizio per operazioni specificate dal servizio.
L'oggetto Aws\EndpointDiscovery\Configuration
accetta due opzioni, incluso un valore booleano, "abilitato", che indica se il rilevamento di endpoint è abilitato e un "cache_limit" intero che indica il numero massimo di chiavi nella cache di endpoint.
Per ogni client creato, passa un oggetto Aws\EndpointDiscovery\Configuration
per utilizzare una configurazione specifica per il rilevamento di endpoint.
use Aws\EndpointDiscovery\Configuration; use Aws\S3\S3Client; $enabled = true; $cache_limit = 1000; $config = new Aws\EndpointDiscovery\Configuration ( $enabled, $cache_limit ); $s3 = new Aws\S3\S3Client([ 'version' => 'latest', 'region' => 'us-east-2', 'endpoint_discovery' => $config, ]);
Passa un'istanza di Aws\CacheInterface
per memorizzare nella cache i valori restituiti dal rilevamento di endpoint su più processi.
use Aws\DoctrineCacheAdapter; use Aws\S3\S3Client; use Doctrine\Common\Cache\ApcuCache; $s3 = new S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'endpoint_discovery' => new DoctrineCacheAdapter(new ApcuCache), ]);
Passa un array al rilevamento di endpoint.
use Aws\S3\S3Client; $s3 = new S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'endpoint_discovery' => [ 'enabled' => true, 'cache_limit' => 1000 ], ]);
handler
- Type (Tipo)
-
callable
Un gestore che accetta un oggetto di comando e un oggetto di richiesta e che restituisce una promessa (GuzzleHttp\Promise\PromiseInterface
) che viene soddisfatta con un oggetto Aws\ResultInterface
o rifiutata con un Aws\Exception\AwsException
. Un gestore non accetta un gestore successivo poiché è terminale e tenuto a soddisfare un comando. Se non viene fornito alcun gestore, viene utilizzato un gestore Guzzle predefinito.
Puoi usare Aws\MockHandler
per restituire risultati fittizi o generare eccezioni fittizie. Tu metti in coda i risultati o le eccezioni e il MockHandler li elimina dalla coda in ordine FIFO.
use Aws\Result; use Aws\MockHandler; use Aws\DynamoDb\DynamoDbClient; use Aws\CommandInterface; use Psr\Http\Message\RequestInterface; use Aws\Exception\AwsException; $mock = new MockHandler(); // Return a mocked result $mock->append(new Result(['foo' => 'bar'])); // You can provide a function to invoke; here we throw a mock exception $mock->append(function (CommandInterface $cmd, RequestInterface $req) { return new AwsException('Mock exception', $cmd); }); // Create a client with the mock handler $client = new DynamoDbClient([ 'region' => 'us-west-2', 'version' => 'latest', 'handler' => $mock ]); // Result object response will contain ['foo' => 'bar'] $result = $client->listTables(); // This will throw the exception that was enqueued $client->listTables();
http
- Type (Tipo)
-
array
Impostato su una gamma di opzioni di HTTP che vengono applicate alle richieste e ai trasferimenti HTTP creati tramite l'SDK.
L'SDK supporta le opzioni di configurazione seguenti:
cert
- Type (Tipo)
-
string|array
Specifica il certificato lato client formattato PEM.
-
Imposta come stringa per il percorso del solo file di certificato.
use Aws\S3\S3Client; $client = new S3Client([ 'region' => 'us-west-2', 'version' => 'latest', 'http' => ['cert' => '/path/to/cert.pem'] ]);
-
Imposta come array contenente il percorso e la password.
use Aws\S3\S3Client; $client = new S3Client([ 'region' => 'us-west-2', 'version' => 'latest', 'http' => [ 'cert' => ['/path/to/cert.pem', 'password'] ] ]);
connect_timeout
Un float che descrive il numero di secondi da attendere durante il tentativo di connettersi a un server. Utilizza 0
per attendere un periodo di tempo indefinito (comportamento predefinito).
use Aws\DynamoDb\DynamoDbClient; // Timeout after attempting to connect for 5 seconds $client = new DynamoDbClient([ 'region' => 'us-west-2', 'version' => 'latest', 'http' => [ 'connect_timeout' => 5 ] ]);
debug
- Type (Tipo)
-
bool|resource
Istruisce il gestore HTTP sottostante di emettere le informazioni di debug. Le informazioni di debug fornite da diversi gestori HTTP possono variare.
-
Passa
true
per scrivere l'output di debug in STDOUT. -
Passa una
resource
come restituita dafopen
per scrivere l'output di debug in un determinato flusso di risorse PHP.
decode_content
- Type (Tipo)
-
bool
Istruisce il gestore HTTP sottostante di decomprimere il corpo delle risposte compromesse. Quando non è abilitato, i corpi compressi delle risposte potrebbero essere decompressi con un GuzzleHttp\Psr7\InflateStream
.
La decodifica dei contenuti è abilitata per impostazione predefinita nel gestore HTTP predefinito dell'SDK. Per garantire la compatibilità con le versioni precedenti, questa impostazione predefinita non può essere modificata. Se archivi file compressi in Amazon S3, ti consigliamo di disabilitare la decodifica dei contenuti a livello di client S3.
use Aws\S3\S3Client; use GuzzleHttp\Psr7\InflateStream; $client = new S3Client([ 'region' => 'us-west-2', 'version' => 'latest', 'http' => ['decode_content' => false], ]); $result = $client->getObject([ 'Bucket' => 'my-bucket', 'Key' => 'massize_gzipped_file.tgz' ]); $compressedBody = $result['Body']; // This content is still gzipped $inflatedBody = new InflateStream($result['Body']); // This is now readable
delay
- Type (Tipo)
-
int
Il numero di ritardo in millisecondi prima dell'invio della richiesta. Questo è spesso usato per inserire un ritardo prima di inviare di nuovo la richiesta.
expect
- Type (Tipo)
-
bool|string
Questa opzione viene passata tramite il gestore HTTP sottostante. Per impostazione predefinita, aspettatevi: L'intestazione 100-Continue è impostata quando il corpo della richiesta supera 1 MB.true
ofalse
abilita o disabilita l'intestazione su tutte le richieste. Se viene utilizzato un intero, solo le richieste con corpi che superano questa impostazione utilizzeranno l'intestazione. Quando utilizzato come un intero, se le dimensioni del corpo non sono note, verrà inviata l'intestazione Expect.
La disabilitazione dell'intestazione Expect può impedire al servizio da restituire l'autenticazione o altri errori. Questa opzione deve essere configurata con cautela.
progress
- Type (Tipo)
-
callable
Definisce una funzione da invocare quando vi è un avanzamento del trasferimento. La funzione accetta i seguenti argomenti:
-
Il numero totale di byte previsti che saranno scaricati.
-
Il numero di byte scaricati fino a ora.
-
Il numero totale di byte previsti che saranno caricati.
-
Il numero di byte caricati fino a ora.
use Aws\S3\S3Client; $client = new S3Client([ 'region' => 'us-west-2', 'version' => 'latest' ]); // Apply the http option to a specific command using the "@http" // command parameter $result = $client->getObject([ 'Bucket' => 'my-bucket', 'Key' => 'large.mov', '@http' => [ 'progress' => function ($expectedDl, $dl, $expectedUl, $ul) { printf( "%s of %s downloaded, %s of %s uploaded.\n", $expectedDl, $dl, $expectedUl, $ul ); } ] ]);
proxy
- Type (Tipo)
-
string|array
È possibile connettersi a unAWSservizio tramite un proxy utilizzando ilproxy
opzione.
-
Fornisci un valore di stringa di connessione a un proxy per tutti i tipi di URI. Il valore di stringa proxy può contenere uno schema, nome utente e password. Ad esempio,
"http://username:password@192.168.16.1:10"
. -
Fornisci un array associativo delle impostazioni proxy in cui la chiave è la combinazione di URI, e il valore è il proxy per un determinato URI (ad esempio, puoi fornire diversi proxy per endpoint "http" e "https").
use Aws\DynamoDb\DynamoDbClient; // Send requests through a single proxy $client = new DynamoDbClient([ 'region' => 'us-west-2', 'version' => 'latest', 'http' => [ 'proxy' => 'http://192.168.16.1:10' ] ]); // Send requests through a different proxy per scheme $client = new DynamoDbClient([ 'region' => 'us-west-2', 'version' => 'latest', 'http' => [ 'proxy' => [ 'http' => 'tcp://192.168.16.1:10', 'https' => 'tcp://192.168.16.1:11', ] ] ]);
Puoi utilizzare la variabile ambiente HTTP_PROXY
per configurare un proxy specifico del protocollo "http" e la variabile ambiente HTTPS_PROXY
per configurare un proxy specifico "https".
sink
- Type (Tipo)
-
resource|string|Psr\Http\Message\StreamInterface
L'opzione sink
controlla dove vengono scaricati i dati di risposta di un'operazione.
-
Fornisci un
resource
come restituito dafopen
per scaricare il corpo della risposta in un flusso PHP. -
Fornisci il percorso di un file su disco come un valore
string
per scaricare il corpo della risposta su un determinato file su disco. -
Fornisci un
Psr\Http\Message\StreamInterface
per scaricare il corpo della risposta in un oggetto di flusso PSR specifico.
L'SDK scarica il corpo della risposta in un flusso temp PHP per impostazione predefinita. Ciò significa che i dati rimangono in memoria fino a quando le dimensioni del corpo non raggiungono 2 MB; dopodiché i dati vengono scritti in un file temporaneo su disco.
synchronous
- Type (Tipo)
-
bool
L'opzione synchronous
informa il gestore HTTP che desideri bloccare il risultato.
stream
- Type (Tipo)
-
bool
Imposta su true
per comunicare al gestore HTTP sottostante che desideri trasmettere il corpo di una risposta dal servizio Web, anziché scaricarlo tutto subito. Ad esempio, questa opzione è utilizzata nella classe del wrapper di flusso di Amazon S3 per garantire che i dati vengono trasmessi.
timeout
- Type (Tipo)
-
float
Un float che descrive il timeout della richiesta in secondi. Utilizza 0
per attendere un periodo di tempo indefinito (comportamento predefinito).
use Aws\DynamoDb\DynamoDbClient; // Timeout after 5 seconds $client = new DynamoDbClient([ 'region' => 'us-west-2', 'version' => 'latest', 'http' => [ 'timeout' => 5 ] ]);
verify
- Type (Tipo)
-
bool|string
Puoi personalizzare il comportamento di verifica del certificato SSL/TLS dell'SDK tramite l'opzione verify
http
.
-
Imposta su
true
per abilitare la verifica del certificato SSL/TLS peer e utilizzare il bundle CA predefinito fornito dal sistema operativo. -
Imposta su
false
per disabilitare la verifica del certificato peer. (Questa operazione non è sicura!) -
Imposta su una stringa per fornire il percorso a un bundle di certificazione CA per abilitare la verifica utilizzando un bundle CA personalizzato.
Se il bundle CA non viene individuato per il sistema e ricevi un errore, specifica il percorso di un bundle CA per l'SDK. Se non hai bisogno di un bundle CA specifico, Mozilla fornisce un bundle CA comune che puoi scaricare quiopenssl.cafile
per puntare al percorso del file, consentendo di omettere l'opzione di richiesta verify
. Per ulteriori dettagli sui certificati SSL, consulta il sito Web di cURL
use Aws\DynamoDb\DynamoDbClient; // Use a custom CA bundle $client = new DynamoDbClient([ 'region' => 'us-west-2', 'version' => 'latest', 'http' => [ 'verify' => '/path/to/my/cert.pem' ] ]); // Disable SSL/TLS verification $client = new DynamoDbClient([ 'region' => 'us-west-2', 'version' => 'latest', 'http' => [ 'verify' => false ] ]);
http_handler
- Type (Tipo)
-
callable
L'opzione http_handler
viene utilizzata per integrare l'SDK con altri client HTTP. Un'opzione http_handler
è una funzione che accetta un oggetto Psr\Http\Message\RequestInterface
e una vasta gamma di opzioni http
applicate al comando e restituisce un oggetto GuzzleHttp\Promise\PromiseInterface
che viene soddisfatto con un oggetto Psr\Http\Message\ResponseInterface
o rifiutato con una vasta gamma dei seguenti dati di eccezione:
-
exception
- (\Exception
) l'eccezione che è stata riscontrata. -
response
- (Psr\Http\Message\ResponseInterface
) la risposta che è stata ricevuta (se presente). -
connection_error
- (bool) imposta sutrue
per segnalare l'errore come un errore di connessione. L'impostazione di questo valore sutrue
consente anche all'SDK di effettuare nuovamente l'operazione, se necessario.
L'SDK converte automaticamente l'http_handler
dato in una normale opzione handler
includendo l'http_handler
fornito con un oggetto Aws\WrappedHttpHandler
.
Per impostazione predefinita, l'SDK utilizza Guzzle come gestore HTTP. È possibile fornire qui un gestore HTTP diverso o fornire un client Guzzle con le proprie opzioni personalizzate definite.
Impostazione della versione TLS
Un caso d'uso è quello di impostare la versione TLS utilizzata da Guzzle con Curl, supponendo che Curl sia installato nel proprio ambiente. Notare i vincoli di versione
È possibile individuare la versione TLS utilizzata per una determinata operazione client impostando l'opzione client debug
su true ed esaminando l'output della connessione SSL. Quella linea potrebbe essere simile a SSL connection using TLSv1.2
Esempio di impostazione di TLS 1.2 con Guzzle 6:
use Aws\DynamoDb\DynamoDbClient; use Aws\Handler\GuzzleV6\GuzzleHandler; use GuzzleHttp\Client; $handler = new GuzzleHandler( new Client([ 'curl' => [ CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_2 ] ]) ); $client = new DynamoDbClient([ 'region' => 'us-west-2', 'version' => 'latest', 'http_handler' => $handler ]);
Questa opzione http_handler
sostituisce qualsiasi opzione handler
fornita.
profile
- Type (Tipo)
-
string
Consente di specificare quale profilo utilizzare quando vengono create le credenziali dalAWSfile credenziali nella tua directory HOME. Questa impostazione sostituisce la variabile ambiente AWS_PROFILE
.
Specificando "profile", la chiave "credentials" sarà ignorata.
// Use the "production" profile from your credentials file $ec2 = new Aws\Ec2\Ec2Client([ 'version' => '2014-10-01', 'region' => 'us-west-2', 'profile' => 'production' ]);
Consulta .Credenziali perAWS SDK for PHPVersione 3per ulteriori informazioni sulla configurazione di credenziali e sul formato di file.ini.
Regione
- Type (Tipo)
-
string
- Obbligatorio
-
true
AWSRegione cui connettersi. Consulta ilAWSRegioni ed endpointper un elenco delle regioni disponibili.
// Set the Region to the EU (Frankfurt) Region $s3 = new Aws\S3\S3Client([ 'region' => 'eu-central-1', 'version' => '2006-03-01' ]);
retries
- Type (Tipo)
-
int|array|Aws\CacheInterface|Aws\Retry\ConfigurationInterface|callable
- Default (predefinito)
-
int(3)
Configura la modalità nuovi tentativi e il numero massimo di tentativi consentiti per un client. Passa 0
per disabilitare i nuovi tentativi.
Le tre modalità di nuovi tentativi sono: * legacy
- l'implementazione predefinita dei tentativi legacy * standard
- aggiunge un sistema di quote di nuovi tentativi per evitare tentativi che con pochissime probabilità
avranno successo
-
adaptive
: si basa sulla modalità standard, aggiungendo un limitatore di velocità lato client. Questa modalità è considerata sperimentale.
La configurazione dei nuovi tentativi consiste nella modalità e nel massimo tentativo da utilizzare per ogni richiesta. La configurazione può essere impostata in un paio di posizioni diverse, nel seguente ordine di precedenza.
Ordine di precedenza
L'ordine di precedenza per la configurazione dei tentativi è il seguente (1 sostituisce 2-3, ecc.):
-
Opzione di configurazione client
-
Variabili di ambiente
-
AWSfile di configurazione condiviso
Variabili di ambiente
-
AWS_RETRY_MODE
impostato sulegacy
,standard
oadaptive
-
AWS_MAX_ATTEMPTS
- impostato su un valore intero per il massimo di tentativi per richiesta
Chiavi file di configurazione condiviso
-
retry_mode
impostato sulegacy
,standard
oadaptive
-
max_attempts
- impostato su un valore intero per il massimo di tentativi per richiesta
Configurazione del client
L'esempio seguente disattiva i nuovi tentativi per il client Amazon DynamoDB.
// Disable retries by setting "retries" to 0 $client = new Aws\DynamoDb\DynamoDbClient([ 'version' => '2012-08-10', 'region' => 'us-west-2', 'retries' => 0 ]);
L'esempio seguente passa in un numero intero, che per impostazione predefinita sarà la modalità legacy
con il numero passato di nuovi tentativi
// Disable retries by setting "retries" to 0 $client = new Aws\DynamoDb\DynamoDbClient([ 'version' => '2012-08-10', 'region' => 'us-west-2', 'retries' => 6 ]);
- L'oggetto
Aws\Retry\Configuration
accetta due parametri, la modalità di nuovi tentativi -
e un numero intero per il numero massimo di tentativi per richiesta. Questo esempio passa in un
oggetto Aws\Retry\Configuration
per ripetere la configurazione.
use Aws\EndpointDiscovery\Configuration; use Aws\S3\S3Client; $enabled = true; $cache_limit = 1000; $config = new Aws\Retry\Configuration('adaptive', 10); $s3 = new Aws\S3\S3Client([ 'version' => 'latest', 'region' => 'us-east-2', 'retries' => $config, ]);
Questo esempio passa in un array per la configurazione dei nuovi tentativi.
use Aws\S3\S3Client; $s3 = new S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'retries' => [ 'mode' => 'standard, 'max_attempts' => 7 ], ]);
In questo esempio viene passata un'istanza di Aws\CacheInterface
per memorizzare nella cache i valori restituiti dal provider di configurazione dei nuovi tentativi predefinito.
use Aws\DoctrineCacheAdapter; use Aws\S3\S3Client; use Doctrine\Common\Cache\ApcuCache; $s3 = new S3Client([ 'version' => 'latest', 'region' => 'us-west-2', 'endpoint_discovery' => new DoctrineCacheAdapter(new ApcuCache), ]);
scheme
- Type (Tipo)
-
string
- Default (predefinito)
-
string(5) "https"
Schema di URI da usare per la connessione. L'SDK usa endpoint "https" (ovvero, utilizza le connessioni SSL/TLS) per impostazione predefinita. Puoi tentare di connetterti a un servizio su un endpoint "http" non crittografato impostando scheme
su "http".
$s3 = new Aws\S3\S3Client([ 'version' => '2006-03-01', 'region' => 'us-west-2', 'scheme' => 'http' ]);
Consulta ilAWSRegioni ed endpointper un elenco di endpoint e per sapere se un servizio supporta ilhttp
schema.
service
- Type (Tipo)
-
string
- Obbligatorio
-
true
Nome del servizio da utilizzare. Questo valore viene fornito per impostazione predefinita quando si usa un client fornito dall'SDK (ad esempio, Aws\S3\S3Client
). Questa opzione è utile quando si testa un servizio non ancora pubblicato nell'SDK, ma che hai disponibile su disco.
signature_provider
- Type (Tipo)
-
callable
Un richiamabile che accetta il nome di una versione della firma (ad es.v4
), un nome di servizio eAWSRegione e restituisce unAws\Signature\SignatureInterface
oggetto oNULL
se il provider è in grado di creare un firmatario per i parametri specificati. Questo provider viene utilizzato per creare firmatari utilizzati dal client.
Esistono varie funzioni fornite dall'SDK nella classe Aws\Signature\SignatureProvider
che possono essere utilizzati per creare provider di firma personalizzati.
signature_version
- Type (Tipo)
-
string
Una stringa che rappresenta una versione di firma personalizzata per l'uso con un servizio (ad esempio v4
, ecc.). In base alla firma dell'operazione, la versione POTREBBE ignorare questa versione di firma richiesta, se necessario.
I seguenti esempi mostrano come configurare un client Amazon S3 da utilizzareSignature Version 4:
// Set a preferred signature version $s3 = new Aws\S3\S3Client([ 'version' => '2006-03-01', 'region' => 'us-west-2', 'signature_version' => 'v4' ]);
Il signature_provider
utilizzato dal client DEVE essere in grado di creare l'opzione signature_version
che fornisci. Il signature_provider
predefinito utilizzato dall'SDK può creare oggetti di firma per le versioni di firma "v4" e "anonime".
ua_append
- Type (Tipo)
-
string|string[]
- Default (predefinito)
-
[]
Una stringa o matrice di stringhe che vengono aggiunte alla stringa utente-agente passata al gestore HTTP.
use_aws_shared_config_files
- Type (Tipo)
-
bool|array
- Default (predefinito)
-
bool(true)
Imposta su false per disabilitare il controllo del file di configurazione condiviso in '~/.aws/config' e '~/.aws/credentials'. Ciò sostituirà la variabile d'ambiente AWS_CONFIG_FILE.
validate
- Type (Tipo)
-
bool|array
- Default (predefinito)
-
bool(true)
Imposta su false
per disabilitare la convalida del parametro lato client. Puoi notare che la disattivazione della convalida può migliorare leggermente le prestazioni del client, ma la differenza è trascurabile.
// Disable client-side validation $s3 = new Aws\S3\S3Client([ 'version' => '2006-03-01', 'region' => 'eu-west-1', 'validate' => false ]);
Imposta su un array associativo di opzioni di convalida per abilitare vincoli di convalida specifici:
-
required
- Convalida che i parametri necessari sono presenti (attiva per impostazione predefinita). -
min
- Convalida la lunghezza minima di un valore (attiva per impostazione predefinita). -
max
- Convalida la lunghezza massima di un valore. -
pattern
- Convalida che il valore corrisponde a un'espressione regolare.
// Validate only that required values are present $s3 = new Aws\S3\S3Client([ 'version' => '2006-03-01', 'region' => 'eu-west-1', 'validate' => ['required' => true] ]);
versione
- Type (Tipo)
-
string
- Obbligatorio
-
true
La versione del servizio Web da utilizzare (ad esempio, 2006-03-01
).
Un valore di configurazione "versione" è obbligatorio. Specificando un vincolo di versione si garantisce che il codice non sarà interessato da un'interruzione delle modifiche apportate al servizio. Ad esempio, quando usi Amazon S3, puoi bloccare la versione dell'API su2006-03-01
.
$s3 = new Aws\S3\S3Client([ 'version' => '2006-03-01', 'region' => 'us-east-1' ]);
Puoi trovare un elenco delle versioni dell'API disponibili nella pagina della documentazione API di ciascun client. Se non riesci a caricare una versione dell'API specifica, potrebbe essere necessario aggiornare la copia dell'SDK.
Puoi specificare la stringa latest
nel valore di configurazione "versione" per utilizzare la versione dell'API più recente disponibile che il provider dell'API del client è in grado di trovare (l'api_provider predefinito analizzerà la directory src/data
dell'SDK per cercare i modelli di API).
// Use the latest version available $s3 = new Aws\S3\S3Client([ 'version' => 'latest', 'region' => 'us-east-1' ]);
Non è consigliabile utilizzare latest
in un'applicazione di produzione, perché l'importazione di una nuova versione secondaria dell'SDK che include un aggiornamento dell'API potrebbe interrompere il funzionamento di tale applicazione di produzione.