amazon.aws.rds_instance модуль — Управление экземплярами RDS

Примечание

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

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

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

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

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

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

Описание

Создание, изменение и удаление экземпляров RDS.
Этот модуль был первоначально добавлен в community.aws в релизе 1.0.0.

Требования

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

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

Параметры

Параметр	Комментарии
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string	Идентификатор ключа доступа AWS. См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные среды `AWS_ACCESS_KEY_ID`, `AWS_ACCESS_KEY` или `EC2_ACCESS_KEY` также могут использоваться в порядке убывания приоритета. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в версии 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
allocated_storage integer	Объем хранилища (в гибибайтах), который необходимо выделить для экземпляра DB.
allow_major_version_upgrade boolean	Разрешать ли обновления до основных версий. Варианты: `false` `true`
apply_immediately boolean	Значение, указывающее, следует ли применять изменение экземпляра с `new_db_instance_identifier` и master_user_password как можно скорее, независимо от настройки `preferred_maintenance_window`. Если `false`, изменения применяются во время следующего окна обслуживания. Варианты: `false` ← (по умолчанию) `true`
auto_minor_version_upgrade boolean	Применяются ли обновления до второстепенных версий автоматически к экземпляру DB во время окна обслуживания. Варианты: `false` `true`
availability_zone aliases: az, zone string	Список зон доступности EC2, в которых может быть создан экземпляр DB. Может использоваться при создании экземпляра или при восстановлении из S3 или снимка. Взаимоисключающий с `multi_az`.
aws_ca_bundle path	Расположение пакета CA, который используется при проверке SSL-сертификатов. Переменная среды `AWS_CA_BUNDLE` также может использоваться.
aws_config dictionary	Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
backup_retention_period integer	Количество дней, в течение которых хранятся автоматические резервные копии. При установке значения `0` автоматические резервные копии будут отключены. (Не применимо, если экземпляр DB является источником для чтения реплик) Может использоваться при создании нового экземпляра, при восстановлении из S3 или при изменении экземпляра.
ca_certificate_identifier string	Идентификатор сертификата CA для экземпляра DB.
character_set_name string	Кодировка символов, которая будет связана с экземпляром DB.
copy_tags_to_snapshot boolean	Копировать ли все теги из экземпляра DB в снимки экземпляра. При первоначальном создании экземпляра DB API RDS по умолчанию устанавливает это значение в `false`, если оно не указано. Варианты: `false` `true`
creation_source string	Какой источник использовать при восстановлении из шаблона (существующий экземпляр, корзину S3 или снимок). Варианты: `"snapshot"` `"s3"` `"instance"`
db_cluster_identifier aliases: cluster_id string	Идентификатор кластера DB (в нижнем регистре), к которому нужно добавить экземпляр aurora DB. Идентификатор должен содержать от 1 до 63 букв, цифр или дефисов, а первый символ должен быть буквой; он не может заканчиваться дефисом или содержать последовательные дефисы.
db_instance_class aliases: class, instance_type string	Вычислительные ресурсы и объем памяти экземпляра DB, например `db.t3.micro`.
db_instance_identifier aliases: instance_id, id string / required	Идентификатор экземпляра DB (в нижнем регистре). Идентификатор должен содержать от 1 до 63 букв, цифр или дефисов, а первый символ должен быть буквой; он не может заканчиваться дефисом или содержать последовательные дефисы.

