Модуль amazon.aws.s3_bucket_info – Список ведер S3 в AWS

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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.26.0
botocore >= 1.29.0

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_key aliases: 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 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
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_facts dictionary добавлено в amazon.aws 1.4.0	Получение запрошенной подробной информации о бакете S3. Каждый параметр bucket_X выполняет один вызов API, поэтому установка многих параметров в значение `true` приведет к замедлению выполнения модуля. Вы можете ограничить бакеты, используя параметр `name` или `name_filter`.
bucket_accelerate_configuration boolean	Получить конфигурацию ускорения S3. Варианты: `false` ← (по умолчанию) `true`
bucket_acl boolean	Получить списки управления доступом (ACL) к бакетам S3. Варианты: `false` ← (по умолчанию) `true`
bucket_cors boolean	Получить конфигурацию CORS для бакетов S3. Варианты: `false` ← (по умолчанию) `true`
bucket_encryption boolean	Получить шифрование бакетов S3. Варианты: `false` ← (по умолчанию) `true`
bucket_lifecycle_configuration boolean	Получить конфигурацию жизненного цикла бакетов S3. Варианты: `false` ← (по умолчанию) `true`
bucket_location boolean	Получить расположение бакета S3. Варианты: `false` ← (по умолчанию) `true`
bucket_logging boolean	Получить ведение журнала для бакетов S3. Варианты: `false` ← (по умолчанию) `true`
bucket_notification_configuration boolean	Получить конфигурацию уведомлений для бакетов S3. Варианты: `false` ← (по умолчанию) `true`
bucket_ownership_controls boolean	Получить элементы управления владением S3. Варианты: `false` ← (по умолчанию) `true`
bucket_policy boolean	Получить политику бакета S3. Варианты: `false` ← (по умолчанию) `true`
bucket_policy_status boolean	Получить состояние политики бакета S3. Варианты: `false` ← (по умолчанию) `true`
bucket_replication boolean	Получить репликацию бакета S3. Варианты: `false` ← (по умолчанию) `true`

bucket_request_payment boolean	Получить данные о запрошенной оплате для ведра S3. Варианты: `false` ← (по умолчанию) `true`
bucket_tagging boolean	Получить теги для ведра S3. Варианты: `false` ← (по умолчанию) `true`
bucket_versioning boolean добавлен в amazon.aws 7.3.0	Получить состояние управления версиями ведра. Для получения состояния управления версиями ведра, необходимо быть владельцем ведра. Варианты: `false` ← (по умолчанию) `true`
bucket_website boolean	Получить веб-сайт ведра S3. Варианты: `false` ← (по умолчанию) `true`
public_access_block boolean	Получить параметры блокировки публичного доступа для ведра S3. Варианты: `false` ← (по умолчанию) `true`
debug_botocore_endpoint_logs boolean	Использовать логгер `botocore.endpoint` для анализа уникальных (а не общих) `"resource:action"` API-вызовов во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте `aws_resource_action` callback для вывода полного списка, созданного во время выполнения плейбука. Также можно использовать переменную окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
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.
name string добавлен в amazon.aws 1.4.0	Имя ведра для запроса. По умолчанию: `""`
name_filter string добавлен в amazon.aws 1.4.0	Ограничивает выбор ведром только теми, чьи имена содержат строку в `name_filter`. По умолчанию: `""`
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.
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.
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 для согласованности с AWS botocore SDK. Псевдоним 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.
transform_location boolean added in 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 boolean	При установке в `false`, сертификаты SSL не будут проверятся при общении с API AWS. Установка validate_certs=false категорически не рекомендуется; вместо этого, рассмотрите возможность установки aws_ca_bundle. Выбираемые значения: `false` `true` ← (по умолчанию)

Примечания

Примечание

