Модуль amazon.aws.s3_bucket — управление бакетами S3 в AWS, DigitalOcean, Ceph, Walrus, FakeS3 и StorageGRID

accelerate_enabled

boolean

добавлено в amazon.aws 8.1.0

Включает Amazon S3 Transfer Acceleration: отправляемые данные будут передаваться в Amazon S3 по оптимизированному сетевому маршруту.

Transfer Acceleration недоступна в AWS GovCloud (US).

См. https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/govcloud-s3.html#govcloud-S3-diffs.

Варианты:

• false
• true

access_key

псевдонимы: aws_access_key_id, aws_access_key

string

Идентификатор ключа доступа AWS.

Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные окружения AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY в порядке убывания предпочтительности.

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.

account_regional

boolean

добавлено в amazon.aws 11.3.0

Определяет, будет ли бакет создан в пространстве имён аккаунта и региона вместо глобального пространства имён.

Если установлено значение true, имя бакета должно соответствовать формату prefix-accountId-region-an.

Можно задать только при создании бакета. Для существующих бакетов изменить нельзя.

Не поддерживается для бакетов каталогов.

Требуется botocore >= 1.42.67

Варианты:

• false
• true

acl

string

добавлено в amazon.aws 3.1.0

Предустановленный ACL, применяемый к бакету.

Если для владельца бакета используется параметр принудительного применения в настройках S3 Object Ownership, ACL отключаются и больше не влияют на разрешения.

Если для параметра public_access.ignore_public_acls=true установить значение acl, отличное от private, запрос может завершиться успешно, но не оказать влияния.

Варианты:

• "private"
• "public-read"
• "public-read-write"
• "authenticated-read"

aws_ca_bundle

path

Путь к пакету сертификатов центра сертификации, используемому для проверки сертификатов SSL.

Также можно использовать переменную окружения AWS_CA_BUNDLE.

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Параметры приведены в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

bucket_key_enabled

boolean

добавлено в amazon.aws 4.1.0

Включает ключи бакета S3 для SSE-KMS у новых объектов.

Дополнительные сведения см. в документации AWS: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html.

Шифрование с помощью ключа бакета поддерживается только если encryption=aws:kms.

Варианты:

• false
• true

ceph

псевдонимы: rgw

boolean

Включает совместимость API с Ceph RGW.

По возможности модуль работает одинаково, учитывая подмножество API S3, поддерживаемое Ceph.

Требуется endpoint_url, если ceph=true.

Варианты:

• false ← (по умолчанию)
• true

debug_botocore_endpoint_logs

boolean

Использует регистратор botocore.endpoint для анализа уникальных (а не общего числа) вызовов API "resource:action", выполненных во время задачи, и записывает этот набор в ключ resource_actions результатов задачи. Используйте обработчик обратного вызова aws_resource_action, чтобы вывести общий список вызовов, выполненных в ходе плейбука.

Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

• false ← (по умолчанию)
• true

delete_object_ownership

boolean

добавлено в amazon.aws 2.0.0

Удаляет параметры управления владельцем бакета.

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

Варианты:

• false ← (по умолчанию)
• true

delete_public_access

boolean

добавлено в amazon.aws 1.3.0

Удаляет конфигурацию блокировки публичного доступа к бакету.

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

Варианты:

• false ← (по умолчанию)
• true

dualstack

boolean

добавлено в amazon.aws 6.0.0

Включает конечные точки Amazon S3 Dual-Stack, позволяя обмениваться данными с S3 через IPv4 и IPv6.

Несовместим с endpoint_url.

Варианты:

• false ← (по умолчанию)
• true

encryption

string

Задает шифрование на стороне сервера по умолчанию для новых объектов в бакете. Чтобы отключить шифрование на стороне сервера, явно укажите для encryption значение «none».

Примечание. С января 2023 года Amazon S3 не поддерживает отключение шифрования в бакетах S3.

Варианты:

• "none"
• "AES256"
• "aws:kms"

encryption_key_id

string

Идентификатор главного ключа KMS для шифрования по умолчанию.

