Spec-Zone.ru › AWS CLI v2

[ aws . opsworkscm ]

create-backup

Описание

Создает резервную копию сервера на уровне приложения. Пока сервер находится в состоянии BACKING_UP, его нельзя изменить и нельзя создать дополнительную резервную копию.

Резервные копии могут быть созданы для серверов в состояниях RUNNING, HEALTHY и UNHEALTHY. По умолчанию вы можете создать максимум 50 ручных резервных копий.

Данная операция является асинхронной.

Исключение LimitExceededException возникает, когда достигнуто максимальное количество ручных резервных копий. Исключение InvalidStateException возникает, когда сервер не находится ни в одном из следующих состояний: RUNNING, HEALTHY или UNHEALTHY. Исключение ResourceNotFoundException возникает, когда сервер не найден. Исключение ValidationException возникает, когда параметры запроса некорректны.

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

Синтаксис

  create-backup
--server-name <value>
[--description <value>]
[--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]

Параметры

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

Имя сервера, который вы хотите резервировать.

--description (строка)

Пользовательское описание резервной копии.

--tags (список)

Список тегов, содержащий ключи и значения тегов, которые необходимо прикрепить к резервной копии сервера AWS OpsWorks-CM.

  • Ключ не может быть пустым.
  • Ключ может содержать не более 127 символов и может содержать только буквы Unicode, цифры или разделители, или следующие специальные символы: + - = . _ : /
  • Значение может содержать не более 255 символов и может содержать только буквы Unicode, цифры или разделители, или следующие специальные символы: + - = . _ : /
  • Пробелы в начале и конце ключа и значения удаляются.
  • Допускается не более 50 пользовательских тегов для поддерживаемых тегами ресурсов AWS OpsWorks-CM.

(структура)

Список тегов, содержащий ключи и значения тегов, которые необходимо прикрепить к серверу AWS OpsWorks for Chef Automate или AWS OpsWorks for Puppet Enterprise. Пробелы в начале и конце ключа и значения удаляются. Допускается не более 50 пользовательских тегов для поддерживаемых тегами ресурсов AWS OpsWorks-CM.

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

Ключ тега, например, Stage или Name. Ключ тега не может быть пустым. Ключ может содержать не более 127 символов и может содержать только буквы Unicode, цифры или разделители, или следующие специальные символы: + - = . _ : /

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

Необязательное значение тега, например, Production или test-owcm-server. Значение может содержать не более 255 символов и может содержать только буквы Unicode, цифры или разделители, или следующие специальные символы: + - = . _ : /

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "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
  • text
  • таблица
  • 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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, 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.

Для создания резервных копий

Следующая команда AWS CLI запускает ручную резервную копию сервера Chef Automate с именем automate-06 в регионе us-east-1. Команда добавляет описательное сообщение к резервной копии в параметре --description.

aws opsworks-cm create-backup \
    --server-name 'automate-06' \
    --description "state of my infrastructure at launch"

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

Вывод:

{
    "Backups": [
        {
            "BackupArn": "string",
            "BackupId": "automate-06-20160729133847520",
            "BackupType": "MANUAL",
            "CreatedAt": 2016-07-29T13:38:47.520Z,
            "Description": "state of my infrastructure at launch",
            "Engine": "Chef",
            "EngineModel": "Single",
            "EngineVersion": "12",
            "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/automate-06-1010V4UU2WRM2",
            "InstanceType": "m4.large",
            "KeyPair": "",
            "PreferredBackupWindow": "",
            "PreferredMaintenanceWindow": "",
            "S3LogUrl": "https://s3.amazonaws.com/<bucket-name>/automate-06-20160729133847520",
            "SecurityGroupIds": [ "sg-1a24c270" ],
            "ServerName": "automate-06",
            "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role.1114810729735",
            "Status": "OK",
            "StatusDescription": "",
            "SubnetIds": [ "subnet-49436a18" ],
            "ToolsVersion": "string",
            "UserArn": "arn:aws:iam::1019881987024:user/opsworks-user"
        }
    ],
}

Для получения дополнительной информации см. раздел Создание резервных копий и восстановление сервера AWS OpsWorks for Chef Automate в руководстве пользователя AWS OpsWorks.

Вывод

Резервная копия -> (структура)

Резервная копия создана по запросу.

BackupArn -> (строка)

ARN резервной копии.

BackupId -> (строка)

Сгенерированный идентификатор резервной копии. Пример: myServerName-yyyyMMddHHmmssSSS

BackupType -> (строка)

Тип резервной копии. Допустимые значения - automated или manual.

CreatedAt -> (временная метка)

Временная метка создания резервной копии в базе данных. Пример: 2016-07-29T13:38:47.520Z

Description -> (строка)

Пользовательское описание ручной резервной копии. Для автоматических резервных копий это поле пустое.

Engine -> (строка)

Тип движка, полученный с сервера при создании резервной копии.

EngineModel -> (строка)

Модель движка, полученная с сервера при создании резервной копии.

EngineVersion -> (строка)

Версия движка, полученная с сервера при создании резервной копии.

InstanceProfileArn -> (строка)

ARN профиля EC2 экземпляра, полученного с сервера при создании резервной копии. Так как это значение сохраняется, вам не нужно предоставлять InstanceProfileArn повторно при восстановлении резервной копии.

InstanceType -> (строка)

Тип экземпляра, полученный с сервера при создании резервной копии.

KeyPair -> (строка)

Пара ключа, полученная с сервера при создании резервной копии.

PreferredBackupWindow -> (строка)

Предпочтительный период резервного копирования, полученный с сервера при создании резервной копии.

PreferredMaintenanceWindow -> (строка)

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

S3DataSize -> (целое число)

Это поле устарело и больше не используется.

S3DataUrl -> (строка)

Это поле устарело и больше не используется.

S3LogUrl -> (строка)

URL Amazon S3 для файла журнала резервной копии.

SecurityGroupIds -> (список)

Идентификаторы групп безопасности, полученные с сервера при создании резервной копии.

(строка)

ServerName -> (строка)

Имя сервера, с которого была создана резервная копия.

ServiceRoleArn -> (строка)

ARN роли службы, полученной с сервера при создании резервной копии.

Status -> (строка)

Статус резервной копии во время выполнения.

StatusDescription -> (строка)

Информационное сообщение о статусе резервной копии.

SubnetIds -> (список)

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

(строка)

ToolsVersion -> (строка)

Версия инструментов AWS OpsWorks CM, полученная с сервера при создании резервной копии.

UserArn -> (строка)

IAM ARN пользователя, запросившего ручную резервную копию. Для автоматических резервных копий это поле пустое.

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

Spec-Zone.ru

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