View a markdown version of this page

sam deploy - AWS Serverless Application Model

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

sam deploy

Questa pagina fornisce informazioni di riferimento per AWS Serverless Application Model Interfaccia a riga di comando (AWS SAM CLI) sam deploy comando.

Il sam deploy il comando distribuisce un'applicazione in Cloud AWS utilizzando AWS CloudFormation.

Importante

Non correre sam deploy su codice non attendibile. Il comando usa il tuo AWS credenziali per creare le risorse definite dal modello, inclusi i ruoli e le policy IAM, e caricare i file locali a cui fa riferimento il modello. Applica inoltre le opzioni nel file di configurazione del progetto così come scritto. Rivedi il modello e il file di configurazione prima di distribuire un progetto di cui non sei l'autore.

Utilizzo

$ <environment variables> sam deploy <options>

Variabili di ambiente

SAM_CLI_POLL_DELAY

Imposta il SAM_CLI_POLL_DELAY variabile di ambiente con un valore di secondi nella shell per configurare la frequenza AWS SAM CLI controlla CloudFormation lo stato dello stack, utile quando si verifica una limitazione da CloudFormation. Questa variabile env viene utilizzata per il polling describe_stack Chiamate API, che vengono effettuate durante l'esecuzione sam deploy.

Di seguito è riportato un esempio di questa variabile:

$ SAM_CLI_POLL_DELAY=5 sam deploy

Opzioni

--capabilities LIST

Un elenco di funzionalità che è necessario specificare per consentire CloudFormation per creare determinati stack. Alcuni modelli di stack potrebbero includere risorse che influiscono sulle autorizzazioni del tuo Account AWS, ad esempio, creandone di nuovi AWS Identity and Access Management utenti (IAM). Per questi stack, è necessario riconoscerne esplicitamente le funzionalità specificando questa opzione. Gli unici valori validi sono CAPABILITY_IAM e CAPABILITY_NAMED_IAM. Se disponi di risorse IAM, puoi specificare entrambe le funzionalità. Se disponi di risorse IAM con nomi personalizzati, devi specificare CAPABILITY_NAMED_IAM. Se non si specifica questa opzione, l'operazione restituisce un InsufficientCapabilities errore.

Quando si distribuisce un'applicazione che contiene applicazioni annidate, è necessario utilizzare CAPABILITY_AUTO_EXPAND per confermare che l'applicazione contiene applicazioni annidate. Per ulteriori informazioni, consulta Distribuzione di applicazioni annidate.

--config-env TEXT

Il nome dell'ambiente che specifica i valori dei parametri predefiniti nel file di configurazione da utilizzare. Il valore predefinito è default. Per ulteriori informazioni sui file di configurazione, consulta AWS SAMCLIfile di configurazione.

--config-file PATH

Il percorso e il nome del file di configurazione contenente i valori dei parametri predefiniti da utilizzare. Il valore predefinito è samconfig.toml nella cartella principale della cartella del progetto. Per ulteriori informazioni sui file di configurazione, consulta AWS SAMCLIfile di configurazione.

--confirm-changeset | --no-confirm-changeset

Richiesta di conferma se AWS SAM CLI distribuisce il changeset calcolato.

--debug

Attiva la registrazione di debug per stampare il messaggio di debug che il AWS SAM CLI genera e visualizza i timestamp.

--disable-rollback | --no-disable-rollback

Specifica se ripristinare il tuo CloudFormation stack se si verifica un errore durante una distribuzione. Per impostazione predefinita, se si verifica un errore durante una distribuzione, CloudFormation lo stack torna all'ultimo stato stabile. Se si specifica --disable-rollback e si verifica un errore durante una distribuzione, le risorse create o aggiornate prima che si verificasse l'errore non vengono ripristinate.

--express | --no-express

Specifica se utilizzare CloudFormation Modalità Express. Quando è attiva, le operazioni sullo stack vengono completate una volta applicata la configurazione delle risorse. Le risorse continuano a essere pronte in background. I tempi di implementazione possono essere ridotti fino a 4 volte.

Il AWS SAM CLI passa il comportamento di rollback al CloudFormation DeploymentConfig parametro quando si specifica anche --disable-rollback.

Il valore predefinito è --no-express.

