community / community.aws / 5.1.0 / module / dms_endpoint Creates or destroys a data migration services endpoint | "added in version" 1.0.0 of community.aws" Authors: Rui Moreira (@ruimoreira)community.aws.dms_endpoint (5.1.0) — module
Install with ansible-galaxy collection install community.aws:==5.1.0
collections: - name: community.aws version: 5.1.0
Creates or destroys a data migration services endpoint, that can be used to replicate data.
# 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
port: description: - TCP port for access to the database. type: int tags: aliases: - resource_tags description: - A list of tags to add to the endpoint. required: false type: dict wait: default: false description: - Whether Ansible should wait for the object to be deleted when I(state=absent). type: bool state: choices: - present - absent default: present description: - State of the endpoint. type: str region: aliases: - aws_region - ec2_region description: - The AWS region to use. - For global services such as IAM, Route53 and CloudFront, I(region) is ignored. - The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used. - See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region). - The C(ec2_region) alias has been deprecated and will be removed in a release after 2024-12-01 - Support for the C(EC2_REGION) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str profile: aliases: - aws_profile description: - A named AWS profile to use for authentication. - See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html). - The C(AWS_PROFILE) environment variable may also be used. - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key) and I(security_token) options. type: str retries: description: - number of times we should retry when deleting a resource - Required when I(wait=true). type: int sslmode: choices: - none - require - verify-ca - verify-full default: none description: - Mode used for the SSL connection. type: str timeout: description: - Time in seconds we should wait for when deleting a resource. - Required when I(wait=true). type: int kmskeyid: description: - Encryption key to use to encrypt replication storage and connection information. type: str password: description: - Password used to connect to the database this attribute can only be written the AWS API does not return this parameter. type: str username: description: - Username our endpoint will use to connect to the database. type: str access_key: aliases: - aws_access_key_id - aws_access_key - ec2_access_key description: - AWS access key ID. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables may also be used in decreasing order of preference. - The I(aws_access_key) and I(profile) options are mutually exclusive. - The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_access_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). type: dict 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 limitations. - Required when I(state=present). type: str purge_tags: default: true description: - If I(purge_tags=true) and I(tags) is set, existing tags will be purged from the resource to match exactly what is defined by I(tags) parameter. - If the I(tags) parameter is not set then tags will not be modified, even if I(purge_tags=True). - Tag keys beginning with C(aws:) are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the I(purge_tags) parameter. See the Amazon documentation for more information U(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions). required: false type: bool s3settings: description: - S3 buckets settings for the target Amazon S3 endpoint. type: dict secret_key: aliases: - aws_secret_access_key - aws_secret_key - ec2_secret_key description: - AWS secret access key. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variables may also be used in decreasing order of preference. - The I(secret_key) and I(profile) options are mutually exclusive. - The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_secret_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str servername: description: - Servername that the endpoint will connect to. type: str databasename: description: - Name for the database on the origin or target side. type: str endpoint_url: aliases: - ec2_url - aws_endpoint_url - s3_url description: - 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 C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing order of preference. - The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_URL) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str endpointtype: choices: - source - target description: - Type of endpoint we want to manage. - Required when I(state=present). type: str aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - The C(AWS_CA_BUNDLE) environment variable may also be used. type: path session_token: aliases: - aws_session_token - security_token - aws_security_token - access_token description: - AWS STS session token for use with temporary credentials. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variables may also be used in decreasing order of preference. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with the parameter being renamed from I(security_token) to I(session_token) in release 6.0.0. - The I(security_token), I(aws_security_token), and I(access_token) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables has been deprecated and will be removed in a release after 2024-12-01. type: str certificatearn: description: - Amazon Resource Name (ARN) for the certificate. type: str validate_certs: default: true description: - When set to C(false), SSL certificates will not be validated for communication with the AWS APIs. - Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider setting I(aws_ca_bundle) instead. type: bool kinesissettings: description: - Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. type: dict mongodbsettings: description: - Settings in JSON format for the source MongoDB endpoint. type: dict dynamodbsettings: description: - Settings in JSON format for the target Amazon DynamoDB endpoint if source or target is dynamodb. type: dict endpointidentifier: description: - An identifier name for the endpoint. required: true type: str dmstransfersettings: description: - The settings in JSON format for the DMS transfer type of source endpoint. type: dict serviceaccessrolearn: description: - Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. type: str elasticsearchsettings: description: - Settings in JSON format for the target Elasticsearch endpoint. type: dict externaltabledefinition: description: - The external table definition. type: str 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." type: str debug_botocore_endpoint_logs: default: false description: - Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action") API calls made during a task, outputing the set to the resource_actions key in the task results. Use the C(aws_resource_action) callback to output to total list made during a playbook. - The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used. type: bool
endpoint: contains: database_name: description: - The name of the database at the endpoint. example: exampledb returned: success type: str dms_transfer_settings: description: - Additional transfer related settings. returned: when additional DMS Transfer settings have been configured. type: dict doc_db_settings: description: - Additional settings for DocumentDB endpoints. returned: when the I(endpoint_type) is C(documentdb) type: dict elasticsearch_settings: description: - Additional settings for Elasticsearch endpoints. returned: when the I(endpoint_type) is C(elasticsearch) type: dict endpoint_arn: description: - The ARN that uniquely identifies the endpoint. example: arn:aws:dms:us-east-1:123456789012:endpoint:1234556789ABCDEFGHIJKLMNOPQRSTUVWXYZ012 returned: success type: str endpoint_identifier: description: - The database endpoint identifier. example: ansible-test-12345678-dms returned: success type: str endpoint_type: description: - The type of endpoint. Valid values are C(SOURCE) and C(TARGET). example: SOURCE returned: success type: str engine_display_name: description: - The expanded name for the engine name. example: Amazon Aurora MySQL returned: success type: str engine_name: description: - The database engine name. example: aurora returned: success type: str i_b_m_db_settings: description: - Additional settings for IBM DB2 endpoints. returned: when the I(endpoint_type) is C(db2) type: dict kafka_settings: description: - Additional settings for Kafka endpoints. returned: when the I(endpoint_type) is C(kafka) type: dict kinesis_settings: description: - Additional settings for Kinesis endpoints. returned: when the I(endpoint_type) is C(kinesis) type: dict kms_key_id: description: - An KMS key ID that is used to encrypt the connection parameters for the endpoint. example: arn:aws:kms:us-east-1:123456789012:key/01234567-abcd-12ab-98fe-123456789abc returned: success type: str microsoft_sql_server_settings: description: - Additional settings for Microsoft SQL Server endpoints. returned: when the I(endpoint_type) is C(sqlserver) type: dict mongo_db_settings: description: - Additional settings for MongoDB endpoints. returned: when the I(endpoint_type) is C(mongodb) type: dict my_sql_settings: description: - Additional settings for MySQL endpoints. returned: when the I(endpoint_type) is C(mysql) type: dict neptune_settings: description: - Additional settings for Amazon Neptune endpoints. returned: when the I(endpoint_type) is C(neptune) type: dict oracle_settings: description: - Additional settings for Oracle endpoints. returned: when the I(endpoint_type) is C(oracle) type: dict port: description: - The port used to access the endpoint. example: 3306 returned: success type: str postgre_sql_settings: description: - Additional settings for PostgrSQL endpoints. returned: when the I(endpoint_type) is C(postgres) type: dict redis_settings: description: - Additional settings for Redis endpoints. returned: when the I(endpoint_type) is C(redshift) type: dict redshift_settings: description: - Additional settings for Redshift endpoints. returned: when the I(endpoint_type) is C(redshift) type: dict s3_settings: description: - Additional settings for S3 endpoints. returned: when the I(endpoint_type) is C(s3) type: dict server_name: description: - The name of the server at the endpoint. example: ansible-test-123456789.example.com returned: success type: str ssl_mode: description: - The SSL mode used to connect to the endpoint. example: none returned: success type: str sybase_settings: description: - Additional settings for Sybase endpoints. returned: when the I(endpoint_type) is C(sybase) type: dict tags: description: - A dictionary representing the tags attached to the endpoint. example: MyTagKey: MyTagValue returned: success type: dict username: description: - The user name used to connect to the endpoint. example: example-username returned: success type: str description: - A description of the DMS endpoint. returned: success type: dict