Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

обновление-фреймворка

Описание

Обновляет указанный фреймворк.

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

Синтаксис

  update-framework
--framework-name <value>
[--framework-description <value>]
[--framework-controls <value>]
[--idempotency-token <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]

Параметры

--framework-name (строка)

Уникальное имя фреймворка. Длина имени должна быть от 1 до 256 символов, начинаться с буквы и содержать буквы (a-z, A-Z), цифры (0-9) и символы подчеркивания (_).

--framework-description (строка)

Необязательное описание фреймворка, максимальная длина 1024 символа.

--framework-controls (список)

Элементы управления, составляющие фреймворк. Каждый элемент управления в списке имеет имя, входные параметры и область действия.

(структура)

Содержит подробную информацию обо всех элементах управления фреймворка. Каждый фреймворк должен содержать по крайней мере один элемент управления.

ControlName -> (строка)

Имя элемента управления. Длина имени должна быть от 1 до 256 символов.

ControlInputParameters -> (список)

Список пар имя/значение.

(структура)

Параметры для элемента управления. Элемент управления может иметь ноль, одну или более параметров. Пример элемента управления с двумя параметрами: «частота планирования резервного копирования не менее daily, а срок хранения не менее 1 year». Первый параметр — daily. Второй параметр — 1 year.

ParameterName -> (строка)

Имя параметра, например, BackupPlanFrequency.

ParameterValue -> (строка)

Значение параметра, например, hourly.

ControlScope -> (структура)

Область действия элемента управления. Область действия элемента управления определяет, что будет оцениваться элементом управления. Три примера областей действия элемента управления: определенный план резервного копирования, все планы резервного копирования со специфической меткой или все планы резервного копирования.

Для получения дополнительной информации см. ` ControlScope . <https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ControlScope.html>`__

ComplianceResourceIds -> (список)

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

(строка)

ComplianceResourceTypes -> (список)

Описание того, включает ли область действия элемента управления один или несколько типов ресурсов, например, EFS или RDS.

(строка)

Tags -> (карта)

Пара пары ключ-значение тега, применённые к тем ресурсам Amazon Web Services, которые вы хотите использовать для запуска оценки правила. Максимально одна пара ключ-значение может быть предоставлена. Значение тега необязательно, но оно не может быть пустой строкой, если вы создаёте или редактируете фреймворк из консоли (хотя значение может быть пустой строкой, если включено в шаблон CloudFormation).

Структура для назначения тега: [{"Key":"string","Value":"string"}].

key -> (строка)

value -> (строка)

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

ControlName=string,ControlInputParameters=[{ParameterName=string,ParameterValue=string},{ParameterName=string,ParameterValue=string}],ControlScope={ComplianceResourceIds=[string,string],ComplianceResourceTypes=[string,string],Tags={KeyName1=string,KeyName2=string}} ...

Синтаксис JSON:

[
  {
    "ControlName": "string",
    "ControlInputParameters": [
      {
        "ParameterName": "string",
        "ParameterValue": "string"
      }
      ...
    ],
    "ControlScope": {
      "ComplianceResourceIds": ["string", ...],
      "ComplianceResourceTypes": ["string", ...],
      "Tags": {"string": "string"
        ...}
    }
  }
  ...
]

--idempotency-token (строка)

Выбранная пользователем строка, которую вы можете использовать для различения в противном случае идентичных вызовов UpdateFrameworkInput. Повторный вызов успешного запроса с тем же токеном идемпотенции приводит к сообщению об успехе без каких-либо действий.

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

Вывод

FrameworkName -> (строка)

Уникальное имя фреймворка. Длина имени должна быть от 1 до 256 символов, начинаться с буквы и содержать буквы (a-z, A-Z), цифры (0-9) и символы подчеркивания (_).

FrameworkArn -> (строка)

Amazon Resource Name (ARN), который однозначно идентифицирует ресурс. Формат ARN зависит от типа ресурса.

CreationTime -> (метка времени)

Дата и время создания фреймворка в формате ISO 8601. Значение CreationTime точное до миллисекунд. Например, 2020-07-10T15:00:00.000-08:00 — 10 июля 2020 года в 15:00, отстающие на 8 часов от UTC.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API