Try SpotterManage an AWS Glue connection
| "added in version" 1.0.0 of community.aws"
Authors: Rob White (@wimnat)
Install with ansible-galaxy collection install community.aws:==5.1.0
collections:
- name: community.aws
version: 5.1.0Manage an AWS Glue connection. See U(https://aws.amazon.com/glue/) for details.
Prior to release 5.0.0 this module was called C(community.aws.aws_glue_connection). The usage did not change.
# Note: These examples do not set authentication details, see the AWS Guide for details.
# Create an AWS Glue connection
- community.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.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.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.
- 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
subnet_id:
description:
- The subnet ID used by the connection.
- Required when I(connection_type=NETWORK).
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
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
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
description:
description:
- The description of the connection.
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
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
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
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
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: 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
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