db_name string	Имя вашей базы данных. Если имя не указано, Amazon RDS не создаст базу данных.
db_parameter_group_name string	Имя группы параметров БД, которое следует связать с этим экземпляром БД. При создании экземпляра БД, если этот аргумент опущен, используется группа параметров БД по умолчанию для указанного движка.
db_security_groups list / elements=string	(Платформа EC2-Classic) Список групп безопасности БД, которые следует связать с этим экземпляром БД.
db_snapshot_identifier aliases: snapshot_identifier, snapshot_id string	Идентификатор или ARN моментальной копии БД, из которого необходимо восстановить при использовании `creation_source=snapshot`.
db_subnet_group_name aliases: subnet_group 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 добавлено в community.aws 3.3.0	Значение, указывающее, включена ли защита от удаления для экземпляра БД. При включённой защите от удаления базу данных нельзя удалить. По умолчанию защита от удаления отключена. Варианты: `false` `true`
domain string	Домен Active Directory, в котором необходимо восстановить экземпляр.
domain_iam_role_name string	Имя роли IAM, которое будет использоваться при выполнении API-вызовов к службе каталогов.
enable_cloudwatch_logs_exports aliases: cloudwatch_log_exports list / elements=string	Список типов логов, которые необходимо включить для экспорта в CloudWatch Logs.
enable_iam_database_authentication boolean	Включить отображение учетных записей AWS Identity and Access Management (IAM) в учетные записи баз данных. Если этот параметр опущен при создании экземпляра, Amazon RDS устанавливает его в значение `false`. Варианты: `false` `true`
enable_performance_insights boolean	Включить Performance Insights для экземпляра БД. Варианты: `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	Имя базы данных, используемого движка, для этого экземпляра БД. Это обязательно для создания экземпляра. Варианты: `"aurora"` `"aurora-mysql"` `"aurora-postgresql"` `"mariadb"` `"mysql"` `"oracle-ee"` `"oracle-ee-cdb"` `"oracle-se2"` `"oracle-se2-cdb"` `"postgres"` `"sqlserver-ee"` `"sqlserver-se"` `"sqlserver-ex"` `"sqlserver-web"`
engine_version string	Номер версии используемого движка базы данных. Для Aurora MySQL это может быть `5.6.10a`, `5.7.12`. Пример для Aurora PostgreSQL, `9.6.3`
final_db_snapshot_identifier aliases: final_snapshot_identifier string	Идентификатор моментальной копии экземпляра БД нового экземпляра БД, созданной, когда `skip_final_snapshot` `false`.
force_failover boolean	Установите в значение `true`, чтобы выполнить перезагрузку через отказоустойчивое переключение MultiAZ. Варианты: `false` `true`

force_update_password boolean	Установите в значение `true`, чтобы обновить пароль вашей базы данных с `master_user_password`. Поскольку сравнение паролей для определения необходимости обновления невозможно, по умолчанию это значение установлено в `false` для обеспечения идемпотентности. Варианты: `false` ← (по умолчанию) `true`
iam_roles list / elements=dictionary добавлен в community.aws 3.3.0	Список ролей управления доступом и идентификацией (IAM) Amazon Web Services для ассоциации с экземпляром БД.
feature_name string / обязательно	Имя функции, связанной с ролью IAM.
role_arn string / обязательно	ARN роли IAM для ассоциации с экземпляром БД.
iops integer	Значение Provisioned IOPS (количество операций ввода/вывода в секунду). Устанавливается только при использовании `storage_type`, установленного в io1.
kms_key_id string	ARN идентификатора ключа AWS KMS для зашифрованного экземпляра БД. Если вы создаёте экземпляр БД с использованием той же учётной записи AWS, что и владелец ключа шифрования KMS, используемого для шифрования нового экземпляра БД, вы можете использовать псевдоним ключа KMS вместо ARN ключа шифрования KM. Если `storage_encrypted` имеет значение `true` и этот параметр не указан, используется ключ шифрования по умолчанию.
license_model string	Модель лицензии для экземпляра БД. Доступны варианты: license-included, bring-your-own-license и general-public-license. Этот параметр также можно опустить, чтобы использовать значение по умолчанию.
master_user_password aliases: password string	Пароль пользователя master базы данных длиной от 8 до 41 символа. Пароль может содержать любые печатные символы ASCII, кроме `/`, `"` или `@`. Для изменения пароля используйте force_update_password. Используйте `apply_immediately`, чтобы изменить пароль немедленно, в противном случае он будет обновлён во время следующего окна технического обслуживания.
master_username aliases: username string	Имя пользователя master для экземпляра БД. Должно содержать от 1 до 16 букв или цифр и начинаться с буквы.
max_allocated_storage integer	Максимальный объём хранилища, до которого Amazon RDS может автоматически масштабировать хранилище экземпляра БД.
monitoring_interval integer	Интервал (в секундах) сбора данных мониторинга Enhanced Monitoring для экземпляра БД. Для отключения сбора данных укажите `0`. Amazon RDS по умолчанию устанавливает это значение в 0, если оно не указано при первоначальном создании экземпляра БД.
monitoring_role_arn string	ARN роли IAM, разрешающей RDS отправлять данные улучшенного мониторинга в Amazon CloudWatch Logs.
multi_az boolean	Указывает, является ли экземпляр БД многозонной установкой Multi-AZ. Взаимоисключительно с `availability_zone`. Варианты: `false` `true`
new_db_instance_identifier aliases: new_instance_id, new_id string	Новый идентификатор экземпляра БД (строчные буквы) для переименования экземпляра БД. Идентификатор должен содержать от 1 до 63 букв, цифр или дефисов, начинаться с буквы и не может заканчиваться дефисом или содержать последовательные дефисы. Используйте `apply_immediately`, чтобы переименовать немедленно, в противном случае это будет обновлено во время следующего окна технического обслуживания.
option_group_name string	Группа параметров, которая будет ассоциирована с экземпляром БД.
performance_insights_kms_key_id string	Идентификатор ключа AWS KMS (ARN, имя или псевдоним) для шифрования данных Performance Insights.
performance_insights_retention_period integer	Срок хранения данных Performance Insights в днях. Допустимые значения: 7 или 731.
port integer	Номер порта, на котором экземпляры принимают подключения.
preferred_backup_window aliases: backup_window string	Временной диапазон (в формате UTC) продолжительностью не менее 30 минут, в течение которого создаются автоматические резервные копии, если автоматические резервные копии включены с помощью `backup_retention_period`. Параметр должен иметь формат «hh24:mi-hh24:mi» и не должен конфликтовать с `preferred_maintenance_window`.

