Spec-Zone.ru › Ansible

Модуль community.aws.dms_endpoint — создание или удаление конечной точки службы миграции данных

Примечание

Этот модуль входит в коллекцию community.aws (версия 10.1.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.34.0
  • botocore >= 1.34.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_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 в порядке убывания предпочтения.

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.

aws_ca_bundle

путь

Путь к пакету сертификатов центра сертификации, используемому для проверки SSL-сертификатов.

Также можно использовать переменную окружения AWS_CA_BUNDLE.

aws_config

словарь

Словарь для изменения конфигурации botocore.

Описание параметров доступно в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

certificatearn

строка

Имя ресурса Amazon (ARN) сертификата.

databasename

строка

Имя базы данных на исходной или целевой стороне.

debug_botocore_endpoint_logs

логическое значение

Использовать регистратор botocore.endpoint для разбора уникальных (а не общего количества) вызовов API "resource:action", выполненных во время задачи, и выводить набор в ключ resource_actions результатов задачи. Используйте callback aws_resource_action, чтобы вывести общий список вызовов, выполненных во время плейбука.

Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (по умолчанию)
  • true

dmstransfersettings

словарь

Параметры в формате JSON для типа передачи DMS исходной конечной точки.

dynamodbsettings

словарь

Параметры в формате JSON для целевой конечной точки Amazon DynamoDB, если источником или целью является dynamodb.

elasticsearchsettings

словарь

Параметры в формате JSON для целевой конечной точки Elasticsearch.

endpoint_url

псевдонимы: aws_endpoint_url

строка

URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws тестируются только с AWS.

Также можно использовать переменную окружения AWS_URL.

endpointidentifier

строка / обязательный

Имя-идентификатор конечной точки.

endpointtype

строка

Тип конечной точки, которой нужно управлять.

Обязателен, если state=present.

Варианты:

  • "source"
  • "target"

enginename

строка

Ядро базы данных, которое нужно использовать. Дополнительные сведения о поддерживаемых ядрах и ограничениях см. в документации AWS DMS.

Обязателен, если state=present.

Варианты:

  • "mysql"
  • "oracle"
  • "postgres"
  • "mariadb"
  • "aurora"
  • "redshift"
  • "s3"
  • "db2"
  • "azuredb"
  • "sybase"
  • "dynamodb"
  • "mongodb"
  • "sqlserver"

externaltabledefinition

строка

Определение внешней таблицы.

extraconnectionattributes

строка

Дополнительные атрибуты подключения к базе данных. В документации AWS сказано: «Дополнительные сведения о дополнительных атрибутах подключения см. в разделе документации для вашего хранилища данных».

kinesissettings

словарь

Параметры в формате JSON для целевой конечной точки Amazon Kinesis Data Streams.

kmskeyid

строка

Ключ шифрования для шифрования хранилища репликации и сведений о подключении.

mongodbsettings

словарь

Параметры в формате JSON для исходной конечной точки MongoDB.

password

строка

Пароль для подключения к базе данных. Этот атрибут можно только записывать: API AWS не возвращает этот параметр.

port

целое число

TCP-порт для доступа к базе данных.

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 и session_token.

purge_tags

логическое значение

Если purge_tags=true и задан параметр tags, существующие теги будут удалены из ресурса, чтобы его набор тегов в точности соответствовал определенному параметром tags.

Если параметр tags не задан, теги не будут изменены, даже если purge_tags=True.

Ключи тегов, начинающиеся с aws:, зарезервированы Amazon и не могут быть изменены. Поэтому при обработке параметра purge_tags они игнорируются. Дополнительные сведения см. в документации Amazon https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.

Варианты:

  • false
  • true ← (по умолчанию)

region

псевдонимы: aws_region

строка

Регион AWS, который нужно использовать.

Для глобальных служб, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

Также можно использовать переменную окружения AWS_REGION.

Дополнительные сведения см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

retries

целое число

Количество повторных попыток удаления ресурса

Обязателен, если wait=true.

s3settings

словарь

Параметры корзин S3 для целевой конечной точки Amazon S3.

secret_key

псевдонимы: aws_secret_access_key, aws_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 в порядке убывания предпочтения.

Параметры secret_key и profile являются взаимоисключающими.

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.

servername

строка

Имя сервера, к которому будет подключаться конечная точка.

serviceaccessrolearn

строка

Имя ресурса Amazon (ARN) роли доступа к службе, которую нужно использовать для создания конечной точки.

session_token

псевдонимы: aws_session_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.

Параметры session_token и profile являются взаимоисключающими.

sslmode

строка

Режим SSL-подключения.

Варианты:

  • "none" ← (по умолчанию)
  • "require"
  • "verify-ca"
  • "verify-full"

state

строка

Состояние конечной точки.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tags

псевдонимы: resource_tags

словарь

Список тегов для добавления к конечной точке.

timeout

целое число

Время ожидания в секундах при удалении ресурса.

Обязателен, если wait=true.

username

строка

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

validate_certs

логическое значение

Если задано значение false, SSL-сертификаты не будут проверяться при взаимодействии с API AWS.

Настоятельно не рекомендуется устанавливать validate_certs=false. Вместо этого рассмотрите возможность задать параметр aws_ca_bundle.

Варианты:

  • false
  • true ← (по умолчанию)

wait

логическое значение

Нужно ли Ansible ожидать удаления объекта, если state=absent.

Варианты:

  • false ← (по умолчанию)
  • true

Примечания

Примечание

  • Внимание: Для модулей переменные окружения и файлы конфигурации считываются из контекста Ansible «хост», а не из контекста «контроллер». Поэтому файлы может потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются из контекста Ansible «контроллер», а не из контекста «хост».
  • Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте 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.

Возвращается: при успешном выполнении

database_name

string

Имя базы данных на конечной точке.

Возвращается: при успешном выполнении

Пример: "exampledb"

dms_transfer_settings

dictionary

Дополнительные параметры, связанные с передачей данных.

Возвращается: если настроены дополнительные параметры передачи данных DMS.

doc_db_settings

dictionary

Дополнительные параметры конечных точек DocumentDB.

Возвращается: если endpoint_type имеет значение documentdb

elasticsearch_settings

dictionary

Дополнительные параметры конечных точек Elasticsearch.

Возвращается: если endpoint_type имеет значение elasticsearch

endpoint_arn

string

ARN, однозначно идентифицирующий конечную точку.

Возвращается: при успешном выполнении

Пример: "arn:aws:dms:us-east-1:123456789012:endpoint:1234556789ABCDEFGHIJKLMNOPQRSTUVWXYZ012"

endpoint_identifier

string

Идентификатор конечной точки базы данных.

Возвращается: при успешном выполнении

Пример: "ansible-test-12345678-dms"

endpoint_type

string

Тип конечной точки. Допустимые значения: SOURCE и TARGET.

Возвращается: при успешном выполнении

Пример: "SOURCE"

engine_display_name

string

Полное отображаемое имя подсистемы.

Возвращается: при успешном выполнении

Пример: "Amazon Aurora MySQL"

engine_name

string

Имя подсистемы базы данных.

Возвращается: при успешном выполнении

Пример: "aurora"

i_b_m_db_settings

dictionary

Дополнительные параметры конечных точек IBM DB2.

Возвращается: если endpoint_type имеет значение db2

kafka_settings

dictionary

Дополнительные параметры конечных точек Kafka.

Возвращается: если endpoint_type имеет значение kafka

kinesis_settings

dictionary

Дополнительные параметры конечных точек Kinesis.

Возвращается: если endpoint_type имеет значение kinesis

kms_key_id

string

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

Возвращается: при успешном выполнении

Пример: "arn:aws:kms:us-east-1:123456789012:key/01234567-abcd-12ab-98fe-123456789abc"

microsoft_sql_server_settings

dictionary

Дополнительные параметры конечных точек Microsoft SQL Server.

Возвращается: если endpoint_type имеет значение sqlserver

mongo_db_settings

dictionary

Дополнительные параметры конечных точек MongoDB.

Возвращается: если endpoint_type имеет значение mongodb

my_sql_settings

dictionary

Дополнительные параметры конечных точек MySQL.

Возвращается: если endpoint_type имеет значение mysql

neptune_settings

dictionary

Дополнительные параметры конечных точек Amazon Neptune.

Возвращается: если endpoint_type имеет значение neptune

oracle_settings

dictionary

Дополнительные параметры конечных точек Oracle.

Возвращается: если endpoint_type имеет значение oracle

port

string

Порт, используемый для доступа к конечной точке.

Возвращается: при успешном выполнении

Пример: "3306"

postgre_sql_settings

dictionary

Дополнительные параметры конечных точек PostgreSQL.

Возвращается: если endpoint_type имеет значение postgres

redis_settings

dictionary

Дополнительные параметры конечных точек Redis.

Возвращается: если endpoint_type имеет значение redshift

redshift_settings

dictionary

Дополнительные параметры конечных точек Redshift.

Возвращается: если endpoint_type имеет значение redshift

s3_settings

dictionary

Дополнительные параметры конечных точек S3.

Возвращается: если endpoint_type имеет значение s3

server_name

string

Имя сервера на конечной точке.

Возвращается: при успешном выполнении

Пример: "ansible-test-123456789.example.com"

ssl_mode

string

Режим SSL, используемый для подключения к конечной точке.

Возвращается: при успешном выполнении

Пример: "none"

sybase_settings

dictionary

Дополнительные параметры конечных точек Sybase.

Возвращается: если endpoint_type имеет значение sybase

tags

dictionary

Словарь с тегами, назначенными конечной точке.

Возвращается: при успешном выполнении

Пример: {"MyTagKey": "MyTagValue"}

username

string

Имя пользователя, используемое для подключения к конечной точке.

Возвращается: при успешном выполнении

Пример: "example-username"

Авторы

  • Rui Moreira (@ruimoreira)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Связь

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

Spec-Zone.ru

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