Spec-Zone.ru › AWS CLI v2

[ aws . s3api ]

put-bucket-replication

Описание

Примечание

Данная операция не поддерживается для ведер-каталогов.

Создает конфигурацию репликации или заменяет существующую. Для получения дополнительной информации, см. Репликация в руководстве пользователя Amazon S3.

Укажите конфигурацию репликации в теле запроса. В конфигурации репликации вы указываете имя целевого ведра или ведер, где Amazon S3 должен реплицировать объекты, роль IAM, которую Amazon S3 может принять, чтобы реплицировать объекты от вашего имени, и другую соответствующую информацию. Вы можете вызвать этот запрос для конкретного региона Amazon Web Services, используя ключевое условие ` aws:RequestedRegion https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requestedregion`__.

Конфигурация репликации должна включать как минимум одно правило и может содержать максимум 1000. Каждое правило определяет подмножество объектов для репликации, фильтруя объекты в исходном ведре. Чтобы выбрать дополнительные подмножества объектов для репликации, добавьте правило для каждого подмножества.

Чтобы указать подмножество объектов в исходном ведре, к которому нужно применить правило репликации, добавьте элемент Filter в качестве дочернего элемента элемента Rule. Вы можете фильтровать объекты по префиксу имени ключа объекта, одному или нескольким тегам объекта или обоим. Когда вы добавляете элемент Filter в конфигурацию, вы также должны добавить следующие элементы: DeleteMarkerReplication , Status , и Priority .

Примечание

Если вы используете более раннюю версию конфигурации репликации, Amazon S3 обрабатывает репликацию маркеров удаления по-другому. Для получения дополнительной информации, см. Обратная совместимость.

Сведения об включении версии ведра см. в разделе Использование версиирования.

Обработка репликации зашифрованных объектов

По умолчанию Amazon S3 не реплицирует объекты, хранящиеся в режиме покоя с использованием шифрования на стороне сервера с ключами KMS. Чтобы реплицировать объекты, зашифрованные с помощью KMS Amazon Web Services, добавьте следующее: SourceSelectionCriteria , SseKmsEncryptedObjects , Status , EncryptionConfiguration , и ReplicaKmsKeyID . Сведения о конфигурации репликации см. в разделе Репликация объектов, созданных с помощью SSE с использованием ключей KMS.

Для получения информации об ошибках PutBucketReplication, см. Список кодов ошибок, связанных с репликацией.

Разрешения

Чтобы создать запрос PutBucketReplication, у вас должны быть s3:PutReplicationConfiguration разрешения для ведра.

По умолчанию владелец ресурса, в данном случае учетная запись Amazon Web Services, которая создала ведро, может выполнить эту операцию. Владелец ресурса также может предоставить другим разрешения на выполнение операции. Дополнительную информацию о разрешениях см. в разделах Указание разрешений в политике и Управление разрешениями доступа к вашим ресурсам Amazon S3.

Примечание

Для выполнения этой операции у пользователя или роли, выполняющей действие, должно быть разрешение iam:PassRole.

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

  • GetBucketReplication
  • DeleteBucketReplication

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

Синопсис

  put-bucket-replication
--bucket <value>
[--content-md5 <value>]
[--checksum-algorithm <value>]
--replication-configuration <value>
[--token <value>]
[--expected-bucket-owner <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]

Параметры

--bucket (строка)

Имя ведра

--content-md5 (строка)

Базовая 128-битная MD5 -сумма проверки данных в Base64 кодировке. Вы должны использовать этот заголовок в качестве проверки целостности сообщения, чтобы убедиться, что тело запроса не было повреждено при передаче. Дополнительную информацию см. в RFC 1864.

Для запросов, выполненных с помощью командной строки Amazon Web Services (CLI) или Amazon Web Services SDK, этот параметр вычисляется автоматически.

--checksum-algorithm (строка)

Указывает алгоритм, используемый для создания контрольной суммы запроса при использовании SDK. Этот заголовок не предоставит дополнительных функций, если вы не используете SDK. Если вы отправляете этот заголовок, необходимо также отправить соответствующий заголовок x-amz-checksum или x-amz-trailer. В противном случае Amazon S3 отклоняет запрос с кодом состояния HTTP 400 Bad Request . Дополнительную информацию см. в разделе Проверка целостности объекта в руководстве пользователя Amazon S3.

