Spec-Zone.ru › Ansible

Модуль amazon.aws.rds_cluster — модуль rds_cluster

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: amazon.aws.rds_cluster.

Добавлено в amazon.aws 5.0.0

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

Краткое описание

  • Создание, изменение и удаление кластеров RDS.
  • Этот модуль был впервые добавлен в community.aws в выпуске 3.2.0.

Требования

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

  • python >= 3.6
  • boto3 >= 1.35.0
  • botocore >= 1.35.0

Параметры

Параметр

Комментарии

access_key

aliases: 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.

allocated_storage

integer

добавлено в amazon.aws 5.5.0

Объём хранилища в гибибайтах (ГиБ), выделяемый для каждого экземпляра БД в кластере БД Multi-AZ.

Этот параметр необходим для создания кластера БД Multi-AZ.

apply_immediately

boolean

Значение, указывающее, следует ли применить изменения кластера с помощью new_db_cluster_identifier и master_user_password как можно скорее, независимо от параметра preferred_maintenance_window. Если задано значение false, изменения применяются во время следующего окна обслуживания.

Возможные значения:

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

availability_zones

псевдонимы: zones, az

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

Список зон доступности EC2, в которых можно создать экземпляры кластера БД. Можно использовать при создании кластера, а также при восстановлении из S3 или снимка.

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.

backtrack_to

string

Метка времени, к которой нужно выполнить откат кластера БД, в формате ISO 8601, например «2017-07-08T18:00Z».

backtrack_window

integer

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

Если параметр указан, его значение должно быть числом от 0 до 259,200 (72 часа).

backup_retention_period

integer

Количество дней хранения автоматических резервных копий (значение должно быть в диапазоне от 1 до 35). Можно использовать при создании кластера, восстановлении из S3 или изменении кластера.

По умолчанию: 1

character_set_name

string

Набор символов, связанный с кластером БД.

copy_tags_to_snapshot

boolean

Указывает, следует ли копировать все теги кластера БД в снимки этого кластера. По умолчанию теги не копируются.

Возможные значения:

  • false
  • true

creation_source

string

Источник для создания из шаблона (существующий кластер, корзина S3 или снимок).

Возможные значения:

  • "snapshot"
  • "s3"
  • "cluster"

database_name

псевдонимы: db_name

string

Имя базы данных. Если имя не указано, Amazon RDS не создаст базу данных.

db_cluster_identifier

псевдонимы: cluster_id, id, cluster_name

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

Идентификатор кластера БД (строчными буквами). Идентификатор должен содержать от 1 до 63 букв, цифр или дефисов; первый символ должен быть буквой, идентификатор не может оканчиваться дефисом или содержать два дефиса подряд.

db_cluster_instance_class

string

добавлено в amazon.aws 5.5.0

Вычислительная мощность и объём памяти каждого экземпляра БД в кластере БД Multi-AZ, например db.m6gd.xlarge.

Не все классы экземпляров БД доступны во всех регионах Amazon Web Services и для всех подсистем баз данных.

Полный список классов экземпляров БД и сведения об их доступности для вашей подсистемы см. по адресу https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html.

Этот параметр необходим для создания кластера БД Multi-AZ.

db_cluster_parameter_group_name

string

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

db_subnet_group_name

string

Группа подсетей БД, связываемая с этим кластером, если не используется группа по умолчанию.

debug_botocore_endpoint_logs

boolean

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

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

Возможные значения:

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

deletion_protection

boolean

Значение, указывающее, включена ли для кластера БД защита от удаления. Если защита включена, базу данных нельзя удалить. По умолчанию защита от удаления отключена.

Возможные значения:

  • false
  • true

domain

string

Идентификатор каталога Active Directory, в котором нужно создать кластер БД.

domain_iam_role_name

string

Имя роли IAM, используемой при вызове API Directory Service.

enable_cloudwatch_logs_exports

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

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

Для подсистемы aurora-mysql поддерживаются audit, error, general и slowquery.

Для подсистемы aurora-postgresql поддерживается postgresql.

enable_global_write_forwarding

boolean