Если параметр не указан, будет использоваться предоставленный AWS ключ KMS.

Этот параметр поддерживается только если encryption — aws:kms.

endpoint_url

псевдонимы: aws_endpoint_url

string

URL для подключения вместо конечных точек AWS по умолчанию. Этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, однако коллекции amazon.aws и community.aws проходят тестирование только с AWS.

Также можно использовать переменную окружения AWS_URL.

force

boolean

При удалении бакета сначала удаляет все ключи (включая версии и маркеры удаления) из бакета. Для успешного удаления бакет S3 должен быть пустым.

Варианты:

• false ← (по умолчанию)
• true

inventory

list / элементы=dictionary

Включает S3 Inventory — ежедневное или еженедельное сохранение списка объектов бакета S3 и соответствующих им метаданных.

destination

dictionary / обязательный

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

account_id

string

Идентификатор аккаунта, которому принадлежит целевой бакет S3. Если идентификатор аккаунта не указан, владелец не проверяется перед экспортом данных.

bucket

string / обязательный

Имя ресурса Amazon (ARN) бакета, в который будут публиковаться результаты инвентаризации.

format

string / обязательный

Задает формат выходных данных результатов инвентаризации.

Варианты:

• "CSV"
• "ORC"
• "Parquet"

prefix

string

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

filter

string

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

id

string / обязательный

Идентификатор конфигурации инвентаризации.

included_object_versions

string / обязательный

Версии объектов, включаемые в список инвентаризации. Если задано значение All, список включает все версии объектов, а также связанные с версиями поля VersionId, IsLatest и DeleteMarker. Если задано значение Current, эти поля, связанные с версиями, в список не включаются.

Варианты:

• "All"
• "Current"

optional_fields

list / элементы=string

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

Варианты:

• "Size"
• "LastModifiedDate"
• "StorageClass"
• "ETag"
• "IsMultipartUploaded"
• "ReplicationStatus"
• "EncryptionStatus"
• "ObjectLockRetainUntilDate"
• "ObjectLockMode"
• "ObjectLockLegalHoldStatus"
• "IntelligentTieringAccessTier"
• "BucketKeyStatus"
• "ChecksumAlgorithm"
• "ObjectAccessControlList"
• "ObjectOwner"

schedule

string / обязательный

Задает расписание формирования результатов инвентаризации.

Варианты:

• "Daily"
• "Weekly"

logging

dictionary

добавлено в amazon.aws 11.3.0

Настраивает ведение журналов бакета S3 для отслеживания запросов на доступ к бакету.

Чтобы отключить ведение журналов, явно задайте для logging.target_bucket пустую строку.

Примечание. Для целевого бакета необходимо настроить соответствующие разрешения. Этот модуль НЕ настраивает ACL целевого бакета автоматически. Сведения о необходимых разрешениях см. в документации AWS.

target_bucket

string / обязательный

Имя бакета, в котором Amazon S3 должен хранить файлы журнала доступа к серверу.

target_prefix

string

Префикс для всех ключей объектов журнала.

По умолчанию: ""

name

string / обязательный

Имя бакета S3.

object_lock_default_retention

dictionary

добавлено в amazon.aws 8.1.0

Конфигурация Object Lock по умолчанию, применяемая к каждому новому объекту, помещенному в указанный бакет.

Необходимо включить object_lock_enabled и задать для него значение True.

Политику хранения Object Lock нельзя удалить.

days

integer

Количество дней, задаваемое для периода хранения по умолчанию.

Взаимоисключающий параметр с object_lock_default_retention.years.

mode

string / обязательный

Тип режима хранения.

Варианты:

• "GOVERNANCE"
• "COMPLIANCE"

years

integer

Количество лет, задаваемое для периода хранения по умолчанию.

Взаимоисключающий параметр с object_lock_default_retention.days.

object_lock_enabled

boolean

добавлено в amazon.aws 5.3.0

Определяет, будет ли включена функция S3 Object Lock.

При создании нового бакета по умолчанию используется значение false.

Варианты:

• false
• true

object_ownership

string

добавлено в amazon.aws 2.0.0

