Модуль amazon.aws.s3_bucket_info — выводит список бакетов S3 в AWS

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить ее, используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.s3_bucket_info.

Добавлено в community.aws 1.0.0

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Выводит список бакетов S3 и сведения о них.
До выпуска версии 5.0.0 этот модуль назывался community.aws.aws_s3_bucket_info. Использование не изменилось.

Псевдонимы: aws_s3_bucket_info

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

python >= 3.6
boto3 >= 1.35.0
botocore >= 1.35.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key строка	Идентификатор ключа доступа 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 SDK botocore.
aws_ca_bundle путь	Путь к набору сертификатов CA, который используется для проверки SSL-сертификатов. Также можно использовать переменную окружения `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Список параметров приведен в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
bucket_facts словарь добавлено в amazon.aws 1.4.0	Получить подробные сведения о запрошенных бакетах S3. Каждый параметр bucket_X вызывает один API-вызов, поэтому множество параметров со значением `true` замедлит выполнение модуля. Ограничить список бакетов можно с помощью параметра `name` или `name_filter`.
bucket_accelerate_configuration логическое значение	Получить конфигурацию ускорения S3. Варианты: `false` ← (по умолчанию) `true`
bucket_acl логическое значение	Получить списки контроля доступа (ACL) бакета S3. Варианты: `false` ← (по умолчанию) `true`
bucket_cors логическое значение	Получить конфигурацию CORS бакета S3. Варианты: `false` ← (по умолчанию) `true`
bucket_encryption логическое значение	Получить настройки шифрования бакета S3. Варианты: `false` ← (по умолчанию) `true`
bucket_lifecycle_configuration логическое значение	Получить конфигурацию жизненного цикла бакета S3. Варианты: `false` ← (по умолчанию) `true`
bucket_location логическое значение	Получить расположение бакета S3. Варианты: `false` ← (по умолчанию) `true`
bucket_logging логическое значение	Получить настройки ведения журналов бакета S3. Варианты: `false` ← (по умолчанию) `true`
bucket_notification_configuration логическое значение	Получить конфигурацию уведомлений бакета S3. Варианты: `false` ← (по умолчанию) `true`
bucket_ownership_controls логическое значение	Получить параметры контроля владения бакетом S3. Варианты: `false` ← (по умолчанию) `true`
bucket_policy логическое значение	Получить политику бакета S3. Варианты: `false` ← (по умолчанию) `true`
bucket_policy_status логическое значение	Получить статус политики бакета S3. Варианты: `false` ← (по умолчанию) `true`
bucket_replication логическое значение	Получить настройки репликации бакета S3. Варианты: `false` ← (по умолчанию) `true`
bucket_request_payment логическое значение	Получить настройки оплаты запросов к бакету S3. Варианты: `false` ← (по умолчанию) `true`
bucket_tagging логическое значение	Получить теги бакета S3. Варианты: `false` ← (по умолчанию) `true`
bucket_versioning логическое значение добавлено в amazon.aws 7.3.0	Получить состояние версионирования бакета. Чтобы получить состояние версионирования бакета, необходимо быть его владельцем. Варианты: `false` ← (по умолчанию) `true`
bucket_website логическое значение	Получить параметры веб-сайта бакета S3. Варианты: `false` ← (по умолчанию) `true`
public_access_block логическое значение	Получить настройки блокировки публичного доступа к бакету S3. Варианты: `false` ← (по умолчанию) `true`
debug_botocore_endpoint_logs логическое значение	Использовать регистратор `botocore.endpoint` для разбора уникальных (а не общего количества) API-вызовов `"resource:action"`, выполненных в ходе задачи, и выводить полученный набор в ключ resource_actions результатов задачи. Используйте обработчик обратного вызова `aws_resource_action`, чтобы вывести общий список вызовов, выполненных в плейбуке. Также можно использовать переменную окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо стандартных конечных точек AWS. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения `AWS_URL`.
name строка добавлено в amazon.aws 1.4.0	Имя запрашиваемого бакета. По умолчанию: `""`
name_filter строка добавлено в amazon.aws 1.4.0	Ограничивает список бакетами, в именах которых содержится строка из `name_filter`. По умолчанию: `""`
profile псевдонимы: aws_profile строка	Именованный профиль 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.
region псевдонимы: aws_region строка	Регион AWS для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную окружения `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка	Секретный ключ доступа 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 строка	Токен сеанса 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 являются взаимоисключающими.
transform_location логическое значение добавлено в amazon.aws 1.4.0	Расположение бакета S3 в регионе us-east-1 по умолчанию обычно возвращается как `null`. Если задать этому параметру значение `true`, вместо этого будет возвращено `us-east-1`. Влияет только на запросы с параметрами `bucket_facts=true` и `bucket_facts.bucket_location=true`. Варианты: `false` ← (по умолчанию) `true`
validate_certs логическое значение	Если задано значение `false`, SSL-сертификаты при взаимодействии с API AWS проверяться не будут. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные окружения и файлы конфигурации считываются в контексте «узла» Ansible, а не «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются в контексте «контроллера» Ansible, а не «узла».
Используемый Ansible AWS SDK (boto3) также может считывать значения учетных данных и других параметров по умолчанию, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Note: Only AWS S3 is currently supported

