community.aws.glue_crawler module – Manage an AWS Glue crawler
Note
This module is part of the community.aws collection (version 9.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.glue_crawler.
New in community.aws 4.1.0
Synopsis
Manage an AWS Glue crawler. See https://aws.amazon.com/glue/ for details.
Prior to release 5.0.0 this module was called
community.aws.aws_glue_crawler. The usage did not change.
Aliases: aws_glue_crawler
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.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. |
|
The name of the database where results are written. |
|
Use a The Choices:
|
|
Description of the crawler being defined. |
|
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 |
|
The name you assign to this crawler definition. It must be unique in your account. |
|
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 If the Tag keys beginning with Choices:
|
|
A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run. |
|
Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. Supported options are |
|
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 |
|
The name or ARN of the IAM role associated with this crawler. Required when state=present. |
|
The policy for the crawler’s update and deletion behavior. |
|
Defines the deletion behavior when the crawler finds a deleted object. Supported options are |
|
Defines the update behavior when the crawler finds a changed schema.. Supported options are |
|
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 |
|
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 |
|
Create or delete the AWS Glue crawler. Choices:
|
|
The table prefix used for catalog tables that are created. |
|
A dictionary representing the tags to be applied to the resource. If the |
|
A list of targets to crawl. See example below. Required when state=present. |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. 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, see the AWS Guide for details.
# Create an AWS Glue crawler
- community.aws.glue_crawler:
name: my-glue-crawler
database_name: my_database
role: my-iam-role
schema_change_policy:
delete_behavior: DELETE_FROM_DATABASE
update_behavior: UPDATE_IN_DATABASE
recrawl_policy:
recrawl_ehavior: CRAWL_EVERYTHING
targets:
S3Targets:
- Path: "s3://my-bucket/prefix/folder/"
ConnectionName: my-connection
Exclusions:
- "**.json"
- "**.yml"
state: present
# Delete an AWS Glue crawler
- community.aws.glue_crawler:
name: my-glue-crawler
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The time and date that this crawler definition was created. Returned: when state is present Sample: |
|
The name of the database where results are written. Returned: when state is present Sample: |
|
Description of the crawler. Returned: when state is present Sample: |
|
The time and date that this crawler definition was last updated. Returned: when state is present Sample: |
|
The name of the AWS Glue crawler. Returned: always Sample: |
|
A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run. Returned: when state is present |
|
Whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. Returned: when state is present Sample: |
|
The name or ARN of the IAM role associated with this crawler. Returned: when state is present Sample: |
|
The policy for the crawler’s update and deletion behavior. Returned: when state is present |
|
The deletion behavior when the crawler finds a deleted object. Returned: when state is present Sample: |
|
The update behavior when the crawler finds a changed schema. Returned: when state is present Sample: |
|
The table prefix used for catalog tables that are created. Returned: when state is present Sample: |
|
A list of targets to crawl. Returned: when state is present |
|
List of catalog targets. Returned: when state is present |
|
List of DynamoDB targets. Returned: when state is present |
|
List of JDBC targets. Returned: when state is present |
|
List of Mongo DB targets. Returned: when state is present |
|
List of S3 targets. Returned: when state is present |