Настраивает управление владельцем бакета.

BucketOwnerEnforced — ACL отключены и больше не влияют на разрешения доступа к бакету. Запросы на установку или обновление ACL завершаются ошибкой. Однако запросы на чтение ACL поддерживаются. Владелец бакета получает полное владение и контроль. Автор загрузки объекта больше не получает полного владения и контроля.

BucketOwnerPreferred — Владельцем объектов, загруженных в бакет с предустановленным ACL bucket-owner-full-control, становится владелец бакета.

ObjectWriter — Загружающий аккаунт будет владельцем объекта, если объект загружен с предустановленным ACL bucket-owner-full-control.

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

BucketOwnerEnforced добавлен в версии 3.2.0.

Примечание. В конце апреля 2023 года Amazon обновила значение по умолчанию на BucketOwnerEnforced.

Варианты:

• "BucketOwnerEnforced"
• "BucketOwnerPreferred"
• "ObjectWriter"

policy

json

Политика JSON в виде строки. Укажите строку "null", чтобы принудительно удалить политику.

profile

псевдонимы: aws_profile

string

Именованный профиль AWS для аутентификации.

Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также можно использовать переменную окружения AWS_PROFILE.

Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и session_token.

public_access

dictionary

добавлено в amazon.aws 1.3.0

Настраивает блокировку публичного доступа к бакету S3.

Этот параметр нельзя использовать вместе с delete_public_access.

Примечание. В конце апреля 2023 года Amazon обновила настройки по умолчанию, включив блокировку публичного доступа. Несмотря на то, что значения по умолчанию этого модуля не изменились, для включения ACL публичного доступа необходимо явно передать параметр public_access.

block_public_acls

boolean

Задает значение BlockPublicAcls.

Варианты:

• false ← (по умолчанию)
• true

block_public_policy

boolean

Задает значение BlockPublicPolicy.

Варианты:

• false ← (по умолчанию)
• true

ignore_public_acls

boolean

Задает значение IgnorePublicAcls.

Варианты:

• false ← (по умолчанию)
• true

restrict_public_buckets

boolean

Задает значение RestrictPublicAcls.

Варианты:

• false ← (по умолчанию)
• true

purge_tags

boolean

Если purge_tags=true и задан параметр tags, существующие теги ресурса будут удалены, чтобы их набор точно соответствовал указанному в параметре tags.

Если параметр tags не задан, теги не будут изменены, даже если purge_tags=True.

Ключи тегов, начинающиеся с aws:, зарезервированы Amazon и не могут быть изменены. Поэтому они игнорируются при обработке параметра purge_tags. Дополнительную информацию см. в документации Amazon: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.

Варианты:

• false
• true ← (по умолчанию)

region

псевдонимы: aws_region

string

Регион AWS, который следует использовать.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

Также можно использовать переменную среды AWS_REGION.

Дополнительную информацию см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

requester_pays

boolean

В бакетах с оплатой со стороны запрашивающего стоимость запроса и загрузки данных из бакета оплачивает запрашивающий, а не владелец бакета.

Варианты:

• false
• true

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key

string

Секретный ключ доступа AWS.

Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные среды AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY в порядке убывания приоритета.

Параметры secret_key и profile являются взаимоисключающими.

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS SDK botocore.

session_token

псевдонимы: aws_session_token

string

Токен сеанса AWS STS для использования с временными учетными данными.

Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменную среды AWS_SESSION_TOKEN.

Параметры session_token и profile являются взаимоисключающими.

state

string

Создать или удалить бакет S3.

Варианты:

• "present" ← (по умолчанию)
• "absent"

tags

псевдонимы: resource_tags

dictionary

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

Если параметр tags не задан, теги не будут изменены.

validate_bucket_name

boolean

добавлен в amazon.aws 3.1.0

Следует ли проверять соответствие имени бакета правилам именования AWS S3.

По умолчанию включено; параметр можно отключить для серверных частей S3, которые не применяют эти правила.

См. https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html.

Варианты:

• false
• true ← (по умолчанию)

validate_certs

boolean