Значение, указывающее, следует ли разрешить этому кластеру БД перенаправлять операции записи в основной кластер глобальной базы данных Aurora. По умолчанию в кластерах Aurora DB, являющихся вторичными кластерами глобальной базы данных Aurora, операции записи запрещены.

Это значение можно задать только для кластеров Aurora DB, входящих в глобальную базу данных Aurora.

Возможные значения:

  • false
  • true

enable_http_endpoint

boolean

Значение, указывающее, следует ли включить конечную точку HTTP для бессерверного кластера Aurora DB. По умолчанию конечная точка HTTP отключена.

Возможные значения:

  • false
  • true

enable_iam_database_authentication

boolean

Включить сопоставление учетных записей AWS Identity and Access Management (IAM) с учетными записями баз данных. Если этот параметр не указан при создании кластера, Amazon RDS задает для него значение false.

Возможные значения:

  • false
  • true

endpoint_url

псевдонимы: aws_endpoint_url

string

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

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

engine

string

Имя подсистемы базы данных для этого кластера БД. Этот параметр обязателен для создания кластера.

Сочетание параметров engine и engine_mode может не поддерживаться.

Подробности см. в документации AWS: Документация Amazon RDS.

Если указано engine=mysql, необходимо также указать allocated_storage, iops и db_cluster_instance_class.

Если задано engine=postgres, необходимо также указать allocated_storage, iops и db_cluster_instance_class.

Поддержка postgres и mysql добавлена в amazon.aws 5.5.0.

Возможные значения:

  • "aurora"
  • "aurora-mysql"
  • "aurora-postgresql"
  • "mysql"
  • "postgres"

engine_mode

string

добавлено в amazon.aws 5.5.0

Режим подсистемы БД кластера БД. Сочетание engine и engine_mode может не поддерживаться.

Подробности см. в документации AWS: Документация Amazon RDS.

Возможные значения:

  • "provisioned"
  • "serverless"
  • "parallelquery"
  • "global"
  • "multimaster"

engine_version

string

Номер версии подсистемы базы данных.

Для Aurora MySQL это может быть 5.6.10a, 5.7.12.

Пример для Aurora PostgreSQL: 9.6.3.

final_snapshot_identifier

string

Идентификатор снимка кластера БД, создаваемого при выполнении skip_final_snapshot=false.

force_backtrack

boolean

Логическое значение, указывающее, следует ли принудительно выполнить откат кластера БД при включенном двоичном журналировании. В противном случае при включенном двоичном журналировании возникает ошибка.

Возможные значения:

  • false
  • true

force_update_password

boolean

Задайте значение true, чтобы обновить пароль кластера с помощью master_user_password.

Поскольку сравнить пароли и определить необходимость обновления невозможно, по умолчанию задано значение false, обеспечивающее идемпотентность.

Возможные значения:

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

global_cluster_identifier

string

Идентификатор глобального кластера Aurora, который становится основным кластером новой глобальной базы данных.

iops

integer

добавлено в amazon.aws 5.5.0

Начальное количество выделяемых операций ввода-вывода в секунду (IOPS) для каждого экземпляра БД в кластере БД Multi-AZ.

Этот параметр необходим для создания кластера БД Multi-AZ.

Значение должно быть кратно объёму хранилища кластера БД и находиться в диапазоне от 0,5 до 50.

kms_key_id

string

Идентификатор ключа AWS KMS (ARN, если только вы не создаёте кластер в той же учётной записи, которой принадлежит ключ KMS; в этом случае можно использовать псевдоним ключа KMS).

Если replication_source_identifier указывает на зашифрованный источник, Amazon RDS будет использовать ключ, которым был зашифрован источник.

Если задано storage_encrypted=true и не указан replication_source_identifier, используется ключ шифрования по умолчанию.

master_user_password

псевдонимы: password

string

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

Пароль может содержать любые печатные символы ASCII, кроме /, " или @.

Чтобы изменить пароль, используйте force_update_password. Используйте apply_immediately, чтобы изменить пароль немедленно; в противном случае он будет обновлён во время следующего окна обслуживания.

master_username

псевдонимы: username

string

Имя главного пользователя кластера БД. Имя должно содержать от 1 до 16 букв или цифр и начинаться с буквы.