# Lists all S3 buckets
- amazon.aws.s3_bucket_info:
  register: result

# Retrieve detailed bucket information
- amazon.aws.s3_bucket_info:
    # Show only buckets with name matching
    name_filter: your.testing
    # Choose facts to retrieve
    bucket_facts:
      # bucket_accelerate_configuration: true
      bucket_acl: true
      bucket_cors: true
      bucket_encryption: true
      # bucket_lifecycle_configuration: true
      bucket_location: true
      # bucket_logging: true
      # bucket_notification_configuration: true
      # bucket_ownership_controls: true
      # bucket_policy: true
      # bucket_policy_status: true
      # bucket_replication: true
      # bucket_request_payment: true
      # bucket_tagging: true
      # bucket_website: true
      # public_access_block: true
    transform_location: true
    register: result

# Print out result
- name: List buckets
  ansible.builtin.debug:
    msg: "{{ result['buckets'] }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
buckets complex	Список бакетов S3. Возвращается: всегда
bucket_accelerate_configuration dictionary	Конфигурация ускорения бакета. Возвращается: если `bucket_facts=true` и `buckets.bucket_accelerate_configuration=true`. Пример: `{"RequestCharged": "requester", "Status": "Enabled"}`
bucket_acl complex	Конфигурация ACL бакета. Возвращается: если `bucket_facts=true` и `buckets.bucket_acl=true`.
Grants list / elements=dictionary	Список разрешений ACL. Возвращается: при успешном выполнении Пример: `[{"Grantee": {"DisplayName": "abc-aws-root+721234567890", "ID": "1234567890cbc0f1234567890f1234567890c123456789012123456789091234", "Type": "CanonicalUser"}, "Permission": "FULL_CONTROL"}]`
Grantee dictionary	Лицо, которому предоставляются разрешения. Возвращается: при успешном выполнении
DisplayName string	Отображаемое имя получателя разрешения. Возвращается: при успешном выполнении
ID string	Канонический идентификатор пользователя — получателя разрешения. Возвращается: при успешном выполнении
Type string	Тип получателя разрешения. Возвращается: при успешном выполнении
Permission string	Указывает разрешение, предоставленное получателю. Возвращается: при успешном выполнении
Owner dictionary	Сведения о владельце бакета. Возвращается: при успешном выполнении Пример: `{"DisplayName": "abc-aws-root+721234567890", "ID": "1234567890cbc0f1234567890f1234567890c123456789012123456789091234"}`
DisplayName string	Отображаемое имя пользователя — владельца бакета. Возвращается: при успешном выполнении
ID string	Идентификатор пользователя — владельца бакета. Возвращается: при успешном выполнении
bucket_cors complex	Конфигурация CORS бакета. Возвращается: если `bucket_facts=true` и `buckets.bucket_cors=true`
CORSRules list / elements=string	Конфигурация CORS бакета. Возвращается: если для бакета заданы правила CORS Пример: `[]`
bucket_encryption complex	Конфигурация шифрования бакета. Возвращается: если `bucket_facts=true` и `buckets.bucket_encryption=true`. Пример: `{"ServerSideEncryptionConfiguration": {"Rules": [{"ApplyServerSideEncryptionByDefault": {"SSEAlgorithm": "AES256"}, "BucketKeyEnabled": true}]}}`
ServerSideEncryptionConfiguration complex	Конфигурация ServerSideEncryptionConfiguration. Возвращается: если шифрование включено для бакета.
Rules list / elements=dictionary	Список применённых правил шифрования. Возвращается: если шифрование включено для бакета.
ApplyServerSideEncryptionByDefault dictionary	Указывает шифрование на стороне сервера по умолчанию, применяемое к новым объектам в бакете. Возвращается: при успешном выполнении
KMSMasterKeyID string	Идентификатор клиентского ключа Amazon Web Services KMS (Key Management Service) для шифрования по умолчанию. Возвращается: при успешном выполнении
SSEAlgorithm string	Алгоритм шифрования на стороне сервера, используемый для шифрования по умолчанию. Возвращается: при успешном выполнении
BucketKeyEnabled boolean	Указывает, следует ли Amazon S3 использовать ключ бакета S3 при шифровании новых объектов в бакете на стороне сервера с помощью KMS (SSE-KMS). Возвращается: при успешном выполнении
bucket_lifecycle_configuration list / elements=dictionary	Параметры конфигурации жизненного цикла бакета. Возвращается: если `bucket_facts=true` и `buckets.bucket_lifecycle_configuration=true`.
Rules list / elements=string	Список правил управления жизненным циклом. Возвращается: если конфигурация жизненного цикла задана. Пример: `[{"ID": "example-rule", "Status": "Enabled"}]`
bucket_location dictionary	Расположение бакета. Возвращается: если `bucket_facts=true` и `buckets.bucket_location=true`. Пример: `{"LocationConstraint": "us-east-1"}`
LocationConstraint string	Регион AWS. Возвращается: всегда
bucket_logging complex	Конфигурация журналирования доступа к серверу. Возвращается: если `bucket_facts=true` и `buckets.bucket_logging=true`.
LoggingEnabled complex	Конфигурация журналирования доступа к серверу. Возвращается: если для бакета задано журналирование доступа к серверу.
TargetBucket string	Имя целевого бакета. Возвращается: всегда Пример: `"logging-bucket-name"`
TargetPrefix string	Префикс в целевом бакете. Возвращается: всегда Пример: `""`
bucket_name_filter string	Строка для фильтрации бакетов. См. name_filter. Возвращается: если задан параметр `name_filter` Пример: `"filter-by-this-string"`
bucket_notification_configuration complex	Параметры уведомлений бакета. Возвращается: если `bucket_facts=true` и `buckets.bucket_notification_configuration=true`.
TopicConfigurations list / elements=string	Список конфигураций событий уведомлений. Возвращается: если настроено хотя бы одно уведомление. Пример: `[{"Events": ["s3:ObjectCreated:Copy"], "Filter": {"Key": {"FilterRules": [{"Name": "Prefix", "Value": "test/"}]}}, "Id": "topic-config-dev001", "TopicArn": "arn:aws:sns:us-west-1:721234567890:sns-dev001-topic"}]`
bucket_ownership_controls complex	Настройки предпочтительного владельца объектов. Возвращается: если `bucket_facts=true` и `buckets.bucket_ownership_controls=true` Пример: `{"OwnershipControls": {"Rules": [{"ObjectOwnership": "BucketOwnerEnforced"}]}}`
OwnershipControls complex	Настройки владельца объектов. Возвращается: если для бакета заданы элементы управления владельцем.
Rules list / elements=string	Список правил владения. Возвращается: если задано правило владения.
bucket_policy string	Содержимое политики бакета. Возвращается: если `bucket_facts=true` и `buckets.bucket_policy=true`. Пример: `"{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"AddCannedAcl\",\"Effect\":\"Allow\",..}}]}"`
bucket_policy_status dictionary	Статус политики бакета. Возвращается: если `bucket_facts=true` и `buckets.bucket_policy_status=true`.
PolicyStatus dictionary	Статус политики бакета. Возвращается: если для бакета задана политика.
IsPublic boolean	Сообщает, является ли политика бакета общедоступной. Возвращается: если для бакета задана политика. Пример: `true`
bucket_replication complex	Параметры конфигурации репликации. Возвращается: если `bucket_facts=true` и `buckets.bucket_replication=true`.
Role string	Роль IAM, используемая для репликации. Возвращается: если задано правило репликации. Пример: `"arn:aws:iam::123:role/example-role"`
Rules list / elements=string	Список правил репликации. Возвращается: если задано правило репликации. Пример: `[{"Filter": "{}", "ID": "rule-1"}]`
bucket_request_payment complex	Настройка оплаты запрашивающим. Возвращается: если `bucket_facts=true` и `buckets.bucket_request_payment=true` Пример: `{"Payer": "BucketOwner"}`
Payer string	Текущая сторона, оплачивающая запросы. Возвращается: всегда
bucket_tagging dictionary	Теги бакета. Возвращается: если `bucket_facts=true` и `buckets.bucket_tagging=true`. Пример: `{"Tag1": "Value1", "Tag2": "Value2"}`
bucket_versioning dictionary добавлено в amazon.aws 7.2.0	Состояние версионирования бакета. Также указывается, включено ли удаление с MFA в конфигурации версионирования бакета, если для бакета настроено удаление с MFA. Возвращается: если `bucket_facts=true` и `buckets.bucket_versioning=true`. Пример: `{"Status": "Enabled"}`
bucket_website complex	Размещение статического веб-сайта. Возвращается: если `bucket_facts=true` и `buckets.bucket_website=true`.
ErrorDocument dictionary	Объект, используемый в качестве страницы ошибки HTTP. Возвращается: если размещение статического веб-сайта включено. Пример: `{"Key": "error.html"}`
IndexDocument dictionary	Объект, используемый в качестве индексной страницы HTTP. Возвращается: если размещение статического веб-сайта включено. Пример: `{"Suffix": "error.html"}`
RedirectAllRequestsTo complex	Параметры перенаправления веб-сайта. Возвращается: если настроено перенаправление запросов.