Если задано значение false, SSL-сертификаты при взаимодействии с API AWS проверяться не будут.

Настоятельно не рекомендуется устанавливать validate_certs=false; вместо этого рассмотрите возможность задать aws_ca_bundle.

Варианты:

• false
• true ← (по умолчанию)

versioning

boolean

Включено ли управление версиями (обратите внимание: после включения управление версиями можно только приостановить).

Варианты:

• false
• true

accelerate_enabled

boolean

Состояние ускорения бакета S3.

Возвращается: state=present

Пример: true

acl

dictionary

Предустановленный ACL бакета S3.

Возвращается: если state=present.

Пример: "public-read"

bucket_inventory

list / элементы=string

Конфигурация инвентаризации бакета S3.

Возвращается: если state=present

Пример: [{"Destination": {"S3BucketDestination": {"Bucket": "arn:aws:s3:::9c2a337ba5fd64de777f499441f83093-inventory-target", "Format": "CSV"}}, "Id": "9c2a337ba5fd64de777f499441f83093-inventory-target", "IncludedObjectVersions": "All", "IsEnabled": true, "OptionalFields": [], "Schedule": {"Frequency": "Daily"}}]

encryption

dictionary

Шифрование объектов бакета S3 на стороне сервера.

Возвращается: если state=present

Пример: {"SSEAlgorithm": "AES256"}

logging

dictionary

Конфигурация журналирования бакета S3.

Возвращается: если state=present

Пример: {"target_bucket": "my-logging-bucket", "target_prefix": "logs/"}

name

string

Имя бакета.

Возвращается: если state=present

Пример: "a-testing-bucket-name"

object_lock_default_retention

dictionary

Политика хранения объектов с блокировкой в бакете S3.

Возвращается: если state=present

Пример: {"Days": 1, "Mode": "GOVERNANCE", "Years": 0}

object_lock_enabled

boolean

Включена ли блокировка объектов S3.

Возвращается: если state=present

Пример: false

object_ownership

string

Настройки владения объектами бакета S3.

Возвращается: если state=present

Пример: "BucketOwnerPreferred"

policy

dictionary

Политика бакета S3.

Возвращается: если state=present

Пример: {"Statement": [{"Action": "s3:GetObject", "Effect": "Allow", "Principal": "*", "Resource": "arn:aws:s3:::2d3ce10a8210d36d6b4d23b822892074complex/*", "Sid": "AddPerm"}], "Version": "2012-10-17"}

public_access_block

dictionary

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

Возвращается: если state=present

Пример: {"PublicAccessBlockConfiguration": {"BlockPublicAcls": true, "BlockPublicPolicy": true, "IgnorePublicAcls": true, "RestrictPublicBuckets": true}}

PublicAccessBlockConfiguration

dictionary

Конфигурация PublicAccessBlock, действующая в данный момент для этого бакета Amazon S3.

Возвращается: при успешном выполнении

BlockPublicAcls

boolean

Указывает, следует ли Amazon S3 блокировать списки управления доступом (ACL), предоставляющие публичный доступ к этому бакету и его объектам.

Возвращается: при успешном выполнении

BlockPublicPolicy

boolean

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

Возвращается: при успешном выполнении

IgnorePublicAcls

boolean

Указывает, следует ли Amazon S3 игнорировать публичные ACL для этого бакета и его объектов.

Возвращается: при успешном выполнении

RestrictPublicBuckets

boolean

Указывает, следует ли Amazon S3 ограничивать публичные политики бакета для этого бакета.

Возвращается: при успешном выполнении

requester_pays

boolean

Указывает, что плата за запрос успешно списана с запрашивающего.

Возвращается: если state=present

Пример: true

tags

dictionary

Теги бакета S3.

Возвращается: если state=present

Пример: {"Tag1": "tag1", "Tag2": "tag2"}

versioning

dictionary

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

Возвращается: если state=present

Пример: {"MfaDelete": "Disabled", "Versioning": "Enabled"}

MfaDelete

string

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

Возвращается: если state=presnet и для бакета настроен MfaDelete.

Versioning

string

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

Возвращается: всегда