ansible / ansible.builtin / v2.9.17 / module / dms_endpoint creates or destroys a data migration services endpoint | "added in version" 2.9 of ansible.builtin" Authors: Rui Moreira (@ruimoreira) preview | supported by communityansible.builtin.dms_endpoint (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
creates or destroys a data migration services endpoint, that can be used to replicate data.
# 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
port: description: - TCP port for access to the database tags: description: - A list of tags to add to the endpoint wait: default: 'false' description: - should wait for the object to be deleted when state = absent type: bool state: choices: - present - absent default: present description: - State of the endpoint region: description: - aws region, should be read from the running aws config ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - 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. type: str profile: aliases: - aws_profile description: - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str retries: description: - number of times we should retry when deleting a resource type: int sslmode: choices: - none - require - verify-ca - verify-full default: none description: - Mode used for the ssl connection timeout: description: - time in seconds we should wait for when deleting a resource type: int kmskeyid: description: - Encryption key to use to encrypt replication storage and connection information password: description: - Password used to connect to the database this attribute can only be written the AWS API does not return this parameter username: description: - Username our endpoint will use to connect to the database aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). - Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict aws_region: description: - alias for region ec2_region: description: - alias for region enginename: choices: - mysql - oracle - postgres - mariadb - aurora - redshift - s3 - db2 - azuredb - sybase - dynamodb - mongodb - sqlserver description: - Database engine that we want to use, please refer to the AWS DMS for more information on the supported engines and their limitation s3settings: description: - S3 buckets settings for the target Amazon S3 endpoint. servername: description: - Servername that the endpoint will connect to databasename: description: - Name for the database on the origin or target side endpointtype: choices: - source - target description: - Type of endpoint we want to manage aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Not used by boto 2 based modules. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str certificatearn: description: - Amazon Resource Name (ARN) for the certificate security_token: aliases: - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool kinesissettings: description: - Settings in JSON format for the target Amazon Kinesis Data Streams endpoint mongodbsettings: description: - Settings in JSON format for the source MongoDB endpoint dynamodbsettings: description: - Settings in JSON format for the target Amazon DynamoDB endpoint if source or target is dynamodb endpointidentifier: description: - An identifier name for the endpoint dmstransfersettings: description: - The settings in JSON format for the DMS transfer type of source endpoint serviceaccessrolearn: description: - Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. elasticsearchsettings: description: - Settings in JSON format for the target Elasticsearch endpoint externaltabledefinition: description: - The external table definition extraconnectionattributes: description: - 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." debug_botocore_endpoint_logs: default: 'no' description: - 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. type: bool