Spec-Zone.ru › AWS CLI v2

[ aws . s3control ]

get-bucket-replication

Описание

Примечание

Данная операция получает конфигурацию репликации ведра Amazon S3 на Outposts. Чтобы получить конфигурацию репликации ведра S3, см. GetBucketReplication в Справочнике по API Amazon S3 .

Возвращает конфигурацию репликации ведра S3 на Outposts. Дополнительную информацию об S3 на Outposts см. в Руководстве пользователя Amazon S3 . Информацию о конфигурации репликации S3 на Outposts см. в Руководстве пользователя Amazon S3 в разделе Репликация объектов для S3 на Outposts.

Примечание

Обработка запросов PUT или DELETE на получение конфигурации репликации может потребовать некоторое время для распространения на все системы S3 на Outposts. Поэтому конфигурация репликации, возвращаемая запросом GET сразу после запроса PUT или DELETE, может возвращать более свежие данные, чем те, которые находятся на Outpost. Если Outpost недоступен, задержка обновления конфигурации репликации на этом Outpost может быть значительной.

Для выполнения этой операции требуются разрешения на действие s3-outposts:GetReplicationConfiguration. Владелец ведра Outposts обладает этим разрешением по умолчанию и может предоставить его другим. Дополнительную информацию о разрешениях см. в Руководстве пользователя Amazon S3 в разделах Настройка IAM с S3 на Outposts и Управление доступом к ведру S3 на Outposts.

Все запросы Amazon S3 REST API на Outposts для этой операции требуют дополнительного параметра x-amz-outpost-id, который необходимо передавать в запросе. Кроме того, необходимо использовать префикс имени хоста конечной точки S3 на Outposts вместо s3-control. Пример синтаксиса запроса для Amazon S3 на Outposts, использующего префикс имени хоста конечной точки S3 на Outposts и значение x-amz-outpost-id, полученное с использованием ARN точки доступа, см. в разделе Примеры.

Если вы включаете элемент Filter в конфигурации репликации, необходимо также включить элементы DeleteMarkerReplication, Status и Priority. Эти элементы также будут возвращены в ответе.

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

Следующие операции связаны с GetBucketReplication :

  • PutBucketReplication
  • DeleteBucketReplication

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

Синтаксис

  get-bucket-replication
--account-id <value>
--bucket <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]

Параметры

--account-id (строка)

Идентификатор учетной записи Amazon Web Services для ведра Outposts.

--bucket (строка)

Указывает ведро, для которого нужно получить информацию о репликации.

Для использования этого параметра с Amazon S3 на Outposts с REST API необходимо указать имя и x-amz-outpost-id.

Для использования этого параметра с S3 на Outposts с Amazon Web Services SDK и CLI необходимо указать ARN ведра, доступ к которому осуществляется через формат arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name> . Например, для доступа к ведру reports через Outpost my-outpost, принадлежащем учетной записи 123456789012 в регионе us-west-2, используйте URL-кодирование arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. Значение должно быть URL-кодированным.

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

Вывод

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

Контейнер для одного или нескольких правил репликации. Конфигурация репликации должна содержать как минимум одно правило, и вы можете добавить до 100 правил. Максимальный размер конфигурации репликации составляет 128 КБ.

Role -> (строка)

Amazon Resource Name (ARN) роли управления доступом и идентификацией (IAM) учетной записи Amazon, которая используется S3 в Outposts при репликации объектов. Дополнительная информация о конфигурации репликации S3 в Outposts находится в руководстве по использованию Amazon S3.

Rules -> (список)

Контейнер для одного или нескольких правил репликации. Конфигурация репликации должна содержать как минимум одно правило и может содержать массив из не более чем 100 правил.

(структура)

Указывает, какие объекты S3 в Outposts нужно реплицировать и куда поместить копии.

ID -> (строка)

Уникальный идентификатор правила. Максимальное значение - 255 символов.

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

Приоритет указывает, какое правило имеет преимущество, когда два или более правил репликации конфликтуют. S3 в Outposts пытается реплицировать объекты по всем правилам репликации. Однако, если существует два или более правила с одинаковым целевым ведром Outposts, объекты будут реплицированы в соответствии с правилом с наивысшим приоритетом. Чем больше число, тем выше приоритет.

Дополнительную информацию можно найти в руководстве по использованию Amazon S3.

Prefix -> (строка)

Префикс имени ключа объекта, который определяет объект или объекты, к которым применяется правило. Максимальная длина префикса - 1024 символа. Чтобы включить все объекты в ведре Outposts, укажите пустую строку.

Предупреждение

При использовании XML-запросов необходимо заменить специальные символы (например, возврат каретки) в ключах объектов их эквивалентными кодами XML-сущностей. Дополнительную информацию можно найти в руководстве по использованию Amazon S3.

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

Фильтр, определяющий подмножество объектов, к которым применяется правило репликации. Элемент Filter должен содержать ровно один из элементов Prefix, Tag или And.

Prefix -> (строка)

Префикс имени ключа объекта, который определяет подмножество объектов, к которым применяется правило.

Предупреждение

При использовании XML-запросов необходимо заменить специальные символы (например, возврат каретки) в ключах объектов их эквивалентными кодами XML-сущностей. Дополнительную информацию можно найти в руководстве по использованию Amazon S3.

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

Контейнер для пары ключ-значение.

Key -> (строка)

Ключ тега

Value -> (строка)

Значение тега

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

Контейнер для указания фильтров правил. Фильтры определяют подмножество объектов, к которым применяется правило. Этот элемент требуется только если вы указали более одного фильтра. Например:

  • Если вы указали как фильтр Prefix, так и Tag, оберните эти фильтры в элемент And.
  • Если вы указали фильтр, основанный на нескольких тегах, оберните элементы Tag в элемент And.