preferred_maintenance_window aliases: maintenance_window string	Диапазон времени в течение недели (в UTC) продолжительностью не менее 30 минут, в который может происходить техническое обслуживание системы. Параметр должен быть в формате «ddd:hh24:mi-ddd:hh24:mi», где ddd — один из Mon, Tue, Wed, Thu, Fri, Sat, Sun.
processor_features dictionary	Словарь пар Имя-Значение, указывающий количество ядер процессора и количество потоков на ядро для класса базы данных экземпляра базы данных. Имена — threadsPerCore и coreCount. Установите этот параметр в пустой словарь, чтобы использовать стандартные характеристики процессора.
coreCount string	Количество ядер процессора
threadsPerCore string	Количество потоков на ядро
profile aliases: aws_profile string	Используемый именованный профиль AWS для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды `AWS_PROFILE`. Параметр profile несовместим с параметрами aws_access_key, aws_secret_key и security_token.
promotion_tier integer	Целое число, указывающее порядок, в котором репликация Aurora повышается до основного экземпляра после отказа существующего основного экземпляра.
publicly_accessible boolean	Указывает параметры доступности для экземпляра базы данных. Значение Vtrue) указывает экземпляр, доступный через Интернет, с публичным именем DNS, которое разрешается по общедоступному IP-адресу. Значение `false` указывает внутренний экземпляр с именем DNS, которое разрешается по частному IP-адресу. Варианты: `false` `true`
purge_cloudwatch_logs_exports boolean	Установите в значение `false`, чтобы сохранить все включенные журналы cloudwatch, которые не указаны в задании и связаны с экземпляром. Установите `enable_cloudwatch_logs_exports` в пустой список, чтобы отключить все. Варианты: `false` `true` ← (по умолчанию)
purge_iam_roles boolean добавлен в community.aws 3.3.0	Установите в `true`, чтобы удалить все роли IAM, которые не указаны в задании и связаны с экземпляром. Варианты: `false` ← (по умолчанию) `true`
purge_security_groups boolean добавлен в community.aws 1.5.0	Установите в `false`, чтобы сохранить все включенные группы безопасности, которые не указаны в задании и связаны с экземпляром. Может применяться к `vpc_security_group_ids` и `db_security_groups` Варианты: `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` ← (по умолчанию)
read_replica boolean	Установите в значение `false`, чтобы повысить экземпляр-реплику чтения до основного или `true`, чтобы создать его. При создании реплики чтения `creation_source` следует установить в «instance» или не указывать. `source_db_instance_identifier` должен быть предоставлен с этим параметром. Варианты: `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.
restore_time string	Если используется creation_source=instance, это указывает дату и время UTC для восстановления из исходного экземпляра. Например, «2009-09-07T23:45:00Z». Можно также установить `use_latest_restorable_time=true`. Можно указать только один из `use_latest_restorable_time` и `restore_time`.

s3_bucket_name string	Имя корзины Amazon S3, содержащей данные, используемые для создания экземпляра Amazon DB.
s3_ingestion_role_arn string	Универсальное имя ресурса (ARN) роли AWS Identity and Access Management (IAM), которая разрешает Amazon RDS доступ к корзине Amazon S3 от вашего имени.
s3_prefix string	Префикс для всех имен файлов, содержащих данные, используемые для создания экземпляра Amazon DB. Если вы не укажете значение SourceS3Prefix, то экземпляр Amazon DB будет создан с использованием всех файлов в корзине Amazon S3.
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.
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_db_snapshot_identifier` должно быть указано. Варианты: `false` ← (по умолчанию) `true`
source_db_instance_identifier string	Идентификатор или ARN исходного экземпляра DB, из которого выполняется восстановление при создании реплики для чтения или запуске экземпляра DB в определенный момент времени с использованием `creation_source=instance`. Если исходный DB находится не в том же регионе, это должен быть ARN.
source_engine string	Идентификатор для механизма базы данных, который был зарезервирован для создания файлов, хранящихся в корзине Amazon S3. Варианты: `"mysql"`
source_engine_version string	Версия базы данных, из которой были созданы резервные файлы.
source_region string	Регион экземпляра DB, из которого создается реплика.
state string	Требуемое состояние экземпляра RDS. `state=rebooted` не является идемпотентным и оставит экземпляр DB в рабочем состоянии и запустит его перед перезагрузкой, если он был остановлен. `present` оставит экземпляр DB в текущем рабочем/остановленном состоянии (рабочем, если создается экземпляр DB). `state=running` и state=started являются синонимами, как и `state=rebooted` и `state=restarted`. Варианты: `"present"` ← (по умолчанию) `"absent"` `"terminated"` `"running"` `"started"` `"stopped"` `"rebooted"` `"restarted"`
storage_encrypted boolean	Зашифрован ли экземпляр DB. Варианты: `false` `true`
storage_throughput integer добавлено в amazon.aws 5.2.0	Пропускная способность хранилища, когда `storage_type` является `gp3`. Когда выделенное хранилище меньше 400 ГБ, пропускная способность хранилища всегда будет 125 МБ/с. Когда выделенное хранилище больше или равно 400 ГБ, пропускная способность начинается с 500 МБ/с. Требуется botocore >= 1.29.0.
storage_type string	Тип хранилища, который будет связан с экземпляром DB. `storage_type` не применяется к экземплярам Aurora DB. Варианты: `"standard"` `"gp2"` `"gp3"` `"io1"`