--fail-on-empty-changeset | --no-fail-on-empty-changeset

Specifica se restituire un codice di uscita diverso da zero se non ci sono modifiche da apportare allo stack. Il comportamento predefinito prevede la restituzione di un codice di uscita diverso da zero.

--force-upload

Specifica questa opzione per caricare gli artefatti anche se corrispondono agli artefatti esistenti nel bucket Amazon S3. Gli artefatti corrispondenti vengono sovrascritti.

--guided, -g

Specificate questa opzione per avere AWS SAM CLI utilizza i prompt per guidarti nella distribuzione.

--help

Mostra questo messaggio ed esci.

--image-repositories TEXT

Una mappatura delle funzioni all'URI del loro repository Amazon ECR. Fai riferimento alle funzioni in base al loro ID logico. Di seguito è riportato un esempio:

$ sam deploy --image-repositories Function1=123456789012.dkr.ecr.us-east-1.amazonaws.com/my-repo

È possibile specificare questa opzione più volte in un unico comando.

--image-repository TEXT

Il nome del repository Amazon ECR in cui questo comando carica l'immagine della funzione. Questa opzione è obbligatoria per le funzioni dichiarate con Image tipo di pacchetto.

--kms-key-id TEXT

L'ID di un AWS Key Management Service (AWS KMS) chiave utilizzata per crittografare gli artefatti inattivi nel bucket Amazon S3. Se non specifichi questa opzione, AWS SAM utilizza Amazon S3-managed chiavi di crittografia.

Per un AWS::Serverless::WebFunction caricato nel bucket specificato con --s3-bucket, la chiave deve essere una chiave gestita dal cliente la cui politica chiave lo consenta lambda.amazonaws.com chiamare kms:Decrypt.

--metadata

Una mappa di metadati da allegare a tutti gli artefatti a cui si fa riferimento nel modello.

--no-execute-changeset

Indica se applicare il changeset. Specificate questa opzione se desiderate visualizzare le modifiche allo stack prima di applicare il changeset. Questo comando crea un CloudFormation changeset e quindi esce senza applicare il changeset. Per applicare il changeset, esegui lo stesso comando senza questa opzione.

--no-progressbar

Non visualizzare una barra di avanzamento durante il caricamento di artefatti su Amazon S3.

--notification-arns LIST

Un elenco di argomenti di Amazon Simple Notification Service (Amazon SNS) che CloudFormation si associa allo stack.

--on-failure [ROLLBACK | DELETE | DO_NOTHING]

Specifica l'azione da intraprendere quando uno stack non riesce a creare.

Sono disponibili le seguenti opzioni:

  • ROLLBACK — Riporta lo stack a un precedente stato buono noto.

  • DELETE — Riporta lo stack a un precedente stato buono noto, se ne esiste uno. In caso contrario, elimina lo stack.

  • DO_NOTHING — Non ripristina né elimina lo stack. L'effetto è lo stesso di --disable-rollback.

Il comportamento predefinito è ROLLBACK.

Nota

È possibile specificare --disable-rollback opzione o --on-failure opzione, ma non entrambe.

--output [ text | json ]

Il formato dell'output del comando:

  • text — Stampa un output regolare e leggibile dall'uomo. Si tratta del valore di default.

  • json — Stampa un output strutturato e leggibile dalla macchina. Utilizza questo formato quando desideri utilizzare l'output a livello di programmazione, ad esempio in CI/CD pipeline, estensioni IDE e AI-assisted strumenti.

Una distribuzione viene eseguita per un periodo di tempo. Quando si specifica --output json, il AWS SAM CLI stampa un flusso di oggetti JSON, uno per riga, man mano che la distribuzione procede. Ogni oggetto include un type campo che identifica il tipo di informazioni che contiene, ad esempio il changeset, gli eventi di distribuzione, gli output dello stack e il risultato finale. In caso di errore, l'oggetto finale include un error oggetto che descrive cosa è andato storto.

Nota

La --output json l'opzione non è compatibile con le opzioni che richiedono prompt interattivi, come --guided e --confirm-changeset.

--parameter-overrides LIST

Una stringa che contiene CloudFormation i parametri sostituiscono le coppie codificate come coppie chiave-valore. Ogni override utilizza il formato ParameterKey=name,ParameterValue=value. Le sostituzioni multiple sono separate da spazi. Di seguito, sono riportati due esempi:

