community.aws.dms_endpoint – Создаёт или удаляет конечную точку служб миграции данных

Примечание

Этот плагин входит в коллекцию community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в книге задач укажите: community.aws.dms_endpoint.

Новое в версии 1.0.0: коллекции community.aws

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

Обзор

Создаёт или удаляет конечную точку служб миграции данных, которую можно использовать для репликации данных.

Требования

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

python >= 2.6
boto

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key строка		Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Использование параметров aws_access_key и profile одновременно устарело и будет сделано взаимоисключающим после 2022-06-01. псевдонимы: ec2_access_key, access_key
aws_ca_bundle путь		Расположение файла с сертификатами CA для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: файл CA Bundle читается со стороны модуля и, возможно, требует явного копирования с контроллера, если он не запускается локально.
aws_config словарь		Словарь для модификации конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. Подробнее о конфигурации boto см. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto.
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Использование параметров aws_secret_key и profile одновременно устарело и будет сделано взаимоисключающим после 2022-06-01. псевдонимы: ec2_secret_key, secret_key
certificatearn строка		Amazon Resource Name (ARN) для сертификата.
databasename строка		Имя базы данных на стороне источника или целевой стороны.
debug_botocore_endpoint_logs булево	Варианты: нет ← да	Использовать логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие» во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, созданного во время исполнения playbook. Также может быть использована переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
dmstransfersettings словарь		Настройки типа передачи DMS в формате JSON для конечной точки источника.
dynamodbsettings словарь		Настройки в формате JSON для целевой конечной точки Amazon DynamoDB, если источник или цель — dynamodb.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она задана. псевдонимы: aws_endpoint_url, endpoint_url
elasticsearchsettings словарь		Настройки в формате JSON для целевой конечной точки Elasticsearch.
endpointidentifier строка / обязательно		Идентификатор имени конечной точки.
endpointtype строка / обязательно	Варианты: источник цель	Тип конечной точки, которую мы хотим управлять.
enginename строка / обязательно	Варианты: mysql oracle postgres mariadb aurora redshift s3 db2 azuredb sybase dynamodb mongodb sqlserver	Двигатель базы данных, который мы хотим использовать. Обратитесь к документации AWS DMS для получения дополнительной информации о поддерживаемых движках и их ограничениях.
externaltabledefinition строка		Определение внешней таблицы.
extraconnectionattributes строка		Дополнительные атрибуты для подключения к базе данных. Документация AWS содержит информацию: «Для получения дополнительной информации об дополнительных атрибутах подключения см. раздел документации для вашего хранилища данных».
kinesissettings словарь		Настройки в формате JSON для целевой конечной точки Amazon Kinesis Data Streams.
kmskeyid строка		Используемый ключ шифрования для шифрования информации о репликации и подключении.
mongodbsettings словарь		Настройки в формате JSON для конечной точки источника MongoDB.
password строка		Пароль для подключения к базе данных. Этот атрибут может быть только записан, так как API AWS не возвращает этот параметр.
port целое число		TCP-порт для доступа к базе данных.
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token, и поддержка их одновременного использования с profile устарела. aws_access_key, aws_secret_key и security_token будут взаимоисключающими с profile после 2022-06-01. псевдонимы: aws_profile
region строка		AWS-регион для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковая имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region псевдонимы: aws_region, ec2_region
retries целое число		Количество попыток повторного удаления ресурса. Требуется при wait=true.
s3settings словарь		Настройки ведер S3 для целевой конечной точки Amazon S3.
security_token строка		Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Использование параметров security_token и profile одновременно устарело и будет сделано взаимоисключающим после 2022-06-01. псевдонимы: aws_security_token, access_token
servername строка		Имя сервера, к которому будет подключаться конечная точка.
serviceaccessrolearn строка		Amazon Resource Name (ARN) для роли доступа к сервису, которую вы хотите использовать для создания конечной точки.
sslmode строка	Варианты: нет ← требовать проверить-ca проверить-полностью	Режим, используемый для SSL-соединения.
state строка	Варианты: наличие ← отсутствие	Состояние конечной точки.
tags словарь		Список тегов для добавления к конечной точке.
timeout целое число		Время ожидания в секундах при удалении ресурса. Требуется при wait=true.
username строка		Имя пользователя, которое будет использоваться конечной точкой для подключения к базе данных.
validate_certs булево	Варианты: нет да ←	Если установлено в «нет», SSL-сертификаты не будут проверяться для версий boto >= 2.6.0.
wait булево	Варианты: нет ← да	Указывает, следует ли Ansible ожидать удаления объекта, когда state=отсутствует.

Примечания

Примечание

Если параметры не заданы в модуле, могут быть использованы следующие переменные окружения в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION обычно используются для указания AWS-региона, когда это необходимо, но его также можно настроить в файле конфигурации boto

Примеры

# Note: These examples do not set authentication details
- name: Endpoint Creation
  community.aws.dms_endpoint:
    state: absent
    endpointidentifier: 'testsource'
    endpointtype: source
    enginename: aurora
    username: testing1
    password: testint1234
    servername: testing.domain.com
    port: 3306
    databasename: 'testdb'
    sslmode: none
    wait: false

Авторы

Rui Moreira (@ruimoreira)

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