sam package

La interfaz de línea de comandos AWS Serverless Application Model (AWS SAMCLI) empaqueta una aplicación AWS SAM.

Este comando crea un archivo .zip de su código y sus dependencias y, a continuación, sube el archivo a Amazon Simple Storage Service (Amazon S3). AWS SAM permite el cifrado de todos los archivos almacenados en Amazon S3. Después, el comando devuelve una copia de la plantilla de AWS SAM, sustituyendo las referencias a artefactos locales con la ubicación de Amazon S3 donde el comando cargó los artefactos.

De forma predeterminada, cuando utiliza este comando, CLI de AWS SAM asume que su directorio de trabajo actual es el directorio raíz del proyecto. La primera CLI de AWS SAM intenta localizar un archivo de plantilla creado con el comando sam build, ubicado en la subcarpeta .aws-sam y denominado template.yaml. A continuación, la CLI de AWS SAM intenta localizar un archivo de plantilla llamado template.yaml o template.yml en el directorio de trabajo actual. Si especificas la opción --template, el comportamiento predeterminado de la CLI de AWS SAM se anula su y se empaquetarán únicamente esa plantilla de AWS SAM y los recursos locales a los que apunte.

nota

sam deploy ahora ejecuta implícitamente la funcionalidad del sam package. Puede utilizar el comando sam deploy directamente para empaquetar e implementar su aplicación.

Uso

$ sam package <arguments> <options>

Argumentos

ID de recursos

El ID de la función de Lambda que se va a empaquetar.

Este argumento es opcional. Si la aplicación contiene una sola función de Lambda, la CLI de AWS SAM la empaquetará. Si la aplicación contiene varias funciones, proporciones el ID de la función para empaquetar una sola función.

Valores válidos: el identificador lógico o el ARN del recurso.

Opciones

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

--debug

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

--force-upload

Anular los archivos existentes en el bucket de Amazon S3. Especificar este indicador para cargar artefactos incluso si coinciden con los artefactos existentes en el bucket de Amazon S3.

--help

Muestra este mensaje y sale.

--image-repository TEXT

La URI del repositorio Amazon Elastic Container Registry (Amazon ECR) donde este comando sube la imagen de la función. Necesario 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 especificas no esta opción, entonces AWS SAM utilizará las claves de cifrado administradas por Amazon S3.

--metadata

(Opcional) Un mapa de metadatos para adjuntarlo a todos los artefactos a los que se hace referencia en la plantilla.

--no-progressbar

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

--output-template-file PATH

La ruta al archivo donde el comando escribe la plantilla empaquetada. Si especificas una ruta, el comando escribe la plantilla en la salida estándar.

--profile TEXT

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

--region TEXT

La región de AWS en la que se va a realizar la implementación. Por ejemplo, us-east-1.

--resolve-s3

Creación automática de un bucket de Amazon S3 para empaquetar. Si especificas las opciones --s3-bucket y --resolve-s3, entonces se producirá un error.

--s3-bucket TEXT

El nombre del bucket de Amazon S3 donde este comando carga el artefacto. Si el artefacto tiene más de 51 200 bytes, necesitará la opción --s3-bucket o --resolve-s3. Si especificas las opciones --s3-bucket y --resolve-s3, entonces se producirá un error.

--s3-prefix TEXT

Prefijo agregado al nombre 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. Esto solo se aplica a las funciones declaradas con el tipo de paquete Zip.

--save-params

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

--signing-profiles LIST

(Opcional) La lista de perfiles de firma con los que firmar los paquetes de implementación. Este parámetro toma 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.

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

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

nota

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

--use-json

JSON de salida para la plantilla de CloudFormation. YAML se utiliza de forma predeterminada.

Ejemplo

En el siguiente ejemplo se crean y empaquetan artefactos para una función de Lambda y aplicaciones de CodeDeploy. Los artefactos se cargan en un bucket de Amazon S3. El resultado del comando es un nuevo archivo llamado package.yml.

$ sam package \
  --template-file template.yml \
  --output-template-file package.yml \
  --s3-bucket amzn-s3-demo-bucket