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

accelerate_enabled

boolean

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

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

Ускорение передачи недоступно в AWS GovCloud (США).

См. 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, ec2_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 или EC2_ACCESS_KEY также могут использоваться в порядке убывания предпочтения.

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

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

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

acl

string

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

Заранее определенный ACL для применения к бакету.

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

Варианты:

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

aws_ca_bundle

path

Расположение пакета CA для использования при проверке 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 Bucket для SSE-KMS для новых объектов.

См. документацию AWS для получения дополнительной информации https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html.

Шифрование ключом Bucket поддерживается только если 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 для вывода в общий список, сделанный во время выполнения playbook.

Переменная среды 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

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

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

Варианты:

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

encryption_key_id

string

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

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

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

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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

Также могут использоваться переменные среды AWS_URL или EC2_URL, в порядке убывания приоритета.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

force

boolean

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

Варианты:

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

inventory

list / elements=dictionary

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

destination

dictionary / required

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

account_id

string

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

bucket

string / required

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

format

string / required

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

Варианты:

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

prefix

string

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

filter

string

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

id

string / required

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

included_object_versions

string / required

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

Варианты:

• "All"
• "Current"

optional_fields

list / elements=string

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

Варианты:

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

schedule

string / required

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

Варианты:

• "Daily"
• "Weekly"

name

string / required

Название корзины S3.

object_lock_default_retention

dictionary

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

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

Должно быть включено object_lock_enabled и установлено в True.

Политику хранения блокировки объектов нельзя удалить.

days

integer

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

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

mode

string / required

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

Варианты:

• "GOVERNANCE"
• "COMPLIANCE"

years

integer

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

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

object_lock_enabled

boolean

added in amazon.aws 5.3.0

Включить S3 Object Lock.

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

Варианты:

• false
• true

object_ownership

string

added in 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

aliases: 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 и security_token.

public_access

dictionary

added in amazon.aws 1.3.0

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

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

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

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

aliases: aws_region, ec2_region

string

Используемый регион AWS.

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

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

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

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

requester_pays

boolean

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

Варианты:

• false
• true

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_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, или EC2_SECRET_KEY в порядке убывания приоритета.

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

Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для соответствия SDK botocore AWS.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_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, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

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

Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0.

Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

state

string

Создать или удалить ведро S3.

Варианты:

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

tags

aliases: 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 / elements=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"}

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

Возвращаемое значение: при 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

Настройки блокировки публичного доступа к 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 delete в настройках версионирования ведра.

Возвращается: когда state=presnet и MFA Delete настроено в ведре.

Versioning

string

Состояние версионирования ведра.

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