Модуль amazon.aws.rds_option_group – Управляет созданием, модификацией и удалением групп опций RDS

Примечание

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

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

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

Для использования в книге задач укажите: amazon.aws.rds_option_group.

Новое в amazon.aws 5.0.0

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

Описание

Управляет созданием, модификацией, удалением групп опций RDS.
Этот модуль был первоначально добавлен в community.aws в выпуске 2.1.0.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_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` или `EC2_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
apply_immediately булево	Указывает, должны ли изменения применяться немедленно или во время следующего окна технического обслуживания. Варианты: `false` ← (по умолчанию) `true`
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.
debug_botocore_endpoint_logs булево	Используйте `botocore.endpoint` логгер для анализа уникальных (а не общих) `"resource:action"` API-вызовов, выполненных во время задачи, выводив набор в ключ resource_actions в результатах задачи. Используйте `aws_resource_action` обратный вызов для вывода полного списка, выполненного во время выполнения книги. Также может использоваться переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка	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 строка	Указывает имя движка, с которым должна быть связана эта группа параметров.
major_engine_version строка	Указывает основную версию движка, с которой должна быть связана эта группа параметров.
option_group_description строка	Описание группы параметров.
option_group_name строка / обязательно	Указывает имя группы параметров, подлежащей созданию.
options список / элементы=словарь	Параметры в этом списке добавляются в группу параметров. Если параметр уже существует, указанная конфигурация используется для обновления существующей конфигурации. Если параметры не заданы, все существующие параметры удаляются.
db_security_group_memberships список / элементы=строка	Список строк с именами `DBSecurityGroupMembership`, используемых для данного параметра.
option_name строка	Конфигурация параметров, которые нужно включить в группу.
option_settings список / элементы=словарь	Настройки параметров, которые нужно включить в группу параметров.
allowed_values строка	Допустимые значения параметра.
apply_type строка	Тип параметра, специфичный для СУБД.
data_type строка	Тип данных параметра.
default_value строка	Значение параметра по умолчанию.

END_OF_DOCUMENT_MARKER

описание строка	Описание параметра настройки.
is_collection булево	Указывает, является ли параметр настройки частью набора. Варианты: `false` `true`
is_modifiable булево	Булевое значение, которое, когда `true`, указывает, что настройку параметра можно изменить по умолчанию. Варианты: `false` `true`
название строка	Имя параметра, для которого можно задать настройки.
значение строка	Текущее значение параметра настройки.
версия_параметра строка	Версия параметра.
порт целое число	Необязательный порт для параметра.
vpc_security_group_memberships список / элементы=строка	Список `VpcSecurityGroupMembership` имен строк, используемых для этого параметра.
профиль псевдонимы: aws_profile строка	Используемый профиль AWS для аутентификации. См. документацию AWS для получения дополнительной информации о профилях: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также может использоваться переменная окружения `AWS_PROFILE`. Параметр профиль взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token.
purge_tags булево	Если purge_tags=true и метки установлено, существующие метки будут удалены из ресурса, чтобы точно соответствовать тому, что определено параметром метки. Если параметр метки не установлен, метки не будут изменены, даже если purge_tags=True. Ключи меток, начинающиеся с `aws:`, зарезервированы Amazon и не могут быть изменены. Таким образом, они будут проигнорированы для целей параметра purge_tags. Дополнительную информацию см. в документации Amazon: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions. Варианты: `false` `true` ← (по умолчанию)
регион псевдонимы: aws_region, ec2_region строка	Используемый регион AWS. Для глобальных служб, таких как IAM, Route53 и CloudFront, регион игнорируется. Также могут использоваться переменные окружения `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.
ключ_секрета псевдонимы: aws_secret_access_key, aws_secret_key, ec2_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`, или `EC2_SECRET_KEY` в порядке убывания предпочтения. Параметры ключ_секрета и профиль взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для соответствия SDK botocore AWS. Псевдоним ec2_secret_key устарел и будет удалён в релизе после 2024-12-01. Поддержка переменной окружения `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.
токен_сессии псевдонимы: 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. Также могут использоваться переменные окружения `AWS_SESSION_TOKEN`, `AWS_SECURITY_TOKEN` или `EC2_SECURITY_TOKEN` в порядке убывания предпочтения. Параметры токен_сессии и профиль взаимоисключающие. Псевдонимы aws_session_token и токен_сессии были добавлены в релизе 3.2.0, а параметр был переименован из security_token в токен_сессии в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных окружения `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в релизе после 2024-12-01.
состояние строка / обязательно	Указывает, должен ли набор параметров быть `present` или `absent`. Варианты: `"present"` `"absent"`

метки псевдонимы: resource_tags словарь	Словарь, представляющий метки, которые необходимо применить к ресурсу. Если параметр метки не задан, метки не будут изменены.
validate_certs логическое	Если установлено в значение `false`, сертификаты SSL не будут проверяться для связи с API AWS. Установка validate_certs=false категорически не рекомендуется. В качестве альтернативы рассмотрите установку aws_ca_bundle. Возможные значения: `false` `true` ← (по умолчанию)
ждать логическое	Ожидать доступности или удаления кластера. Возможные значения: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

