View a markdown version of this page

Introduzione all'uso stessa sincronizzazione da sincronizzare con Cloud AWS - 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à.

Introduzione all'uso stessa sincronizzazione da sincronizzare con Cloud AWS

Il AWS Serverless Application Model Interfaccia a riga di comando (AWS SAM CLI) sam sync il comando fornisce opzioni per sincronizzare rapidamente le modifiche dell'applicazione locale con Cloud AWS. Uso sam sync quando sviluppate le vostre applicazioni per:

  1. Rileva e sincronizza automaticamente le modifiche locali con Cloud AWS.

  2. Personalizza le modifiche locali sincronizzate con Cloud AWS.

  3. Prepara la tua applicazione nel cloud per il test e la convalida.

Con sam sync, puoi creare un flusso di lavoro di sviluppo rapido che riduca il tempo necessario per sincronizzare le modifiche locali con il cloud per il test e la convalida.

Importante

Ogni sincronizzazione esegue gli strumenti e gli script di compilazione del progetto localmente e distribuisce le sue risorse con il tuo AWS credenziali. Usa sam sync solo su progetti che hai scritto o recensito.

Nota

Il sam sync il comando è consigliato per gli ambienti di sviluppo. Per gli ambienti di produzione, si consiglia di utilizzare sam deploy o configurando un integrazione e distribuzione continue (CI/CD) oleodotto. Per ulteriori informazioni, consulta Implementa la tua applicazione e le tue risorse con AWS SAM.

La sam sync il comando fa parte di AWS SAM Accelerate. AWS SAM Accelerate fornisce strumenti che è possibile utilizzare per velocizzare l'esperienza di sviluppo e test di applicazioni serverless in Cloud AWS.

Rileva e sincronizza automaticamente le modifiche locali con Cloud AWS

Esegui sam sync con --watch opzione per iniziare a sincronizzare l'applicazione con Cloud AWS. Questo esegue le seguenti operazioni:

  1. Crea la tua applicazione — Questo processo è simile all'utilizzo di sam build comando.

  2. Distribuisci la tua applicazione — Il AWS SAM CLI distribuisce la tua applicazione su AWS CloudFormation utilizzando le impostazioni predefinite. Vengono utilizzati i seguenti valori predefiniti:

    1. AWS credenziali e impostazioni generali di configurazione disponibili nel tuo .aws cartella utente.

    2. Le impostazioni di distribuzione dell'applicazione si trovano nella tua applicazione samconfig.toml file.

    Se non è possibile trovare i valori predefiniti, AWS SAM CLI ti informerà e uscirà dal processo di sincronizzazione.

  3. Tieni d'occhio le modifiche locali — Il AWS SAM CLI rimane in esecuzione e controlla le modifiche locali all'applicazione. Questo è ciò che --watch l'opzione prevede.

    Il codice di un AWS::Serverless::WebFunction non viene controllato, perché ogni modifica al codice crea una nuova revisione. Le modifiche al codice vengono implementate con la successiva sincronizzazione dell'infrastruttura.

    Questa opzione può essere attivata per impostazione predefinita. Per i valori predefiniti, consulta quelli della tua applicazione samconfig.toml file. Di seguito è riportato un esempio del file .

    ... [default.sync] [default.sync.parameters] watch = true ...
  4. Sincronizza le modifiche locali con Cloud AWS — Quando si apportano modifiche locali, AWS SAM CLI rileva e sincronizza tali modifiche con Cloud AWS tramite il metodo più rapido disponibile. A seconda del tipo di modifica, può verificarsi quanto segue:

    1. Se la risorsa aggiornata supporta AWS API di servizio, AWS SAM CLI lo utilizzerà per implementare le modifiche. Ciò si traduce in una sincronizzazione rapida per aggiornare la risorsa in Cloud AWS.

    2. Se la tua risorsa aggiornata non supporta AWS API di servizio, AWS SAM CLI eseguirà un CloudFormation distribuzione. Questo aggiorna l'intera applicazione in Cloud AWS. Sebbene non sia così rapido, evita di dover avviare manualmente una distribuzione.

