sam deploy

Esta página proporciona información de referencia para el AWS Serverless Application Model comando Command Line Interface (AWS SAMCLI)sam deploy.

• Para obtener una introducción al AWS SAMCLI, consulte¿Qué es el? AWS SAMCLI.

• Para obtener documentación sobre el uso del AWS SAMCLI sam deploy comando, consulteIntroducción a la implementación con el sam deploy comando.

El sam deploy comando despliega una aplicación para el usuario Nube de AWS . AWS CloudFormation

Uso

$ <environment variables> sam deploy <options>

Variables de entorno

SAM_CLI_POLL_DELAY

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

A continuación se muestra un ejemplo de esta variable:

$ SAM_CLI_POLL_DELAY=5 sam deploy

Opciones

--capabilities LIST

Una lista de capacidades que debe especificar para AWS CloudFormation permitir la creación de determinadas pilas. Algunas plantillas de pila pueden incluir recursos que afectan a sus permisos, por ejemplo Cuenta de AWS, mediante la creación de nuevos usuarios AWS Identity and Access Management (de 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.

--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, consulte 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, consulte 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 revertir la AWS CloudFormation pila en caso de que se produzca un error durante una implementación. De forma predeterminada, si se produce un error durante una implementación, la AWS CloudFormation pila vuelve al último estado estable. Si especifica --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.

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

Especifique 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

Especifique 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

Especifique 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

El ID de una clave AWS Key Management Service (AWS KMS) que se utiliza para cifrar los artefactos que se encuentran en reposo en el bucket de Amazon S3. Si no especifica esta opción, utilizará claves de cifrado administradas por Amazon S3. AWS SAM

--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. Especifique 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 AWS CloudFormation y, a continuación, se cierra sin aplicar el conjunto de cambios. Para aplicar el conjunto de cambios, ejecute 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 los ARN de temas de Amazon Simple Notification Service (Amazon SNS) asociados a la pila AWS CloudFormation .

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

Especifique 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

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

--parameter-overrides

Una cadena que contiene anulaciones de AWS CloudFormation parámetros codificadas como pares clave-valor. Usa el mismo formato que (). AWS Command Line Interface AWS CLI Por ejemplo, ParameterKey=ParameterValue InstanceType=t1.micro.

--profile TEXT

El perfil específico del archivo de credenciales que recibe AWS las credenciales.

--region TEXT

El en el Región de AWS que se va a implementar. Por ejemplo, us-east-1.

--resolve-image-repos

Cree 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 especifica la opción --guided, entonces la CLI de AWS SAM ignora --resolve-image-repos.

nota

Si crea AWS SAM automáticamente cualquier repositorio de Amazon ECR para funciones o capas con esta opción y, posteriormente, elimina esas funciones o capas de la AWS SAM plantilla, los repositorios de Amazon ECR correspondientes se eliminarán automáticamente.

--resolve-s3

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

--role-arn TEXT

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

--s3-bucket TEXT

El nombre del bucket de Amazon S3 en el que este comando carga la AWS 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 especifica las opciones --s3-bucket y --resolve-s3, entonces se produce un error.

--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 proporcione en la línea de comandos en el archivo de AWS SAM 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 de la AWS CloudFormation pila en la que se va a realizar la implementación. Si especifica una pila existente, el comando la actualiza. Si especifica una nueva pila, el comando la crea.

--tags LIST

Una lista de etiquetas para asociarlas a la pila que se crea o actualiza. AWS 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 se encuentra la AWS SAM plantilla.

nota

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

--use-json

Genera JSON para la AWS CloudFormation plantilla. El resultado predeterminado es YAML.