put-parameter

Описание

Создайте или обновите параметр в хранилище параметров.

См. также: Документация API AWS

Синтаксис

  put-parameter
--name <value>
[--description <value>]
--value <value>
[--type <value>]
[--key-id <value>]
[--overwrite | --no-overwrite]
[--allowed-pattern <value>]
[--tags <value>]
[--tier <value>]
[--policies <value>]
[--data-type <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <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]

Параметры

--name (строка)

Полное имя параметра, который вы хотите создать или обновить.

Примечание

Вы не можете ввести Amazon Resource Name (ARN) для параметра, только само имя параметра.

Полное имя включает полную иерархию пути и имени параметра. Для параметров в иерархии необходимо включить начальный символ косой черты (/) при создании или ссылке на параметр. Например: /Dev/DBServer/MySQL/db-string13

Ограничения на имена:

Имена параметров чувствительны к регистру.
Имя параметра должно быть уникальным в регионе Amazon Web Services
Имя параметра не может начинаться с «aws » или «ssm » (регистронезависимо).
Имена параметров могут содержать только следующие символы и буквы: a-zA-Z0-9_.- Кроме того, символ косой черты ( / ) используется для обозначения иерархий в именах параметров. Например: /Dev/Production/East/Project-ABC/MyParameter
Имя параметра не может содержать пробелы.
Иерархия параметров ограничена максимальной глубиной пятнадцатью уровнями.

Дополнительную информацию о допустимых значениях имен параметров см. в руководстве пользователя Amazon Web Services Systems Manager по созданию параметров Systems Manager .

Примечание

Указанная максимальная длина имени параметра в 2048 символов включает 1037 символов, зарезервированных для внутреннего использования Systems Manager. Максимальная длина имени параметра, которое вы указываете, составляет 1011 символов.

Это количество в 1011 символов включает символы в ARN, предшествующие имени, которое вы указываете. Длина этого ARN будет различаться в зависимости от вашей области и региона. Например, следующие 45 символов учитываются в максимальном значении в 1011 символов для параметра, созданного в регионе США Восточный (Огайо): arn:aws:ssm:us-east-2:111122223333:parameter/ .

--description (строка)

Информация о параметре, который вы хотите добавить в систему. Необязательно, но рекомендуется.

Предупреждение

Не вводите персональную информацию в это поле.

--value (строка)

Значение параметра, которое вы хотите добавить в систему. Стандартные параметры имеют предел значения в 4 КБ. Расширенные параметры имеют предел значения в 8 КБ.

Примечание

Параметры не могут быть сохранены или вложены в значениях других параметров. Вы не можете включать значения, заключенные в двойные скобки {{}} или {{ssm:*parameter-name* }}, в значение параметра.

--type (строка)

Тип параметра, который вы хотите создать.

Примечание

SecureString в настоящее время не поддерживается для шаблонов CloudFormation.

Элементы в StringList должны быть разделены запятыми (,). Вы не можете использовать другие знаки препинания или специальные символы для экранирования элементов в списке. Если значение параметра требует запятой, используйте тип данных String.

Предупреждение

Указывать тип параметра не требуется при обновлении параметра. Вы должны указать тип параметра при создании параметра.

Возможные значения:

String
StringList
SecureString

--key-id (строка)

Идентификатор Key Management Service (KMS), который вы хотите использовать для шифрования параметра. Используйте собственный ключ для большей безопасности. Требуется для параметров, использующих тип данных SecureString.

Если вы не укажете идентификатор ключа, система использует по умолчанию ключ, связанный с вашей учетной записью Amazon Web Services, что менее безопасно, чем использование пользовательского ключа.

Для использования пользовательского ключа KMS выберите тип данных SecureString с параметром Key ID.

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

Перезаписать существующий параметр. Значение по умолчанию — false .

--allowed-pattern (строка)

Регулярное выражение, используемое для проверки значения параметра. Например, для типов String со значениями, ограниченными числами, вы можете указать следующее: AllowedPattern=^d+$

--tags (список)

Необязательные метаданные, которые вы назначаете ресурсу. Теги позволяют категоризировать ресурс по-разному, например, по назначению, владельцу или среде. Например, вы можете пометить параметр Systems Manager, чтобы определить тип ресурса, к которому он относится, среду или тип конфигурационных данных, на которые ссылается параметр. В этом случае вы можете указать следующие пары ключ-значение:

Key=Resource,Value=S3bucket
Key=OS,Value=Windows
Key=ParameterType,Value=LicenseKey

Примечание

Чтобы добавить теги к существующему параметру Systems Manager, используйте операцию AddTagsToResource.

(структура)