Dal momento che sam sync il comando aggiorna automaticamente l'applicazione in Cloud AWS, è consigliato solo per gli ambienti di sviluppo. Quando corri sam sync, ti verrà chiesto di confermare:

**The sync command should only be used against a development stack**.

Confirm that you are synchronizing a development stack.

Enter Y to proceed with the command, or enter N to cancel:
 [Y/n]: ENTER

Personalizza le modifiche locali sincronizzate con Cloud AWS

Fornisci opzioni per personalizzare le modifiche locali sincronizzate con Cloud AWS. Questo può velocizzare il tempo necessario per visualizzare le modifiche locali nel cloud per il test e la convalida.

Ad esempio, fornisci il --code opzione per sincronizzare solo le modifiche al codice, ad esempio AWS Lambda Codice della funzione evento. Durante lo sviluppo, se ti concentri specificamente sul codice Lambda, le modifiche verranno trasferite rapidamente nel cloud per il test e la convalida. Di seguito è riportato un esempio:

$ sam sync --code --watch

Per sincronizzare solo le modifiche al codice per una funzione o un livello Lambda specifico, usa --resource-id opzione. Di seguito è riportato un esempio:

$ sam sync --code --resource-id HelloWorldFunction --resource-id HelloWorldLayer

Prepara la tua applicazione nel cloud per il test e la convalida

Il sam sync il comando trova automaticamente il metodo più rapido disponibile per aggiornare l'applicazione nel Cloud AWS. Questo può velocizzare i flussi di lavoro di sviluppo e test sul cloud. Utilizzando AWS le API di servizio, puoi sviluppare, sincronizzare e testare rapidamente le risorse supportate. Per un esempio pratico, vedi Modulo 6 - AWS SAM Accelera nel Il completo AWS SAM Workshop.

Opzioni per il comando sam sync

Di seguito sono riportate alcune delle opzioni principali che è possibile utilizzare per modificare sam sync comando. Per un elenco di tutte le opzioni, vedere sincronizzazione sam.

Esegui una sola volta CloudFormation implementazione

Usa il --no-watch opzione per disattivare la sincronizzazione automatica. Di seguito è riportato un esempio:

$ sam sync --no-watch

La AWS SAM CLI si esibirà una sola volta CloudFormation distribuzione. Questo comando raggruppa le azioni eseguite da sam build e sam deploy comandi.

Salta l'iniziale CloudFormation implementazione

È possibile personalizzare se CloudFormation la distribuzione è richiesta ogni volta sam sync viene eseguito.

  • Fornire --no-skip-deploy-sync richiedere un CloudFormation distribuzione ogni volta sam sync viene eseguito. Ciò garantisce che l'infrastruttura locale sia sincronizzata con CloudFormation, prevenendo la deriva. L'utilizzo di questa opzione aggiunge ulteriore tempo al flusso di lavoro di sviluppo e test.

  • Fornisci --skip-deploy-sync da fare CloudFormation distribuzione opzionale. La AWS SAM CLI confronterà il tuo locale AWS SAM modello con quello distribuito CloudFormation modello e salterà l'iniziale CloudFormation distribuzione se non viene rilevata una modifica. Saltando CloudFormation l'implementazione può farti risparmiare tempo durante la sincronizzazione delle modifiche locali con Cloud AWS.

    Se non viene rilevata alcuna modifica, AWS SAM CLI eseguirà comunque un CloudFormation distribuzione nei seguenti scenari:

    • Se sono trascorsi 7 giorni o più dall'ultima CloudFormation distribuzione.

    • Se viene rilevato un numero elevato di modifiche al codice funzione Lambda, CloudFormation l'implementazione è il metodo più rapido per aggiornare l'applicazione.

