Spec-Zone.ru › AWS CLI v2

[ aws . docdb ]

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

Описание

Добавляет атрибут и значения к или удаляет атрибут и значения из ручного снимка кластера.

Чтобы поделиться ручным снимком кластера с другими учётными записями Amazon Web Services, укажите restore в качестве AttributeName и используйте параметр ValuesToAdd для добавления списка идентификаторов учётных записей Amazon Web Services, уполномоченных на восстановление ручного снимка кластера. Используйте значение all, чтобы сделать ручной снимок кластера общедоступным, то есть его можно копировать или восстанавливать все учётные записи Amazon Web Services. Не добавляйте значение all для любых снимков ручных кластеров, содержащих конфиденциальную информацию, которую вы не хотите предоставлять всем учётным записям Amazon Web Services. Если ручной снимок кластера зашифрован, он может быть общим, но только указав список идентификаторов учётных записей Amazon Web Services для параметра ValuesToAdd. В этом случае вы не можете использовать all в качестве значения для этого параметра.

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

Синтаксис

  modify-db-cluster-snapshot-attribute
--db-cluster-snapshot-identifier <value>
--attribute-name <value>
[--values-to-add <value>]
[--values-to-remove <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 (строка)

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

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

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

Для управления авторизацией других учётных записей Amazon Web Services для копирования или восстановления ручного снимка кластера установите это значение в restore .

--values-to-add (список)

Список атрибутов снимка кластера, которые необходимо добавить к атрибуту, указанному в AttributeName.

Чтобы разрешить другим учётным записям Amazon Web Services копировать или восстанавливать ручной снимок кластера, включите в этот список один или несколько идентификаторов учётных записей Amazon Web Services. Чтобы сделать ручной снимок кластера доступным для восстановления любой учётной записью Amazon Web Services, установите это значение в all. Не добавляйте значение all для любых снимков ручных кластеров, содержащих конфиденциальную информацию, которую вы не хотите предоставлять всем учётным записям Amazon Web Services.

(строка)

Синтаксис:

"string" "string" ...

--values-to-remove (список)

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

Чтобы отменить авторизацию других учётных записей Amazon Web Services для копирования или восстановления ручного снимка кластера, включите в этот список один или несколько идентификаторов учётных записей Amazon Web Services. Чтобы отменить авторизацию любой учётной записи Amazon Web Services для копирования или восстановления снимка кластера, установите это значение в all. Если вы укажете all, учётная запись Amazon Web Services, идентификатор которой явно добавлен в атрибут restore, по-прежнему может копировать или восстанавливать ручной снимок кластера.

(строка)

Синтаксис:

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

Примеры

Примечание

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

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

Пример 1: добавление атрибута к снимку Amazon DocumentDB

Следующий пример modify-db-cluster-snapshot-attribute добавляет четыре значения атрибута к снимку кластера Amazon DocumentDB.

aws docdb modify-db-cluster-snapshot-attribute \
    --db-cluster-snapshot-identifier sample-cluster-snapshot \
    --attribute-name restore \
    --values-to-add 123456789011 123456789012 123456789013

Вывод:

{
    "DBClusterSnapshotAttributesResult": {
        "DBClusterSnapshotAttributes": [
            {
                "AttributeName": "restore",
                "AttributeValues": [
                    "123456789011",
                    "123456789012",
                    "123456789013"
                ]
            }
        ],
        "DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
    }
}

Пример 2: удаление атрибутов из снимка Amazon DocumentDB

Следующий пример modify-db-cluster-snapshot-attribute удаляет два значения атрибута из снимка кластера Amazon DocumentDB.

aws docdb modify-db-cluster-snapshot-attribute \
    --db-cluster-snapshot-identifier sample-cluster-snapshot \
    --attribute-name restore \
    --values-to-remove 123456789012

Вывод:

{
    "DBClusterSnapshotAttributesResult": {
        "DBClusterSnapshotAttributes": [
            {
                "AttributeName": "restore",
                "AttributeValues": [
                    "123456789011",
                    "123456789013"
                ]
            }
        ],
        "DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
    }
}

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

Вывод

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

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

DBClusterSnapshotIdentifier -> (строка)

Идентификатор снимка кластера, к которому применяются атрибуты.

DBClusterSnapshotAttributes -> (список)

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

(структура)

Содержит имя и значения атрибута ручного снимка кластера.

Атрибуты ручного снимка кластера используются для авторизации других учётных записей Amazon Web Services для восстановления ручного снимка кластера.

AttributeName -> (строка)

Имя атрибута ручного снимка кластера.

Атрибут с именем restore относится к списку учётных записей Amazon Web Services, имеющих разрешение на копирование или восстановление ручного снимка кластера.

AttributeValues -> (список)

Значения для атрибута ручного снимка кластера.

Если поле AttributeName установлено в restore , то этот элемент возвращает список идентификаторов учётных записей Amazon Web Services, уполномоченных на копирование или восстановление ручного снимка кластера. Если значение all находится в списке, то ручной снимок кластера общедоступен и доступен для копирования или восстановления любой учётной записью Amazon Web Services.

(строка)

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

Spec-Zone.ru

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