HostName string	Имя хоста для перенаправления. Возвращается: всегда Пример: `"www.example.com"`
Protocol string	Протокол, используемый для перенаправления. Возвращается: всегда Пример: `"https"`
creation_date string	Метка времени создания бакета. Возвращается: всегда Пример: `"2021-01-21T12:44:10+00:00"`
name string	Имя бакета. Возвращается: всегда Пример: `"a-testing-bucket-name"`
public_access_block dictionary	Конфигурация блокировки публичного доступа к бакету. Возвращается: когда `bucket_facts=true` и `buckets.public_access_block=true`. Пример: `{"PublicAccessBlockConfiguration": {"BlockPublicAcls": true, "BlockPublicPolicy": true, "IgnorePublicAcls": true, "RestrictPublicBuckets": true}}`
PublicAccessBlockConfiguration complex	Данные PublicAccessBlockConfiguration. Возвращается: если для бакета определён PublicAccessBlockConfiguration
BlockPublicAcls boolean	Значение параметра BlockPublicAcls. Возвращается: при успешном выполнении
BlockPublicPolicy boolean	Значение параметра BlockPublicPolicy. Возвращается: при успешном выполнении
IgnorePublicAcls boolean	Значение параметра IgnorePublicAcls. Возвращается: при успешном выполнении
RestrictPublicBuckets boolean	Значение параметра RestrictPublicBuckets. Возвращается: при успешном выполнении

Авторы

Gerben Geijteman (@hyperized)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/s3_bucket_info_module.html