create-configuration-profile
Описание
Создаёт профиль конфигурации, содержащий информацию, необходимую AppConfig для доступа к источнику конфигурации. Допустимые источники конфигурации включают:
- Данные конфигурации в форматах YAML, JSON и других, хранящиеся в хранилище конфигураций AppConfig
- Данные конфигурации, хранящиеся в виде объектов в ведре Amazon Simple Storage Service (Amazon S3)
- Пайплайны, хранящиеся в CodePipeline
- Секреты, хранящиеся в Secrets Manager
- Стандартные и защищённые строковые параметры, хранящиеся в Amazon Web Services Systems Manager Parameter Store
- Данные конфигурации в документах SSM, хранящихся в хранилище документов Systems Manager
Профиль конфигурации включает следующую информацию:
- URI расположения данных конфигурации.
- Роль Identity and Access Management (IAM), предоставляющая доступ к данным конфигурации.
- Валидатор для данных конфигурации. Доступные валидаторы — JSON Schema или функция Amazon Web Services Lambda.
Для получения дополнительной информации обратитесь к разделу Создайте конфигурацию и профиль конфигурации в руководстве пользователя AppConfig.
См. также: Документация API AWS
Синтаксис
create-configuration-profile
--application-id <value>
--name <value>
[--description <value>]
--location-uri <value>
[--retrieval-role-arn <value>]
[--validators <value>]
[--tags <value>]
[--type <value>]
[--kms-key-identifier <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]
Параметры
--application-id (строка)
--name (строка)
--description (строка)
--location-uri (строка)
URI для поиска конфигурации. Можно указать следующее:
- Для хранилища конфигураций AppConfig и для флагов функций укажите
hosted. - Для параметра Amazon Web Services Systems Manager Parameter Store укажите имя параметра в формате
ssm-parameter://<parameter name>или ARN. - Для пайплайна Amazon Web Services CodePipeline укажите URI в следующем формате:
codepipeline://<имя пайплайна>. - Для секрета Secrets Manager укажите URI в следующем формате:
secretsmanager://<имя секрета>. - Для объекта Amazon S3 укажите URI в следующем формате:
s3://<bucket>/<objectKey>. Пример:s3://amzn-s3-demo-bucket/my-app/us-east-1/my-config.json - Для документа SSM укажите имя документа в формате
ssm-document://<document name>или Amazon Resource Name (ARN).
--retrieval-role-arn (строка)
ARN роли IAM с разрешениями на доступ к конфигурации по указанному LocationUri.
Предупреждение
ARN роли для извлечения данных не требуется для конфигураций, хранящихся в CodePipeline или хранилище конфигураций AppConfig. Он требуется для всех других источников хранения конфигураций.--validators (список)
Список методов для проверки конфигурации.
(структура)
Валидатор предоставляет синтаксическую или семантическую проверку, гарантируя, что конфигурация, которую вы хотите развернуть, работает как ожидается. Для проверки данных конфигурации приложения вы предоставляете схему или функцию Amazon Web Services Lambda, которая выполняется над конфигурацией. Развёртывание или обновление конфигурации может произойти только при валидных данных конфигурации. Подробнее см. в разделе О валидаторах в руководстве пользователя AppConfig.
Тип -> (строка)
JSON_SCHEMA и LAMBDA
Содержание -> (строка)
Краткая запись:
Type=string,Content=string ...
JSON-синтаксис:
[
{
"Type": "JSON_SCHEMA"|"LAMBDA",
"Content": "string"
}
...
]
--tags (карта)
Метаданные для назначения профилю конфигурации. Теги помогают организовать и классифицировать ресурсы AppConfig. Каждый тег состоит из ключа и необязательного значения, которые вы определяете.
ключ -> (строка)
значение -> (строка)
Краткая запись:
KeyName1=string,KeyName2=string
JSON-синтаксис:
{"string": "string"
...}
--type (строка)
Тип конфигураций в профиле. AppConfig поддерживает feature flags и freeform конфигурации. Рекомендуется создавать конфигурации флагов функций для включения или отключения новых функций и свободные конфигурации для распространения конфигураций приложения. При вызове этого API введите одно из следующих значений для Type:
AWS.AppConfig.FeatureFlags
AWS.Freeform
--kms-key-identifier (строка)
hosted типов конфигурации. Идентификатор может быть ID ключа KMS, алиасом или Amazon Resource Name (ARN) ID или алиаса ключа. Для шифрования данных, управляемых в других хранилищах конфигурации, ознакомьтесь с документацией по указанию ключа KMS для этого конкретного сервиса.--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.
Для создания профиля конфигурации
В следующем create-configuration-profile примере создаётся профиль конфигурации с использованием конфигурации, хранящейся в Parameter Store, функциональности Systems Manager.
aws appconfig create-configuration-profile \
--application-id "339ohji" \
--name "Example-Configuration-Profile" \
--location-uri "ssm-parameter://Example-Parameter" \
--retrieval-role-arn "arn:aws:iam::111122223333:role/Example-App-Config-Role"
Вывод:
{
"ApplicationId": "339ohji",
"Description": null,
"Id": "ur8hx2f",
"LocationUri": "ssm-parameter://Example-Parameter",
"Name": "Example-Configuration-Profile",
"RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role",
"Type": null,
"Validators": null
}
Для получения дополнительной информации см. раздел Шаг 3: Создание конфигурации и профиля конфигурации в руководстве пользователя AWS AppConfig.
Вывод
ApplicationId -> (строка)
Id -> (строка)
Name -> (строка)
Description -> (строка)
LocationUri -> (строка)
RetrievalRoleArn -> (строка)
LocationUri.Validators -> (список)
Список методов для проверки конфигурации.
(структура)
Ва́лидатор обеспечивает синтаксическую или семантическую проверку для обеспечения того, что конфигурация, которую вы хотите развернуть, работает как ожидается. Для проверки данных конфигурации приложения вы предоставляете схему или функцию Amazon Web Services Lambda, которая выполняется по отношению к конфигурации. Развёртывание или обновление конфигурации может быть продолжено только в случае валидности данных конфигурации. Дополнительную информацию можно найти в разделе Общие сведения о валидаторах в руководстве пользователя AppConfig.
Type -> (строка)
JSON_SCHEMA и LAMBDA
Content -> (строка)
Type -> (строка)
Тип конфигураций, содержащихся в профиле. AppConfig поддерживает feature flags и freeform конфигурации. Рекомендуется создавать конфигурации флагов функций для включения или выключения новых функций и свободные конфигурации для распространения конфигураций по приложению. При вызове данного API введите одно из следующих значений для Type :
AWS.AppConfig.FeatureFlags
AWS.Freeform
KmsKeyArn -> (строка)
hosted типов конфигурации. Чтобы зашифровать данные, управляемые в других хранилищах конфигураций, ознакомьтесь с документацией о том, как указать ключ KMS для конкретной службы.KmsKeyIdentifier -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.