Di seguito è riportato un esempio:

$ sam sync --skip-deploy-sync

Sincronizza una risorsa da uno stack annidato

Per sincronizzare una risorsa da uno stack annidato
  1. Fornisci lo stack principale usando --stack-name.

  2. Identifica la risorsa nello stack annidato utilizzando il seguente formato: nestedStackId/resourceId.

  3. Fornisci la risorsa nello stack annidato usando --resource-id.

    Di seguito è riportato un esempio:

    $ sam sync --code --stack-name sam-app --resource-id myNestedStack/HelloWorldFunction

Per ulteriori informazioni sulla creazione di applicazioni annidate, vedere Riutilizza codice e risorse utilizzando applicazioni annidate in AWS SAM.

Specifica uno specifico CloudFormation stack da aggiornare

Per specificare uno specifico CloudFormation stack da aggiornare, fornisci --stack-name opzione. Di seguito è riportato un esempio:

$ sam sync --stack-name dev-sam-app

Accelera i tempi di compilazione compilando il progetto nella cartella sorgente

Per i runtime e i metodi di compilazione supportati, puoi usare --build-in-source opzione per creare il progetto direttamente nella cartella sorgente. Per impostazione predefinita, AWS SAM CLI viene creato in una directory temporanea, che comporta la copia del codice sorgente e dei file di progetto. Con --build-in-source, il AWS SAM CLI viene compilato direttamente nella cartella sorgente, il che velocizza il processo di compilazione eliminando la necessità di copiare i file in una directory temporanea.

Per un elenco dei runtime e dei metodi di compilazione supportati, consulta --build-in-source.

Specifica i file e le cartelle che non avvieranno una sincronizzazione

Usa il --watch-exclude opzione per specificare qualsiasi file o cartella che non avvierà una sincronizzazione una volta aggiornato. Per ulteriori informazioni su questa opzione, consulta --watch-exclude.

Di seguito è riportato un esempio che esclude package-lock.json file associato al nostro HelloWorldFunction funzione:

$ sam sync --watch --watch-exclude HelloWorldFunction=package-lock.json

Quando viene eseguito questo comando, AWS SAM CLI avvierà il processo di sincronizzazione. Questo include gli output seguenti:

  • Esegui sam build per creare le tue funzioni e preparare l'applicazione per la distribuzione.

  • Esegui sam deploy per distribuire l'applicazione.

  • Controlla le modifiche alla tua applicazione.

Quando modifichiamo il package-lock.json file, il AWS SAM CLI non avvierà una sincronizzazione. Quando viene aggiornato un altro file, AWS SAM CLI avvierà una sincronizzazione, che includerà package-lock.json file.

Di seguito è riportato un esempio di specificazione di una funzione Lambda di uno stack secondario:

$ sam sync --watch --watch-exclude ChildStackA/MyFunction=database.sqlite3

Risoluzione dei problemi

Per risolvere i problemi di AWS SAM CLI, vedi AWS SAM CLI risoluzione dei problemi.

Esempi

Utilizzo di sam sync per aggiornare l'applicazione Hello World

In questo esempio, iniziamo inizializzando l'applicazione Hello World di esempio. Per saperne di più su questa applicazione, vedi Tutorial: Implementa un'applicazione Hello World con AWS SAM.

Correre sam sync inizia il processo di creazione e distribuzione.

