redshift - создание, удаление или изменение экземпляра Amazon Redshift

Новая версия 2.2.

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

Обзор

Создаёт, удаляет или изменяет экземпляры кластеров Amazon Redshift.

Требования

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

boto
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
allow_version_upgrade	Значение по умолчанию: да	флаг, определяющий, возможно ли обновление версии псевдонимы: version_upgrade
automated_snapshot_retention_period	Значение по умолчанию: None	период, в течение которого создаются снимки псевдонимы: retention_period
availability_zone		зона доступности для запуска кластера псевдонимы: zone, aws_zone
aws_access_key	Значение по умолчанию: None	ключ доступа AWS. Если не указан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key
aws_secret_key	Значение по умолчанию: None	секретный ключ AWS. Если не указан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key
cluster_parameter_group_name	Значение по умолчанию: None	имя группы параметров кластера псевдонимы: param_group_name
cluster_security_groups	Значение по умолчанию: None	группа безопасности, к которой принадлежит кластер псевдонимы: security_groups
cluster_subnet_group_name		подсеть для размещения кластера псевдонимы: subnet
cluster_type	Варианты: многоузловой одноузловой ←	Тип кластера.
cluster_version	Варианты: 1.0 Значение по умолчанию: None	необходимая версия кластера псевдонимы: version
command обязательно	Варианты: create facts delete modify	Указывает действие, которое необходимо выполнить.
db_name	Значение по умолчанию: None	Имя базы данных.
ec2_url	Значение по умолчанию: None	URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не указан, используется значение переменной окружения EC2_URL, если таковое есть.
elastic_ip	Значение по умолчанию: None	есть ли у кластера Elastic IP или нет
encrypted	Значение по умолчанию: нет	шифруется ли кластер или нет
final_cluster_snapshot_identifier (добавлено в 2.4)	Значение по умолчанию: None	идентификатор конечного снимка, который будет создан перед удалением кластера. Если этот параметр указан, final_cluster_snapshot_identifier должен быть false. Используется только когда command=delete. псевдонимы: final_snapshot_id
identifier обязательно		Идентификатор кластера Redshift.
new_cluster_identifier	Значение по умолчанию: None	Используется только когда command=modify. псевдонимы: new_identifier
node_type	Варианты: ds1.xlarge ds1.8xlarge ds2.xlarge ds2.8xlarge dc1.large dc1.8xlarge dc2.large dc2.8xlarge dw1.xlarge dw1.8xlarge dw2.large dw2.8xlarge	Тип узла кластера. Должен быть указан при command=create.
number_of_nodes	Значение по умолчанию: None	Количество узлов. Используется только когда cluster_type=multi-node.
password		Пароль для основной базы данных. Используется только когда command=create.
port	Значение по умолчанию: None	Порт, на котором прослушивает кластер.
preferred_maintenance_window	Значение по умолчанию: None	интервал технического обслуживания псевдонимы: maintance_window, maint_window
profile (добавлено в 1.6)	Значение по умолчанию: None	Использует профиль 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)	Значение по умолчанию: None	Токен безопасности 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 (добавлено в 1.5)	Варианты: нет да ←	Если установлено значение "нет", сертификаты SSL не будут проверены для версий boto >= 2.6.0.
vpc_security_group_ids	Значение по умолчанию: None	Группа безопасности VPC псевдонимы: vpc_security_groups
wait	Варианты: да нет ←	При 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	словарь, содержащий всю информацию о кластере
	status строка	success	Состояние кластера. Пример: available
	public_ip_address строка	success	Публичный IP-адрес основного узла. Пример: 0.0.0.0
	availability_zone строка	success	Зона доступности Amazon, в которой расположен кластер. Пример: us-east-1b
	url строка	success	FQDN основного узла кластера. Пример: new-redshift_cluster.jfkdjfdkj.us-east-1.redshift.amazonaws.com
	db_name строка	success	Имя базы данных. Пример: new_db_name
	create_time число с плавающей запятой	success	Время создания кластера как метка времени. Пример: 1430158536.31
	private_ip_address строка	success	Приватный IP-адрес основного узла. Пример: 10.10.10.10
	identifier строка	success	Идентификатор кластера. Пример: new_redshift_cluster
	port целое число	success	Порт кластера. Пример: 5439
	maintenance_window строка	success	Временной интервал, когда выполняются обслуживание/апгрейды. Пример: sun:09:30-sun:10:00

Состояние

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

Автор

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.5/modules/redshift_module.html