Spec-Zone.ru › Ansible 2.7

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
-
    Варианты:
  • 1.0
необходимая версия кластера

псевдонимы: 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
-
    Варианты:
  • 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
-
Количество узлов. Используется только при 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
boolean
добавлено в 1.5
    Варианты:
  • нет
  • да ←
При значении "нет" сертификаты SSL не будут проверяться для версий boto >= 2.6.0.
vpc_security_group_ids
-
Группа безопасности VPC

псевдонимы: vpc_security_groups
wait
boolean
    Варианты:
  • нет ←
  • да
При command=create, modify или restore ожидание состояния базы данных 'доступно'. При 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), если учетные данные не предоставлены. См. https://boto.readthedocs.io/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
сложный
успех
словарь, содержащий всю информацию о кластере

availability_zone
строка
успех
Зона доступности Amazon, где расположен кластер.

Пример:
us-east-1b
create_time
вещественное число
успех
Время создания кластера в виде метки времени.

Пример:
1430158536.308
db_name
строка
успех
Имя базы данных.

Пример:
new_db_name
identifier
строка
успех
Идентификатор кластера.

Пример:
new_redshift_cluster
maintenance_window
строка
успех
Временной интервал, когда выполняются обслуживание/обновление.

Пример:
sun:09:30-sun:10:00
port
целое число
успех
Порт кластера.

Пример:
5439
private_ip_address
строка
успех
Приватный IP-адрес основного узла.

Пример:
10.10.10.10
public_ip_address
строка
успех
Публичный IP-адрес основного узла.

Пример:
0.0.0.0
status
строка
успех
Статус кластера.

Пример:
доступно
url
строка
успех
FQDN основного узла кластера.

Пример:
new-redshift_cluster.jfkdjfdkj.us-east-1.redshift.amazonaws.com


Статус

  • Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
  • Этот модуль поддерживается сообществом 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.7/modules/redshift_module.html

Spec-Zone.ru

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