W3cubDocs

/Ansible

community.aws.dms_endpoint – Creates or destroys a data migration services endpoint

Note

This plugin is part of the community.aws collection (version 1.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.aws.

To use it in a playbook, specify: community.aws.dms_endpoint.

New in version 1.0.0: of community.aws

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.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
aws_ca_bundle
path
The location of a CA Bundle to use when validating SSL certificates.
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
aws_config
dictionary
A dictionary to modify the botocore configuration.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
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.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
certificatearn
string
Amazon Resource Name (ARN) for the certificate.
databasename
string
Name for the database on the origin or target side.
debug_botocore_endpoint_logs
boolean
    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
dictionary
The settings in JSON format for the DMS transfer type of source endpoint.
dynamodbsettings
dictionary
Settings in JSON format for the target Amazon DynamoDB endpoint if source or target is dynamodb.
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.

aliases: aws_endpoint_url, endpoint_url
elasticsearchsettings
dictionary
Settings in JSON format for the target Elasticsearch endpoint.
endpointidentifier
string / required
An identifier name for the endpoint.
endpointtype
string / required
    Choices:
  • source
  • target
Type of endpoint we want to manage.
enginename
string / required
    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 limitations.
externaltabledefinition
string
The external table definition.
extraconnectionattributes
string
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
dictionary
Settings in JSON format for the target Amazon Kinesis Data Streams endpoint.
kmskeyid
string
Encryption key to use to encrypt replication storage and connection information.
mongodbsettings
dictionary
Settings in JSON format for the source MongoDB endpoint.
password
string
Password used to connect to the database this attribute can only be written the AWS API does not return this parameter.
port
integer
TCP port for access to the database.
profile
string
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
region
string
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

aliases: aws_region, ec2_region
retries
integer
number of times we should retry when deleting a resource
Required when wait=true.
s3settings
dictionary
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.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
servername
string
Servername that the endpoint will connect to.
serviceaccessrolearn
string
Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
sslmode
string
    Choices:
  • none ←
  • require
  • verify-ca
  • verify-full
Mode used for the SSL connection.
state
string
    Choices:
  • present ←
  • absent
State of the endpoint.
tags
dictionary
A list of tags to add to the endpoint.
timeout
integer
Time in seconds we should wait for when deleting a resource.
Required when wait=true.
username
string
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
Whether Ansible 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_PROFILE or AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
  • 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
- 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

Authors

  • Rui Moreira (@ruimoreira)

© 2012–2018 Michael DeHaan
© 2018–2021 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