Метаданные, которые вы назначаете своим ресурсам Amazon Web Services. Теги позволяют категоризировать ваши ресурсы по-разному, например, по назначению, владельцу или среде. В Amazon Web Services Systems Manager вы можете применять теги к документам Systems Manager (SSM документы), управляемым узлам, окнам технического обслуживания, параметрам, базовым настройкам исправлений, OpsItems и OpsMetadata.

Ключ -> (строка)

Название тега.

Значение -> (строка)

Значение тега.

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--tier (строка)

Уровень параметра, который нужно назначить параметру.

Хранилище параметров предлагает стандартный и расширенный уровни для параметров. Стандартные параметры имеют предел размера содержимого 4 КБ и не могут быть настроены для использования политик параметров. Вы можете создать не более 10 000 стандартных параметров для каждого региона в вашей учетной записи Amazon Web Services. Стандартные параметры предоставляются без дополнительной платы.

Расширенные параметры имеют предел размера содержимого 8 КБ и могут быть настроены для использования политик параметров. Вы можете создать не более 100 000 расширенных параметров для каждого региона в вашей учетной записи Amazon Web Services. Расширенные параметры взимают плату. Дополнительные сведения см. в руководстве пользователя Amazon Web Services Systems Manager по управлению уровнями параметров .

Вы можете изменить стандартный параметр на расширенный в любое время. Но вы не можете вернуть расширенный параметр к стандартному. Возврат расширенного параметра к стандартному приведет к потере данных, поскольку система обрезает размер параметра с 8 КБ до 4 КБ. Возврат также удалит любые политики, прикрепленные к параметру. Кроме того, расширенные параметры используют другой метод шифрования, чем стандартные параметры.

Если вам больше не нужен расширенный параметр или вы больше не хотите платить за расширенный параметр, вы должны его удалить и создать новый стандартный параметр.

Использование конфигурации уровня по умолчанию

В запросах PutParameter вы можете указать уровень, для создания параметра. Всякий раз, когда вы указываете уровень в запросе, хранилище параметров создает или обновляет параметр в соответствии с этим запросом. Однако если вы не указываете уровень в запросе, хранилище параметров назначает уровень в соответствии с текущей конфигурацией уровня по умолчанию хранилища параметров.

Уровень по умолчанию при первом использовании хранилища параметров — стандартный уровень параметра. Если вы используете расширенный уровень параметра, вы можете указать один из следующих вариантов в качестве значения по умолчанию:

Расширенный : с этим параметром хранилище параметров обрабатывает все запросы как запросы на создание расширенных параметров.
Интеллектуальный выбор уровня : с этим параметром хранилище параметров оценивает каждый запрос, чтобы определить, является ли параметр стандартным или расширенным. Если запрос не содержит никаких параметров, требующих расширенного уровня, параметр создается на стандартном уровне. Если в запросе присутствует один или несколько параметров, требующих расширенного уровня, хранилище параметров создает параметр на расширенном уровне. Этот подход помогает контролировать расходы, связанные с параметрами, создавая всегда стандартные параметры, если только не требуется расширенный параметр.

Параметры, требующие расширенного уровня, включают следующее:

Размер содержимого параметра превышает 4 КБ.
Параметр использует политику параметра.
В вашей учетной записи Amazon Web Services в текущем регионе Amazon Web Services уже существует более 10 000 параметров.

Дополнительные сведения о настройке параметра по умолчанию см. в руководстве пользователя Amazon Web Services Systems Manager по указанию уровня параметров по умолчанию .

Возможные значения:

Standard
Advanced
Intelligent-Tiering

--policies (строка)

Одна или несколько политик, применяемых к параметру. Эта операция принимает JSON-массив. Хранилище параметров в Amazon Web Services Systems Manager поддерживает следующие типы политик:

Истечение срока действия: эта политика удаляет параметр после истечения срока действия. При создании политики вы указываете дату истечения срока действия. Вы можете обновить дату и время истечения срока действия путем обновления политики. Обновление параметра не влияет на дату и время истечения срока действия. Когда время истечения срока действия наступает, хранилище параметров удаляет параметр.

Уведомление об истечении срока действия: эта политика запускает событие в Amazon CloudWatch Events, уведомляющее вас об истечении срока действия. Используя эту политику, вы можете получать уведомления до или после истечения срока действия в единицах дней или часов.

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

Все существующие политики сохраняются до тех пор, пока вы не отправите новые политики или пустую политику. Дополнительные сведения о политиках параметров см. в разделе Назначение политик параметров .

--data-type (строка)

Тип данных для параметра String. Поддерживаемые типы данных включают обычный текст и идентификаторы Amazon Machine Image (AMI).

