Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

создать-снимок-кластера-баз-данных

Описание

Создает снимок кластера баз данных.

Дополнительную информацию об Amazon Aurora см. в разделе Что такое Amazon Aurora? в Руководстве пользователя Amazon Aurora.

Дополнительную информацию о кластерах баз данных Multi-AZ см. в разделе Развертывания кластеров баз данных Multi-AZ в Руководстве пользователя Amazon RDS.

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

Синтаксис

  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-cluster1-snapshot1

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

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

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

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

Пример: my-cluster1

--tags (список)

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

(структура)

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

Дополнительную информацию см. в разделе Использование тегов для ресурсов Amazon RDS в Руководстве пользователя Amazon RDS или в разделе Использование тегов для ресурсов Amazon Aurora и Amazon RDS в Руководстве пользователя Amazon Aurora.

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

Ключ — это требуемое имя тега. Значение строки может иметь длину от 1 до 128 символов Юникода и не может начинаться с aws: или rds:. Строка может содержать только набор символов Unicode, цифр, пробелов, «_», «.», «:», «/», «=», «+», «-», «@» (Java regex: «^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$»).

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

Значение — это необязательное значение тега. Значение строки может иметь длину от 1 до 256 символов Юникода и не может начинаться с aws: или rds:. Строка может содержать только набор символов Unicode, цифр, пробелов, «_», «.», «:», «/», «=», «+», «-», «@» (Java regex: «^([\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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

Для создания снимка кластера баз данных

Следующий create-db-cluster-snapshot пример создает снимок кластера баз данных.

aws rds create-db-cluster-snapshot \
    --db-cluster-identifier mydbcluster \
    --db-cluster-snapshot-identifier mydbclustersnapshot

Вывод:

{
    "DBClusterSnapshot": {
        "AvailabilityZones": [
            "us-east-1a",
            "us-east-1b",
            "us-east-1e"
        ],
        "DBClusterSnapshotIdentifier": "mydbclustersnapshot",
        "DBClusterIdentifier": "mydbcluster",
        "SnapshotCreateTime": "2019-06-18T21:21:00.469Z",
        "Engine": "aurora-mysql",
        "AllocatedStorage": 1,
        "Status": "creating",
        "Port": 0,
        "VpcId": "vpc-6594f31c",
        "ClusterCreateTime": "2019-04-15T14:18:42.785Z",
        "MasterUsername": "myadmin",
        "EngineVersion": "5.7.mysql_aurora.2.04.2",
        "LicenseModel": "aurora-mysql",
        "SnapshotType": "manual",
        "PercentProgress": 0,
        "StorageEncrypted": true,
        "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE",
        "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot",
        "IAMDatabaseAuthenticationEnabled": false
    }
}

Дополнительную информацию см. в разделе Создание снимка кластера баз данных в Руководстве пользователя Amazon Aurora.

Вывод

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

Содержит детали моментального снимка кластера баз данных Amazon RDS.

Этот тип данных используется в качестве элемента ответа в действии DescribeDBClusterSnapshots.

AvailabilityZones -> (список)

Список доступных зон (AZ), в которых можно восстановить экземпляры в моментальном снимке кластера баз данных.

(строка)

DBClusterSnapshotIdentifier -> (строка)

Идентификатор моментального снимка кластера баз данных.

DBClusterIdentifier -> (строка)

Идентификатор кластера баз данных, из которого был создан данный моментальный снимок кластера баз данных.

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

Время создания снимка в формате универсального времени координации (UTC).

Engine -> (строка)

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

EngineMode -> (строка)

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

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

Размер выделенного хранилища моментального снимка кластера баз данных в гигабайтах (GiB).

Status -> (строка)

Статус моментального снимка кластера баз данных. Допустимые статусы:

  • available
  • copying
  • creating

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

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

VpcId -> (строка)

Идентификатор VPC, связанный с моментальным снимком кластера баз данных.

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

Время создания кластера баз данных в формате универсального времени координации (UTC).

MasterUsername -> (строка)

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

EngineVersion -> (строка)

Версия движка базы данных для данного моментального снимка кластера баз данных.

LicenseModel -> (строка)

Информация о модели лицензии для данного моментального снимка кластера баз данных.

SnapshotType -> (строка)

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

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

Процент завершения передачи данных.

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

Указывает, зашифрован ли моментальный снимок кластера баз данных.

KmsKeyId -> (строка)

Если StorageEncrypted имеет значение true, идентификатор ключа KMS Amazon Web Services для зашифрованного моментального снимка кластера баз данных.

Идентификатор ключа KMS Amazon Web Services — это ARN ключа, идентификатор ключа, ARN псевдонима или имя псевдонима для ключа KMS.

DBClusterSnapshotArn -> (строка)

Amazon Resource Name (ARN) моментального снимка кластера баз данных.

SourceDBClusterSnapshotArn -> (строка)

Если моментальный снимок кластера баз данных был скопирован из исходного моментального снимка кластера баз данных, Amazon Resource Name (ARN) исходного моментального снимка кластера баз данных, иначе — значение null.

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

Указывает, включена ли возможность сопоставления учетных записей Amazon Web Services Identity and Access Management (IAM) с учетными записями баз данных.

TagList -> (список)

Список тегов.

Дополнительную информацию см. в разделе «Тегирование ресурсов Amazon RDS» в руководстве пользователя Amazon RDS или «Тегирование ресурсов Amazon Aurora и Amazon RDS» в руководстве пользователя Amazon Aurora.

(структура)

Метаданные, назначенные ресурсу Amazon RDS, представленные в виде пары ключ-значение.

Дополнительную информацию см. в разделе «Тегирование ресурсов Amazon RDS» в руководстве пользователя Amazon RDS или «Тегирование ресурсов Amazon Aurora и Amazon RDS» в руководстве пользователя Amazon Aurora.

Key -> (строка)

Ключ — это обязательное имя тега. Строковое значение может иметь длину от 1 до 128 символов Unicode и не может начинаться с aws: или rds:. Строка может содержать только набор Unicode-букв, цифр, пробелов, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

Value -> (строка)

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

DBSystemId -> (строка)

Зарезервировано для будущего использования.

StorageType -> (строка)

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

Эта настройка применяется только к кластерам баз данных Aurora.

DbClusterResourceId -> (строка)

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

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

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

Эта настройка применяется только к кластерам баз данных Multi-AZ, не являющимся кластерами Aurora.

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

Spec-Zone.ru

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