community.aws.dms_endpoint module – Creates or destroys a data migration services endpoint
Note
This module is part of the community.aws collection (version 8.0.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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.aws.dms_endpoint
.
New in community.aws 1.0.0
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 >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0
Parameters
Parameter |
Comments |
---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
Amazon Resource Name (ARN) for the certificate. |
|
Name for the database on the origin or target side. |
|
Use a The Choices:
|
|
The settings in JSON format for the DMS transfer type of source endpoint. |
|
Settings in JSON format for the target Amazon DynamoDB endpoint if source or target is dynamodb. |
|
Settings in JSON format for the target Elasticsearch endpoint. |
|
URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
An identifier name for the endpoint. |
|
Type of endpoint we want to manage. Required when state=present. Choices:
|
|
Database engine that we want to use, please refer to the AWS DMS for more information on the supported engines and their limitations. Required when state=present. Choices:
|
|
The external table definition. |
|
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.” |
|
Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. |
|
Encryption key to use to encrypt replication storage and connection information. |
|
Settings in JSON format for the source MongoDB endpoint. |
|
Password used to connect to the database this attribute can only be written the AWS API does not return this parameter. |
|
TCP port for access to the database. |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified, even if purge_tags=True. Tag keys beginning with Choices:
|
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
number of times we should retry when deleting a resource Required when wait=true. |
|
S3 buckets settings for the target Amazon S3 endpoint. |
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Servername that the endpoint will connect to. |
|
Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Mode used for the SSL connection. Choices:
|
|
State of the endpoint. Choices:
|
|
A list of tags to add to the endpoint. |
|
Time in seconds we should wait for when deleting a resource. Required when wait=true. |
|
Username our endpoint will use to connect to the database. |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
|
Whether Ansible should wait for the object to be deleted when state=absent. Choices:
|
Notes
Note
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials
). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A description of the DMS endpoint. Returned: success |
|
The name of the database at the endpoint. Returned: success Sample: |
|
Additional transfer related settings. Returned: when additional DMS Transfer settings have been configured. |
|
Additional settings for DocumentDB endpoints. Returned: when the endpoint_type is |
|
Additional settings for Elasticsearch endpoints. Returned: when the endpoint_type is |
|
The ARN that uniquely identifies the endpoint. Returned: success Sample: |
|
The database endpoint identifier. Returned: success Sample: |
|
The type of endpoint. Valid values are Returned: success Sample: |
|
The expanded name for the engine name. Returned: success Sample: |
|
The database engine name. Returned: success Sample: |
|
Additional settings for IBM DB2 endpoints. Returned: when the endpoint_type is |
|
Additional settings for Kafka endpoints. Returned: when the endpoint_type is |
|
Additional settings for Kinesis endpoints. Returned: when the endpoint_type is |
|
An KMS key ID that is used to encrypt the connection parameters for the endpoint. Returned: success Sample: |
|
Additional settings for Microsoft SQL Server endpoints. Returned: when the endpoint_type is |
|
Additional settings for MongoDB endpoints. Returned: when the endpoint_type is |
|
Additional settings for MySQL endpoints. Returned: when the endpoint_type is |
|
Additional settings for Amazon Neptune endpoints. Returned: when the endpoint_type is |
|
Additional settings for Oracle endpoints. Returned: when the endpoint_type is |
|
The port used to access the endpoint. Returned: success Sample: |
|
Additional settings for PostgrSQL endpoints. Returned: when the endpoint_type is |
|
Additional settings for Redis endpoints. Returned: when the endpoint_type is |
|
Additional settings for Redshift endpoints. Returned: when the endpoint_type is |
|
Additional settings for S3 endpoints. Returned: when the endpoint_type is |
|
The name of the server at the endpoint. Returned: success Sample: |
|
The SSL mode used to connect to the endpoint. Returned: success Sample: |
|
Additional settings for Sybase endpoints. Returned: when the endpoint_type is |
|
A dictionary representing the tags attached to the endpoint. Returned: success Sample: |
|
The user name used to connect to the endpoint. Returned: success Sample: |