Configurazione del AWS SAM CLI

Uno dei vantaggi AWS SAM è che ottimizza il tempo dello sviluppatore eliminando le attività ripetitive. AWS SAM CLI include un file di configurazione denominato a questo samconfig scopo. Per impostazione predefinita, nessuna configurazione per AWS SAM CLI è necessaria, ma è possibile aggiornare il file di configurazione per consentire di eseguire comandi con un minor numero di parametri, consentendo invece di AWS SAM fare riferimento ai parametri personalizzati nel file di configurazione. Gli esempi nella tabella seguente mostrano come ottimizzare i comandi:

Originale	Ottimizzato con samconfig
sam build --cached --parallel --use-containers	sam build
sam local invoke --env-vars locals.json	sam local invoke
sam local start-api --env-vars locals.json --warm-containers EAGER	sam local start-api

Il AWS SAM CLI fornisce una serie di comandi per aiutare gli sviluppatori a creare, sviluppare e distribuire applicazioni serverless. Ciascuno di questi comandi è configurabile con flag opzionali in base alle preferenze dell'applicazione e dello sviluppatore. Per ulteriori informazioni, consultare la AWS SAM. CLI contenuto in GitHub

Negli argomenti di questa sezione viene illustrato come creare AWS SAM CLI file di configurazione e personalizzare le impostazioni predefinite per ottimizzare i tempi di sviluppo dell'applicazione serverless.

Come creare il file di configurazione (il samconfig file)

La AWS SAM CLI il file di configurazione (filenamesamconfig) è un file di testo che in genere utilizza la struttura TOML, ma può anche essere in YAML. Quando si utilizza un modello di avvio AWS rapido, questo file viene creato quando si esegue il comando. sam init È possibile aggiornare questo file quando si distribuisce un'applicazione utilizzando il sam deploy -\-guided comando.

Al termine della distribuzione, il samconfig file contiene un profilo denominato default se sono stati utilizzati i valori predefiniti. Quando si esegue nuovamente il deploy comando, AWS SAM applica le impostazioni di configurazione memorizzate da questo profilo.

Il vantaggio del samconfig file è che AWS SAM memorizza le impostazioni di configurazione per tutti gli altri comandi disponibili oltre al comando deploy. Oltre a questi valori creati durante una nuova distribuzione, nel samconfig file è possibile impostare una serie di attributi che possono semplificare altri aspetti del flusso di lavoro degli sviluppatori con AWS SAM CLI.

Configura le impostazioni del progetto

È possibile specificare impostazioni specifiche del progetto, ad esempio AWS SAM CLI valori dei parametri di comando, in un file di configurazione da utilizzare con AWS SAM CLI. Per ulteriori informazioni su questo file di configurazione, vedereAWS SAM CLI file di configurazione.

Utilizzo dei file di configurazione

I file di configurazione sono strutturati per ambiente, comando e valore dei parametri. Per ulteriori informazioni, consulta Nozioni di base sui file di configurazione.

Per configurare un nuovo ambiente

1. Specificate il nuovo ambiente nel file di configurazione.

   Di seguito è riportato un esempio di specificazione di un nuovo prod ambiente:

   TOML

   [prod.global.parameters]

   YAML

   prod:
     global:
       parameters:

2. Specificate i valori dei parametri come coppie chiave-valore nella sezione parametri del file di configurazione.

   Di seguito è riportato un esempio di specificazione del nome dello stack dell'applicazione per l'ambiente. prod

   TOML

   [prod.global.parameters]
   stack_name = "prod-app"

   YAML

   prod:
     global:
       parameters:
         stack_name: prod-app

3. Utilizzate l'--config-envopzione per specificare l'ambiente da utilizzare.

   Di seguito è riportato un esempio:

   $ sam deploy --config-env "prod"

Per configurare i valori dei parametri

1. Specificare il AWS SAM CLI comando per il quale desideri configurare i valori dei parametri. Per configurare i valori dei parametri per tutti AWS SAM CLI comandi, usa l'globalidentificatore.

   Di seguito è riportato un esempio di specificazione dei valori dei parametri per il comando default dell'ambiente: sam deploy

   TOML

   [default.deploy.parameters]
   confirm_changeset = true

   YAML

   default:
     deploy:
       parameters:
         confirm_changeset: true

   Di seguito è riportato un esempio di specificazione dei valori dei parametri per tutti AWS SAM CLI comandi nell'defaultambiente:

   TOML

   [default.global.parameters]
   stack_name = "sam-app"

   YAML

   default:
     global:
       parameters:
         stack_name: sam-app

2. È inoltre possibile specificare i valori dei parametri e modificare il file di configurazione tramite AWS SAM CLI flusso interattivo.

   Di seguito è riportato un esempio di flusso sam deploy --guided interattivo:

   $ sam deploy --guided
   
   Configuring SAM deploy
   ======================
   
       Looking for config file [samconfig.toml] :  Found
       Reading default arguments  :  Success
   
       Setting default arguments for 'sam deploy'
       =========================================
       Stack Name [sam-app]: ENTER
       AWS Region [us-west-2]: ENTER
       #Shows you resources changes to be deployed and require a 'Y' to initiate deploy
       Confirm changes before deploy [Y/n]: n
       #SAM needs permission to be able to create roles to connect to the resources in your template
       Allow SAM CLI IAM role creation [Y/n]: ENTER
       #Preserves the state of previously provisioned resources when an operation fails
       Disable rollback [y/N]: ENTER
       HelloWorldFunction may not have authorization defined, Is this okay? [y/N]: y
       Save arguments to configuration file [Y/n]: ENTER
       SAM configuration file [samconfig.toml]: ENTER
       SAM configuration environment [default]: ENTER

Per ulteriori informazioni, consulta Creazione e modifica dei file di configurazione.

Esempi

Base TOML example

Di seguito è riportato un esempio di file di samconfig.toml configurazione:

...
version = 0.1

[default]
[default.global]
[default.global.parameters]
stack_name = "sam-app"

[default.build.parameters]
cached = true
parallel = true

[default.deploy.parameters]
capabilities = "CAPABILITY_IAM"
confirm_changeset = true
resolve_s3 = true

[default.sync.parameters]
watch = true

[default.local_start_api.parameters]
warm_containers = "EAGER"

[prod]
[prod.sync]
[prod.sync.parameters]
watch = false

Base YAML example

Di seguito è riportato un esempio di samconfig.yaml file di configurazione:

version 0.1
default:
  global:
    parameters:
      stack_name: sam-app
  build:
    parameters:
      cached: true
      parallel: true
  deploy:
    parameters:
      capabilities: CAPABILITY_IAM
      confirm_changeset: true
      resolve_s3: true
  sync:
    parameters:
      watch: true
  local_start_api:
    parameters:
      warm_containers: EAGER
prod:
  sync:
    parameters:
      watch: false

Configurare le credenziali e le impostazioni di base

Usa AWS Command Line Interface (AWS CLI) per configurare le impostazioni di base come AWS credenziali, nome dell'area predefinita e formato di output predefinito. Una volta configurate, è possibile utilizzare queste impostazioni con AWS SAM CLI. Per ulteriori informazioni, consulta quanto segue nella Guida AWS Command Line Interface per l'utente:

• Nozioni di base sulla configurazione

• Impostazioni dei file di configurazione e credenziali

• Profili denominati per AWS CLI

• Utilizzo di un profilo denominato abilitato per IAM Identity Center

Per istruzioni di configurazione rapide, consultaPassaggio 5: Utilizzare AWS CLI per configurare le AWS credenziali.