Spec-Zone.ru › Ansible

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_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.

debug_botocore_endpoint_logs

boolean

Использовать botocore.endpoint регистратор для анализа уникальных (а не общих) "resource:action" вызовов API, выполненных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время playbook.

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

engine_name

string

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

Значение по умолчанию: ""

major_engine_version

string

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

Если указано, то engine_name также должно быть указано.

Значение по умолчанию: ""

marker

string

Если этот параметр указан, ответ включает только записи после маркера, до значения, указанного max_records.

Допустимые значения находятся между 20 и 100.

max_records

integer

Максимальное количество записей, которые нужно включить в ответ.

Значение по умолчанию: 100

option_group_name

string

Имя группы опций для описания.

Не может быть указано вместе с engine_name или major_engine_version.

Значение по умолчанию: ""

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 для согласованности с SDK AWS botocore.

Алиас 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.

validate_certs

boolean

При установке в false, сертификаты SSL не будут проверяться для связи с API AWS.

Настройка validate_certs=false категорически не рекомендуется; в качестве альтернативы, рассмотрите возможность настройки aws_ca_bundle вместо этого.

Варианты:

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

Примечания

Примечание

  • Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста 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 завершается успешно.

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

Пример: false

result

complex

Доступные группы параметров RDS.

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

allows_vpc_and_non_vpc_instance_memberships

boolean

Указывает, может ли эта группа параметров применяться к экземплярам как в VPC, так и вне VPC.

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

Пример: false

engine_name

string

Указывает имя движка, к которому может быть применена эта группа параметров.

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

Пример: "mysql"

major_engine_version

string

Указывает основную версию движка, связанную с этой группой параметров.

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

Пример: "5.6"

option_group_arn

string

Amazon Resource Name (ARN) группы параметров.

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

Пример: "arn:aws:rds:ap-southeast-2:123456789012:og:ansible-test-option-group"

option_group_description

string

Описание группы параметров.

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

Пример: "test mysql option group"

option_group_name

string

Имя группы параметров.

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

Пример: "test-mysql-option-group"

options

complex

Доступные параметры в группе параметров.

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

db_security_group_memberships

complex

Если параметр требует доступа к порту, эта группа безопасности БД разрешает доступ к порту.

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

Пример: "list"

db_security_group_name

string

Имя группы безопасности БД.

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

Пример: "mydbsecuritygroup"

status

string

Статус группы безопасности БД.

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

Пример: "available"

option_description

string

Описание параметра.

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

Пример: "Innodb Memcached for MySQL"

option_name

string

Имя параметра.

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

Пример: "MEMCACHED"

option_settings

complex

Имя параметра.

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

allowed_values

string

Допустимые значения параметра.

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

Пример: "1-2048"

apply_type

string

Тип параметра, специфичный для СУБД.

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

Пример: "STATIC"

data_type

string

Тип данных параметра.

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

Пример: "INTEGER"

default_value

string

Значение параметра по умолчанию.

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

Пример: "1024"

description

string

Описание параметра.

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

Пример: "Verbose level for memcached."

is_collection

boolean

Указывает, является ли параметр частью коллекции.

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

Пример: true

is_modifiable

boolean

Логическое значение, которое, если истинно, указывает, что параметр можно изменить по умолчанию.

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

Пример: true

name

string

Имя параметра, настройки которого можно установить.

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

Пример: "INNODB_API_ENABLE_MDL"

value

string

Текущее значение параметра.

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

Пример: "0"

permanent

boolean

Указывает, является ли этот параметр постоянным.

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

Пример: true

persistent

boolean

Указывает, является ли этот параметр постоянным.

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

Пример: true

port

integer

При необходимости, порт, настроенный для использования этим параметром.

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

Пример: 11211

vpc_security_group_memberships

list / elements=dictionary

Если параметр требует доступа к порту, эта группа безопасности VPC разрешает доступ к порту.

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

status

string

Статус группы безопасности VPC.

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

Пример: "available"

vpc_security_group_id

string

Имя группы безопасности VPC.

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

Пример: "sg-0cd636a23ae76e9a4"

tags

dictionary

Теги, связанные с группой параметров RDS.

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

Пример: {"Ansible": "Test"}

vpc_id

string

Если присутствует, эта группа параметров может применяться только к экземплярам, находящимся в VPC, указанном в этом поле.

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

Пример: "vpc-bf07e9d6"

Авторы

  • Alina Buzachis (@alinabuzachis)

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

  • Система отслеживания ошибок
  • Репозиторий (Исходный код)
  • Связь

© 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API