Spec-Zone.ru › Ansible

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

Примечание

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

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

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_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 (в порядке убывания приоритета).

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id добавлен в версии 5.1.0 для согласованности с AWS botocore SDK.

apply_immediately

boolean

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

Варианты:

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

aws_ca_bundle

path

Путь к пакету центров сертификации, используемому для проверки 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 для анализа уникальных (а не всех) вызовов API "resource:action", выполненных во время задачи, и выводить их набор в ключ resource_actions результатов задачи. Используйте callback aws_resource_action, чтобы вывести полный список вызовов, выполненных в рамках плейбука.

Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

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

endpoint_url

псевдоним: aws_endpoint_url

string

URL для подключения вместо конечных точек AWS по умолчанию. Хотя его можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS.

Также можно использовать переменную окружения AWS_URL.

engine_name

string

Задаёт имя ядра СУБД, с которым должна быть связана эта группа параметров.

major_engine_version

string

Задаёт основную версию ядра СУБД, с которой должна быть связана эта группа параметров.

option_group_description

string

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

option_group_name

string / обязательный

Задаёт имя создаваемой группы параметров.

options

list / элементы=dictionary

Параметры из этого списка добавляются в группу параметров.

Если параметр уже существует, указанная конфигурация используется для обновления существующей конфигурации.

Если параметры не указаны, все существующие параметры удаляются.

db_security_group_memberships

list / элементы=string

Список строк с именами DBSecurityGroupMembership, используемых для этого параметра.

option_name

string

Конфигурация параметров, включаемых в группу.

option_settings

list / элементы=dictionary

Настройки параметров, включаемые в группу параметров.

allowed_values

string

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

apply_type

string

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

data_type

string

Тип данных настройки параметра.

default_value

string

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

description

string

Описание настройки параметра.

is_collection

boolean

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

Варианты:

  • false
  • true

is_modifiable

boolean

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

Варианты:

  • false
  • true

name

string

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

value

string

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

option_version

string

Версия параметра.

port

integer

Необязательный порт для параметра.

vpc_security_group_memberships

list / элементы=string

Список строк с именами VpcSecurityGroupMembership, используемых для этого параметра.

profile

псевдоним: 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 и session_token.

purge_tags

boolean

Если задано purge_tags=true и указан параметр tags, существующие теги ресурса будут удалены, чтобы их набор точно соответствовал значению параметра tags.

Если параметр tags не задан, теги не изменяются, даже если указано purge_tags=True.

Ключи тегов, начинающиеся с aws:, зарезервированы Amazon и не могут быть изменены. Поэтому они игнорируются при обработке параметра purge_tags. Дополнительные сведения см. в документации Amazon: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.

Варианты:

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

region

псевдоним: aws_region

string

Регион AWS.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, значение region игнорируется.

Также можно использовать переменную окружения AWS_REGION.

Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

secret_key

псевдонимы: aws_secret_access_key, aws_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 (в порядке убывания приоритета).

Параметры secret_key и profile являются взаимоисключающими.

Псевдоним aws_secret_access_key добавлен в версии 5.1.0 для согласованности с AWS botocore SDK.

session_token

псевдоним: aws_session_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.

Параметры session_token и profile являются взаимоисключающими.

state

string / обязательный

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

Варианты:

  • "present"
  • "absent"

tags

псевдоним: resource_tags

dictionary

Словарь тегов, применяемых к ресурсу.

Если параметр tags не задан, теги не изменяются.

validate_certs

boolean

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

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

Варианты:

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

wait

boolean

Ожидать ли, пока кластер станет доступен или будет удалён.

Варианты:

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

Примечания

Примечание

  • Внимание: Для модулей переменные окружения и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому может потребоваться явно скопировать файлы на «узел». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
  • Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учётных данных и других параметров, например региона, из файлов конфигурации в контексте «узла» 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

boolean

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

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

Пример: false

changed

boolean

Изменилась ли группа параметров.

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

Пример: true

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

list / elements=dictionary

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

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

db_security_group_memberships

list / elements=dictionary

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

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

db_security_group_name

string

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

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

Пример: "mydbsecuritygroup"

status

string

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

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

Пример: "available"

option_description

string

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

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

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

option_name

string

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

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

Пример: "MEMCACHED"

option_settings

list / elements=string

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

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

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 указывает, что настройку параметра можно изменить относительно значения по умолчанию.

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

Пример: 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"

Авторы

  • Nick Aslanidis (@naslanidis)
  • Will Thames (@willthames)
  • Alina Buzachis (@alinabuzachis)

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

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

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

Spec-Zone.ru

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