new_db_cluster_identifier

псевдонимы: new_cluster_id, new_id, new_cluster_name

string

Новый идентификатор кластера БД (строчными буквами), используемый при переименовании кластера.

Идентификатор должен содержать от 1 до 63 букв, цифр или дефисов; первый символ должен быть буквой, идентификатор не может оканчиваться дефисом или содержать два дефиса подряд.

Используйте apply_immediately для немедленного переименования; в противном случае изменение будет выполнено во время следующего окна обслуживания.

option_group_name

string

Группа параметров, связываемая с кластером БД.

port

integer

Номер порта, на котором экземпляры кластера БД принимают подключения. Если параметр не указан, Amazon RDS по умолчанию задаёт значение 3306, если engine равно aurora, и значение 5432, если engine равно aurora-postgresql.

preferred_backup_window

псевдонимы: backup_window

string

Ежедневный временной интервал (в UTC) продолжительностью не менее 30 минут, в течение которого создаются автоматические резервные копии, если они включены с помощью backup_retention_period. Значение должно иметь формат «hh24:mi-hh24:mi» и не должно пересекаться с preferred_maintenance_window.

preferred_maintenance_window

псевдонимы: maintenance_window

string

Еженедельный временной интервал (в UTC) продолжительностью не менее 30 минут, в течение которого может выполняться обслуживание системы. Значение должно иметь формат «ddd:hh24:mi-ddd:hh24:mi», где ddd — один из дней: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

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.

promote

boolean

Установите значение true, чтобы повысить кластер-реплику для чтения.

Варианты:

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

purge_cloudwatch_logs_exports

boolean

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

Варианты:

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

purge_security_groups

boolean

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

Можно применить к vpc_security_group_ids

Варианты:

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

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.

remove_from_global_db

boolean

добавлено в amazon.aws 6.5.0

Если установлено значение true, кластер будет удалён из глобальной БД.

При использовании remove_from_global_db=true необходимо указать параметры global_cluster_identifier и db_cluster_identifier.

Варианты:

  • false
  • true

replication_source_identifier

псевдоним: replication_src_id

string

Имя ресурса Amazon (ARN) исходного экземпляра БД или кластера БД, если этот кластер БД создан как реплика для чтения.

restore_to_time

string

Дата и время в формате UTC, на которые нужно восстановить кластер БД. Значение должно иметь формат «2015-03-07T23:45:00Z».

Если при восстановлении кластера это значение не задано, необходимо указать use_latest_restorable_time. Не может быть указано, если для restore_type задано значение copy-on-write.

restore_type

string

Тип выполняемого восстановления. Если значение не задано, Amazon RDS использует полное копирование.

Варианты:

  • "full-copy"
  • "copy-on-write"

role_arn

string

Имя ресурса Amazon (ARN) роли IAM, которую нужно связать с кластером Aurora DB, например «arn:aws:iam::123456789012:role/AuroraAccessRole»

s3_bucket_name

string

Имя бакета Amazon S3, содержащего данные для создания кластера Amazon Aurora DB.

s3_ingestion_role_arn

string

Имя ресурса Amazon (ARN) роли AWS Identity and Access Management (IAM), которая разрешает Amazon RDS обращаться от вашего имени к бакету Amazon S3.

s3_prefix

string

Префикс для всех имён файлов, содержащих данные для создания кластера Amazon Aurora DB.

Если не указать значение SourceS3Prefix, кластер Amazon Aurora DB будет создан с использованием всех файлов в бакете Amazon S3.

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.

serverless_v2_scaling_configuration

dictionary

добавлено в amazon.aws 7.3.0

Содержит конфигурацию масштабирования кластера Aurora Serverless v2 DB.

max_capacity

float

Максимальное количество единиц ёмкости Aurora (ACU) для экземпляра БД в кластере Aurora Serverless v2.

Значения ACU можно задавать с шагом в половину единицы, например 40, 40.5, 41 и так далее.

Максимально возможное значение — 128.

min_capacity

float

Минимальное количество единиц ёмкости Aurora (ACU) для экземпляра БД в кластере Aurora Serverless v2.

