Модуль community.aws.dms_endpoint – Создает или удаляет конечную точку служб миграции данных
Примечание
Этот модуль входит в коллекцию community.aws (версия 8.0.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля потребуются дополнительные требования, см. Требования для получения подробной информации.
Для использования в книге задач укажите: community.aws.dms_endpoint.
Добавлена в community.aws 1.0.0
Обзор
- Создает или уничтожает конечную точку служб миграции данных, которая может использоваться для репликации данных.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 3.6
- boto3 >= 1.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string | Идентификатор ключа доступа AWS. См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные среды Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
aws_ca_bundle path | Расположение пакета CA, используемого при проверке сертификатов SSL. Переменная среды |
aws_config dictionary | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
certificatearn string | Универсальное имя ресурса (ARN) для сертификата. |
databasename string | Имя базы данных на стороне источника или получателя. |
debug_botocore_endpoint_logs boolean | Использовать Переменная среды Варианты:
|
dmstransfersettings dictionary | Параметры в формате JSON для типа передачи DMS конечной точки источника. |
dynamodbsettings dictionary | Параметры в формате JSON для конечной точки Amazon DynamoDB, если источник или получатель - dynamodb. |
elasticsearchsettings dictionary | Параметры в формате JSON для конечной точки Elasticsearch. |
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string | URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws тестируются только с AWS. Переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
endpointidentifier string / required | Идентификатор конечной точки. |
endpointtype string | Тип конечной точки, которой мы хотим управлять. Обязательно, когда state=present. Варианты:
|
enginename string | Движок базы данных, который мы хотим использовать, см. документацию AWS DMS для получения дополнительной информации о поддерживаемых движках и их ограничениях. Обязательно, когда state=present. Варианты:
|
externaltabledefinition string | Определение внешней таблицы. |
extraconnectionattributes string | Дополнительные атрибуты для подключения к базе данных, в документации AWS говорится: «Для получения дополнительной информации о дополнительных атрибутах подключения см. раздел документации для вашего хранилища данных». |
kinesissettings dictionary | Параметры в формате JSON для конечной точки Amazon Kinesis Data Streams. |
kmskeyid string | Ключ шифрования, используемый для шифрования хранилища репликации и информации о подключении. |
mongodbsettings dictionary | Параметры в формате JSON для конечной точки источника MongoDB. |
пароль строка | Пароль для подключения к базе данных. Это свойство может быть записано только в API AWS; AWS API не возвращает это значение. |
порт целое число | TCP-порт для доступа к базе данных. |
профиль псевдонимы: aws_profile строка | Используемый именованный профиль AWS для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды Параметр профиль взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token. |
purge_tags булево | Если purge_tags=true и tags задано, существующие метки будут удалены с ресурса, чтобы точно соответствовать тому, что определено параметром tags. Если параметр tags не задан, метки не будут изменены, даже если purge_tags=True. Ключи меток, начинающиеся с Варианты:
|
регион псевдонимы: aws_region, ec2_region строка | Используемый регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, регион игнорируется. Также можно использовать переменные среды Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
повторные попытки целое число | Количество попыток повторного выполнения при удалении ресурса. Требуется при wait=true. |
s3settings словарь | Настройки для ведер Amazon S3 в качестве целевого конечного пункта. |
секретный ключ псевдонимы: 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. Также можно использовать переменные среды Параметры secret_key и профиль взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
имя сервера строка | Имя сервера, к которому будет подключаться конечный пункт. |
serviceaccessrolearn строка | Идентификатор ресурса Amazon (ARN) для роли доступа к сервису, которую необходимо использовать для создания конечного пункта. |
токен сессии псевдонимы: 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. Также можно использовать переменные среды Параметры security_token и профиль взаимоисключающие. Псевдонимы aws_session_token и токен_сессии были добавлены в релизе 3.2.0, а параметр был переименован из security_token в токен_сессии в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды |
sslmode строка | Режим, используемый для SSL-соединения. Варианты:
|
состояние строка | Состояние конечного пункта. Варианты:
|
метки псевдонимы: resource_tags словарь | Список меток для добавления к конечной точке. |
timeout integer | Время в секундах, которое следует ожидать при удалении ресурса. Требуется, когда wait=true. |
username string | Имя пользователя, которое будет использовать наш конечная точка для подключения к базе данных. |
validate_certs boolean | При установке в Установка validate_certs=false настоятельно не рекомендуется; в качестве альтернативы, рассмотрите установку aws_ca_bundle вместо этого. Варианты:
|
wait boolean | Ожидать ли Ansible удаления объекта, когда state=absent. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не «контроллер». Поэтому файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост».
- AWS SDK (boto3), который используется Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно
~/.aws/credentials). См. https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html для получения дополнительной информации.
Примеры
# 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
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
endpoint dictionary | Описание конечной точки DMS. Возвращается: success |
|
database_name string |
Имя базы данных в конечной точке. Возвращается: success Пример: |
|
dms_transfer_settings dictionary |
Дополнительные параметры, связанные с передачей. Возвращается: когда настроены дополнительные параметры передачи DMS. |
|
doc_db_settings dictionary |
Дополнительные параметры для конечных точек DocumentDB. Возвращается: когда endpoint_type равен |
|
elasticsearch_settings dictionary |
Дополнительные параметры для конечных точек Elasticsearch. Возвращается: когда endpoint_type равен |
|
endpoint_arn string |
ARN, однозначно идентифицирующий конечную точку. Возвращается: success Пример: |
|
endpoint_identifier string |
Идентификатор конечной точки базы данных. Возвращается: success Пример: |
|
endpoint_type string |
Тип конечной точки. Допустимые значения: Возвращается: success Пример: |
|
engine_display_name string |
Развернутое имя для имени движка. Возвращается: success Пример: |
|
engine_name string |
Имя движка базы данных. Возвращается: success Пример: |
|
i_b_m_db_settings dictionary |
Дополнительные параметры для конечных точек IBM DB2. Возвращается: когда endpoint_type равен |
|
kafka_settings dictionary |
Дополнительные параметры для конечных точек Kafka. Возвращается: когда endpoint_type равен |
|
kinesis_settings dictionary |
Дополнительные параметры для конечных точек Kinesis. Возвращается: когда endpoint_type равен |
|
kms_key_id string |
Идентификатор ключа KMS, используемый для шифрования параметров подключения к конечной точке. Возвращается: success Пример: |
|
microsoft_sql_server_settings dictionary |
Дополнительные параметры для конечных точек Microsoft SQL Server. Возвращается: когда endpoint_type равен |
|
mongo_db_settings dictionary |
Дополнительные параметры для конечных точек MongoDB. Возвращается: когда endpoint_type равен |
|
my_sql_settings dictionary |
Дополнительные параметры для конечных точек MySQL. Возвращается: когда endpoint_type равен |
|
neptune_settings dictionary |
Дополнительные параметры для конечных точек Amazon Neptune. Возвращается: когда endpoint_type равен |
|
oracle_settings dictionary |
Дополнительные параметры для конечных точек Oracle. Возвращается: когда endpoint_type равен |
|
порт строка |
Порт, используемый для доступа к конечной точке. Возвращается: успешно Пример: |
|
postgre_sql_настройки словарь |
Дополнительные настройки для конечных точек PostgrSQL. Возвращается: при endpoint_type равен |
|
redis_настройки словарь |
Дополнительные настройки для конечных точек Redis. Возвращается: при endpoint_type равен |
|
redshift_настройки словарь |
Дополнительные настройки для конечных точек Redshift. Возвращается: при endpoint_type равен |
|
s3_настройки словарь |
Дополнительные настройки для конечных точек S3. Возвращается: при endpoint_type равен |
|
имя_сервера строка |
Имя сервера в конечной точке. Возвращается: успешно Пример: |
|
ssl_режим строка |
Режим SSL, используемый для подключения к конечной точке. Возвращается: успешно Пример: |
|
sybase_настройки словарь |
Дополнительные настройки для конечных точек Sybase. Возвращается: при endpoint_type равен |
|
метки словарь |
Словарь, представляющий метки, прикрепленные к конечной точке. Возвращается: успешно Пример: |
|
имя_пользователя строка |
Имя пользователя, используемое для подключения к конечной точке. Возвращается: успешно Пример: |
Ссылки на сборку
© 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/dms_endpoint_module.html