Если вы предоставляете отдельную контрольную сумму, Amazon S3 игнорирует предоставленный параметр ChecksumAlgorithm.

Возможные значения:

  • CRC32
  • CRC32C
  • SHA1
  • SHA256
  • CRC64NVME

--replication-configuration (структура)

Контейнер для правил репликации. Вы можете добавить до 1000 правил. Максимальный размер конфигурации репликации — 2 МБ.

Role -> (строка)

Идентификатор ресурса Amazon (ARN) роли управления доступом и безопасностью (IAM), которую Amazon S3 использует при репликации объектов. Дополнительную информацию см. в разделе «Настройка репликации» в руководстве пользователя Amazon S3.

Rules -> (список)

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

(структура)

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

ID -> (строка)

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

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

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

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

Prefix -> (строка)

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

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

Необходимо заменить ключи объектов, содержащие специальные символы (такие как возврат каретки), при использовании запросов XML. Дополнительную информацию см. в разделе «Ограничения ключей объектов, связанных с XML».

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

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

Prefix -> (строка)

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

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

Необходимо заменить ключи объектов, содержащие специальные символы (такие как возврат каретки), при использовании запросов XML. Дополнительную информацию см. в разделе «Ограничения ключей объектов, связанных с XML».

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

Контейнер для указания ключа и значения тега.

Правило применяется только к объектам, имеющим тег в их наборе тегов.

Key -> (строка)

Имя ключа объекта.

Value -> (строка)

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

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

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

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

Prefix -> (строка)

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

Tags -> (список)

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

(структура)

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

Key -> (строка)

Имя ключа объекта.

Value -> (строка)

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

Status -> (строка)

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

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

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

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

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

Status -> (строка)

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

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

Фильтр, который вы можете указать для выбора модификаций реплик. Amazon S3 по умолчанию не реплицирует модификации реплик. В последней версии конфигурации репликации (когда указан Filter), вы можете указать этот элемент и установить статус на Enabled, чтобы реплицировать модификации реплик.

Примечание

Если вы не укажете элемент Filter, Amazon S3 предположит, что конфигурация репликации — это предыдущая версия V1. В предыдущей версии этот элемент недопустим.

Status -> (строка)

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

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

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

Примечание

Этот параметр больше не поддерживается. Чтобы реплицировать существующие объекты, см. Репликация существующих объектов с помощью S3 Batch Replication в руководстве пользователя Amazon S3.

Status -> (строка)

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

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

Контейнер с информацией о пункте назначения репликации и его конфигурациях, включая включение S3 Replication Time Control (S3 RTC).

Bucket -> (строка)

Идентификатор ресурса Amazon (ARN) области, в которую вы хотите, чтобы Amazon S3 сохранил результаты.

Account -> (строка)

Идентификатор учетной записи владельца целевой области. В сценарии межсчётных операций, если вы направляете Amazon S3 на изменение владения репликой на учетную запись Amazon Web Services, владеющую целевой областью, указав свойство AccessControlTranslation, это идентификатор учетной записи владельца целевой области. Дополнительную информацию см. в разделе «Дополнительные конфигурации репликации: изменение владельца реплики» в руководстве пользователя Amazon S3.

StorageClass -> (строка)

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

Для допустимых значений см. элемент StorageClass действия PUT Bucket replication в справке по API Amazon S3.

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

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

Owner -> (строка)

Указывает владение репликой. Дополнительные сведения о значениях по умолчанию и допустимых значениях см. в разделе PUT bucket replication в справке по API Amazon S3.

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

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

ReplicaKmsKeyID -> (строка)

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

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

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

Status -> (строка)

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

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

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

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

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

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

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

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

Status -> (строка)

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

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

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

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

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

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

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

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

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

Примечание

Если вы используете более раннюю версию конфигурации репликации, Amazon S3 обрабатывает репликацию меток удаления иначе. Дополнительную информацию см. в разделе «Обратная совместимость».

Status -> (строка)

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

Примечание

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

Синтаксис JSON:

