redshift - создание, удаление или изменение экземпляра Amazon Redshift
Новое в версии 2.2.
Краткое описание
- Создает, удаляет или изменяет экземпляры кластеров Amazon Redshift.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- boto
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| allow_version_upgrade | Значение по умолчанию: "да" | флаг, определяющий возможность обновления версии псевдонимы: 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 |
| Тип кластера. |
| cluster_version |
| версия кластера псевдонимы: version |
| command обязательно |
| Указывает действие, которое нужно выполнить. |
| db_name | Имя базы данных. | |
| ec2_url | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию используется конечная точка EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не указан, используется значение переменной окружения EC2_URL, если она есть. | |
| elastic_ip | есть ли у кластера эластичный 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 | Значение по умолчанию: "нет" | доступен ли кластер публично |
| region | Регион AWS. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | |
| security_token (добавлено в 1.6) | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | |
| skip_final_cluster_snapshot (добавлено в 2.4) | Значение по умолчанию: "нет" | пропустить создание конечного снимка перед удалением кластера. Используется только при command=delete. псевдонимы: skip_final_snapshot |
| username | Имя пользователя основной базы данных. Используется только при command=create. | |
| validate_certs bool (добавлено в 1.5) |
| При значении "нет", сертификаты SSL не будут проверены для версий boto >= 2.6.0. |
| vpc_security_group_ids | группа безопасности VPC псевдонимы: vpc_security_groups | |
| wait bool |
| При command=create, modify или restore ожидание состояния базы данных 'available'. При command=delete ожидание завершения удаления. |
| wait_timeout | Значение по умолчанию: 300 | время ожидания, в секундах |
Примечания
Примечание
- Если параметры не заданы в модуле, могут быть использованы следующие переменные среды в порядке убывания приоритета
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
Примеры
# 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 сложный | success | словарь, содержащий всю информацию о кластере | |
| identifier строка | success | Идентификатор кластера. Пример: new_redshift_cluster | |
| create_time число с плавающей точкой | success | Время создания кластера в формате метки времени. Пример: 1430158536.308 | |
| status строка | success | Статус кластера. Пример: available | |
| db_name строка | success | Имя базы данных. Пример: new_db_name | |
| availability_zone строка | success | Зона доступности Amazon, где расположен кластер. Пример: us-east-1b | |
| maintenance_window строка | success | Период времени, когда выполняются обслуживание/обновление. Пример: sun:09:30-sun:10:00 | |
| private_ip_address строка | success | Приватный IP-адрес основного узла. Пример: 10.10.10.10 | |
| public_ip_address строка | success | Публичный IP-адрес основного узла. Пример: 0.0.0.0 | |
| port целое число | success | Порт кластера. Пример: 5439 | |
| url строка | success | FQDN основного узла кластера. Пример: new-redshift_cluster.jfkdjfdkj.us-east-1.redshift.amazonaws.com | |
Статус
Этот модуль помечен как предварительная версия, что означает, что он не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. в разделе здесь.
Автор
- Jens Carl (@j-carl), Hothead Games Inc.
Подсказка
Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/redshift_module.html