Spec-Zone.ru › Ansible

Модуль amazon.aws.rds_instance — управление инстансами RDS

Примечание

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

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

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

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

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

Варианты:

  • false
  • true

availability_zone

aliases: az, zone

string

Список зон доступности EC2, в которых можно создать экземпляр БД. Параметр можно использовать при создании экземпляра или восстановлении из S3 либо снимка. Взаимоисключающий с multi_az.

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.

backup_retention_period

integer

Количество дней хранения автоматических резервных копий.

Если задано значение 0, автоматическое резервное копирование будет отключено. (Не применяется, если экземпляр БД является источником для реплик чтения.)

Можно использовать при создании экземпляра, восстановлении из S3 или изменении экземпляра.

ca_certificate_identifier

string

Идентификатор сертификата центра сертификации для экземпляра БД.

character_set_name

string

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

copy_tags_to_snapshot

boolean

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

Варианты:

  • false
  • true

creation_source

string

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

Варианты:

  • "snapshot"
  • "s3"
  • "instance"

db_cluster_identifier

aliases: cluster_id

string

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

db_instance_class

aliases: class, instance_type

string

Вычислительная мощность и объем памяти экземпляра БД, например db.t3.micro.

db_instance_identifier

aliases: instance_id, id

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

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

db_name

string

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

db_parameter_group_name

string

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

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

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: aws_endpoint_url

string

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

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

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

Список ролей Amazon Web Services Identity and Access Management (IAM), связываемых с экземпляром БД.

feature_name

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

Имя функции, связанной с ролью IAM.

role_arn

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

ARN роли IAM, связываемой с экземпляром БД.

iops

integer

Значение Provisioned IOPS (операций ввода-вывода в секунду). Устанавливается только в том случае, если для storage_type задано значение io1 или io2.

kms_key_id

string

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

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

license_model

string

Модель лицензирования экземпляра БД.

Доступны варианты: лицензия включена, использование собственной лицензии и общедоступная лицензия.

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

master_user_password

aliases: password

string

Пароль главного пользователя базы данных длиной от 8 до 41 символа. Пароль может содержать любые печатные символы ASCII, кроме /, " или @. Для изменения пароля используйте force_update_password. Используйте apply_immediately, чтобы изменить пароль немедленно; в противном случае он будет обновлен во время следующего окна обслуживания.

master_username

aliases: username

string

Имя главного пользователя экземпляра БД. Должно содержать от 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

multi_tenant

boolean

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

Указывает, следует ли использовать конфигурацию с несколькими арендаторами или конфигурацию с одним арендатором (по умолчанию).

Этот параметр применяется только к движкам контейнерных баз данных Oracle (CDB) в RDS.

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

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

Варианты:

  • 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 и session_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

string

Регион AWS для использования.

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

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

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

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