Значения ACU можно задавать с шагом в половину единицы, например 8, 8.5, 9 и так далее.

Минимально возможное значение — 0.5.

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 являются взаимоисключающими.

skip_final_snapshot

boolean

Следует ли создавать итоговый снимок кластера БД перед его удалением.

Если задано значение false, необходимо указать final_snapshot_identifier.

Варианты:

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

snapshot_identifier

string

Идентификатор снимка БД или снимка кластера БД, из которого выполняется восстановление.

Для указания снимка кластера БД можно использовать имя или ARN. Для указания снимка БД можно использовать только ARN.

source_db_cluster_identifier

string

Идентификатор исходного кластера БД, из которого выполняется восстановление.

source_engine

string

Идентификатор СУБД, резервная копия которой использовалась для создания файлов в бакете Amazon S3.

Варианты:

  • "mysql"

source_engine_version

string

Версия базы данных, для которой были созданы файлы резервной копии.

source_region

string

Идентификатор региона, в котором находится источник кластера БД.

state

string

Должен ли снимок существовать.

Значения started и stopped можно использовать только с кластерами Aurora.

Поддержка значений started и stopped добавлена в выпуске 6.3.0.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"
  • "started"
  • "stopped"

storage_encrypted

boolean

Зашифрован ли кластер БД.

Варианты:

  • false
  • true

storage_type

string

добавлено в amazon.aws 5.5.0

Указывает тип хранилища, связанного с кластером БД.

Этот параметр необходим для создания кластера БД Multi-AZ.

Для кластеров БД Multi-AZ значение storage_type по умолчанию равно io1, а параметр iops необходимо задать.

Для кластеров Aurora DB значение storage_type по умолчанию равно aurora standard.

Для кластеров mysql и postgres DB значение storage_type по умолчанию равно io1.

Поддержка значений aurora и aurora-iopt1 добавлена в выпуске 8.2.0.

Варианты:

  • "io1"
  • "aurora"
  • "aurora-iopt1"

tags

псевдоним: resource_tags

dictionary

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

Если параметр tags не задан, теги не будут изменены.

use_earliest_time_on_point_in_time_unavailable

boolean

Если для backtrack_to задана временная метка, предшествующая самому раннему времени обратного восстановления, этот параметр восстанавливает кластер БД до самого раннего возможного времени обратного восстановления. В противном случае возникает ошибка.

Варианты:

  • false
  • true

use_latest_restorable_time

boolean

Следует ли восстановить кластер БД до последнего времени, на которое возможно восстановление из резервной копии. Можно указать только один из параметров: use_latest_restorable_time или restore_to_time.

Варианты:

  • false
  • true

validate_certs

boolean

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

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

Варианты:

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

vpc_security_group_ids

list / elements=string

Список групп безопасности EC2 VPC, которые нужно связать с кластером БД.

wait

boolean

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

Варианты:

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

Примечания

Примечание

  • Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «хоста» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «хоста».
  • Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учётных данных и других параметров, например региона, из файлов конфигурации в контексте «хоста» 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: Create minimal Aurora cluster in default VPC and default subnet group
  amazon.aws.rds_cluster:
    cluster_id: "{{ cluster_id }}"
    engine: "aurora"
    password: "{{ password }}"
    username: "{{ username }}"

- name: Add a new security group without purge
  amazon.aws.rds_cluster:
    id: "{{ cluster_id }}"
    state: present
    vpc_security_group_ids:
      - sg-0be17ba10c9286b0b
    purge_security_groups: false

- name: Modify password
  amazon.aws.rds_cluster:
    id: "{{ cluster_id }}"
    state: present
    password: "{{ new_password }}"
    force_update_password: true
    apply_immediately: true

- name: Rename the cluster
  amazon.aws.rds_cluster:
    engine: aurora
    password: "{{ password }}"
    username: "{{ username }}"
    cluster_id: "cluster-{{ resource_prefix }}"
    new_cluster_id: "cluster-{{ resource_prefix }}-renamed"
    apply_immediately: true