Поддерживаются следующие типы данных.

text
aws:ec2:image
aws:ssm:integration

При создании параметра String и указании aws:ec2:image, Amazon Web Services Systems Manager проверяет, соответствует ли значение параметра требуемому формату, например, ami-12345abcdeEXAMPLE, и доступна ли указанная AMI в вашей учетной записи Amazon Web Services.

Примечание

Если действие выполняется успешно, служба возвращает ответ HTTP 200, который указывает на успешное выполнение вызова PutParameter во всех случаях, кроме типа данных aws:ec2:image. Если вы вызываете PutParameter с типом данных aws:ec2:image, успешный ответ HTTP 200 не гарантирует, что ваш параметр был успешно создан или обновлен. Значение aws:ec2:image проверяется асинхронно, и вызов PutParameter возвращается до завершения проверки. Если вы передадите недопустимое значение AMI, операция PutParameter вернёт успех, но асинхронная проверка завершится неудачей, и параметр не будет создан или обновлён. Чтобы отслеживать успешность создания параметров aws:ec2:image, см. Настройка уведомлений или запуск действий на основе событий хранилища параметров. Дополнительную информацию о проверке формата AMI см. в разделе Поддержка параметров AMI для Amazon Machine Image.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передать произвольные двоичные значения с помощью JSON-значения, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или значение input, выводится пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, будет выведен пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

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

--debug (булево)

Включить отладку регистрации.

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

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

--no-verify-ssl (булево)

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

--no-paginate (булево)

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

--output (строка)

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

json
текст
таблица
yaml
yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

включено
выключено
автоматически

--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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

Чтобы использовать следующие примеры, вам необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.

Если не указано иное, все примеры имеют правила цитирования Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки терминала. См. Использование кавычек со строками в руководстве пользователя AWS CLI.

Пример 1: Изменение значения параметра

Следующий пример put-parameter изменяет значение указанного параметра.

aws ssm put-parameter \
    --name "MyStringParameter" \
    --type "String" \
    --value "Vici" \
    --overwrite

Вывод:

{
    "Version": 2,
    "Tier": "Standard"
}

Дополнительную информацию см. в разделе Создание параметра Systems Manager (AWS CLI), Управление уровнями параметров и Работа с политиками параметров в руководстве пользователя AWS Systems Manager.

Пример 2: Создание расширенного параметра

Следующий пример put-parameter создает расширенный параметр.

aws ssm put-parameter \
    --name "MyAdvancedParameter" \
    --description "This is an advanced parameter" \
    --value "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat [truncated]" \
    --type "String" \
    --tier Advanced

Вывод:

{
    "Version": 1,
    "Tier": "Advanced"
}

Пример 3: Преобразование стандартного параметра в расширенный параметр

Следующий пример put-parameter преобразует существующий стандартный параметр в расширенный параметр.

aws ssm put-parameter \
    --name "MyConvertedParameter" \
    --value "abc123" \
    --type "String" \
    --tier Advanced \
    --overwrite

Вывод:

{
    "Version": 2,
    "Tier": "Advanced"
}

Пример 4: Создание параметра с прикрепленной политикой

Следующий пример put-parameter создает расширенный параметр с прикреплённой политикой параметра.

aws ssm put-parameter \
    --name "/Finance/Payroll/q2accesskey" \
    --value "P@sSwW)rd" \
    --type "SecureString" \
    --tier Advanced \
    --policies "[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-06-30T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}},{\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After\":\"60\",\"Unit\":\"Days\"}}]"

Вывод:

{
    "Version": 1,
    "Tier": "Advanced"
}

Пример 5: Добавление политики к существующему параметру

Следующий пример put-parameter добавляет политику к существующему расширенному параметру.

aws ssm put-parameter \
    --name "/Finance/Payroll/q2accesskey" \
    --value "N3wP@sSwW)rd" \
    --type "SecureString" \
    --tier Advanced \
    --policies "[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-06-30T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}},{\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After\":\"60\",\"Unit\":\"Days\"}}]"
    --overwrite

Вывод:

{
    "Version": 2,
    "Tier": "Advanced"
}

Вывод

Версия -> (целое)

Новый номер версии параметра. Если вы редактируете значение параметра, хранилище параметров автоматически создаёт новую версию и присваивает ей уникальный идентификатор. Вы можете использовать идентификатор версии параметра в операциях API или в документах Systems Manager (SSM-документы). По умолчанию, если вы не указываете определённую версию, система возвращает последнее значение параметра при вызове параметра.

Уровень -> (строка)

Уровень, назначенный параметру.