View a markdown version of this page

sam sync - AWS Serverless Application Model

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

sam sync

Esta página proporciona información de referencia para la AWS Serverless Application Model Interfaz de línea de comandos (AWS SAM CLI) sam sync comando.

El comando sam sync sincroniza los cambios de la aplicación local con Nube de AWS.

importante

No corras sam sync en código que no es de confianza. El comando crea el proyecto en tu entorno local, que ejecuta las herramientas de compilación y los scripts que define el proyecto. A continuación, implementa los recursos de la plantilla en su AWS cuenta con tus credenciales.

De uso

$ sam sync <options>

Opciones

--base-dir, -s DIRECTORY

Resuelve las rutas relativas al código fuente de la función o capa con respecto a este directorio. Utiliza esta opción para cambiar la forma en que se resuelven las rutas relativas a las carpetas de código fuente. De forma predeterminada, las rutas relativas se resuelven con respecto a AWS SAM ubicación de la plantilla.

Además de los recursos de la aplicación o pila raíz que esté creando, esta opción también se aplica a las aplicaciones o pilas anidadas. Además, esta opción se aplica a los siguientes tipos y propiedades de recursos:

  • Tipo de recurso: AWS::Serverless::Function Propiedad: CodeUri

  • Tipo de recurso: AWS::Serverless::Function Atributo de recurso: Metadata Entrada: DockerContext

  • Tipo de recurso: AWS::Serverless::LayerVersion Propiedad: ContentUri

  • Tipo de recurso: AWS::Lambda::Function Propiedad: Code

  • Tipo de recurso: AWS::Lambda::LayerVersion Propiedad: Content

--build-image TEXT

El URI de la imagen de contenedor que quiere utilizar al crear la aplicación. De forma predeterminada, AWS SAM usa la URI del repositorio de imágenes del contenedor de Amazon Elastic Container Registry (Amazon ECR) Public. Especifica esta opción para utilizar una imagen diferente.

Puede utilizar esta opción varias veces con un solo comando. Cada opción acepta una cadena o un par clave-valor.

  • Cadena: especifica el URI de la imagen del contenedor que utilizarán todos los recursos de la aplicación. A continuación, se muestra un ejemplo:

    $ sam sync --build-image amazon/aws-sam-cli-build-image-python3.8
  • Key-value par — Especifique el nombre del recurso como clave y el URI de la imagen del contenedor que se utilizará con ese recurso como valor. Utiliza este formato para especificar un URI de imagen de contenedor diferente para cada recurso de la aplicación. A continuación, se muestra un ejemplo:

    $ sam sync --build-image Function1=amazon/aws-sam-cli-build-image-python3.8

Esta opción solo se aplica si se especifica la opción --use-container; de lo contrario, se producirá un error.

--build-in-source | --no-build-in-source

Proporciona --build-in-source para compilar el proyecto directamente en la carpeta de origen.

La opción --build-in-source admite los siguientes tiempos de ejecución y métodos de compilación:

  • Tiempos de ejecución: cualquier tiempo de ejecución Node.js compatible con la opción sam init --runtime.

  • Métodos de compilación: Makefile, esbuild.

La opción --build-in-source no es compatible con las siguientes opciones:

  • --use-container

Valor predeterminado: --no-build-in-source

--capabilities LIST

Una lista de las capacidades que especificas para permitir CloudFormation para crear determinadas pilas. Algunas plantillas de pila pueden incluir recursos que pueden afectar a los permisos de tu Cuenta de AWS. Por ejemplo, creando nuevos AWS Identity and Access Management usuarios (IAM). Especifica esta opción para anular los valores predeterminados. Entre los valores válidos se incluyen:

  • CAPABILITY_IAM

  • CAPABILITY_NAMED_IAM

  • CAPABILITY_RESOURCE_POLICY

  • CAPABILITY_AUTO_EXPAND

Valores predeterminados: CAPABILITY_NAMED_IAM y CAPABILITY_AUTO_EXPAND

--code

De forma predeterminada, AWS SAM sincroniza todos los recursos de tu aplicación. Especifica esta opción para sincronizar solo los recursos de código, que incluyen lo siguiente:

  • AWS::Serverless::Function

  • AWS::Lambda::Function

  • AWS::Serverless::LayerVersion

  • AWS::Lambda::LayerVersion

  • AWS::Serverless::Api

  • AWS::ApiGateway::RestApi

  • AWS::Serverless::HttpApi

  • AWS::ApiGatewayV2::Api

  • AWS::Serverless::StateMachine

  • AWS::StepFunctions::StateMachine

