dms_endpoint – creates or destroys a data migration services endpoint — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# dms_endpoint – creates or destroys a data migration services endpoint

New in version 2.9.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Status

## Synopsis

- creates or destroys a data migration services endpoint, that can be used to replicate data.

## Requirements

The below requirements are needed on the host that executes this module.

- python >= 2.6
- boto

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
aws_access_key string |  | AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. aliases: ec2_access_key, access_key
aws_region - |  | alias for region
aws_secret_key string |  | AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. aliases: ec2_secret_key, secret_key
certificatearn - |  | Amazon Resource Name (ARN) for the certificate
databasename - |  | Name for the database on the origin or target side
debug_botocore_endpoint_logs boolean added in 2.8 | Choices: no ← yes | Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
dmstransfersettings - |  | The settings in JSON format for the DMS transfer type of source endpoint
dynamodbsettings - |  | Settings in JSON format for the target Amazon DynamoDB endpoint if source or target is dynamodb
ec2_region - |  | alias for region
ec2_url string |  | Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
elasticsearchsettings - |  | Settings in JSON format for the target Elasticsearch endpoint
endpointidentifier - |  | An identifier name for the endpoint
endpointtype - | Choices: source target | Type of endpoint we want to manage
enginename - | Choices: mysql oracle postgres mariadb aurora redshift s3 db2 azuredb sybase dynamodb mongodb sqlserver | Database engine that we want to use, please refer to the AWS DMS for more information on the supported engines and their limitation
externaltabledefinition - |  | The external table definition
extraconnectionattributes - |  | Extra attributes for the database connection, the AWS documentation states " For more information about extra connection attributes, see the documentation section for your data store."
kinesissettings - |  | Settings in JSON format for the target Amazon Kinesis Data Streams endpoint
kmskeyid - |  | Encryption key to use to encrypt replication storage and connection information
mongodbsettings - |  | Settings in JSON format for the source MongoDB endpoint
password - |  | Password used to connect to the database this attribute can only be written the AWS API does not return this parameter
port - |  | TCP port for access to the database
profile string |  | Uses a boto profile. Only works with boto >= 2.24.0.
region - |  | aws region, should be read from the running aws config
retries integer |  | number of times we should retry when deleting a resource
s3settings - |  | S3 buckets settings for the target Amazon S3 endpoint.
security_token string |  | AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. aliases: access_token
servername - |  | Servername that the endpoint will connect to
serviceaccessrolearn - |  | Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
sslmode - | Choices: none ← require verify-ca verify-full | Mode used for the ssl connection
state - | Choices: present ← absent | State of the endpoint
tags - |  | A list of tags to add to the endpoint
timeout integer |  | time in seconds we should wait for when deleting a resource
username - |  | Username our endpoint will use to connect to the database
validate_certs boolean | Choices: no yes ← | When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
wait boolean | Choices: no ← yes | should wait for the object to be deleted when state = absent

## Notes

Note

- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence `AWS_URL` or `EC2_URL`, `AWS_ACCESS_KEY_ID` or `AWS_ACCESS_KEY` or `EC2_ACCESS_KEY`, `AWS_SECRET_ACCESS_KEY` or `AWS_SECRET_KEY` or `EC2_SECRET_KEY`, `AWS_SECURITY_TOKEN` or `EC2_SECURITY_TOKEN`, `AWS_REGION` or `EC2_REGION`
- Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
- `AWS_REGION` or `EC2_REGION` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

## Examples

    # Note: These examples do not set authentication details
    # Endpoint Creation
    - 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

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Rui Moreira (@ruimoreira)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.