{
  "Role": "string",
  "Rules": [
    {
      "ID": "string",
      "Priority": integer,
      "Prefix": "string",
      "Filter": {
        "Prefix": "string",
        "Tag": {
          "Key": "string",
          "Value": "string"
        },
        "And": {
          "Prefix": "string",
          "Tags": [
            {
              "Key": "string",
              "Value": "string"
            }
            ...
          ]
        }
      },
      "Status": "Enabled"|"Disabled",
      "SourceSelectionCriteria": {
        "SseKmsEncryptedObjects": {
          "Status": "Enabled"|"Disabled"
        },
        "ReplicaModifications": {
          "Status": "Enabled"|"Disabled"
        }
      },
      "ExistingObjectReplication": {
        "Status": "Enabled"|"Disabled"
      },
      "Destination": {
        "Bucket": "string",
        "Account": "string",
        "StorageClass": "STANDARD"|"REDUCED_REDUNDANCY"|"STANDARD_IA"|"ONEZONE_IA"|"INTELLIGENT_TIERING"|"GLACIER"|"DEEP_ARCHIVE"|"OUTPOSTS"|"GLACIER_IR"|"SNOW"|"EXPRESS_ONEZONE",
        "AccessControlTranslation": {
          "Owner": "Destination"
        },
        "EncryptionConfiguration": {
          "ReplicaKmsKeyID": "string"
        },
        "ReplicationTime": {
          "Status": "Enabled"|"Disabled",
          "Time": {
            "Minutes": integer
          }
        },
        "Metrics": {
          "Status": "Enabled"|"Disabled",
          "EventThreshold": {
            "Minutes": integer
          }
        }
      },
      "DeleteMarkerReplication": {
        "Status": "Enabled"|"Disabled"
      }
    }
    ...
  ]
}

--token (строка)

Токен для включения Object Lock для существующей области.

--expected-bucket-owner (строка)

Идентификатор учетной записи, ожидаемый владелец области. Если указанный вами идентификатор учетной записи не соответствует фактическому владельцу области, запрос завершается с кодом HTTP-статуса 403 Forbidden (доступ запрещен).

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

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

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

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

Примеры

Примечание

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

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

Настройка репликации для корзины S3

Следующий put-bucket-replication пример применяет конфигурацию репликации к указанной корзине S3.

aws s3api put-bucket-replication \
    --bucket amzn-s3-demo-bucket1 \
    --replication-configuration file://replication.json

Содержание replication.json:

{
    "Role": "arn:aws:iam::123456789012:role/s3-replication-role",
    "Rules": [
        {
            "Status": "Enabled",
            "Priority": 1,
            "DeleteMarkerReplication": { "Status": "Disabled" },
            "Filter" : { "Prefix": ""},
            "Destination": {
                "Bucket": "arn:aws:s3:::amzn-s3-demo-bucket2"
            }
        }
    ]
}

Корзина назначения должна иметь включенную версионирование. Указанная роль должна иметь разрешение на запись в корзину назначения и иметь отношения доверия, которые разрешают Amazon S3 принять на себя роль.

Пример политики разрешений роли:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "s3:GetReplicationConfiguration",
                "s3:ListBucket"
            ],
            "Resource": [
                "arn:aws:s3:::amzn-s3-demo-bucket1"
            ]
        },
        {
            "Effect": "Allow",
            "Action": [
                "s3:GetObjectVersion",
                "s3:GetObjectVersionAcl",
                "s3:GetObjectVersionTagging"
            ],
            "Resource": [
                "arn:aws:s3:::amzn-s3-demo-bucket1/*"
            ]
        },
        {
            "Effect": "Allow",
            "Action": [
                "s3:ReplicateObject",
                "s3:ReplicateDelete",
                "s3:ReplicateTags"
            ],
            "Resource": "arn:aws:s3:::amzn-s3-demo-bucket2/*"
        }
    ]
}

Пример политики отношений доверия:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Principal": {
                "Service": "s3.amazonaws.com"
            },
            "Action": "sts:AssumeRole"
        }
    ]
}

Эта команда не выводит ничего.

Для получения дополнительной информации обратитесь к этой теме в Руководстве пользователя Amazon Simple Storage Service Console.

Вывод

Нет

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

Spec-Zone.ru

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