метки псевдонимы: resource_tags словарь	Словарь, представляющий метки, которые необходимо применить к ресурсу. Если параметр метки не задан, метки не будут изменены.
tde_credential_arn псевдонимы: transparent_data_encryption_arn строка	ARN из хранилища ключей, с которым необходимо связать экземпляр для прозрачного шифрования данных. Это поддерживается экземплярами баз данных Oracle или SQL Server и может использоваться в сочетании с `storage_encrypted`, хотя это может немного повлиять на производительность вашей базы данных.
tde_credential_password псевдонимы: transparent_data_encryption_password строка	Пароль для данного ARN из хранилища ключей для доступа к устройству.
часовой пояс строка	Часовой пояс экземпляра БД.
use_latest_restorable_time псевдонимы: restore_from_latest логическое	Восстановить экземпляр БД до последнего времени, доступного для восстановления. Можно указать только один из `use_latest_restorable_time` и `restore_time`. Варианты: `false` `true`
validate_certs логическое	Если установлено `false`, сертификаты SSL не будут проверены для связи с API AWS. Сильно не рекомендуется устанавливать validate_certs=false, в качестве альтернативы, рассмотрите установку aws_ca_bundle вместо этого. Варианты: `false` `true` ← (по умолчанию)
vpc_security_group_ids список / элементы=строка	Список EC2 групп безопасности VPC для ассоциации с экземпляром БД.
ожидание логическое	Ожидать готовности, остановки или удаления экземпляра. В будущем может быть добавлен параметр wait_timeout. После каждого вызова API для создания/модификации/удаления экземпляра используется ожидание с задержкой 60 секунд 30 раз, пока экземпляр не достигнет ожидаемого состояния (доступен/остановлен/удален). Общее время выполнения задачи также может зависеть от AWSRetry, который помогает стабилизировать ситуацию, если экземпляр находится в недопустимом состоянии для операций (например, если вы пытаетесь остановить его, когда он перезапускается). Если установить значение `false`, повторы задачи и задержки могут улучшить обработку таймаутов вашей книги задач при основных изменениях. Варианты: `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 instance in default VPC and default subnet group
  amazon.aws.rds_instance:
    engine: aurora
    db_instance_identifier: ansible-test-aurora-db-instance
    instance_type: db.t3.small
    password: "{{ password }}"
    username: "{{ username }}"
    cluster_id: ansible-test-cluster  # This cluster must exist - see rds_cluster to manage it

- name: Create a DB instance using the default AWS KMS encryption key
  amazon.aws.rds_instance:
    id: test-encrypted-db
    state: present
    engine: mariadb
    storage_encrypted: true
    db_instance_class: db.t3.medium
    username: "{{ username }}"
    password: "{{ password }}"
    allocated_storage: "{{ allocated_storage }}"

- name: Remove the DB instance without a final snapshot
  amazon.aws.rds_instance:
    id: "{{ instance_id }}"
    state: absent
    skip_final_snapshot: true

- name: Remove the DB instance with a final snapshot
  amazon.aws.rds_instance:
    id: "{{ instance_id }}"
    state: absent
    final_snapshot_identifier: "{{ snapshot_id }}"

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

# Add IAM role to db instance
- name: Create IAM policy
  amazon.aws.iam_managed_policy:
    policy_name: "my-policy"
    policy: "{{ lookup('file','files/policy.json') }}"
    state: present
  register: iam_policy

- name: Create IAM role
  community.aws.iam_role:
    assume_role_policy_document: "{{ lookup('file','files/assume_policy.json') }}"
    name: "my-role"
    state: present
    managed_policy: "{{ iam_policy.policy.arn }}"
  register: iam_role

- name: Create DB instance with added IAM role
  amazon.aws.rds_instance:
    id: "my-instance-id"
    state: present
    engine: postgres
    engine_version: 14.2
    username: "{{ username }}"
    password: "{{ password }}"
    db_instance_class: db.m6g.large
    allocated_storage: "{{ allocated_storage }}"
    iam_roles:
      - role_arn: "{{ iam_role.arn }}"
        feature_name: 's3Export'

- name: Remove IAM role from DB instance
  amazon.aws.rds_instance:
    id: "my-instance-id"
    state: present
    purge_iam_roles: true

# Restore DB instance from snapshot
- name: Create a snapshot and wait until completion
  amazon.aws.rds_instance_snapshot:
    instance_id: 'my-instance-id'
    snapshot_id: 'my-new-snapshot'
    state: present
    wait: true
  register: snapshot

- name: Restore DB from snapshot
  amazon.aws.rds_instance:
    id: 'my-restored-db'
    creation_source: snapshot
    snapshot_identifier: 'my-new-snapshot'
    engine: mariadb
    state: present
  register: restored_db

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

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

Ключ	Описание
allocated_storage целое число	Размер выделенного хранилища в гигабайтах. Для движков баз данных Aurora всегда равно 1. Возвращается: всегда Пример: `20`
associated_roles список / элементы=строка	Список текущих связанных ролей. Возвращается: всегда Пример: `[]`
auto_minor_version_upgrade логическое значение	Применяются ли автоматически мелкие обновления движка к экземпляру БД во время окна обслуживания. Возвращается: всегда Пример: `true`
availability_zone строка	Зона доступности для экземпляра БД. Возвращается: всегда Пример: `"us-east-1f"`
backup_retention_period целое число	Количество дней, в течение которых сохраняются автоматические резервные копии. Возвращается: всегда Пример: `1`
ca_certificate_identifier строка	Идентификатор сертификата CA для экземпляра БД. Требуется минимальная версия botocore 1.29.44. Возвращается: всегда Пример: `"rds-ca-2015"`
copy_tags_to_snapshot логическое значение	Копируются ли метки с экземпляра БД на снимки экземпляра БД. Возвращается: всегда Пример: `false`
db_instance_arn строка	Amazon Resource Name (ARN) для экземпляра БД. Возвращается: всегда Пример: `"arn:aws:rds:us-east-1:123456789012:db:ansible-test"`
db_instance_class строка	Название класса вычислительной и оперативной памяти экземпляра БД. Возвращается: всегда Пример: `"db.m5.large"`
db_instance_identifier строка	Идентификатор экземпляра БД. Возвращается: всегда Пример: `"ansible-test"`
db_instance_port целое число	Порт, на котором работает экземпляр БД. Возвращается: всегда Пример: `0`
db_instance_status строка	Текущее состояние базы данных. Возвращается: всегда Пример: `"stopped"`
db_parameter_groups сложное	Список групп параметров БД, применяемых к этому экземпляру БД. Возвращается: всегда
db_parameter_group_name строка	Имя группы параметров DP. Возвращается: всегда Пример: `"default.mariadb10.0"`
parameter_apply_status строка	Статус обновлений параметров. Возвращается: всегда Пример: `"in-sync"`
db_security_groups список / элементы=строка	Список групп безопасности БД, связанных с этим экземпляром БД. Возвращается: всегда Пример: `[]`
db_subnet_group сложное	Группа подсетей, связанная с экземпляром БД. Возвращается: всегда

db_subnet_group_description string	Описание группы подсетей БД. Возвращается: всегда Пример: `"default"`
db_subnet_group_name string	Имя группы подсетей БД. Возвращается: всегда Пример: `"default"`
subnet_group_status string	Статус группы подсетей БД. Возвращается: всегда Пример: `"Complete"`
subnets complex	Список элементов подсетей. Возвращается: всегда
subnet_availability_zone complex	Зона доступности подсети. Возвращается: всегда
name string	Имя зоны доступности. Возвращается: всегда Пример: `"us-east-1c"`
subnet_identifier string	Идентификатор подсети. Возвращается: всегда Пример: `"subnet-12345678"`
subnet_status string	Статус подсети. Возвращается: всегда Пример: `"Active"`
vpc_id string	VpcId группы подсетей БД. Возвращается: всегда Пример: `"vpc-12345678"`
dbi_resource_id string	Уникальный, неизменяемый идентификатор экземпляра БД, уникальный для региона AWS. Возвращается: всегда Пример: `"db-UHV3QRNWX4KB6GALCIGRML6QFA"`
deletion_protection boolean added in community.aws 3.3.0	`true`, если для экземпляра БД включена защита от удаления, `False`, если нет. Возвращается: всегда Пример: `false`
domain_memberships list / elements=string	Записи членства в домене Active Directory, связанные с экземпляром БД. Возвращается: всегда Пример: `[]`
endpoint complex	Точка подключения. Возвращается: всегда
address string	DNS-адрес экземпляра БД. Возвращается: всегда Пример: `"ansible-test.cvlrtwiennww.us-east-1.rds.amazonaws.com"`
hosted_zone_id string	Идентификатор, назначенный Amazon Route 53 при создании зоны размещения. Возвращается: всегда Пример: `"ZTR2ITUGPA61AM"`
port integer	Порт, на котором прослушивает базовая система управления данными. Возвращается: всегда Пример: `3306`
engine string	Версия СУБД. Возвращается: всегда Пример: `"mariadb"`
engine_version string	Версия СУБД. Возвращается: всегда Пример: `"10.0.35"`

iam_database_authentication_enabled boolean	Включено ли отображение учетных записей AWS Identity and Access Management (IAM) в учетные записи баз данных. Возвращается: всегда Пример: `false`
instance_create_time string	Дата и время создания экземпляра базы данных. Возвращается: всегда Пример: `"2018-07-04T16:48:35.332000+00:00"`
kms_key_id string	Идентификатор ключа AWS KMS для зашифрованного экземпляра базы данных, когда storage_encrypted равно true. Возвращается: Когда storage_encrypted равно true Пример: `"arn:aws:kms:us-east-1:123456789012:key/70c45553-ad2e-4a85-9f14-cfeb47555c33"`
latest_restorable_time string	Самое позднее время, до которого база данных может быть восстановлена с помощью восстановления по состоянию на определенный момент времени. Возвращается: всегда Пример: `"2018-07-04T16:50:50.642000+00:00"`
license_model string	Информация о лицензионной модели для этого экземпляра базы данных. Возвращается: всегда Пример: `"general-public-license"`
master_username string	Имя пользователя для главного пользователя экземпляра базы данных. Возвращается: всегда Пример: `"test"`
max_allocated_storage integer	Максимальный предел, до которого Amazon RDS может автоматически масштабировать хранилище экземпляра базы данных. Возвращается: При наличии максимального выделенного хранилища. Пример: `100`
monitoring_interval integer	Интервал в секундах между моментами сбора метрик Enhanced Monitoring для экземпляра базы данных. 0 означает отключение сбора метрик Enhanced Monitoring. Возвращается: всегда Пример: `0`
multi_az boolean	Является ли экземпляр базы данных развертыванием Multi-AZ. Возвращается: всегда Пример: `false`
option_group_memberships complex	Список членств в группах параметров для этого экземпляра базы данных. Возвращается: всегда
option_group_name string	Имя группы параметров, к которой принадлежит экземпляр. Возвращается: всегда Пример: `"default:mariadb-10-0"`
status string	Статус членства экземпляра базы данных в группе параметров. Возвращается: всегда Пример: `"in-sync"`
pending_modified_values complex	Ожидаемые изменения в экземпляре базы данных. Возвращается: всегда
performance_insights_enabled boolean	true, если для экземпляра базы данных включены Performance Insights, и false в противном случае. Возвращается: всегда Пример: `false`
preferred_backup_window string	Ежедневный диапазон времени, в течение которого создаются автоматические резервные копии, если автоматические резервные копии включены. Возвращается: всегда Пример: `"07:01-07:31"`
preferred_maintenance_window string	Еженедельный диапазон времени (в формате UTC), в течение которого может выполняться техническое обслуживание системы. Возвращается: всегда Пример: `"sun:09:31-sun:10:01"`
publicly_accessible boolean	`True` для экземпляра, доступного через Интернет, с публично разрешаемым именем DNS, `False` для обозначения внутреннего экземпляра с именем DNS, которое разрешается на частный IP-адрес. Возвращается: всегда Пример: `true`

read_replica_db_instance_identifiers список / элементы=строка	Идентификаторы Реплик чтения, связанные с этим экземпляром БД. Возвращается: всегда Пример: `[]`
storage_encrypted логическое	Зашифрован ли том БД. Возвращается: всегда Пример: `false`
storage_type строка	Тип хранилища, который будет связан с экземпляром БД. Возвращается: всегда Пример: `"standard"`
tags сложный	Словарь тегов, связанных с экземпляром БД. Возвращается: всегда
vpc_security_groups сложный	Список элементов групп безопасности VPC, к которым принадлежит экземпляр БД. Возвращается: всегда
status строка	Состояние группы безопасности VPC. Возвращается: всегда Пример: `"active"`
vpc_security_group_id строка	Имя группы безопасности VPC. Возвращается: всегда Пример: `"sg-12345678"`

Авторы

Sloane Hertel (@s-hertel)

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

© 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_instance_module.html