$ sam deploy --parameter-overrides ParameterKey=value1,ParameterValue=value2
$ sam deploy --parameter-overrides ParameterKey=value1,ParameterValue=value2 ParameterKey=hello,ParameterValue=world ParameterKey=apple,ParameterValue=banana
--profile TEXT

Il profilo specifico del tuo file di credenziali che ottiene AWS credenziali.

--region TEXT

Le Regione AWS da distribuire a. Ad esempio, us-east-1.

--resolve-image-repos

Crea automaticamente repository Amazon ECR da utilizzare per la creazione di pacchetti e la distribuzione per distribuzioni non guidate. Questa opzione si applica solo alle funzioni e ai livelli con PackageType: Image specificato. Se si specifica --guided opzione, quindi AWS SAM CLI ignora --resolve-image-repos.

Nota

Se AWS SAM crea automaticamente qualsiasi repository Amazon ECR per funzioni o livelli con questa opzione e successivamente elimini tali funzioni o livelli dal tuo AWS SAM modello, quindi i repository Amazon ECR corrispondenti vengono eliminati automaticamente.

--resolve-s3

Crea automaticamente un bucket Amazon S3 da utilizzare per il packaging e la distribuzione per distribuzioni non guidate. Se specifichi --guided opzione, quindi AWS SAM La CLI ignora --resolve-s3. Se si specificano entrambi --s3-bucket e --resolve-s3 opzioni, quindi si verifica un errore.

Con questa opzione o --guided, il codice di un AWS::Serverless::WebFunction viene caricato in un bucket di codice che appartiene allo stack, non al bucket gestito. Per ulteriori informazioni, consulta Creazione e distribuzione di Lambda Web Functions.

--role-arn TEXT

L'Amazon Resource Name (ARN) di un ruolo IAM che CloudFormation presuppone quando si applica il changeset.

--s3-bucket TEXT

Il nome del bucket Amazon S3 in cui questo comando carica il tuo CloudFormation modello. Se il modello è più grande di 51.200 byte, allora --s3-bucket opzione o --resolve-s3 l'opzione è obbligatoria. Se si specificano entrambi --s3-bucket e --resolve-s3 opzioni, quindi si verifica un errore.

Il codice di un AWS::Serverless::WebFunction viene inoltre caricato in questo bucket, che deve avere il controllo delle versioni abilitato e consentire a Lambda di leggere il codice. Per ulteriori informazioni, consulta Creazione e distribuzione di Lambda Web Functions.

--s3-prefix TEXT

Il prefisso aggiunto ai nomi degli artefatti caricati nel bucket Amazon S3. Il nome del prefisso è il nome del percorso (nome della cartella) per il bucket Amazon S3.

--save-params

Salva i parametri forniti nella riga di comando nel file AWS SAM file di configurazione.

--signing-profiles LIST

L'elenco dei profili di firma con cui firmare i pacchetti di distribuzione. Questa opzione richiede un elenco di coppie chiave-valore, in cui la chiave è il nome della funzione o del livello da firmare e il valore è il profilo di firma, con un proprietario del profilo opzionale delimitato da :. Ad esempio, FunctionNameToSign=SigningProfileName1 LayerNameToSign=SigningProfileName2:SigningProfileOwner.

--stack-name TEXT

(Obbligatorio) Il nome del CloudFormation stack in cui stai distribuendo. Se si specifica uno stack esistente, il comando aggiorna lo stack. Se si specifica un nuovo stack, il comando lo crea.

--tags LIST

Un elenco di tag da associare allo stack creato o aggiornato. CloudFormation inoltre propaga questi tag alle risorse dello stack che li supportano.

--template-file, --template, -t PATH

Il percorso e il nome del file in cui si trova AWS SAM si trova il modello.

Nota

Se si specifica questa opzione, allora AWS SAM distribuisce solo il modello e le risorse locali a cui fa riferimento.

--use-json

Uscita JSON per CloudFormation modello. L'output predefinito è YAML.

Esempio

Per un esempio dettagliato e una guida dettagliata sull'uso di sam deploy sottocomando, fare riferimento a Introduzione all'implementazione con AWS SAM.