search

ansible-collections / amazon.aws

Ansible Collection for Amazon AWS
GNU General Public License v3.0
277 stars 321 forks source link

elb_* - Update RETURN block docs #2151

Open alinabuzachis opened 4 days ago

alinabuzachis commented 4 days ago
SUMMARY

elb_* - Update RETURN block docs

ISSUE TYPE
COMPONENT NAME

elb_*

ADDITIONAL INFORMATION
github-actions[bot] commented 4 days ago

Docs Build πŸ“

Thank you for contribution!✨

The docsite for this PR is available for download as an artifact from this run: https://github.com/ansible-collections/amazon.aws/actions/runs/9695722781

You can compare to the docs for the main branch here: https://ansible-collections.github.io/amazon.aws/branch/main

File changes:

  • M collections/amazon/aws/ec2_vpc_subnet_info_module.html
  • M collections/amazon/aws/elb_application_lb_info_module.html
  • M collections/amazon/aws/elb_application_lb_module.html
  • M collections/amazon/aws/elb_classic_lb_module.html
  • M collections/amazon/aws/iam_access_key_module.html
  • M collections/amazon/aws/index.html
  • M collections/index_module.html
Click to see the diff comparison. **NOTE:** only file modifications are shown here. New and deleted files are excluded. See the file list and check the published docs to see those files. **The diff output was truncated because it exceeded the maximum size.** ```diff diff --git a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/ec2_vpc_subnet_info_module.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/ec2_vpc_subnet_info_module.html index 533f9a4..e28a4ce 100644 --- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/ec2_vpc_subnet_info_module.html +++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/ec2_vpc_subnet_info_module.html @@ -24,7 +24,7 @@ - + @@ -654,7 +654,7 @@ see - +
diff --git a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/elb_application_lb_info_module.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/elb_application_lb_info_module.html index 31dd377..f18a606 100644 --- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/elb_application_lb_info_module.html +++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/elb_application_lb_info_module.html @@ -5,7 +5,7 @@ - amazon.aws.elb_application_lb_info module – Gather information about Application Load Balancers in AWS — Ansible collections documentation + amazon.aws.elb_application_lb_info module — Ansible collections documentation @@ -24,8 +24,8 @@ - - + + @@ -124,7 +124,7 @@
  • Collection Index
  • Collections in the Amazon Namespace
  • Amazon.Aws
    • -
  • amazon.aws.elb_application_lb_info module – Gather information about Application Load Balancers in AWS
    • +
  • amazon.aws.elb_application_lb_info module
  • Edit on GitHub @@ -137,656 +137,23 @@
    -
    -

    amazon.aws.elb_application_lb_info module – Gather information about Application Load Balancers in AWS

    -
    -

    Note

    -

    This module is part of the amazon.aws collection (version 9.0.0-dev0).

    -

    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 amazon.aws. -You need further requirements to be able to use this module, -see Requirements for details.

    -

    To use it in a playbook, specify: amazon.aws.elb_application_lb_info.

    -
    -

    New in amazon.aws 5.0.0

    - -
    -

    Synopsis

    -
      -

    • Gather information about Application Load Balancers in AWS.

      • -

    • This module was originally added to community.aws in release 1.0.0.

      • -
    -
    -
    -

    Requirements

    -

    The below requirements are needed on the host that executes this module.

    -
      -

    • python >= 3.6

      • -

    • boto3 >= 1.26.0

      • -

    • botocore >= 1.29.0

      • -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    Comments

    -
    -
    -
    -

    access_key

    -

    aliases: aws_access_key_id, aws_access_key, ec2_access_key

    -

    string

    -

    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 AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference.

    -

    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 EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

    -
    -

    aws_ca_bundle

    -

    path

    -

    The location of a CA Bundle to use when validating SSL certificates.

    -

    The AWS_CA_BUNDLE environment variable may also be used.

    -
    -

    aws_config

    -

    dictionary

    -

    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.

    -
    -

    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.

    -

    Choices:

    -
      -

    • false ← (default)

      • -

    • true

      • -
    -
    -
    -
    -
    -

    endpoint_url

    -

    aliases: ec2_url, aws_endpoint_url, s3_url

    -

    string

    -

    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 AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference.

    -

    The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01.

    -

    Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

    -
    -

    include_attributes

    -

    boolean

    -

    added in amazon.aws 7.0.0

    -

    Whether or not to include load balancer attributes in the response.

    -

    Choices:

    -
      -

    • false

      • -

    • true ← (default)

      • -
    -
    -

    include_listener_rules

    -

    boolean

    -

    added in amazon.aws 7.0.0

    -

    Whether or not to include load balancer listener rules in the response.

    -

    Implies include_listeners=true

    -

    Choices:

    -
      -

    • false

      • -

    • true ← (default)

      • -
    -
    -

    include_listeners

    -

    boolean

    -

    added in amazon.aws 7.0.0

    -

    Whether or not to include load balancer listeners in the response.

    -

    Choices:

    -
      -

    • false

      • -

    • true ← (default)

      • -
    -
    -

    load_balancer_arns

    -

    list / elements=string

    -

    The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.

    -
    -

    names

    -

    list / elements=string

    -

    The names of the load balancers.

    -
    -
    -

    profile

    -

    aliases: aws_profile

    -

    string

    -

    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 AWS_PROFILE environment variable may also be used.

    -

    The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

    -
    -
    -
    -

    region

    -

    aliases: aws_region, ec2_region

    -

    string

    -

    The AWS region to use.

    -

    For global services such as IAM, Route53 and CloudFront, region is ignored.

    -

    The AWS_REGION or EC2_REGION environment variables may also be used.

    -

    See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

    -

    The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01

    -

    Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

    -
    -
    -
    -
    -

    secret_key

    -

    aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

    -

    string

    -

    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 AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference.

    -

    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 EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

    -
    -
    -
    -
    -
    -

    session_token

    -

    aliases: aws_session_token, security_token, aws_security_token, access_token

    -

    string

    -

    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 AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference.

    -

    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 EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

    -
    -

    validate_certs

    -

    boolean

    -

    When set to false, SSL certificates will not be validated for communication with the AWS APIs.

    -

    Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead.

    -

    Choices:

    -
      -

    • false

      • -

    • true ← (default)

      • -
    -
    -
    -
    -

    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.
-
-- name: Gather information about all ALBs
-  amazon.aws.elb_application_lb_info:
-
-# Equivalent to aws elbv2 describe-load-balancers
-- name: Gather minimal information about all ALBs
-  amazon.aws.elb_application_lb_info:
-    include_attributes: false
-    include_listeners: false
-    include_listener_rules: false
-
-- name: Gather information about a particular ALB given its ARN
-  amazon.aws.elb_application_lb_info:
-    load_balancer_arns:
-      - "arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:loadbalancer/app/my-alb/aabbccddeeff"
-
-- name: Gather information about ALBs named 'alb1' and 'alb2'
-  amazon.aws.elb_application_lb_info:
-    names:
-      - alb1
-      - alb2
-
-- name: Gather information about specific ALB
-  amazon.aws.elb_application_lb_info:
-    names: "alb-name"
-    region: "aws-region"
-  register: alb_info
-- ansible.builtin.debug:
-    var: alb_info
+  
    
+
    amazon.aws.elb_application_lb_info module
    
+
    The documentation for the module plugin, amazon.aws.elb_application_lb_info,  was malformed.
    
+
    The errors were:
    
+
      
+
    • Missing documentation or could not parse documentation: amazon.aws.elb_application_lb_info did not contain a DOCUMENTATION attribute (/home/runner/work/amazon.aws/amazon.aws/ansible_collections/amazon/aws/plugins/modules/elb_application_lb_info.py). Unable to parse documentation in python file '/home/runner/work/amazon.aws/amazon.aws/ansible_collections/amazon/aws/plugins/modules/elb_application_lb_info.py': while scanning a simple key
+  in "<unicode string>", line 116, column 29
+could not find expected ':'
+  in "<unicode string>", line 117, column 25. while scanning a simple key
+  in "<unicode string>", line 116, column 29
+could not find expected ':'
+  in "<unicode string>", line 117, column 25
 
      
 
      
-
    
-
    
-
    Return Values
    
-
    Common return values are documented here, the following are the fields unique to this module:
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Key
    Description
    
-
    load_balancers
    
-
    complex
    
-
    A list of load balancers.
    
-
    Returned: always
    
-
    
-
    access_logs_s3_bucket
    
-
    string
    
-
    The name of the S3 bucket for the access logs.
    
-
    Returned: when include_attributes=true
    
-
    Sample: "mys3bucket"
    
-
    
-
    access_logs_s3_enabled
    
-
    boolean
    
-
    Indicates whether access logs stored in Amazon S3 are enabled.
    
-
    Returned: when include_attributes=true
    
-
    Sample: true
    
-
    
-
    access_logs_s3_prefix
    
-
    string
    
-
    The prefix for the location in the S3 bucket.
    
-
    Returned: when include_attributes=true
    
-
    Sample: "my/logs"
    
-
    
-
    availability_zones
    
-
    list / elements=string
    
-
    The Availability Zones for the load balancer.
    
-
    Returned: success
    
-
    Sample: [{"load_balancer_addresses": [], "subnet_id": "subnet-aabbccddff", "zone_name": "ap-southeast-2a"}]
    
-
    
-
    canonical_hosted_zone_id
    
-
    string
    
-
    The ID of the Amazon Route 53 hosted zone associated with the load balancer.
    
-
    Returned: success
    
-
    Sample: "ABCDEF12345678"
    
-
    
-
    created_time
    
-
    string
    
-
    The date and time the load balancer was created.
    
-
    Returned: success
    
-
    Sample: "2015-02-12T02:14:02+00:00"
    
-
    
-
    deletion_protection_enabled
    
-
    boolean
    
-
    Indicates whether deletion protection is enabled.
    
-
    Returned: when include_attributes=true
    
-
    Sample: true
    
-
    
-
    dns_name
    
-
    string
    
-
    The public DNS name of the load balancer.
    
-
    Returned: success
    
-
    Sample: "internal-my-alb-123456789.ap-southeast-2.elb.amazonaws.com"
    
-
    
-
    idle_timeout_timeout_seconds
    
-
    integer
    
-
    The idle timeout value, in seconds.
    
-
    Returned: when include_attributes=true
    
-
    Sample: 60
    
-
    
-
    ip_address_type
    
-
    string
    
-
    The type of IP addresses used by the subnets for the load balancer.
    
-
    Returned: success
    
-
    Sample: "ipv4"
    
-
    
-
    listeners
    
-
    complex
    
-
    Information about the listeners.
    
-
    Returned: when include_listeners=true or include_listener_rules=true
    
-
    
-
    certificates
    
-
    complex
    
-
    The SSL server certificate.
    
-
    Returned: success
    
-
    
-
    certificate_arn
    
-
    string
    
-
    The Amazon Resource Name (ARN) of the certificate.
    
-
    Returned: success
    
-
    Sample: ""
    
-
    
-
    default_actions
    
-
    string
    
-
    The default actions for the listener.
    
-
    Returned: success
    
-
    
-
    target_group_arn
    
-
    string
    
-
    The Amazon Resource Name (ARN) of the target group.
    
-
    Returned: success
    
-
    Sample: ""
    
-
    
-
    
            
    
                softwarefactory-project-zuul[bot]
                commented
                 4 days ago            
    
            
    
                
    Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/86c8025b264e412aa20d368fae0bdd4f
    

    :x: ansible-galaxy-importer  FAILURE in 4m 42s
:heavy_check_mark: build-ansible-collection  SUCCESS in 12m 29s
:heavy_check_mark: ansible-test-splitter  SUCCESS in 4m 56s
:heavy_check_mark: integration-amazon.aws-1  SUCCESS in 22m 48s
:heavy_check_mark: integration-amazon.aws-2  SUCCESS in 8m 46s
Skipped 42 jobs
                
    
        
    
    
    
    
            
    

    
    
        
      
            
    • Β©  Githubissues.
      • 
            
    • Githubissues is a development platform for aggregating issues.
      •