Spec-Zone.ru › Ansible

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

Примечание

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

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

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key

строка

ID ключа доступа 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.

allocated_storage

целое число

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

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

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

apply_immediately

булево

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

Варианты:

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

availability_zones

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

список / элементы=строка

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

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.

backtrack_to

строка

Отметка времени для возврата кластера БД в формате ISO 8601, например, «2017-07-08T18:00Z».

backtrack_window

целое число

Целевое окно возврата в секундах. Для отключения возврата установите это значение в 0.

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

backup_retention_period

целое число

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

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

character_set_name

строка

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

copy_tags_to_snapshot

булево

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

Варианты:

  • false
  • true

creation_source

строка

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

Варианты:

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

database_name

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

строка

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

db_cluster_identifier

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

строка / обязательно

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

db_cluster_instance_class

строка

добавлено в 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

строка

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

db_subnet_group_name

string

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

debug_botocore_endpoint_logs

boolean

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

enable_cloudwatch_logs_exports

list / elements=string

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

Двигатель aurora-mysql поддерживает audit, error, general и slowquery.

Двигатель aurora-postgresql поддерживает postgresql.

enable_global_write_forwarding

boolean

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

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

Варианты:

  • false
  • true

enable_http_endpoint

boolean

Указывает, нужно ли включить HTTP-точку входа для кластера БД Aurora Serverless. По умолчанию HTTP-точка входа отключена.

Варианты:

  • false
  • true

enable_iam_database_authentication

boolean

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

Варианты:

  • 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

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), которые должны быть первоначально выделены для каждого экземпляра базы данных в многозонном кластере баз данных.

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

Должно быть кратно от 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 символа для пользователя базы данных master.

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

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

master_username

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

string

Имя пользователя master для кластера баз данных. Должно содержать от 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 и security_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

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.

remove_from_global_db

boolean

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

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

Параметры global_cluster_identifier, db_cluster_identifier должны быть указаны, когда remove_from_global_db=true.

Варианты:

  • false
  • true

replication_source_identifier

aliases: replication_src_id

string

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

restore_to_time

string

UTC дата и время восстановления кластера БД. Должен быть в формате “2015-03-07T23:45:00Z”.

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

restore_type

string

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

Варианты:

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

role_arn

string

Amazon Resource Name (ARN) роли IAM, которую нужно ассоциировать с кластером Aurora DB, например “arn:aws:iam::123456789012:role/AuroraAccessRole”

s3_bucket_name

string

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

s3_ingestion_role_arn

string

Amazon Resource Name (ARN) роли AWS Identity and Access Management (IAM), которая разрешает Amazon RDS доступ к Amazon S3 bucket от вашего имени.

s3_prefix

string

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

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

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

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной окружения EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.

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

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.

skip_final_snapshot

boolean

Создается ли финальный снимок кластера DB перед удалением кластера DB.

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

Варианты:

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

snapshot_identifier

string

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

Вы можете использовать имя или ARN для указания снимка кластера DB. Однако вы можете использовать только ARN для указания снимка DB.

source_db_cluster_identifier

string

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

source_engine

string

Идентификатор для механизма базы данных, который был зарезервирован для создания файлов, хранящихся в корзине Amazon S3.

Варианты:

  • "mysql"

source_engine_version

string

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

source_region

string

Идентификатор региона, содержащего источник для кластера DB.

state

string

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

started и stopped могут использоваться только с кластерами Aurora.

Поддержка started и stopped была добавлена в версии 6.3.0.

Варианты:

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

storage_encrypted

boolean

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

Варианты:

  • false
  • true

storage_type

string

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

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

Этот параметр необходим для создания многозонного кластера DB.

Для многозонных кластеров DB storage_type по умолчанию имеет значение io1, и требуется значение для параметра iops.

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

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

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

Варианты:

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

tags

aliases: resource_tags

dictionary

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

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

use_earliest_time_on_point_in_time_unavailable

boolean

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

Варианты:

  • false
  • true

use_latest_restorable_time

boolean

Восстанавливать ли кластер DB до последнего времени восстановления резервной копии. Можно указать только один из параметров 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, которые необходимо связать с кластером DB.

wait

boolean

Ожидать ли готовности или удаления кластера.

Варианты:

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

Примечания

Примечание

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

строка

Статус потока событий базы данных.

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

Пример: "stopped"

allocated_storage

целое число

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

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

Пример: 1

associated_roles

список / элементы=строка

Список словарей ролей управления доступом и идентификацией (IAM) AWS, связанных с кластером баз данных. Каждый словарь содержит role_arn и статус роли.

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

Пример: []

auto_minor_version_upgrade

булево

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

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

Пример: true

availability_zones

список / элементы=строка

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

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

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

backup_retention_period

целое число

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

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

Пример: 1

changed

булево

Если кластер RDS был изменен.

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

Пример: true

cluster_create_time

строка

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

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

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

copy_tags_to_snapshot

булево

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

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

Пример: false

cross_account_clone

булево

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

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

Пример: false

db_cluster_arn

строка

Amazon Resource Name (ARN) для кластера баз данных.

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

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

db_cluster_identifier

строка

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

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

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

db_cluster_members

список / элементы=строка

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

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

Пример: []

db_cluster_parameter_group

строка

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

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

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

db_cluster_resource_id

строка

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

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

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

db_subnet_group

строка

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

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

Пример: "default"

deletion_protection

boolean

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

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

Пример: false

domain_memberships

list / elements=string

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

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

Пример: []

earliest_restorable_time

string

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

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

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

endpoint

string

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

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

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

engine

string

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

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

Пример: "aurora"

engine_mode

string

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

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

Пример: "provisioned"

engine_version

string

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

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

Пример: "5.6.10a"

hosted_zone_id

string

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

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

Пример: "Z2R2ITUGPM61AM"

http_endpoint_enabled

boolean

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

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

Пример: false

iam_database_authentication_enabled

boolean

Возможно ли сопоставление учетных записей IAM с учетными записями базы данных.

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

Пример: false

latest_restorable_time

string

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

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

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

master_username

string

Основное имя пользователя для кластера DB.

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

Пример: "username"

multi_az

boolean

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

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

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

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

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

Пример: []

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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/amazon/aws/rds_cluster_module.html

Spec-Zone.ru

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