# Create an RDS Mysql Option group
- name: Create an RDS Mysql option group
  amazon.aws.rds_option_group:
    state: present
    option_group_name: test-mysql-option-group
    engine_name: mysql
    major_engine_version: 5.6
    option_group_description: test mysql option group
    apply_immediately: true
    options:
      - option_name: MEMCACHED
        port: 11211
        vpc_security_group_memberships:
          - "sg-d188c123"
        option_settings:
          - name: MAX_SIMULTANEOUS_CONNECTIONS
            value: "20"
          - name: CHUNK_SIZE_GROWTH_FACTOR
            value: "1.25"
  register: new_rds_mysql_option_group

# Remove currently configured options for an option group by removing options argument
- name: Create an RDS Mysql option group
  amazon.aws.rds_option_group:
    state: present
    option_group_name: test-mysql-option-group
    engine_name: mysql
    major_engine_version: 5.6
    option_group_description: test mysql option group
    apply_immediately: true
  register: rds_mysql_option_group

- name: Create an RDS Mysql option group using tags
  amazon.aws.rds_option_group:
    state: present
    option_group_name: test-mysql-option-group
    engine_name: mysql
    major_engine_version: 5.6
    option_group_description: test mysql option group
    apply_immediately: true
    tags:
      Tag1: tag1
      Tag2: tag2
  register: rds_mysql_option_group

# Delete an RDS Mysql Option group
- name: Delete an RDS Mysql option group
  amazon.aws.rds_option_group:
    state: absent
    option_group_name: test-mysql-option-group
  register: deleted_rds_mysql_option_group

Значения возврата

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

Ключ	Описание
allows_vpc_and_non_vpc_instance_memberships логическое	Указывает, может ли эта группа параметров применяться к экземплярам как в VPC, так и вне VPC. Возвращается: всегда Пример: `false`
changed логическое	Если группа параметров изменилась. Возвращается: всегда Пример: `true`
engine_name строка	Указывает имя движка, к которому может быть применена эта группа параметров. Возвращается: всегда Пример: `"mysql"`
major_engine_version строка	Указывает основную версию движка, связанную с этой группой параметров. Возвращается: всегда Пример: `"5.6"`
option_group_arn строка	Amazon Resource Name (ARN) группы параметров. Возвращается: всегда Пример: `"arn:aws:rds:ap-southeast-2:123456789012:og:ansible-test-option-group"`
option_group_description строка	Предоставляет описание группы параметров. Возвращается: всегда Пример: `"test mysql option group"`
option_group_name строка	Указывает имя группы параметров. Возвращается: всегда Пример: `"test-mysql-option-group"`
options список / элементы=словарь	Указывает доступные параметры в группе параметров. Возвращается: всегда
db_security_group_memberships список / элементы=словарь	Если параметр требует доступа к порту, эта группа безопасности БД разрешает доступ к порту. Возвращается: всегда
db_security_group_name строка	Имя группы безопасности БД. Возвращается: всегда Пример: `"mydbsecuritygroup"`
status строка	Статус группы безопасности БД. Возвращается: всегда Пример: `"available"`
option_description строка	Описание параметра. Возвращается: всегда Пример: `"Innodb Memcached for MySQL"`
option_name строка	Имя параметра. Возвращается: всегда Пример: `"MEMCACHED"`
option_settings список / элементы=строка	Имя параметра. Возвращается: всегда
allowed_values строка	Допустимые значения параметра. Возвращается: всегда Пример: `"1-2048"`
apply_type строка	Тип параметра, специфичный для движка БД. Возвращается: всегда Пример: `"STATIC"`
data_type строка	Тип данных параметра. Возвращается: всегда Пример: `"INTEGER"`

END_OF_DOCUMENT_MARKER

значение_по_умолчанию строка	Значение параметра по умолчанию. Возвращается: всегда Пример: `"1024"`
описание строка	Описание параметра. Возвращается: всегда Пример: `"Verbose level for memcached."`
является_коллекцией логическое	Указывает, является ли параметр частью коллекции. Возвращается: всегда Пример: `true`
модифицируемый логическое	Логическое значение, которое, при значении true, указывает, что параметр можно изменить от значения по умолчанию. Возвращается: всегда Пример: `true`
имя строка	Название параметра, для которого можно задать настройки. Возвращается: всегда Пример: `"INNODB_API_ENABLE_MDL"`
значение строка	Текущее значение параметра. Возвращается: всегда Пример: `"0"`
постоянный логическое	Указывает, является ли параметр постоянным. Возвращается: всегда Пример: `true`
постоянный логическое	Указывает, является ли параметр постоянным. Возвращается: всегда Пример: `true`
порт целое	Если требуется, порт, настроенный для использования этого параметра. Возвращается: всегда Пример: `11211`
членства_в_группах_безопасности_vpc список / элементы=словарь	Если параметр требует доступа к порту, то эта группа безопасности VPC разрешает доступ к порту. Возвращается: всегда
статус строка	Статус группы безопасности VPC. Возвращается: всегда Пример: `"available"`
id_группы_безопасности_vpc строка	Имя группы безопасности VPC. Возвращается: всегда Пример: `"sg-0cd636a23ae76e9a4"`
метки словарь	Метки, связанные с группой RDS параметров. Возвращается: всегда Пример: `{"Ansible": "Test"}`
id_vpc строка	При наличии, эта группа параметров может быть применена только к экземплярам, которые находятся в VPC, указанном в этом поле. Возвращается: всегда Пример: `"vpc-bf07e9d6"`

Авторы

Nick Aslanidis (@naslanidis)
Will Thames (@willthames)
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_module.html