redshift - создание, удаление или изменение экземпляра Amazon Redshift
Новая версия с 2.2.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Создаёт, удаляет или изменяет экземпляры кластеров Amazon Redshift.
Требования (к хосту, на котором выполняется модуль)
- boto
- python >= 2.6
Параметры
| Параметр | Обязателен | Значение по умолчанию | Варианты | Комментарии |
|---|---|---|---|---|
| allow_version_upgrade | нет | True | Флаг, определяющий возможность обновления версии Псевдонимы: version_upgrade | |
| automated_snapshot_retention_period | нет | Период создания моментальных снимков Псевдонимы: retention_period | ||
| availability_zone | нет | Зона доступности для запуска кластера Псевдонимы: zone, aws_zone | ||
| aws_access_key | нет | AWS ключ доступа. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key | ||
| aws_secret_key | нет | AWS секретный ключ. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key | ||
| cluster_parameter_group_name | нет | Имя группы параметров кластера Псевдонимы: param_group_name | ||
| cluster_security_groups | нет | Группа безопасности, к которой принадлежит кластер Псевдонимы: security_groups | ||
| cluster_subnet_group_name | нет | Подсеть для размещения кластера Псевдонимы: subnet | ||
| cluster_type | нет | single-node |
| Тип кластера. |
| cluster_version | нет |
| Версия кластера Псевдонимы: version | |
| command | да |
| Указывает действие. | |
| db_name | нет | Имя базы данных. | ||
| ec2_url | нет | URL для подключения к EC2 или Eucalyptus облаку (по умолчанию используется конечная точка EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для других модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL (если таковая имеется). | ||
| elastic_ip | нет | Используется ли у кластера Elastic IP? | ||
| encrypted | нет | Зашифрован ли кластер? | ||
| final_cluster_snapshot_identifier (добавлен в 2.4)
| нет | Идентификатор окончательного моментального снимка, создаваемого перед удалением кластера. Если этот параметр указан, final_cluster_snapshot_identifier должен быть false. Используется только при command=delete. Псевдонимы: final_snapshot_id | ||
| identifier | да | Идентификатор кластера Redshift. | ||
| new_cluster_identifier | нет | Используется только при command=modify. Псевдонимы: new_identifier | ||
| node_type | нет |
| Тип узла кластера. Должен быть указан при command=create. | |
| number_of_nodes | нет | Количество узлов. Используется только при cluster_type=multi-node. | ||
| password | нет | Пароль для базы данных. Используется только при command=create. | ||
| port | нет | Порт, на котором работает кластер | ||
| preferred_maintenance_window | нет | Время технического обслуживания Псевдонимы: maintance_window, maint_window | ||
| profile (добавлен в 1.6)
| нет | Использует профиль boto. Работает только с boto >= 2.24.0. | ||
| publicly_accessible | нет | Доступен ли кластер публично? | ||
| security_token (добавлен в 1.6)
| нет | AWS STS security token. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token | ||
| skip_final_cluster_snapshot (добавлен в 2.4)
| нет | Пропустить окончательный снимок перед удалением кластера. Используется только при command=delete. Псевдонимы: skip_final_snapshot | ||
| username | нет | Имя пользователя базы данных. Используется только при command=create. | ||
| validate_certs (добавлен в 1.5)
| нет | да |
| При значении "нет", сертификаты SSL не будут проверятся для версий boto >= 2.6.0. |
| vpc_security_group_ids | нет | Группа безопасности VPC Псевдонимы: vpc_security_groups | ||
| wait | нет | нет |
| При command=create, modify или restore, ожидать, пока база данных не перейдёт в состояние 'available'. При command=delete ожидать завершения удаления базы данных. |
| wait_timeout | нет | 300 | Сколько ждать, пока ожидание не прервётся, в секундах |
Примеры
# Basic cluster provisioning example
- redshift: >
command=create
node_type=ds1.xlarge
identifier=new_cluster
username=cluster_admin
password=1nsecure
# Cluster delete example
- redshift:
command: delete
identifier: new_cluster
skip_final_cluster_snapshot: true
wait: true
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| Имя | Описание | Возвращается | Тип | Пример | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| cluster | Словарь, содержащий всю информацию о кластере | успех | сложный | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| содержит: |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_ACCESS_KEY_IDилиAWS_ACCESS_KEYилиEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYилиAWS_SECRET_KEYилиEC2_SECRET_KEY,AWS_SECURITY_TOKENилиEC2_SECURITY_TOKEN,AWS_REGIONилиEC2_REGION - Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно можно использовать для указания региона AWS, когда это необходимо, но это также можно настроить в файле конфигурации boto
Статус
Этот модуль помечен как превью, что означает, что гарантии обратной совместимости интерфейса нет.
Для получения помощи в разработке модулей, если вы так заинтересованы, пожалуйста, прочтите Информацию о сообществе и участии в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/redshift_module.html