Предупреждение: Для модулей переменные среды и файлы конфигурации считываются из контекста Ansible «хост» а не «контроллер». Поэтому файлы могут потребоваться скопировать явно на «хост». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста Ansible «контроллер», а не «хост».
AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих файлов конфигурации в контексте 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 сложный	Список ведер S3. Возвращаемое значение: всегда
bucket_accelerate_configuration словарь	Настройка ускорения для ведра. Возвращаемое значение: при `bucket_facts=true` и `buckets.bucket_accelerate_configuration=true`. Пример: `{"RequestCharged": "requester", "Status": "Enabled"}`
bucket_acl сложный	Настройка разрешений ведра. Возвращаемое значение: при `bucket_facts=true` и `buckets.bucket_acl=true`.
Grants список / элементы=словарь	Список разрешений ACL. Возвращаемое значение: успех Пример: `[{"Grantee": {"DisplayName": "abc-aws-root+721234567890", "ID": "1234567890cbc0f1234567890f1234567890c123456789012123456789091234", "Type": "CanonicalUser"}, "Permission": "FULL_CONTROL"}]`
Grantee словарь	Лицо, которому предоставляются разрешения. Возвращаемое значение: успех
DisplayName строка	Псевдоним пользователя получателя. Возвращаемое значение: успех
ID строка	Канонический идентификатор пользователя получателя. Возвращаемое значение: успех
Тип строка	Тип получателя. Возвращаемое значение: успех
Разрешение строка	Определяет разрешение, предоставленное получателю. Возвращаемое значение: успех
Владелец словарь	Информация о владельце ведра. Возвращаемое значение: успех Пример: `{"DisplayName": "abc-aws-root+721234567890", "ID": "1234567890cbc0f1234567890f1234567890c123456789012123456789091234"}`
DisplayName строка	Имя пользователя владельца ведра. Возвращаемое значение: успех
ID строка	Идентификатор пользователя владельца ведра. Возвращаемое значение: успех
bucket_cors сложный	Настройка CORS ведра. Возвращаемое значение: при `bucket_facts=true` и `buckets.bucket_cors=true`
CORSRules список / элементы=строка	Настройка CORS ведра. Возвращаемое значение: Если для ведра определены правила CORS Пример: `[]`
bucket_encryption сложный	Настройка шифрования ведра. Возвращаемое значение: при `bucket_facts=true` и `buckets.bucket_encryption=true`. Пример: `{"ServerSideEncryptionConfiguration": {"Rules": [{"ApplyServerSideEncryptionByDefault": {"SSEAlgorithm": "AES256"}, "BucketKeyEnabled": true}]}}`
ServerSideEncryptionConfiguration сложный	Настройка ServerSideEncryptionConfiguration. Возвращаемое значение: при включенном шифровании в ведре.
Rules список / элементы=словарь	Список примененных правил шифрования. Возвращаемое значение: при включенном шифровании в ведре.
ApplyServerSideEncryptionByDefault словарь	Указывает шифрование по умолчанию для новых объектов в ведре. Возвращаемое значение: успех
KMSMasterKeyID строка	Идентификатор ключа KMS Amazon Web Services для шифрования по умолчанию. Возвращаемое значение: успех

END_OF_DOCUMENT_MARKER

