View a markdown version of this page

sam deploy - 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 deploy

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

El sam deploy el comando despliega una aplicación en Nube de AWS usando AWS CloudFormation.

importante

No corras sam deploy en código que no es de confianza. El comando usa tu AWS credenciales para crear los recursos que define la plantilla, incluidos los roles y políticas de IAM, y carga los archivos locales a los que hace referencia la plantilla. También aplica las opciones del archivo de configuración del proyecto tal como están escritas. Revisa la plantilla y el archivo de configuración antes de implementar un proyecto que no hayas creado.

De uso

$ <environment variables> sam deploy <options>

Variables de entorno

SAM_CLI_POLL_DELAY

Configure el SAM_CLI_POLL_DELAY variable de entorno con un valor de segundos en su shell para configurar la frecuencia con la que AWS La CLI de SAM comprueba el CloudFormation estado de pila, lo cual es útil cuando se ve la limitación desde CloudFormation. Esta variable de entorno se utiliza para sondear las llamadas a la API describe_stack, que se realizan durante la ejecución de sam deploy.

A continuación se muestra un ejemplo de la variable.

$ SAM_CLI_POLL_DELAY=5 sam deploy

Opciones

--capabilities LIST

Una lista de las capacidades que debe especificar para permitirlas CloudFormation para crear determinadas pilas. Algunas plantillas de pila pueden incluir recursos que afectan a los permisos de tu Cuenta de AWS, por ejemplo, creando nuevas AWS Identity and Access Management usuarios (IAM). Para estas pilas, debe reconocer explícitamente sus capacidades especificando esta opción. Los únicos valores válidos son CAPABILITY_IAM y CAPABILITY_NAMED_IAM. Si tiene recursos de IAM, puede especificar cualquiera de las dos capacidades. Si tiene recursos de IAM con nombres personalizados, debe especificar CAPABILITY_NAMED_IAM. Si no especifica esta opción, la operación devuelve un error InsufficientCapabilities.

Cuando implementa una aplicación que contiene aplicaciones anidadas, debe usar CAPABILITY_AUTO_EXPAND para reconocer que la aplicación contiene aplicaciones anidadas. Para obtener más información, consulte Implementar aplicaciones anidadas.

--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 predeterminado es default. 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.

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

Solicita confirmar si la CLI de AWS SAM implementa el conjunto de cambios calculado.

--debug

Active el registro de depuración para imprimir el mensaje de depuración que la CLI de AWS SAM genera y para mostrar las marcas temporales.

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

Especifique si desea deshacer su CloudFormation apile si se produce un error durante una implementación. De forma predeterminada, si se produce un error durante una implementación, su CloudFormation la pila vuelve al último estado estable. Si especificas --disable-rollback y se produce un error durante una implementación, los recursos que se crearon o actualizaron antes de que se produjera el error no se revertirán.

--express | --no-express

Especifica si se debe usar CloudFormation Modo exprés. 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 tiempo de implementación se puede reducir hasta 4 veces.

El AWS SAM CLI pasa el comportamiento de reversión al CloudFormation DeploymentConfig parámetro cuando también se especifica --disable-rollback.

El valor predeterminado es --no-express.

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

Especifica si desea devolver un código de salida distinto de cero si no hay cambios que realizar en la pila. El comportamiento predeterminado es devolver un código de salida distinto de cero.

--force-upload

Especifica esta opción para cargar artefactos incluso si coinciden con los artefactos existentes en el bucket de Amazon S3. Los artefactos coincidentes se sobrescriben.

--guided, -g

Especifica esta opción para que la CLI de AWS SAM utilice indicaciones que le guíen durante la implementación.

--help

Muestre este mensaje y salga de él.

--image-repositories TEXT

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

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

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

--image-repository TEXT

El nombre del repositorio de Amazon ECR en el que este comando carga la imagen de la función. Esta opción es necesaria para las funciones declaradas con el tipo de paquete Image.

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

Para un AWS::Serverless::WebFunction subido al bucket con el que especifiques --s3-bucket, la clave debe ser una clave gestionada por el cliente cuya política de claves lo permita lambda.amazonaws.com para llamar kms:Decrypt.

--metadata

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

--no-execute-changeset

Indica si se debe aplicar el conjunto de cambios. Especifica esta opción si desea ver los cambios de la pila antes de aplicar el conjunto de cambios. Este comando crea un conjunto de cambios CloudFormation y, a continuación, se cierra sin aplicar el conjunto de cambios. Para aplicar el conjunto de cambios, ejecuta el mismo comando sin esta opción.

--no-progressbar

No muestre una barra de progreso al cargar artefactos en Amazon S3.

--notification-arns LIST

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

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

Especifica la acción que se debe realizar cuando no se pueda crear una pila.

