Модуль community.aws.redshift_subnet_group — управление группами подсетей кластера Redshift

Примечание

Этот модуль является частью коллекции community.aws (версия 8.0.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.

Для использования в плейбуке укажите: community.aws.redshift_subnet_group.

Новинка в community.aws 1.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Создание, изменение и удаление групп подсетей кластера Redshift.

Требования

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

python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка	Идентификатор ключа доступа 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` или `EC2_ACCESS_KEY` в порядке убывания приоритета. Опции aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
aws_ca_bundle путь	Расположение пакета CA для проверки сертификатов SSL. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs логический	Использовать логгер `botocore.endpoint`, чтобы проанализировать уникальные (а не все) `"resource:action"` API-вызовы, сделанные во время задачи, выведя набор в ключ resource_actions в результатах задачи. Используйте коллбэк `aws_resource_action` для вывода полного списка, сделанного во время выполнения книги задач. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
description псевдонимы: group_description строка	Описание группы подсетей кластера.
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка	URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим службам, совместимым с AWS, коллекции amazon.aws и community.aws протестированы только для AWS. Также можно использовать переменные среды `AWS_URL` или `EC2_URL` в порядке убывания приоритета. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
name псевдонимы: group_name строка / обязательно	Имя группы подсетей кластера.
profile псевдонимы: aws_profile строка	Используемый именованный профиль AWS для аутентификации. См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды `AWS_PROFILE`. Опция profile взаимоисключающая с опциями aws_access_key, aws_secret_key и security_token.
region псевдонимы: aws_region, ec2_region строка	Используемый регион AWS. Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется. Также можно использовать переменные среды `AWS_REGION` или `EC2_REGION`. См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним `ec2_region` устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_REGION` устарела и будет удалена в релизе после 2024-12-01.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key строка	Секретный ключ доступа 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`, или `EC2_SECRET_KEY` в порядке убывания приоритета. Опции secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.

session_token aliases: aws_session_token, security_token, aws_security_token, access_token строка	Токен сеанса 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`, `AWS_SECURITY_TOKEN` или `EC2_SECURITY_TOKEN` в порядке убывания приоритета. Параметры security_token и profile взаимоисключающие. Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 01.12.2024. Поддержка переменных среды `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в релизе после 01.12.2024.
state строка	Указывает, должно ли существовать или отсутствовать группа подсетей. Варианты: `"present"` ← (по умолчанию) `"absent"`
subnets aliases: group_subnets список / элементы=строка	Список идентификаторов подсетей, составляющих группу подсетей кластера. При создании группы подсетей кластера необходимо указать хотя бы одну подсеть.
validate_certs логическое	При установке в `false`, сертификаты SSL не будут проверяться для связи с API AWS. Установка validate_certs=false крайне не рекомендуется. Вместо этого рассмотрите настройку aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста «хост» Ansible, а не из контекста «контроллер». Поэтому файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста «контроллер» Ansible, а не из контекста «хост».
AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте «хост» Ansible (обычно ~/.aws/credentials). См. https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html для получения дополнительной информации.

Примеры

- name: Create a Redshift subnet group
  community.aws.redshift_subnet_group:
    state: present
    group_name: redshift-subnet
    group_description: Redshift subnet
    group_subnets:
      - 'subnet-aaaaa'
      - 'subnet-bbbbb'

- name: Remove subnet group
  community.aws.redshift_subnet_group:
    state: absent
    group_name: redshift-subnet

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
cluster_subnet_group словарь	Словарь, содержащий информацию о группе подсетей Redshift. Возвращаемое значение: success
description строка	Описание группы подсетей кэша. Возвращаемое значение: когда группа подсетей кэша существует Пример: `"Redshift subnet"`
name строка	Имя группы подсетей Redshift. Возвращаемое значение: когда группа подсетей кэша существует Пример: `"redshift_subnet_group_name"`
subnet_ids список / элементы=строка	Идентификаторы подсетей, относящиеся к группе подсетей Redshift. Возвращаемое значение: когда группа подсетей кэша существует Пример: `["subnet-aaaaaaaa", "subnet-bbbbbbbb"]`
vpc_id строка	Идентификатор VPC, в котором расположена подсеть. Возвращаемое значение: когда группа подсетей кэша существует Пример: `"vpc-aabb1122"`

Авторы

Jens Carl (@j-carl), Hothead Games Inc.

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/redshift_subnet_group_module.html