amazon.aws.rds_option_group_info модуль – rds_option_group_info модуль
Примечание
Этот модуль является частью коллекции amazon.aws (версия 8.2.1).
У вас может быть уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить ее, используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля потребуются дополнительные требования, см. Требования для получения подробностей.
Для использования в плейбуке, укажите: amazon.aws.rds_option_group_info.
Новое в amazon.aws 5.0.0
Обзор
- Сбор информации о группах параметров RDS.
- Этот модуль был первоначально добавлен в
community.awsв релизе 2.1.0.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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. |
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. Поддержка переменной среды |
engine_name string | Фильтры списка групп опций, чтобы включать только группы, связанные с определенным механизмом базы данных. Значение по умолчанию: |
major_engine_version string | Фильтры списка групп опций, чтобы включать только группы, связанные с определенной версией механизма базы данных. Если указано, то Значение по умолчанию: |
marker string | Если этот параметр указан, ответ включает только записи после маркера, до значения, указанного Допустимые значения находятся между |
max_records integer | Максимальное количество записей, которые нужно включить в ответ. Значение по умолчанию: |
option_group_name string | Имя группы опций для описания. Не может быть указано вместе с Значение по умолчанию: |
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 для согласованности с SDK AWS botocore. Алиас 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. Также могут быть использованы переменные среды Параметры 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 boolean | При установке в Настройка validate_certs=false категорически не рекомендуется; в качестве альтернативы, рассмотрите возможность настройки aws_ca_bundle вместо этого. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible ‘host’, а не ‘controller’. Поэтому файлы могут потребоваться явно скопировать на ‘host’. Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible ‘controller’, а не ‘host’.
- AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте Ansible ‘host’ (обычно
~/.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: List an option group
amazon.aws.rds_option_group_info:
option_group_name: test-mysql-option-group
register: option_group
- name: List all the option groups
amazon.aws.rds_option_group_info:
region: ap-southeast-2
profile: production
register: option_group
Значения, возвращаемые модулем
Общие значения, возвращаемые модулем, документированы здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
changed boolean | Истина, если список групп параметров RDS завершается успешно. Возвращается: всегда Пример: |
result complex | Доступные группы параметров RDS. Возвращается: всегда |
|
allows_vpc_and_non_vpc_instance_memberships boolean |
Указывает, может ли эта группа параметров применяться к экземплярам как в VPC, так и вне VPC. Возвращается: всегда Пример: |
|
engine_name string |
Указывает имя движка, к которому может быть применена эта группа параметров. Возвращается: всегда Пример: |
|
major_engine_version string |
Указывает основную версию движка, связанную с этой группой параметров. Возвращается: всегда Пример: |
|
option_group_arn string |
Amazon Resource Name (ARN) группы параметров. Возвращается: всегда Пример: |
|
option_group_description string |
Описание группы параметров. Возвращается: всегда Пример: |
|
option_group_name string |
Имя группы параметров. Возвращается: всегда Пример: |
|
options complex |
Доступные параметры в группе параметров. Возвращается: всегда |
|
db_security_group_memberships complex |
Если параметр требует доступа к порту, эта группа безопасности БД разрешает доступ к порту. Возвращается: всегда Пример: |
|
db_security_group_name string |
Имя группы безопасности БД. Возвращается: всегда Пример: |
|
status string |
Статус группы безопасности БД. Возвращается: всегда Пример: |
|
option_description string |
Описание параметра. Возвращается: всегда Пример: |
|
option_name string |
Имя параметра. Возвращается: всегда Пример: |
|
option_settings complex |
Имя параметра. Возвращается: всегда |
|
allowed_values string |
Допустимые значения параметра. Возвращается: всегда Пример: |
|
apply_type string |
Тип параметра, специфичный для СУБД. Возвращается: всегда Пример: |
|
data_type string |
Тип данных параметра. Возвращается: всегда Пример: |
|
default_value string |
Значение параметра по умолчанию. Возвращается: всегда Пример: |
|
description string |
Описание параметра. Возвращается: всегда Пример: |
|
is_collection boolean |
Указывает, является ли параметр частью коллекции. Возвращается: всегда Пример: |
|
is_modifiable boolean |
Логическое значение, которое, если истинно, указывает, что параметр можно изменить по умолчанию. Возвращается: всегда Пример: |
|
name string |
Имя параметра, настройки которого можно установить. Возвращается: всегда Пример: |
|
value string |
Текущее значение параметра. Возвращается: всегда Пример: |
|
permanent boolean |
Указывает, является ли этот параметр постоянным. Возвращается: всегда Пример: |
|
persistent boolean |
Указывает, является ли этот параметр постоянным. Возвращается: всегда Пример: |
|
port integer |
При необходимости, порт, настроенный для использования этим параметром. Возвращается: всегда Пример: |
|
vpc_security_group_memberships list / elements=dictionary |
Если параметр требует доступа к порту, эта группа безопасности VPC разрешает доступ к порту. Возвращается: всегда |
|
status string |
Статус группы безопасности VPC. Возвращается: всегда Пример: |
|
vpc_security_group_id string |
Имя группы безопасности VPC. Возвращается: всегда Пример: |
|
tags dictionary |
Теги, связанные с группой параметров RDS. Возвращается: всегда Пример: |
|
vpc_id string |
Если присутствует, эта группа параметров может применяться только к экземплярам, находящимся в VPC, указанном в этом поле. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/rds_option_group_info_module.html