Para sincronizar los recursos de código, AWS SAM usos AWS las API de servicio directamente, en lugar de implementarlas a través AWS CloudFormation. Para actualizar su CloudFormation apile, ejecute sam sync --watch o sam deploy.

--config-env TEXT

El nombre del entorno que especifica los valores de los parámetros predeterminados del archivo de configuración que se va a utilizar. El valor por defecto es «predeterminado». Para obtener más información sobre los archivos de configuración, consulta Archivo de configuración de la CLI de AWS SAM.

--config-file PATH

La ruta y el nombre del archivo de configuración que contiene los valores de parámetros predeterminados que se van a utilizar. El valor por defecto es «samconfig.toml» en la raíz del directorio del proyecto. Para obtener más información sobre los archivos de configuración, consulta Archivo de configuración de la CLI de AWS SAM.

--dependency-layer | --no-dependency-layer

Especifica si se deben separar las dependencias de las funciones individuales en otra capa para acelerar el proceso de sincronización.

Un AWS::Serverless::WebFunction no puede usar capas, por lo que sus dependencias siempre permanecen en su paquete de implementación.

Valor predeterminado: --dependency-layer

--express | --no-express

Especifica si se debe usar CloudFormation Modo exprés para despliegues de infraestructura. Cuando está activo, las operaciones de pila se completan una vez que se aplica la configuración de recursos. Los recursos siguen preparándose en segundo plano.

El modo exprés solo se aplica a la ruta de sincronización de la infraestructura. Code-only las sincronizaciones (actualizaciones, despliegues y actualizaciones de funciones de eventos de Lambda) evitan CloudFormation y no se ven afectadas por esta opción.

El valor predeterminado es --no-express.

Próximo cambio predeterminado

El valor predeterminado cambia a --express el 1 de septiembre de 2026.

--image-repository TEXT

El nombre del repositorio Amazon Elastic Container Registry (Amazon ECR) en el que este comando carga la imagen de la función. Es necesario para las funciones declaradas con el tipo de paquete Image.

--image-repositories TEXT

Una asignación de funciones a su URI de repositorio de Amazon ECR. Haga referencia a las funciones por su ID lógico. A continuación, se muestra un ejemplo:

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

Puede especificar esta opción varias veces con un solo comando.

--kms-key-id TEXT

La identificación de un AWS Key Management Service (AWS KMS) clave utilizada para cifrar los artefactos que están en reposo en el bucket de Amazon S3. Si no especifica esta opción, AWS SAM usa Amazon S3-managed claves de cifrado.

--metadata

Un mapa de metadatos para adjuntar a todos los artefactos a los que haga referencia en la plantilla.

--notification-arns LIST

Una lista de ARN temáticos de Amazon Simple Notification Service (Amazon SNS) que CloudFormation se asocia a la pila.

--no-use-container

Una opción que permite usar el kit de herramientas de IDE para establecer el comportamiento predeterminado.

--parameter-overrides

Una cadena que contiene CloudFormation anulaciones de parámetros codificadas como pares clave-valor. Utilice el mismo formato que el AWS Command Line Interface (AWS CLI). El formato de la CLI de AWS SAM es de palabras clave y de valor explícitas, y cada modificación está separada por un espacio. A continuación, se incluyen dos ejemplos:

  • --parameter-overrides ParameterKey=hello,ParameterValue=world

  • --parameter-overrides ParameterKey=hello,ParameterValue=world ParameterKey=example1,ParameterValue=example2 ParameterKey=apple,ParameterValue=banana

--resource TEXT

Especifica el tipo de recurso que se va a sincronizar. Para sincronizar varios recursos, puede especificar esta opción varias veces. Esta opción es compatible con la opción --code. El valor debe ser uno de los recursos que se enumeran en --code. Por ejemplo, --resource AWS::Serverless::Function --resource AWS::Serverless::LayerVersion.

--resource-id TEXT