$ sam sync The SAM CLI will use the AWS Lambda, Amazon API Gateway, and AWS StepFunctions APIs to upload your code without performing a CloudFormation deployment. This will cause drift in your CloudFormation stack. **The sync command should only be used against a development stack**. Confirm that you are synchronizing a development stack. Enter Y to proceed with the command, or enter N to cancel: [Y/n]: Queued infra sync. Waiting for in progress code syncs to complete... Starting infra sync. Manifest file is changed (new hash: 3298f13049d19cffaa37ca931dd4d421) or dependency folder (.aws-sam/deps/0663e6fe-a888-4efb-b908-e2344261e9c7) is missing for (HelloWorldFunction), downloading dependencies and copying/building source Building codeuri: /Users/.../Demo/sync/sam-app/hello_world runtime: python3.9 metadata: {} architecture: x86_64 functions: HelloWorldFunction Running PythonPipBuilder:CleanUp Running PythonPipBuilder:ResolveDependencies Running PythonPipBuilder:CopySource Build Succeeded Successfully packaged artifacts and wrote output template to file /var/folders/45/5ct135bx3fn2551_ptl5g6_80000gr/T/tmpx_5t4u3f. Execute the following command to deploy the packaged template sam deploy --template-file /var/folders/45/5ct135bx3fn2551_ptl5g6_80000gr/T/tmpx_5t4u3f --stack-name <YOUR STACK NAME> Deploying with following values =============================== Stack name : sam-app Region : us-west-2 Disable rollback : False Deployment s3 bucket : aws-sam-cli-managed-default-samclisam-s3-demo-bucket-1a4x26zbcdkqr Capabilities : ["CAPABILITY_NAMED_IAM", "CAPABILITY_AUTO_EXPAND"] Parameter overrides : {} Signing Profiles : null Initiating deployment ===================== 2023-03-17 11:17:19 - Waiting for stack create/update to complete CloudFormation events from stack operations (refresh every 0.5 seconds) --------------------------------------------------------------------------------------------------------------------------------------------- ResourceStatus ResourceType LogicalResourceId ResourceStatusReason --------------------------------------------------------------------------------------------------------------------------------------------- CREATE_IN_PROGRESS AWS::CloudFormation::Stack sam-app Transformation succeeded CREATE_IN_PROGRESS AWS::CloudFormation::Stack AwsSamAutoDependencyLayerNestedSt - ack CREATE_IN_PROGRESS AWS::IAM::Role HelloWorldFunctionRole - CREATE_IN_PROGRESS AWS::IAM::Role HelloWorldFunctionRole Resource creation Initiated CREATE_IN_PROGRESS AWS::CloudFormation::Stack AwsSamAutoDependencyLayerNestedSt Resource creation Initiated ack CREATE_COMPLETE AWS::IAM::Role HelloWorldFunctionRole - CREATE_COMPLETE AWS::CloudFormation::Stack AwsSamAutoDependencyLayerNestedSt - ack CREATE_IN_PROGRESS AWS::Lambda::Function HelloWorldFunction - CREATE_IN_PROGRESS AWS::Lambda::Function HelloWorldFunction Resource creation Initiated CREATE_COMPLETE AWS::Lambda::Function HelloWorldFunction - CREATE_IN_PROGRESS AWS::ApiGateway::RestApi ServerlessRestApi - CREATE_IN_PROGRESS AWS::ApiGateway::RestApi ServerlessRestApi Resource creation Initiated CREATE_COMPLETE AWS::ApiGateway::RestApi ServerlessRestApi - CREATE_IN_PROGRESS AWS::ApiGateway::Deployment ServerlessRestApiDeployment47fc2d - 5f9d CREATE_IN_PROGRESS AWS::Lambda::Permission HelloWorldFunctionHelloWorldPermi - ssionProd CREATE_IN_PROGRESS AWS::Lambda::Permission HelloWorldFunctionHelloWorldPermi Resource creation Initiated ssionProd CREATE_IN_PROGRESS AWS::ApiGateway::Deployment ServerlessRestApiDeployment47fc2d Resource creation Initiated 5f9d CREATE_COMPLETE AWS::ApiGateway::Deployment ServerlessRestApiDeployment47fc2d - 5f9d CREATE_IN_PROGRESS AWS::ApiGateway::Stage ServerlessRestApiProdStage - CREATE_IN_PROGRESS AWS::ApiGateway::Stage ServerlessRestApiProdStage Resource creation Initiated CREATE_COMPLETE AWS::ApiGateway::Stage ServerlessRestApiProdStage - CREATE_COMPLETE AWS::Lambda::Permission HelloWorldFunctionHelloWorldPermi - ssionProd CREATE_COMPLETE AWS::CloudFormation::Stack sam-app - --------------------------------------------------------------------------------------------------------------------------------------------- CloudFormation outputs from deployed stack ---------------------------------------------------------------------------------------------------------------------------------------------- Outputs ---------------------------------------------------------------------------------------------------------------------------------------------- Key HelloWorldFunctionIamRole Description Implicit IAM Role created for Hello World function Value arn:aws:iam::012345678910:role/sam-app-HelloWorldFunctionRole-BUFVMO2PJIYF Key HelloWorldApi Description API Gateway endpoint URL for Prod stage for Hello World function Value https://pcrx5gdaof.execute-api.us-west-2.amazonaws.com/Prod/hello/ Key HelloWorldFunction Description Hello World Lambda Function ARN Value arn:aws:lambda:us-west-2:012345678910:function:sam-app-HelloWorldFunction-2PlN6TPTQoco ---------------------------------------------------------------------------------------------------------------------------------------------- Stack creation succeeded. Sync infra completed. Infra sync completed. CodeTrigger not created as CodeUri or DefinitionUri is missing for ServerlessRestApi.

