Update Examples with FQCN (#67)

Updated module examples with FQCN Signed-off-by: Abhijeet Kasurde <[email protected]>
ansible-collections · Jun 16, 2020 · 98173ae · 98173ae
1 parent 7cd211e
commit 98173ae
Show file tree

Hide file tree

Showing 172 changed files with 1,057 additions and 1,089 deletions.
diff --git a/plugins/modules/aws_acm.py b/plugins/modules/aws_acm.py
@@ -157,14 +157,14 @@
 EXAMPLES = '''
 
 - name: upload a self-signed certificate
-  aws_acm:
+  community.aws.aws_acm:
     certificate: "{{ lookup('file', 'cert.pem' ) }}"
     privateKey: "{{ lookup('file', 'key.pem' ) }}"
     name_tag: my_cert # to be applied through an AWS tag as  "Name":"my_cert"
     region: ap-southeast-2 # AWS region
 
 - name: create/update a certificate with a chain
-  aws_acm:
+  community.aws.aws_acm:
     certificate: "{{ lookup('file', 'cert.pem' ) }}"
     privateKey: "{{ lookup('file', 'key.pem' ) }}"
     name_tag: my_cert
@@ -178,19 +178,19 @@
     var: cert_create.certificate.arn
 
 - name: delete the cert we just created
-  aws_acm:
+  community.aws.aws_acm:
     name_tag: my_cert
     state: absent
     region: ap-southeast-2
 
 - name: delete a certificate with a particular ARN
-  aws_acm:
+  community.aws.aws_acm:
     certificate_arn: "arn:aws:acm:ap-southeast-2:123456789012:certificate/01234567-abcd-abcd-abcd-012345678901"
     state: absent
     region: ap-southeast-2
 
 - name: delete all certificates with a particular domain name
-  aws_acm:
+  community.aws.aws_acm:
     domain_name: acm.ansible.com
     state: absent
     region: ap-southeast-2

diff --git a/plugins/modules/aws_acm_info.py b/plugins/modules/aws_acm_info.py
@@ -50,27 +50,27 @@
 
 EXAMPLES = '''
 - name: obtain all ACM certificates
-  aws_acm_info:
+  community.aws.aws_acm_info:
 
 - name: obtain all information for a single ACM certificate
-  aws_acm_info:
+  community.aws.aws_acm_info:
     domain_name: "*.example_com"
 
 - name: obtain all certificates pending validation
-  aws_acm_info:
+  community.aws.aws_acm_info:
     statuses:
     - PENDING_VALIDATION
 
 - name: obtain all certificates with tag Name=foo and myTag=bar
-  aws_acm_info:
+  community.aws.aws_acm_info:
     tags:
       Name: foo
       myTag: bar
 
 
 # The output is still a list of certificates, just one item long.
 - name: obtain information about a certificate with a particular ARN
-  aws_acm_info:
+  community.aws.aws_acm_info:
     certificate_arn:  "arn:aws:acm:ap-southeast-2:123456789876:certificate/abcdeabc-abcd-1234-4321-abcdeabcde12"
 
 '''

diff --git a/plugins/modules/aws_api_gateway.py b/plugins/modules/aws_api_gateway.py
@@ -116,7 +116,7 @@
 
 EXAMPLES = '''
 - name: Setup AWS API Gateway setup on AWS and deploy API definition
-  aws_api_gateway:
+  community.aws.aws_api_gateway:
     swagger_file: my_api.yml
     stage: production
     cache_enabled: true
@@ -126,7 +126,7 @@
     state: present
 
 - name: Update API definition to deploy new version
-  aws_api_gateway:
+  community.aws.aws_api_gateway:
     api_id: 'abc123321cba'
     swagger_file: my_api.yml
     deploy_desc: Make auth fix available.
@@ -136,7 +136,7 @@
     state: present
 
 - name: Update API definitions and settings and deploy as canary
-  aws_api_gateway:
+  community.aws.aws_api_gateway:
     api_id: 'abc123321cba'
     swagger_file: my_api.yml
     cache_enabled: true

diff --git a/plugins/modules/aws_application_scaling_policy.py b/plugins/modules/aws_application_scaling_policy.py
@@ -111,7 +111,7 @@
 
 # Create step scaling policy for ECS Service
 - name: scaling_policy
-  aws_application_scaling_policy:
+  community.aws.aws_application_scaling_policy:
     state: present
     policy_name: test_policy
     service_namespace: ecs
@@ -132,7 +132,7 @@
 
 # Create target tracking scaling policy for ECS Service
 - name: scaling_policy
-  aws_application_scaling_policy:
+  community.aws.aws_application_scaling_policy:
     state: present
     policy_name: test_policy
     service_namespace: ecs
@@ -150,7 +150,7 @@
 
 # Remove scalable target for ECS Service
 - name: scaling_policy
-  aws_application_scaling_policy:
+  community.aws.aws_application_scaling_policy:
     state: absent
     policy_name: test_policy
     policy_type: StepScaling

diff --git a/plugins/modules/aws_batch_compute_environment.py b/plugins/modules/aws_batch_compute_environment.py
@@ -12,8 +12,8 @@
 short_description: Manage AWS Batch Compute Environments
 description:
     - This module allows the management of AWS Batch Compute Environments.
-      It is idempotent and supports "Check" mode.  Use module M(aws_batch_compute_environment) to manage the compute
-      environment, M(aws_batch_job_queue) to manage job queues, M(aws_batch_job_definition) to manage job definitions.
+      It is idempotent and supports "Check" mode.  Use module M(community.aws.aws_batch_compute_environment) to manage the compute
+      environment, M(community.aws.aws_batch_job_queue) to manage job queues, M(community.aws.aws_batch_job_definition) to manage job definitions.
 
 
 author: Jon Meran (@jonmer85)
@@ -131,7 +131,7 @@
     state: present
   tasks:
   - name: My Batch Compute Environment
-    aws_batch_compute_environment:
+    community.aws.aws_batch_compute_environment:
       compute_environment_name: computeEnvironmentName
       state: present
       region: us-east-1

diff --git a/plugins/modules/aws_batch_job_definition.py b/plugins/modules/aws_batch_job_definition.py
@@ -12,8 +12,8 @@
 short_description: Manage AWS Batch Job Definitions
 description:
     - This module allows the management of AWS Batch Job Definitions.
-      It is idempotent and supports "Check" mode.  Use module M(aws_batch_compute_environment) to manage the compute
-      environment, M(aws_batch_job_queue) to manage job queues, M(aws_batch_job_definition) to manage job definitions.
+      It is idempotent and supports "Check" mode.  Use module M(community.aws.aws_batch_compute_environment) to manage the compute
+      environment, M(community.aws.aws_batch_job_queue) to manage job queues, M(community.aws.aws_batch_job_definition) to manage job definitions.
 
 
 author: Jon Meran (@jonmer85)
@@ -185,7 +185,7 @@
     state: present
   tasks:
 - name: My Batch Job Definition
-  aws_batch_job_definition:
+  community.aws.aws_batch_job_definition:
     job_definition_name: My Batch Job Definition
     state: present
     type: container

diff --git a/plugins/modules/aws_batch_job_queue.py b/plugins/modules/aws_batch_job_queue.py
@@ -12,8 +12,8 @@
 short_description: Manage AWS Batch Job Queues
 description:
     - This module allows the management of AWS Batch Job Queues.
-      It is idempotent and supports "Check" mode.  Use module M(aws_batch_compute_environment) to manage the compute
-      environment, M(aws_batch_job_queue) to manage job queues, M(aws_batch_job_definition) to manage job definitions.
+      It is idempotent and supports "Check" mode.  Use module M(community.aws.aws_batch_compute_environment) to manage the compute
+      environment, M(community.aws.aws_batch_job_queue) to manage job queues, M(community.aws.aws_batch_job_definition) to manage job definitions.
 
 
 author: Jon Meran (@jonmer85)
@@ -75,7 +75,7 @@
     state: present
   tasks:
   - name: My Batch Job Queue
-    aws_batch_job_queue:
+    community.aws.aws_batch_job_queue:
       job_queue_name: jobQueueName
       state: present
       region: us-east-1

diff --git a/plugins/modules/aws_codebuild.py b/plugins/modules/aws_codebuild.py
@@ -165,7 +165,7 @@
 EXAMPLES = '''
 # Note: These examples do not set authentication details, see the AWS Guide for details.
 
-- aws_codebuild:
+- community.aws.aws_codebuild:
     name: my_project
     description: My nice little project
     service_role: "arn:aws:iam::123123:role/service-role/code-build-service-role"

diff --git a/plugins/modules/aws_codecommit.py b/plugins/modules/aws_codecommit.py
@@ -126,12 +126,12 @@
 
 EXAMPLES = '''
 # Create a new repository
-- aws_codecommit:
+- community.aws.aws_codecommit:
     name: repo
     state: present
 
 # Delete a repository
-- aws_codecommit:
+- community.aws.aws_codecommit:
     name: repo
     state: absent
 '''

diff --git a/plugins/modules/aws_codepipeline.py b/plugins/modules/aws_codepipeline.py
@@ -82,7 +82,7 @@
 # Note: These examples do not set authentication details, see the AWS Guide for details.
 
 # Example for creating a pipeline for continuous deploy of Github code to an ECS cluster (container)
-- aws_codepipeline:
+- community.aws.aws_codepipeline:
     name: my_deploy_pipeline
     role_arn: arn:aws:iam::123456:role/AWS-CodePipeline-Service
     artifact_store:

diff --git a/plugins/modules/aws_config_aggregation_authorization.py b/plugins/modules/aws_config_aggregation_authorization.py
@@ -41,12 +41,12 @@
 
 EXAMPLES = '''
 - name: Get current account ID
-  aws_caller_info:
+  community.aws.aws_caller_info:
   register: whoami
-- aws_config_aggregation_authorization:
+- community.aws.aws_config_aggregation_authorization:
     state: present
     authorized_account_id: '{{ whoami.account }}'
-    authorzed_aws_region: us-east-1
+    authorized_aws_region: us-east-1
 '''
 
 RETURN = '''#'''

diff --git a/plugins/modules/aws_config_aggregator.py b/plugins/modules/aws_config_aggregator.py
@@ -76,7 +76,7 @@
 
 EXAMPLES = '''
 - name: Create cross-account aggregator
-  aws_config_aggregator:
+  community.aws.aws_config_aggregator:
     name: test_config_rule
     state: present
     account_sources:

diff --git a/plugins/modules/aws_config_delivery_channel.py b/plugins/modules/aws_config_delivery_channel.py
@@ -54,7 +54,7 @@
 
 EXAMPLES = '''
 - name: Create Delivery Channel for AWS Config
-  aws_config_delivery_channel:
+  community.aws.aws_config_delivery_channel:
     name: test_delivery_channel
     state: present
     s3_bucket: 'test_aws_config_bucket'

diff --git a/plugins/modules/aws_config_recorder.py b/plugins/modules/aws_config_recorder.py
@@ -67,7 +67,7 @@
 
 EXAMPLES = '''
 - name: Create Configuration Recorder for AWS Config
-  aws_config_recorder:
+  community.aws.aws_config_recorder:
     name: test_configuration_recorder
     state: present
     role_arn: 'arn:aws:iam::123456789012:role/AwsConfigRecorder'

diff --git a/plugins/modules/aws_config_rule.py b/plugins/modules/aws_config_rule.py
@@ -91,7 +91,7 @@
 
 EXAMPLES = '''
 - name: Create Config Rule for AWS Config
-  aws_config_rule:
+  community.aws.aws_config_rule:
     name: test_config_rule
     state: present
     description: 'This AWS Config rule checks for public write access on S3 buckets'

diff --git a/plugins/modules/aws_direct_connect_connection.py b/plugins/modules/aws_direct_connect_connection.py
@@ -71,7 +71,7 @@
 EXAMPLES = """
 
 # create a Direct Connect connection
-- aws_direct_connect_connection:
+- community.aws.aws_direct_connect_connection:
     name: ansible-test-connection
     state: present
     location: EqDC2
@@ -80,22 +80,22 @@
   register: dc
 
 # disassociate the LAG from the connection
-- aws_direct_connect_connection:
+- community.aws.aws_direct_connect_connection:
     state: present
     connection_id: dc.connection.connection_id
     location: EqDC2
     bandwidth: 1Gbps
 
 # replace the connection with one with more bandwidth
-- aws_direct_connect_connection:
+- community.aws.aws_direct_connect_connection:
     state: present
     name: ansible-test-connection
     location: EqDC2
     bandwidth: 10Gbps
     forced_update: True
 
 # delete the connection
-- aws_direct_connect_connection:
+- community.aws.aws_direct_connect_connection:
     state: absent
     name: ansible-test-connection
 """

diff --git a/plugins/modules/aws_direct_connect_gateway.py b/plugins/modules/aws_direct_connect_gateway.py
@@ -55,15 +55,15 @@
 
 EXAMPLES = '''
 - name: Create a new direct connect gateway attached to virtual private gateway
-  dxgw:
+  community.aws.aws_direct_connect_gateway:
     state: present
     name: my-dx-gateway
     amazon_asn: 7224
     virtual_gateway_id: vpg-12345
   register: created_dxgw
 
 - name: Create a new unattached dxgw
-  dxgw:
+  community.aws.aws_direct_connect_gateway:
     state: present
     name: my-dx-gateway
     amazon_asn: 7224

diff --git a/plugins/modules/aws_direct_connect_link_aggregation_group.py b/plugins/modules/aws_direct_connect_link_aggregation_group.py
@@ -82,7 +82,7 @@
 EXAMPLES = """
 
 # create a Direct Connect connection
-- aws_direct_connect_link_aggregation_group:
+- community.aws.aws_direct_connect_link_aggregation_group:
   state: present
   location: EqDC2
   lag_id: dxlag-xxxxxxxx

diff --git a/plugins/modules/aws_direct_connect_virtual_interface.py b/plugins/modules/aws_direct_connect_virtual_interface.py
@@ -219,14 +219,14 @@
 EXAMPLES = '''
 ---
 - name: create an association between a LAG and connection
-  aws_direct_connect_virtual_interface:
+  community.aws.aws_direct_connect_virtual_interface:
     state: present
     name: "{{ name }}"
     link_aggregation_group_id: LAG-XXXXXXXX
     connection_id: dxcon-XXXXXXXX
 
 - name: remove an association between a connection and virtual interface
-  aws_direct_connect_virtual_interface:
+  community.aws.aws_direct_connect_virtual_interface:
     state: absent
     connection_id: dxcon-XXXXXXXX
     virtual_interface_id: dxv-XXXXXXXX

diff --git a/plugins/modules/aws_eks_cluster.py b/plugins/modules/aws_eks_cluster.py
@@ -65,7 +65,7 @@
 # Note: These examples do not set authentication details, see the AWS Guide for details.
 
 - name: Create an EKS cluster
-  aws_eks_cluster:
+  community.aws.aws_eks_cluster:
     name: my_cluster
     version: 1.14
     role_arn: my_eks_role
@@ -77,7 +77,7 @@
   register: caller_facts
 
 - name: Remove an EKS cluster
-  aws_eks_cluster:
+  community.aws.aws_eks_cluster:
     name: my_cluster
     wait: yes
     state: absent

diff --git a/plugins/modules/aws_elasticbeanstalk_app.py b/plugins/modules/aws_elasticbeanstalk_app.py
@@ -48,13 +48,13 @@
 
 EXAMPLES = '''
 # Create or update an application
-- aws_elasticbeanstalk_app:
+- community.aws.aws_elasticbeanstalk_app:
     app_name: Sample_App
     description: "Hello World App"
     state: present
 
 # Delete application
-- aws_elasticbeanstalk_app:
+- community.aws.aws_elasticbeanstalk_app:
     app_name: Sample_App
     state: absent