amazon.aws.ec2_vpc_igw_info модуль — Сбор информации об интернет-шлюзах в AWS
Примечание
Этот модуль является частью коллекции amazon.aws (версия 8.2.1).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.
Для использования в книге задач укажите: amazon.aws.ec2_vpc_igw_info.
Добавлена в amazon.aws 1.0.0
Описание
- Сбор информации об интернет-шлюзах в AWS.
Требования
Ниже приведены требования, необходимые на хосте, который выполняет этот модуль.
- python >= 3.6
- boto3 >= 1.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
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 и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
aws_ca_bundle path | Расположение пакета CA, используемого при проверке SSL-сертификатов. Переменная среды |
aws_config dictionary | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
convert_tags boolean добавлено в amazon.aws 1.3.0 | Преобразует теги из формата boto3 (список словарей) в стандартный формат словаря. До релиза 4.0.0 это значение по умолчанию было Варианты:
|
debug_botocore_endpoint_logs boolean | Использовать Переменная среды Варианты:
|
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string | URL для подключения вместо стандартных конечных точек AWS. Хотя это может использоваться для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только на AWS. Переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
filters dictionary | Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInternetGateways.html для возможных фильтров. Значение по умолчанию: |
internet_gateway_ids list / elements=string | Получить подробную информацию о конкретном ID шлюза Интернет. Укажите это значение в виде списка. |
profile aliases: aws_profile string | Именованный профиль AWS для использования для аутентификации. См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Переменная среды Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token. |
region aliases: aws_region, ec2_region string | Регион AWS для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, region игнорируется. Переменные среды См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
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. Переменные среды Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
session_token aliases: aws_session_token, security_token, aws_security_token, access_token строка | Токен сеанса AWS STS для использования с временными учетными данными. См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут использоваться переменные окружения Параметры 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. Поддержка переменных окружения |
validate_certs булево | При установке в Установка validate_certs=false категорически не рекомендуется; вместо этого рассмотрите установку aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные окружения и конфигурационные файлы читаются из контекста 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.
- name: Gather information about all Internet Gateways for an account or profile
amazon.aws.ec2_vpc_igw_info:
region: ap-southeast-2
profile: production
register: igw_info
- name: Gather information about a filtered list of Internet Gateways
amazon.aws.ec2_vpc_igw_info:
region: ap-southeast-2
profile: production
filters:
"tag:Name": "igw-123"
register: igw_info
- name: Gather information about a specific internet gateway by InternetGatewayId
amazon.aws.ec2_vpc_igw_info:
region: ap-southeast-2
profile: production
internet_gateway_ids: igw-c1231234
register: igw_info
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
changed булево | Истинно, если перечисление интернет-шлюзов прошло успешно. Возвращается: всегда Пример: |
internet_gateways сложное | Интернет-шлюзы для учетной записи. Возвращается: всегда |
|
attachments сложное |
Любые VPC, подключенные к интернет-шлюзу. Возвращается: всегда |
|
state строка |
Текущее состояние подключения. Возвращается: всегда Пример: |
|
vpc_id строка |
Идентификатор VPC. Возвращается: всегда Пример: |
|
internet_gateway_id строка |
Идентификатор интернет-шлюза. Возвращается: всегда Пример: |
|
tags словарь |
Любые метки, назначенные интернет-шлюзу. Возвращается: всегда Пример: |
Ссылки на сборку
© 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/ec2_vpc_igw_info_module.html