community / community.aws / 4.3.0 / module / aws_glue_connection Manage an AWS Glue connection | "added in version" 1.0.0 of community.aws" Authors: Rob White (@wimnat)community.aws.aws_glue_connection (4.3.0) — module
Install with ansible-galaxy collection install community.aws:==4.3.0
collections: - name: community.aws version: 4.3.0
Manage an AWS Glue connection. See U(https://aws.amazon.com/glue/) for details.
# Note: These examples do not set authentication details, see the AWS Guide for details. # Create an AWS Glue connection - community.aws.aws_glue_connection: name: my-glue-connection connection_properties: JDBC_CONNECTION_URL: jdbc:mysql://mydb:3306/databasename USERNAME: my-username PASSWORD: my-password state: present
# Create an AWS Glue network connection - community.aws.aws_glue_connection: name: my-glue-network-connection availability_zone: us-east-1a connection_properties: JDBC_ENFORCE_SSL: "false" connection_type: NETWORK description: Test connection security_groups: - sg-glue subnet_id: subnet-123abc state: present
# Delete an AWS Glue connection - community.aws.aws_glue_connection: name: my-glue-connection state: absent
name: description: - The name of the connection. required: true type: str state: choices: - present - absent description: - Create or delete the AWS Glue connection. required: true type: str region: aliases: - aws_region - ec2_region description: - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str 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: - Uses a boto profile. Only works with boto >= 2.24.0. - 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 subnet_id: description: - The subnet ID used by the connection. - Required when I(connection_type=NETWORK). type: str 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 catalog_id: description: - The ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default. type: str description: description: - The description of the connection. type: str aws_ca_bundle: description: - 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.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - 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 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: - 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 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 match_criteria: description: - A list of UTF-8 strings that specify the criteria that you can use in selecting this connection. elements: str type: list security_token: aliases: - aws_security_token - access_token description: - AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or 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 boto versions >= 2.6.0. type: bool connection_type: choices: - CUSTOM - JDBC - KAFKA - MARKETPLACE - MONGODB - NETWORK default: JDBC description: - The type of the connection. Currently, SFTP is not supported. type: str security_groups: description: - A list of security groups to be used by the connection. Use either security group name or ID. - Required when I(connection_type=NETWORK). elements: str type: list availability_zone: description: - Availability Zone used by the connection - Required when I(connection_type=NETWORK). type: str version_added: 1.5.0 version_added_collection: community.aws connection_properties: description: - A dict of key-value pairs used as parameters for this connection. - Required when I(state=present). type: dict 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
connection_properties: description: - (deprecated) A dict of key-value pairs (converted to lowercase) used as parameters for this connection. - This return key has been deprecated, and will be removed in a release after 2024-06-01. returned: when state is present sample: jdbc_connection_url: jdbc:mysql://mydb:3306/databasename password: y username: x type: dict connection_type: description: The type of the connection. returned: when state is present sample: JDBC type: str creation_time: description: The time this connection definition was created. returned: when state is present sample: '2018-04-21T05:19:58.326000+00:00' type: str description: description: Description of the job being defined. returned: when state is present sample: My first Glue job type: str last_updated_time: description: The last time this connection definition was updated. returned: when state is present sample: '2018-04-21T05:19:58.326000+00:00' type: str match_criteria: description: A list of criteria that can be used in selecting this connection. returned: when state is present sample: [] type: list name: description: The name of the connection definition. returned: when state is present sample: my-glue-connection type: str physical_connection_requirements: description: A dict of physical connection requirements, such as VPC and SecurityGroup, needed for making this connection successfully. returned: when state is present sample: subnet-id: subnet-aabbccddee type: dict raw_connection_properties: description: A dict of key-value pairs used as parameters for this connection. returned: when state is present sample: JDBC_CONNECTION_URL: jdbc:mysql://mydb:3306/databasename PASSWORD: y USERNAME: x type: dict