- name: Delete Aurora cluster without creating a final snapshot
  amazon.aws.rds_cluster:
    engine: aurora
    password: "{{ password }}"
    username: "{{ username }}"
    cluster_id: "{{ cluster_id }}"
    skip_final_snapshot: true
    tags:
      Name: "cluster-{{ resource_prefix }}"
      Created_By: "Ansible_rds_cluster_integration_test"
    state: absent

- name: Restore cluster from source snapshot
  amazon.aws.rds_cluster:
    engine: aurora
    password: "{{ password }}"
    username: "{{ username }}"
    cluster_id: "cluster-{{ resource_prefix }}-restored"
    snapshot_identifier: "cluster-{{ resource_prefix }}-snapshot"

- name: Create an Aurora PostgreSQL cluster and attach an intance
  amazon.aws.rds_cluster:
    state: present
    engine: aurora-postgresql
    engine_mode: provisioned
    cluster_id: '{{ cluster_id }}'
    username: '{{ username }}'
    password: '{{ password }}'

- name: Attach a new instance to the cluster
  amazon.aws.rds_instance:
    id: '{{ instance_id }}'
    cluster_id: '{{ cluster_id }}'
    engine: aurora-postgresql
    state: present
    db_instance_class: 'db.t3.medium'

- name: Remove a cluster from global DB (do not delete)
  amazon.aws.rds_cluster:
    db_cluster_identifier: '{{ cluster_id }}'
    global_cluster_identifier: '{{ global_cluster_id }}'
    remove_from_global_db: true

- name: Remove a cluster from global DB and Delete without creating a final snapshot
  amazon.aws.rds_cluster:
    engine: aurora
    password: "{{ password }}"
    username: "{{ username }}"
    cluster_id: "{{ cluster_id }}"
    skip_final_snapshot: true
    remove_from_global_db: true
    wait: true
    state: absent

- name: Update cluster port and WAIT for remove secondary DB cluster from global DB to complete
  amazon.aws.rds_cluster:
    db_cluster_identifier: "{{ secondary_cluster_name }}"
    global_cluster_identifier: "{{ global_cluster_name }}"
    remove_from_global_db: true
    state: present
    port: 3389
    region: "{{ secondary_cluster_region }}"

- name: Update cluster port and DO NOT WAIT for remove secondary DB cluster from global DB to complete
  amazon.aws.rds_cluster:
    db_cluster_identifier: "{{ secondary_cluster_name }}"
    global_cluster_identifier: "{{ global_cluster_name }}"
    remove_from_global_db: true
    state: present
    port: 3389
    region: "{{ secondary_cluster_region }}"
    wait: false

Возвращаемые значения

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

Ключ

Описание

activity_stream_status

string

Состояние потока активности базы данных.

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

Пример: "stopped"

allocated_storage

integer

Размер выделенного хранилища в гигабайтах. Поскольку размер хранилища Aurora не фиксирован, для движков баз данных Aurora это значение всегда равно 1.

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

Пример: 1

associated_roles

list / elements=string

Список словарей с ролями AWS Identity and Access Management (IAM), связанными с кластером БД. Каждый словарь содержит role_arn и состояние роли.

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

Пример: []

auto_minor_version_upgrade

boolean

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

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

Пример: true

availability_zones

list / elements=string

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

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

Пример: ["us-east-1c", "us-east-1a", "us-east-1e"]

backup_retention_period

integer

Количество дней хранения автоматических снимков БД.

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

Пример: 1

changed

boolean

Изменился ли кластер RDS.

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

Пример: true

cluster_create_time

string

Время создания кластера БД в формате UTC.

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

Пример: "2018-06-29T14:08:58.491000+00:00"

copy_tags_to_snapshot

boolean

Указывает, копируются ли теги кластера БД в его снимки.

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

Пример: false

cross_account_clone

boolean

Указывает, является ли кластер БД клоном кластера БД, принадлежащего другой учетной записи Amazon Web Services.

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

Пример: false

db_cluster_arn

string

Amazon Resource Name (ARN) кластера БД.

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

Пример: "arn:aws:rds:us-east-1:123456789012:cluster:rds-cluster-demo"

db_cluster_identifier

string

Идентификатор кластера БД в нижнем регистре, заданный пользователем.

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

Пример: "rds-cluster-demo"

