Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

создание-фреймворка

Описание

Создаёт фреймворк с одним или несколькими элементами управления. Фреймворк — это набор элементов управления, которые можно использовать для оценки ваших практик резервного копирования. Используя предварительно созданные настраиваемые элементы управления для определения ваших правил, вы можете оценить, соответствуют ли ваши практики резервного копирования вашим правилам и какие ресурсы ещё не соответствуют им.

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

Синтаксис

  create-framework
--framework-name <value>
[--framework-description <value>]
--framework-controls <value>
[--idempotency-token <value>]
[--framework-tags <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 -> (список)

ID единственного ресурса 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 (строка)

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

--framework-tags (карта)

Теги для назначения фреймворку.

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--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 зависит от типа ресурса.

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

Spec-Zone.ru

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