Prefix -> (строка)

Префикс имени ключа объекта, который определяет подмножество объектов, к которым применяется правило.

Tags -> (список)

Массив тегов, содержащих пары ключ-значение.

(структура)

Контейнер для пары ключ-значение.

Key -> (строка)

Ключ тега

Value -> (строка)

Значение тега

Status -> (строка)

Указывает, включено ли правило.

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

Контейнер, описывающий дополнительные фильтры для определения исходных объектов Outposts, которые вы хотите реплицировать. Вы можете включить или выключить репликацию этих объектов.

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

Фильтр, который можно использовать для выбора объектов Amazon S3, зашифрованных с помощью шифрования на сервере с использованием ключей службы управления ключами (KMS). Если вы включили SourceSelectionCriteria в конфигурации репликации, этот элемент обязателен.

Примечание

Данный функционал не поддерживается ведрами Amazon S3 в Outposts.

Status -> (строка)

Указывает, реплицирует ли Amazon S3 объекты, созданные с шифрованием на сервере с использованием ключа KMS, хранящегося в службе управления ключами.

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

Фильтр, который можно использовать для указания того, включена ли синхронизация изменений реплики. Синхронизация изменений реплики в S3 в Outposts может помочь вам поддерживать синхронизацию метаданных объектов между репликами и исходными объектами. По умолчанию S3 в Outposts реплицирует метаданные из исходных объектов в реплики, только в одну сторону. При включенной синхронизации изменений реплики S3 в Outposts реплицирует изменения метаданных, внесённые в копии реплик, обратно в исходный объект, делая репликацию двунаправленной.

Для репликации изменений метаданных объектов в репликах можно указать этот элемент и установить Status этого элемента в значение Enabled.

Примечание

Для репликации изменений метаданных реплик между исходными объектами и репликами необходимо включить синхронизацию изменений реплики в исходных и целевых ведрах.

Status -> (строка)

Указывает, реплицирует ли S3 в Outposts изменения метаданных объектов в репликах.

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

Необязательная конфигурация для репликации существующих объектов исходного ведра.

Примечание

Данный функционал не поддерживается ведрами Amazon S3 в Outposts.

Status -> (строка)

Указывает, реплицирует ли Amazon S3 существующие объекты исходного ведра.

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

Контейнер для информации о целевом месте репликации и его конфигурациях.

Account -> (строка)

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

Bucket -> (строка)

Amazon Resource Name (ARN) точки доступа к целевому ведру, в котором вы хотите, чтобы S3 в Outposts хранил результаты репликации.

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

Контейнер, который определяет параметры S3 Replication Time Control (S3 RTC), включая включение S3 RTC и время, когда все объекты и операции с объектами должны быть реплицированы. Должен быть указан вместе с блоком Metrics.

Примечание

Данный функционал не поддерживается ведрами Amazon S3 в Outposts.

Status -> (строка)

Указывает, включен ли S3 Replication Time Control (S3 RTC).

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

Контейнер, который определяет время, к которому должна быть завершена репликация всех объектов и операций с объектами.

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

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

Допустимое значение: 15

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

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

Примечание

Данный функционал не поддерживается ведрами Amazon S3 в Outposts.

Owner -> (строка)

Указывает собственника реплики.

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

Контейнер, содержащий информацию о шифровании. Если указано SourceSelectionCriteria, вы должны указать этот элемент.

Примечание

Данный функционал не поддерживается ведрами Amazon S3 в Outposts.

ReplicaKmsKeyID -> (строка)

Указывает идентификатор управляемого пользователем ключа KMS, хранящегося в службе управления ключами (KMS) для целевого ведра. Этот идентификатор является либо Amazon Resource Name (ARN) для ключа KMS, либо алиасом ARN для ключа KMS. Amazon S3 использует этот ключ KMS для шифрования реплицированных объектов. Amazon S3 поддерживает только симметричные ключи KMS. Дополнительную информацию можно найти в руководстве по разработке Amazon Web Services Key Management Service.

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

Контейнер, определяющий параметры, связанные с метриками репликации.

Status -> (строка)

Указывает, включены ли метрики репликации.

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

Контейнер, который определяет временной порог для отправки события s3:Replication:OperationMissedThreshold.

Примечание

Данный функционал не поддерживается ведрами Amazon S3 в Outposts.

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

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

Допустимое значение: 15

StorageClass -> (строка)

Класс хранения, который следует использовать при репликации объектов. Все объекты, хранящиеся в S3 в Outposts, хранятся в классе хранения OUTPOSTS. S3 в Outposts использует класс хранения OUTPOSTS для создания реплик объектов.

Примечание

Значения, отличные от OUTPOSTS, не поддерживаются Amazon S3 в Outposts.

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

Указывает, реплицирует ли S3 в Outposts метки удаления. Если вы указываете элемент Filter в конфигурации репликации, вы также должны указать элемент DeleteMarkerReplication. Если ваш элемент Filter включает элемент Tag, элемент DeleteMarkerReplication должен содержать дочерний элемент Status со значением Disabled, поскольку S3 в Outposts не поддерживает репликацию меток удаления для правил, основанных на тегах.

Дополнительную информацию о репликации меток удаления можно найти в руководстве по использованию Amazon S3.

Status -> (строка)

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

Bucket -> (строка)

Amazon Resource Name (ARN) точки доступа к исходному ведру Outposts, из которого S3 в Outposts нужно реплицировать объекты.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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