SSEAlgorithm string	Алгоритм шифрования на стороне сервера для использования в шифровании по умолчанию. Возвращается: success
BucketKeyEnabled boolean	Указывает, следует ли Amazon S3 использовать ключ хранилища S3 с шифрованием на стороне сервера с помощью KMS (SSE-KMS) для новых объектов в хранилище. Возвращается: success
bucket_lifecycle_configuration list / elements=dictionary	Параметры конфигурации жизненного цикла хранилища. Возвращается: when `bucket_facts=true` and `buckets.bucket_lifecycle_configuration=true`.
Rules list / elements=string	Список правил управления жизненным циклом. Возвращается: when lifecycle configuration is present. Пример: `[{"ID": "example-rule", "Status": "Enabled"}]`
bucket_location dictionary	Расположение хранилища. Возвращается: when `bucket_facts=true` and `buckets.bucket_location=true`. Пример: `{"LocationConstraint": "us-east-1"}`
LocationConstraint string	Регион AWS. Возвращается: always
bucket_logging complex	Конфигурация ведения журнала доступа к серверу. Возвращается: when `bucket_facts=true` and `buckets.bucket_logging=true`.
LoggingEnabled complex	Конфигурация ведения журнала доступа к серверу. Возвращается: when server access logging is defined for the bucket.
TargetBucket string	Имя целевого хранилища. Возвращается: always Пример: `"logging-bucket-name"`
TargetPrefix string	Префикс в целевом хранилище. Возвращается: always Пример: `""`
bucket_name_filter string	Строка, используемая для ограничения хранилищ. Смотрите name_filter. Возвращается: when `name_filter` is defined Пример: `"filter-by-this-string"`
bucket_notification_configuration complex	Параметры уведомлений хранилища. Возвращается: when `bucket_facts=true` and `buckets.bucket_notification_configuration=true`.
TopicConfigurations list / elements=string	Список конфигураций событий уведомлений. Возвращается: when at least one notification is configured. Пример: `[{"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	Предпочтительные параметры владения объектами. Возвращается: when `bucket_facts=true` and `buckets.bucket_ownership_controls=true` Пример: `{"OwnershipControls": {"Rules": [{"ObjectOwnership": "BucketOwnerEnforced"}]}}`
OwnershipControls complex	Параметры владения объектами. Возвращается: when ownership controls are defined for the bucket.
Rules list / elements=string	Список правил владения. Возвращается: when ownership rule is defined.
bucket_policy string	Содержимое политики хранилища. Возвращается: when `bucket_facts=true` and `buckets.bucket_policy=true`. Пример: `"{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"AddCannedAcl\",\"Effect\":\"Allow\",..}}]}"`
bucket_policy_status dictionary	Статус политики хранилища. Возвращается: when `bucket_facts=true` and `buckets.bucket_policy_status=true`.

PolicyStatus словарь	Статус политики ведра. Возвращается: при наличии политики ведра.
IsPublic булево	Отчёт о публичном статусе политики ведра. Возвращается: при наличии политики ведра. Пример: `true`
bucket_replication сложный	Настройки конфигурации репликации. Возвращается: когда `bucket_facts=true` и `buckets.bucket_replication=true`.
Role строка	IAM роль, используемая для репликации. Возвращается: при определении правила репликации. Пример: `"arn:aws:iam::123:role/example-role"`
Rules список / элементы=строка	Список правил репликации. Возвращается: при определении правила репликации. Пример: `[{"Filter": "{}", "ID": "rule-1"}]`
bucket_request_payment сложный	Настройка оплата запросом. Возвращается: когда `bucket_facts=true` и `buckets.bucket_request_payment=true` Пример: `{"Payer": "BucketOwner"}`
Payer строка	Текущий плательщик. Возвращается: всегда
bucket_tagging словарь	Теги ведра. Возвращается: когда `bucket_facts=true` и `buckets.bucket_tagging=true`. Пример: `{"Tag1": "Value1", "Tag2": "Value2"}`
bucket_versioning словарь добавлен в amazon.aws 7.2.0	Состояние ведения версий ведра. Это также укажет, включено ли MFA удаление в конфигурации ведения версий ведра. если только ведро было сконфигурировано с MFA удалением. Возвращается: когда `bucket_facts=true` и `buckets.bucket_versioning=true`. Пример: `{"Status": "Enabled"}`
bucket_website сложный	Хостинг статического веб-сайта. Возвращается: когда `bucket_facts=true` и `buckets.bucket_website=true`.
ErrorDocument словарь	Объект, используемый в качестве страницы ошибки HTTP. Возвращается: при включенном хостинге статического веб-сайта. Пример: `{"Key": "error.html"}`
IndexDocument словарь	Объект, используемый в качестве индексной страницы HTTP. Возвращается: при включенном хостинге статического веб-сайта. Пример: `{"Suffix": "error.html"}`
RedirectAllRequestsTo сложный	Настройки перенаправления веб-сайта. Возвращается: при конфигурировании перенаправления запросов.
HostName строка	Имя хоста для перенаправления. Возвращается: всегда Пример: `"www.example.com"`
Protocol строка	Протокол, используемый для перенаправления. Возвращается: всегда Пример: `"https"`
creation_date строка	Маркер времени создания ведра. Возвращается: всегда Пример: `"2021-01-21T12:44:10+00:00"`
name строка	Имя ведра. Возвращается: всегда Пример: `"a-testing-bucket-name"`

END_OF_DOCUMENT_MARKER

public_access_block словарь	Настройка блокировки публичного доступа к ведру. Возвращается: при `bucket_facts=true` и `buckets.public_access_block=true`. Пример: `{"PublicAccessBlockConfiguration": {"BlockPublicAcls": true, "BlockPublicPolicy": true, "IgnorePublicAcls": true, "RestrictPublicBuckets": true}}`
PublicAccessBlockConfiguration сложное	Данные PublicAccessBlockConfiguration. Возвращается: при определении PublicAccessBlockConfiguration для ведра
BlockPublicAcls булево	Значение настройки BlockPublicAcls. Возвращается: успешно
BlockPublicPolicy булево	Значение настройки BlockPublicPolicy. Возвращается: успешно
IgnorePublicAcls булево	Значение настройки IgnorePublicAcls. Возвращается: успешно
RestrictPublicBuckets булево	Значение настройки RestrictPublicBuckets. Возвращается: успешно

Авторы

Gerben Geijteman (@hyperized)

Ссылки на сборки

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