Una volta completata la distribuzione, modifichiamo il HelloWorldFunction codice. Il AWS SAM CLI rileva questa modifica e sincronizza la nostra applicazione con Cloud AWS. Dal AWS Lambda supporti AWS API di servizio, viene eseguita una sincronizzazione rapida.

Syncing Lambda Function HelloWorldFunction...
Manifest is not changed for (HelloWorldFunction), running incremental build
Building codeuri: /Users/.../Demo/sync/sam-app/hello_world runtime: python3.9 metadata: {} architecture: x86_64 functions: HelloWorldFunction
Running PythonPipBuilder:CopySource
Finished syncing Lambda Function HelloWorldFunction.

Successivamente, modifichiamo il nostro endpoint API nell'applicazione AWS SAM modello. Cambiamo /hello a /helloworld.

AWSTemplateFormatVersion: '2010-09-09' Transform: AWS::Serverless-2016-10-31 ... Resources: HelloWorldFunction: ... Properties: ... Events: HelloWorld: Type: Api Properties: Path: /helloworld Method: get

Poiché la risorsa Amazon API Gateway non supporta AWS API di servizio, il AWS SAM CLI esegue automaticamente un CloudFormation distribuzione. Di seguito è riportato un esempio di output:

Queued infra sync. Waiting for in progress code syncs to complete... Starting infra sync. Manifest is not changed for (HelloWorldFunction), running incremental build Building codeuri: /Users/.../Demo/sync/sam-app/hello_world runtime: python3.9 metadata: {} architecture: x86_64 functions: HelloWorldFunction Running PythonPipBuilder:CopySource Build Succeeded Successfully packaged artifacts and wrote output template to file /var/folders/45/5ct135bx3fn2551_ptl5g6_80000gr/T/tmpuabo0jb9. Execute the following command to deploy the packaged template sam deploy --template-file /var/folders/45/5ct135bx3fn2551_ptl5g6_80000gr/T/tmpuabo0jb9 --stack-name <YOUR STACK NAME> Deploying with following values =============================== Stack name : sam-app Region : us-west-2 Disable rollback : False Deployment s3 bucket : aws-sam-cli-managed-default-samclisam-s3-demo-bucket-1a4x26zbcdkqr Capabilities : ["CAPABILITY_NAMED_IAM", "CAPABILITY_AUTO_EXPAND"] Parameter overrides : {} Signing Profiles : null Initiating deployment ===================== 2023-03-17 14:41:18 - Waiting for stack create/update to complete CloudFormation events from stack operations (refresh every 0.5 seconds) --------------------------------------------------------------------------------------------------------------------------------------------- ResourceStatus ResourceType LogicalResourceId ResourceStatusReason --------------------------------------------------------------------------------------------------------------------------------------------- UPDATE_IN_PROGRESS AWS::CloudFormation::Stack sam-app Transformation succeeded UPDATE_IN_PROGRESS AWS::CloudFormation::Stack AwsSamAutoDependencyLayerNestedSt - ack UPDATE_COMPLETE AWS::CloudFormation::Stack AwsSamAutoDependencyLayerNestedSt - ack UPDATE_IN_PROGRESS AWS::ApiGateway::RestApi ServerlessRestApi - UPDATE_COMPLETE AWS::ApiGateway::RestApi ServerlessRestApi - CREATE_IN_PROGRESS AWS::ApiGateway::Deployment ServerlessRestApiDeployment8cf30e - d3cd UPDATE_IN_PROGRESS AWS::Lambda::Permission HelloWorldFunctionHelloWorldPermi Requested update requires the ssionProd creation of a new physical resource; hence creating one. UPDATE_IN_PROGRESS AWS::Lambda::Permission HelloWorldFunctionHelloWorldPermi Resource creation Initiated ssionProd CREATE_IN_PROGRESS AWS::ApiGateway::Deployment ServerlessRestApiDeployment8cf30e Resource creation Initiated d3cd CREATE_COMPLETE AWS::ApiGateway::Deployment ServerlessRestApiDeployment8cf30e - d3cd UPDATE_IN_PROGRESS AWS::ApiGateway::Stage ServerlessRestApiProdStage - UPDATE_COMPLETE AWS::ApiGateway::Stage ServerlessRestApiProdStage - UPDATE_COMPLETE AWS::Lambda::Permission HelloWorldFunctionHelloWorldPermi - ssionProd UPDATE_COMPLETE_CLEANUP_IN_PROGRE AWS::CloudFormation::Stack sam-app - SS DELETE_IN_PROGRESS AWS::Lambda::Permission HelloWorldFunctionHelloWorldPermi - ssionProd DELETE_IN_PROGRESS AWS::ApiGateway::Deployment ServerlessRestApiDeployment47fc2d - 5f9d DELETE_COMPLETE AWS::ApiGateway::Deployment ServerlessRestApiDeployment47fc2d - 5f9d UPDATE_COMPLETE AWS::CloudFormation::Stack AwsSamAutoDependencyLayerNestedSt - ack DELETE_COMPLETE AWS::Lambda::Permission HelloWorldFunctionHelloWorldPermi - ssionProd UPDATE_COMPLETE AWS::CloudFormation::Stack sam-app - --------------------------------------------------------------------------------------------------------------------------------------------- CloudFormation outputs from deployed stack ---------------------------------------------------------------------------------------------------------------------------------------------- Outputs ---------------------------------------------------------------------------------------------------------------------------------------------- Key HelloWorldFunctionIamRole Description Implicit IAM Role created for Hello World function Value arn:aws:iam::012345678910:role/sam-app-HelloWorldFunctionRole-BUFVMO2PJIYF Key HelloWorldApi Description API Gateway endpoint URL for Prod stage for Hello World function Value https://pcrx5gdaof.execute-api.us-west-2.amazonaws.com/Prod/hello/ Key HelloWorldFunction Description Hello World Lambda Function ARN Value arn:aws:lambda:us-west-2:012345678910:function:sam-app-HelloWorldFunction-2PlN6TPTQoco ---------------------------------------------------------------------------------------------------------------------------------------------- Stack update succeeded. Sync infra completed. Infra sync completed.

Ulteriori informazioni

Per una descrizione di tutto sam sync opzioni, vedi sincronizzazione sam.