Spec-Zone.ru › AWS CLI v2

[ aws . docdb ]

создать-снимок-кластера-db

Описание

Создаёт снимок кластера.

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

Синтаксис

  create-db-cluster-snapshot
--db-cluster-snapshot-identifier <value>
--db-cluster-identifier <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]

Параметры

--db-cluster-snapshot-identifier (строка)

Идентификатор снимка кластера. Этот параметр хранится в нижнем регистре.

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

  • Должен содержать от 1 до 63 букв, цифр или дефисов.
  • Первый символ должен быть буквой.
  • Не может заканчиваться дефисом или содержать два дефиса подряд.

Пример: my-cluster-snapshot1

--db-cluster-identifier (строка)

Идентификатор кластера, для которого необходимо создать снимок. Этот параметр не чувствителен к регистру.

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

  • Должен соответствовать идентификатору существующего DBCluster .

Пример: my-cluster

--tags (список)

Теги, которые необходимо назначить снимку кластера.

(структура)

Метаданные, назначенные ресурсу Amazon DocumentDB, состоящие из пары ключ-значение.

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

Обязательное имя тега. Значение строки может содержать от 1 до 128 символов Юникода и не может начинаться с "aws: " или "rds: ". Строка может содержать только набор символов Юникода, цифр, пробелов, '_', '.', '/', '=', '+', '-' (регулярное выражение Java: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).

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

Необязательное значение тега. Значение строки может содержать от 1 до 256 символов Юникода и не может начинаться с "aws: " или "rds: ". Строка может содержать только набор символов Юникода, цифр, пробелов, '_', '.', '/', '=', '+', '-' (регулярное выражение Java: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).

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

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
  • текст
  • таблица
  • 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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

Создание ручного снимка кластера Amazon DocumentDB

Следующий create-db-cluster-snapshot пример создаёт снимок кластера Amazon DB с именем sample-cluster-snapshot.

aws docdb create-db-cluster-snapshot \
   --db-cluster-identifier sample-cluster \
   --db-cluster-snapshot-identifier sample-cluster-snapshot

Вывод:

{
    "DBClusterSnapshot": {
        "MasterUsername": "master-user",
        "SnapshotCreateTime": "2019-03-18T18:27:14.794Z",
        "AvailabilityZones": [
            "us-west-2a",
            "us-west-2b",
            "us-west-2c",
            "us-west-2d",
            "us-west-2e",
            "us-west-2f"
        ],
        "SnapshotType": "manual",
        "DBClusterSnapshotArn": "arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot",
        "EngineVersion": "3.6.0",
        "PercentProgress": 0,
        "DBClusterSnapshotIdentifier": "sample-cluster-snapshot",
        "Engine": "docdb",
        "DBClusterIdentifier": "sample-cluster",
        "Status": "creating",
        "ClusterCreateTime": "2019-03-15T20:29:58.836Z",
        "Port": 0,
        "StorageEncrypted": false,
        "VpcId": "vpc-91280df6"
    }
}

Дополнительную информацию см. в разделе Создание ручного снимка кластера в руководстве разработчика Amazon DocumentDB.

Вывод

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

Подробная информация о снимке кластера.

AvailabilityZones -> (список)

Предоставляет список Amazon EC2 зон доступности, в которых экземпляры в снимке кластера могут быть восстановлены.

(строка)

DBClusterSnapshotIdentifier -> (строка)

Указывает идентификатор снимка кластера.

DBClusterIdentifier -> (строка)

Указывает идентификатор кластера, из которого был создан этот снимок кластера.

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

Предоставляет время создания снимка в формате UTC.

Engine -> (строка)

Указывает имя базы данных.

Status -> (строка)

Указывает статус снимка кластера.

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

Указывает порт, на котором слушал кластер во время создания снимка.

VpcId -> (строка)

Предоставляет идентификатор виртуальной частной сети (VPC), связанный со снимком кластера.

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

Указывает время создания кластера в формате Universal Coordinated Time (UTC).

MasterUsername -> (строка)

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

EngineVersion -> (строка)

Предоставляет версию базы данных для этого снимка кластера.

SnapshotType -> (строка)

Предоставляет тип снимка кластера.

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

Указывает процент предполагаемых данных, которые были переданы.

StorageEncrypted -> (логическое значение)

Указывает, зашифрован ли снимок кластера.

KmsKeyId -> (строка)

Если StorageEncrypted равно true, идентификатор ключа KMS для зашифрованного снимка кластера.

DBClusterSnapshotArn -> (строка)

Amazon Resource Name (ARN) для снимка кластера.

SourceDBClusterSnapshotArn -> (строка)

Если снимок кластера был скопирован из исходного снимка кластера, ARN исходного снимка кластера; в противном случае, пустое значение.

StorageType -> (строка)

Тип хранилища, связанный со снимком кластера.

Дополнительную информацию о типах хранилищ для кластеров Amazon DocumentDB см. в разделе Настройки хранилища кластера в руководстве разработчика Amazon DocumentDB.

Допустимые значения для типа хранилища - standard | iopt1

Значение по умолчанию - standard

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

Spec-Zone.ru

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