Имя ресурса Amazon (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

string

Секретный ключ доступа AWS.

Дополнительные сведения о токенах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные окружения AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY (в порядке убывания приоритета).

Параметры secret_key и profile нельзя использовать одновременно.

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

session_token

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

Допустимые значения:

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

source_db_instance_identifier

string

Идентификатор или ARN исходного экземпляра БД, из которого выполняется восстановление при создании реплики для чтения или запуске экземпляра БД на определенный момент времени с помощью creation_source=instance. Если исходная БД находится в другом регионе, необходимо указать ARN.

source_engine

string

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

Допустимые значения:

  • "mysql"

source_engine_version

string

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

source_region

string

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

state

string

Желаемое состояние экземпляра RDS.

state=rebooted не является идемпотентным: экземпляр БД останется запущенным, а если он был остановлен, перед перезагрузкой будет запущен. present оставит экземпляр БД в текущем состоянии (запущенном или остановленном; при создании экземпляра БД он будет запущен).

state=running и state=started являются синонимами, как и state=rebooted и state=restarted.

Допустимые значения:

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

storage_encrypted

boolean

Зашифрован ли экземпляр БД.

Допустимые значения:

  • false
  • true

storage_throughput

integer

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

Пропускная способность хранилища, если storage_type имеет значение gp3.

Если выделенный объем хранилища меньше 400 ГБ, пропускная способность хранилища всегда составляет 125 МБ/с.

Если выделенный объем хранилища равен или превышает 400 ГБ, пропускная способность составляет 500 МБ/с.

storage_type

string

Тип хранилища, связываемого с экземпляром БД. storage_type не применяется к экземплярам Aurora DB.

Допустимые значения:

  • "standard"
  • "gp2"
  • "gp3"
  • "io1"
  • "io2"

tags

aliases: resource_tags

dictionary

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

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

tde_credential_arn

aliases: transparent_data_encryption_arn

string

ARN из хранилища ключей, с которым связывается экземпляр для прозрачного шифрования данных. Поддерживается экземплярами Oracle DB и SQL Server DB и может использоваться совместно с storage_encrypted, хотя это может немного снизить производительность базы данных.

tde_credential_password

aliases: transparent_data_encryption_password

string

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

timezone

string

Часовой пояс экземпляра БД.

use_latest_restorable_time

aliases: restore_from_latest

boolean

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

Можно указать только один из параметров use_latest_restorable_time и restore_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

Следует ли ожидать, пока экземпляр станет доступен, остановится или будет удален. Позже может быть добавлен параметр wait_timeout. После каждого вызова API для создания, изменения или удаления экземпляра используется механизм ожидания с задержкой 60 секунд, выполняющий до 30 проверок, пока экземпляр не достигнет ожидаемого состояния (доступен/остановлен/удален). На общее время выполнения задачи также может влиять AWSRetry, помогающий стабилизировать работу, если изначально экземпляр находится в состоянии, в котором с ним нельзя работать (например, если попытаться остановить его во время перезагрузки). Если задать значение false, повторы и задержки задачи могут помочь обработать тайм-ауты при выполнении значительных изменений в плейбуке.

Допустимые значения:

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

Примечания

Примечание

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

# Modify the DB instance type without waiting for a maintenance window
- name: Modify an RDS Instance
  amazon.aws.rds_instance:
    db_instance_identifier: mydbinstance123
    instance_class: db.t2.small
    apply_immediately: true
  register: rds_instance

# 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

integer

Размер выделенного хранилища в гигабайтах. Для ядер СУБД Aurora всегда равен 1.

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

Пример: 20

associated_roles

list / elements=string

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

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

Пример: []

auto_minor_version_upgrade

boolean

Выполняется ли автоматическое применение обновлений минорной версии СУБД к экземпляру БД во время окна обслуживания.

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

Пример: true

availability_zone

string

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

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

Пример: "us-east-1f"

backup_retention_period

integer

Количество дней хранения автоматических резервных копий.

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

Пример: 1

ca_certificate_identifier

string

Идентификатор сертификата CA для экземпляра БД.

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

Пример: "rds-ca-2015"

copy_tags_to_snapshot

boolean

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

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

Пример: false

db_instance_arn

string

Имя ресурса Amazon (ARN) экземпляра БД.

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

Пример: "arn:aws:rds:us-east-1:123456789012:db:ansible-test"

db_instance_class

string

Название класса вычислительных ресурсов и объема памяти экземпляра БД.

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

Пример: "db.m5.large"

db_instance_identifier

string

Идентификатор экземпляра БД.

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

Пример: "ansible-test"

db_instance_port

integer

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

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

Пример: 0

db_instance_status

string

Текущее состояние этой базы данных.

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

Пример: "stopped"

db_parameter_groups

complex

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

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

db_parameter_group_name

string

Название группы параметров DP.

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

Пример: "default.mariadb10.0"

parameter_apply_status

string

Статус обновления параметров.

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

Пример: "in-sync"

db_security_groups

list / elements=string

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

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

Пример: []

db_subnet_group

complex

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

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

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

Идентификатор VPC группы подсетей БД.

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

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

dbi_resource_id

string

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

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

Пример: "db-UHV3QRNWX4KB6GALCIGRML6QFA"

deletion_protection

boolean

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

Интервал в секундах между моментами сбора метрик расширенного мониторинга для экземпляра БД. Значение 0 означает, что сбор метрик расширенного мониторинга отключен.

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

Пример: 0

multi_az

boolean

Является ли экземпляр БД развертыванием Multi-AZ.

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

Пример: false

multi_tenant

boolean

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

Указывает, следует ли использовать конфигурацию с несколькими арендаторами или конфигурацию с одним арендатором (по умолчанию).

Возвращается: для ядер контейнерной базы данных Oracle (CDB) и boto3_version == “1.28.80”

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

list / elements=string

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

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

Пример: []

storage_encrypted

boolean

Зашифрован ли экземпляр БД.

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

Пример: false

storage_type

string

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

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

Пример: "standard"

tags

complex

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

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

vpc_security_groups

complex

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

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

status

string

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

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

Пример: "active"

vpc_security_group_id

string

Название группы безопасности VPC.

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

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

Авторы

  • Sloane Hertel (@s-hertel)

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

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

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

Spec-Zone.ru

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