Especifica el ID del recurso que se va a sincronizar. Para sincronizar varios recursos, puede especificar esta opción varias veces. Esta opción es compatible con la opción --code. Por ejemplo, --resource-id Function1 --resource-id Function2.

--role-arn TEXT

El nombre de recurso de Amazon (ARN) de una función de IAM que CloudFormation asume al aplicar el conjunto de cambios.

--s3-bucket TEXT

El nombre del bucket de Amazon Simple Storage Service (Amazon S3) en el que este comando carga tu CloudFormation plantilla. Si la plantilla tiene más de 51 200 bytes, se requiere la opción --s3-bucket o la --resolve-s3. Si especificas ambas opciones --s3-bucket y --resolve-s3, se producirá un error.

Si especifica esta opción, el código de un AWS::Serverless::WebFunction también se carga en este bucket. De lo contrario, se carga en un depósito de código que pertenece a la pila. Para obtener más información, consulte Creación e implementación de funciones web de Lambda.

--s3-prefix TEXT

El prefijo que se agrega a los nombres de los artefactos que carga en el bucket de Amazon S3. El nombre del prefijo es un nombre de ruta (nombre de carpeta) del bucket de Amazon S3. Esto se aplica únicamente a las funciones declaradas con el tipo de paquete Zip.

--save-params

Guarda los parámetros que se proporcionan en la línea de comandos en AWS SAM archivo de configuración.

--skip-deploy-sync | --no-skip-deploy-sync

Especifica --skip-deploy-sync para omitir la sincronización inicial de la infraestructura si no es necesaria. El AWS SAM CLI comparará tu local AWS SAM plantilla con la implementada CloudFormation crear una plantilla y realizar una implementación solo si se detecta un cambio.

Especifica --no-skip-deploy-sync para realizar un CloudFormation despliegue cada vez sam sync se ejecuta.

Para obtener más información, consulte Omita la inicial CloudFormation Implementación.

Valor predeterminado: --skip-deploy-sync

--stack-name TEXT

El nombre del CloudFormation pila para tu aplicación.

Esta opción es obligatoria.

--tags LIST

Una lista de etiquetas para asociarlas a la pila que se crea o actualiza. CloudFormation también propaga estas etiquetas a los recursos de la pila que las admiten.

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

La ruta y el nombre del archivo donde está AWS SAM se encuentra la plantilla.

nota

Si especifica esta opción, AWS SAM implementa solo la plantilla y los recursos locales a los que apunta.

--use-container, -u

Si tus funciones dependen de paquetes que tienen dependencias compiladas de forma nativa, usa esta opción para crear tu función dentro de un AWS Lambda-like Docker contenedor.

nota

Actualmente, esta opción no es compatible con --dependency-layer. Si usas --use-container con --dependency-layer, la CLI de AWS SAM le informará y continuará con --no-dependency-layer.

--watch

Inicia un proceso que controla la aplicación local en busca de cambios y los sincroniza automáticamente con el Nube de AWS. De forma predeterminada, al especificar esta opción, AWS SAM sincroniza todos los recursos de tu aplicación a medida que los actualizas. Con esta opción, AWS SAM realiza una inicial CloudFormation despliegue. Luego, AWS SAM usos AWS API de servicio para actualizar los recursos de código. AWS SAM usos CloudFormation para actualizar los recursos de la infraestructura al actualizar su AWS SAM plantilla.

El código de un AWS::Serverless::WebFunction no se vigila, porque cada cambio de código crea una nueva revisión. Los cambios de código se implementan con la siguiente sincronización de infraestructura.

--watch-exclude TEXT

Excluye un archivo o carpeta de ser observado para cambios de archivo. Para utilizar esta opción, también se debe proporcionar --watch.

Esta opción recibe un par de clave-valor:

  • Clave: el identificador lógico de una función de Lambda en la aplicación.

  • Valor: el nombre del archivo o la carpeta asociados que se van a excluir.

Al actualizar cualquier archivo o carpeta especificada con el --watch-exclude opción, la AWS SAM CLI no iniciará una sincronización. Sin embargo, cuando una actualización de otros archivos o carpetas inicie una sincronización, estos archivos o carpetas se incluirán en dicha sincronización.

Puede proporcionar esta opción varias veces en un mismo comando.

Ejemplos

Para ver ejemplos sobre el uso de este comando, consulte Opciones para el comando de sincronización sam.