пакет

Описание

Архивирует локальные артефакты (локальные пути), на которые ссылается ваша шаблон AWS CloudFormation. Команда загружает локальные артефакты, такие как исходный код функции AWS Lambda или файл Swagger для REST API AWS API Gateway, в ведро S3. Команда возвращает копию вашего шаблона, заменив ссылки на локальные артефакты расположением в ведре S3, куда команда загрузила артефакты.

Используйте эту команду для быстрого загрузки локальных артефактов, которые могут потребоваться вашему шаблону. После архивирования артефактов вашего шаблона выполните команду deploy для развертывания возвращённого шаблона.

Эта команда может загружать локальные артефакты, на которые ссылаются в следующих местах:

Для указания локального артефакта в вашем шаблоне укажите путь к локальному файлу или папке, как абсолютный, так и относительный путь. Относительный путь — это расположение относительно расположения вашего шаблона.

Например, если исходный код вашей функции AWS Lambda находится в папке /home/user/code/lambdafunction/, укажите CodeUri: /home/user/code/lambdafunction для ресурса AWS::Serverless::Function. Команда возвращает шаблон и заменяет локальный путь на расположение в S3: CodeUri: s3://amzn-s3-demo-bucket/lambdafunction.zip.

Если вы указываете файл, команда загружает его непосредственно в ведро S3. Если вы указываете папку, команда сжимает папку и затем загружает файл .zip. Для большинства ресурсов, если вы не указываете путь, команда сжимает и загружает текущую рабочую директорию. Исключением является AWS::ApiGateway::RestApi; если вы не указываете BodyS3Location, эта команда не загрузит артефакт в S3.

Перед загрузкой артефактов команда проверяет, присутствуют ли артефакты в ведре S3, чтобы предотвратить ненужные загрузки. Команда использует контрольные суммы MD5 для сравнения файлов. Если значения совпадают, команда не загружает артефакты. Используйте --force-upload flag, чтобы пропустить эту проверку и всегда загрузить артефакты.

Синтаксис

  package
--template-file <value>
--s3-bucket <value>
[--s3-prefix <value>]
[--kms-key-id <value>]
[--output-template-file <value>]
[--use-json]
[--force-upload]
[--metadata <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--template-file (строка) Путь к вашему шаблону AWS CloudFormation.

--s3-bucket (строка) Название ведра S3, куда эта команда загружает артефакты, на которые ссылается ваш шаблон.

--s3-prefix (строка) Префиксное имя, которое команда добавляет к имени артефактов при их загрузке в ведро S3. Имя префикса — это имя пути (имя папки) для ведра S3.

--kms-key-id (строка) Идентификатор ключа AWS KMS, который команда использует для шифрования артефактов, хранящихся в ведре S3.

--output-template-file (строка) Путь к файлу, в который команда запишет результирующий шаблон AWS CloudFormation. Если вы не указываете путь, команда запишет шаблон в стандартный вывод.

--use-json (логическое значение) Указывает, использовать ли JSON в качестве формата для результирующего шаблона AWS CloudFormation. По умолчанию используется YAML.

--force-upload (логическое значение) Указывает, перезаписывать ли существующие файлы в ведре S3. Укажите этот флаг, чтобы загрузить артефакты, даже если они совпадают с существующими артефактами в ведре S3.

--metadata (карта) Карта метаданных, которые нужно прикрепить к ВСЕМ артефактам, на которые ссылается ваш шаблон.ключ -> (строка)

Сокращенный синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

Глобальные параметры

--debug (логическое значение)

Включить отладку.

--endpoint-url (строка)

Переопределить URL по умолчанию команды на заданный URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение по умолчанию — проверку SSL-сертификатов.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команды.

• json
• text
• table
• yaml
• yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла учетных данных.

--region (строка)

Используемый регион. Переопределяет параметры конфигурации/среды.

--version (строка)

Показать версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

• on
• off
• auto

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружаться, если этот аргумент задан.

--ca-bundle (строка)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет параметры конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде строки, закодированной в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, а двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для конфигурированного cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить кли-педжер для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическую запрос параметров CLI.

Примеры

Следующая команда экспортирует шаблон под названием template.json, загружая локальные артефакты в ведро S3 bucket-name и записывает экспортированный шаблон в packaged-template.json:

aws cloudformation package --template-file /path_to_template/template.json --s3-bucket bucket-name --output-template-file packaged-template.json --use-json