diff --git a/README.md b/README.md index 48d55ad314a..c8e395d20d7 100644 --- a/README.md +++ b/README.md @@ -46,8 +46,6 @@ Name | Description [community.aws.aws_config_recorder](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_config_recorder_module.rst)|Manage AWS Config Recorders [community.aws.aws_config_rule](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_config_rule_module.rst)|Manage AWS Config resources [community.aws.aws_elasticbeanstalk_app](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_elasticbeanstalk_app_module.rst)|Create, update, and delete an elastic beanstalk application -[community.aws.aws_glue_connection](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_glue_connection_module.rst)|Manage an AWS Glue connection -[community.aws.aws_glue_job](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_glue_job_module.rst)|Manage an AWS Glue job [community.aws.aws_inspector_target](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_inspector_target_module.rst)|Create, Update and Delete Amazon Inspector Assessment Targets [community.aws.aws_msk_cluster](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_msk_cluster_module.rst)|Manage Amazon MSK clusters [community.aws.aws_msk_config](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_msk_config_module.rst)|Manage Amazon MSK cluster configurations. @@ -148,6 +146,9 @@ Name | Description [community.aws.elb_target_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_target_group_module.rst)|Manage a target group for an Application or Network load balancer [community.aws.elb_target_group_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_target_group_info_module.rst)|Gather information about ELB target groups in AWS [community.aws.elb_target_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_target_info_module.rst)|Gathers which target groups a target is associated with. +[community.aws.glue_connection](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.glue_connection_module.rst)|Manage an AWS Glue connection +[community.aws.glue_crawler](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.glue_crawler_module.rst)|Manage an AWS Glue crawler +[community.aws.glue_job](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.glue_job_module.rst)|Manage an AWS Glue job [community.aws.iam_access_key](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.iam_access_key_module.rst)|Manage AWS IAM User access keys [community.aws.iam_access_key_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.iam_access_key_info_module.rst)|fetch information about AWS IAM User access keys [community.aws.iam_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.iam_group_module.rst)|Manage AWS IAM groups diff --git a/changelogs/fragments/1300-rename-glue.yml b/changelogs/fragments/1300-rename-glue.yml new file mode 100644 index 00000000000..7518bb7ee6a --- /dev/null +++ b/changelogs/fragments/1300-rename-glue.yml @@ -0,0 +1,4 @@ +minor_changes: +- aws_glue_connection - the ``aws_glue_connection`` module has been renamed to ``glue_connection``, ``aws_glue_connection`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1300). +- aws_glue_crawler - the ``aws_glue_crawler`` module has been renamed to ``glue_crawler``, ``aws_glue_crawler`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1300). +- aws_glue_job - the ``aws_glue_job`` module has been renamed to ``glue_job``, ``aws_glue_job`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1300). diff --git a/docs/community.aws.aws_glue_connection_module.rst b/docs/community.aws.glue_connection_module.rst similarity index 98% rename from docs/community.aws.aws_glue_connection_module.rst rename to docs/community.aws.glue_connection_module.rst index fb3777d3bad..15c5d9ef6a1 100644 --- a/docs/community.aws.aws_glue_connection_module.rst +++ b/docs/community.aws.glue_connection_module.rst @@ -1,9 +1,9 @@ -.. _community.aws.aws_glue_connection_module: +.. _community.aws.glue_connection_module: -********************************* -community.aws.aws_glue_connection -********************************* +***************************** +community.aws.glue_connection +***************************** **Manage an AWS Glue connection** @@ -18,6 +18,7 @@ Version added: 1.0.0 Synopsis -------- - Manage an AWS Glue connection. See https://aws.amazon.com/glue/ for details. +- Prior to release 5.0.0 this module was called ``community.aws.aws_glue_connection``. The usage did not change. @@ -404,7 +405,7 @@ Examples # Note: These examples do not set authentication details, see the AWS Guide for details. # Create an AWS Glue connection - - community.aws.aws_glue_connection: + - community.aws.glue_connection: name: my-glue-connection connection_properties: JDBC_CONNECTION_URL: jdbc:mysql://mydb:3306/databasename @@ -413,7 +414,7 @@ Examples state: present # Create an AWS Glue network connection - - community.aws.aws_glue_connection: + - community.aws.glue_connection: name: my-glue-network-connection availability_zone: us-east-1a connection_properties: @@ -426,7 +427,7 @@ Examples state: present # Delete an AWS Glue connection - - community.aws.aws_glue_connection: + - community.aws.glue_connection: name: my-glue-connection state: absent diff --git a/docs/community.aws.glue_crawler_module.rst b/docs/community.aws.glue_crawler_module.rst new file mode 100644 index 00000000000..8869433e663 --- /dev/null +++ b/docs/community.aws.glue_crawler_module.rst @@ -0,0 +1,820 @@ +.. _community.aws.glue_crawler_module: + + +************************** +community.aws.glue_crawler +************************** + +**Manage an AWS Glue crawler** + + +Version added: 4.1.0 + +.. contents:: + :local: + :depth: 1 + + +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. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- python >= 3.6 +- boto3 >= 1.17.0 +- botocore >= 1.20.0 + + +Parameters +---------- + +.. raw:: html + +
Parameter | +Choices/Defaults | +Comments | +|
---|---|---|---|
+
+ aws_access_key
+
+
+ string
+
+ |
+ + | +
+ 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.The aws_access_key and profile options are mutually exclusive.
+ aliases: ec2_access_key, access_key |
+ |
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
+ |
+ |
+
+ aws_config
+
+
+ dictionary
+
+ |
+ + | +
+ A dictionary to modify the botocore configuration.
+ Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
+ |
+ |
+
+ aws_secret_key
+
+
+ string
+
+ |
+ + | +
+ 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.The aws_secret_key and profile options are mutually exclusive.
+ aliases: ec2_secret_key, secret_key |
+ |
+
+ database_name
+
+
+ string
+
+ |
+ + | +
+ The name of the database where results are written.
+ |
+ |
+
+ debug_botocore_endpoint_logs
+
+
+ boolean
+
+ |
+
+
|
+
+ 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.
+ |
+ |
+
+ description
+
+
+ string
+
+ |
+ + | +
+ Description of the crawler being defined.
+ |
+ |
+
+ ec2_url
+
+
+ string
+
+ |
+ + | +
+ 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.
+ aliases: aws_endpoint_url, endpoint_url |
+ |
+
+ name
+
+
+ string
+ / required
+
+ |
+ + | +
+ The name you assign to this crawler definition. It must be unique in your account.
+ |
+ |
+
+ profile
+
+
+ string
+
+ |
+ + | +
+ The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
+ aliases: aws_profile |
+ |
+
+ purge_tags
+
+
+ boolean
+
+ |
+
+
|
+
+ 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
+ aws: are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the purge_tags parameter. See the Amazon documentation for more information https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions. |
+ |
+
+ recrawl_policy
+
+
+ dictionary
+
+ |
+ + | +
+ A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
+ |
+ |
+ |
+
+ recrawl_behavior
+
+
+ string
+
+ |
+ + | +
+ Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
+ Supported options are
+ CRAWL_EVERYTHING and CRAWL_NEW_FOLDERS_ONLY . |
+
+
+ region
+
+
+ string
+
+ |
+ + | +
+ 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 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
+ aliases: aws_region, ec2_region |
+ |
+
+ role
+
+
+ string
+
+ |
+ + | +
+ The name or ARN of the IAM role associated with this crawler.
+ Required when state=present.
+ |
+ |
+
+ schema_change_policy
+
+
+ dictionary
+
+ |
+ + | +
+ The policy for the crawler's update and deletion behavior.
+ |
+ |
+ |
+
+ delete_behavior
+
+
+ string
+
+ |
+ + | +
+ Defines the deletion behavior when the crawler finds a deleted object.
+ Supported options are
+ LOG , DELETE_FROM_DATABASE , and DEPRECATE_IN_DATABASE . |
+
+ |
+
+ update_behavior
+
+
+ string
+
+ |
+ + | +
+ Defines the update behavior when the crawler finds a changed schema..
+ Supported options are
+ LOG and UPDATE_IN_DATABASE . |
+
+
+ security_token
+
+
+ string
+
+ |
+ + | +
+ AWS STS security token . If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.The security_token and profile options are mutually exclusive.
+ Aliases aws_session_token and session_token have been added in version 3.2.0.
+ aliases: aws_session_token, session_token, aws_security_token, access_token |
+ |
+
+ state
+
+
+ string
+ / required
+
+ |
+
+
|
+
+ Create or delete the AWS Glue crawler.
+ |
+ |
+
+ table_prefix
+
+
+ string
+
+ |
+ + | +
+ The table prefix used for catalog tables that are created.
+ |
+ |
+
+ tags
+
+
+ dictionary
+
+ |
+ + | +
+ A dictionary representing the tags to be applied to the resource.
+ If the tags parameter is not set then tags will not be modified.
+ aliases: resource_tags |
+ |
+
+ targets
+
+
+ dictionary
+
+ |
+ + | +
+ A list of targets to crawl. See example below.
+ Required when state=present.
+ |
+ |
+
+ validate_certs
+
+
+ boolean
+
+ |
+
+
|
+
+ When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
+ |
+