Están disponibles las siguientes opciones:

  • ROLLBACK: hace retroceder la pila a un estado válido conocido anteriormente.

  • DELETE: hace retroceder la pila a un estado válido conocido anteriormente, si es que existe alguno. De lo contrario, elimina la pila.

  • DO_NOTHING: no revierte ni elimina la pila. El efecto es el mismo que el de --disable-rollback.

El comportamiento predeterminado es ROLLBACK.

nota

Especifica la opción --disable-rollback o la --on-failure, pero no ambas.

--output [ text | json ]

El formato de la salida del comando:

  • text — Imprime un resultado normal y legible por humanos. Este es el valor predeterminado.

  • json — Imprime resultados estructurados y legibles por máquina. Utilice este formato cuando desee consumir la salida mediante programación, como en CI/CD canalizaciones, extensiones IDE y AI-assisted herramientas.

Una implementación se ejecuta durante un período de tiempo. Cuando especifiques --output json, el AWS SAM CLI imprime un flujo de objetos JSON, uno por línea, a medida que avanza la implementación. Cada objeto incluye un type campo que identifica el tipo de información que contiene, como el conjunto de cambios, los eventos de implementación, los resultados de la pila y el resultado final. En caso de error, el objeto final incluye un error objeto que describe lo que salió mal.

nota

El --output json la opción no es compatible con las opciones que requieren indicaciones interactivas, como --guided y --confirm-changeset.

--parameter-overrides LIST

Una cadena que contiene CloudFormation anulaciones de parámetros codificadas como pares clave-valor. Cada anulación usa el formato ParameterKey=name,ParameterValue=value. Las anulaciones múltiples están separadas por espacios. A continuación, se incluyen dos ejemplos:

$ 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

El perfil específico de su archivo de credenciales que obtiene AWS credenciales.

--region TEXT

El Región de AWS para desplegarse en. Por ejemplo, us-east-1.

--resolve-image-repos

Crea automáticamente repositorios de Amazon ECR para usarlos en el empaquetado y la implementación de implementaciones no guiadas. Esta opción solo se aplica a funciones y capas con la especificación PackageType: Image. Si especificas la opción --guided, entonces la CLI de AWS SAM ignora --resolve-image-repos.

nota

Si AWS SAM crea automáticamente cualquier repositorio de Amazon ECR para funciones o capas con esta opción y, posteriormente, eliminas esas funciones o capas de tu AWS SAM plantilla y, a continuación, los repositorios de Amazon ECR correspondientes se eliminan automáticamente.

--resolve-s3

Crea automáticamente un bucket de Amazon S3 para utilizarlo en el empaquetado y la implementación de implementaciones no guiadas. Si especificas la opción --guided, entonces la CLI AWS SAM ignora --resolve-s3. Si especificas las opciones --s3-bucket y --resolve-s3, entonces se produce un error.

Con esta opción o --guided, el código de un AWS::Serverless::WebFunction se carga en un depósito de código que pertenece a la pila, no al depósito gestionado. Para obtener más información, consulte Creación e implementación de funciones web de Lambda.

--role-arn TEXT

El nombre de recurso de Amazon (ARN) de un rol de IAM que CloudFormation asume al aplicar el conjunto de cambios.

--s3-bucket TEXT

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

El código de un AWS::Serverless::WebFunction también se carga en este bucket, que debe tener habilitado el control de versiones y permitir que Lambda lea el código. Para obtener más información, consulte Creación e implementación de funciones web de Lambda.

--s3-prefix TEXT

El prefijo que se ha añadido a los nombres de los artefactos que se cargan en el bucket de Amazon S3. El nombre del prefijo es un nombre de ruta (nombre de la carpeta) del bucket de Amazon S3.

--save-params

Guarde los parámetros que proporciona en la línea de comandos en AWS SAM archivo de configuración.

--signing-profiles LIST

La lista de perfiles de firma con los que firmar los paquetes de implementación. Esta opción utiliza una lista de pares clave-valor, donde la clave es el nombre de la función o capa que se va a firmar y el valor es el perfil de firma, con un propietario del perfil opcional delimitado con :. Por ejemplo, FunctionNameToSign=SigningProfileName1 LayerNameToSign=SigningProfileName2:SigningProfileOwner.

--stack-name TEXT

(Obligatorio) El nombre del CloudFormation pila en la que vas a realizar la implementación. Si especificas una pila existente, el comando la actualiza. Si especificas una nueva pila, el comando la crea.

--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-json

JSON de salida para CloudFormation plantilla. El resultado predeterminado es YAML.

Ejemplo

Para ver un ejemplo y un tutorial detallados sobre el uso del subcomando sam deploy, consulte Introducción a la implementación con AWS SAM.