db_cluster_members

list / elements=string

Список словарей с информацией об экземплярах в кластере. Каждый словарь содержит db_instance_identifier, is_cluster_writer (bool), db_cluster_parameter_group_status и promotion_tier (int).

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

Пример: []

db_cluster_parameter_group

string

Группа параметров, связанная с кластером БД.

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

Пример: "default.aurora5.6"

db_cluster_resource_id

string

Уникальный в регионе AWS неизменяемый идентификатор кластера БД.

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

Пример: "cluster-D2MEQDN3BQNXDF74K6DQJTHASU"

db_subnet_group

string

Имя группы подсетей, связанной с кластером БД.

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

Пример: "default"

deletion_protection

boolean

Указывает, включена ли для кластера БД защита от удаления. При включенной защите базу данных нельзя удалить.

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

Пример: false

domain_memberships

list / elements=string

Записи о членстве в домене Active Directory, связанные с кластером БД.

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

Пример: []

earliest_restorable_time

string

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

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

Пример: "2018-06-29T14:09:34.797000+00:00"

endpoint

string

Конечная точка подключения к основному экземпляру кластера БД.

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

Пример: "rds-cluster-demo.cluster-cvlrtwiennww.us-east-1.rds.amazonaws.com"

engine

string

Движок базы данных кластера БД.

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

Пример: "aurora"

engine_mode

string

Режим движка БД кластера БД.

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

Пример: "provisioned"

engine_version

string

Версия движка базы данных.

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

Пример: "5.6.10a"

hosted_zone_id

string

Идентификатор, который Amazon Route 53 назначает при создании размещенной зоны.

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

Пример: "Z2R2ITUGPM61AM"

http_endpoint_enabled

boolean

Значение, указывающее, включена ли конечная точка HTTP для кластера БД Aurora Serverless.

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

Пример: false

iam_database_authentication_enabled

boolean

Могут ли учетные записи IAM сопоставляться с учетными записями базы данных.

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

Пример: false

latest_restorable_time

string

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

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

Пример: "2018-06-29T14:09:34.797000+00:00"

master_username

string

Имя пользователя администратора кластера БД.

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

Пример: "username"

multi_az

boolean

Есть ли у кластера БД экземпляры в нескольких зонах доступности.

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

Пример: false

port

integer

Порт, на котором прослушивает соединения движок базы данных.

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

Пример: 3306

preferred_backup_window

string

Еженедельный временной интервал в формате UTC, в течение которого может выполняться обслуживание системы.

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

Пример: "10:18-10:48"

preferred_maintenance_window

string

Еженедельный временной интервал в формате UTC, в течение которого может выполняться обслуживание системы.

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

Пример: "tue:03:23-tue:03:53"

read_replica_identifiers

list / elements=string

Список строковых идентификаторов реплик для чтения, связанных с кластером БД.

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

Пример: []

reader_endpoint

string

Конечная точка для чтения кластера БД.

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

Пример: "rds-cluster-demo.cluster-ro-cvlrtwiennww.us-east-1.rds.amazonaws.com"

serverless_v2_scaling_configuration

dictionary

добавлено в amazon.aws 7.3.0

Конфигурация масштабирования кластера БД Aurora Serverless v2.

Возвращается: если настроено

Пример: {"max_capacity": 4.5, "min_capacity": 2.5}

status

string

Состояние кластера БД.

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

Пример: "available"

storage_encrypted

boolean

Зашифровано ли хранилище кластера БД.

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

Пример: false

tag_list

list / elements=dictionary

Список тегов, состоящих из пар «ключ — значение».

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

Пример: [{"key": "Created_By", "value": "Ansible_rds_cluster_integration_test"}]

tags

dictionary

Словарь пар «ключ — значение».

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

Пример: {"Name": "rds-cluster-demo"}

vpc_security_groups

complex

Список групп безопасности кластера БД и их состояний.

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

status

string

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

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

Пример: "active"

vpc_security_group_id

string

Группа безопасности кластера.

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

Пример: "sg-12345678"

Авторы

  • Sloane Hertel (@s-hertel)
  • 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_cluster_module.html

Spec-Zone.ru

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