Refactor rds snapshot modules

[hakbailey]

SUMMARY

Move shared functionality from rds snapshot modules into rds module_utils. Second PR for https://github.com/ansible-collections/amazon.aws/issues/2003 / https://issues.redhat.com/browse/ACA-1343.

COMPONENT NAME

rds_cluster_snapshot rds_instance_snapshot rds_instance rds_snapshot_info module_utils/rds.py

ADDITIONAL INFORMATION

Detailed summary of all the changes:

module_utils/rds.py:

• Add describe_db_cluster_snapshots() function
• Add get_snapshot() function to retrieve a single db instance or cluster snapshot using internal describe_db_snapshots() and describe_db_cluster_snapshots()
• Add format_rds_client_method_parameters() to validate and format parameters for boto3 rds client methods
• Update internal collection imports to use full collection path
• Add unit tests for new functions

rds_instance module:

• Replace get_final_snapshot() function with calls to get_snapshot() from module_utils/rds.py
• Replace parameter formatting logic in get_parameters() with call to format_rds_client_method_parameters() from module_utils/rds.py
• Remove unit tests for deleted get_final_snapshot() function

rds_instance_snapshot module:

• Replace get_snapshot() function with calls to get_snapshot() from module_utils/rds.py
• Replace get_parameters() function with call to format_rds_client_method_parameters() from module_utils/rds.py
• Remove global variables
• Add type hinting to all functions

rds_cluster_snapshot module:

• Replace get_parameters() function with call to format_rds_client_method_parameters() from module_utils/rds.py
• Remove global variables
• Add type hinting to all functions

rds_snapshot_info module:

• Refactor internal common_snapshot_info() function to use describe_db_snapshots() and describe_db_cluster_snapshots() functions from module_utils/rds.py
• Rename some variables to ensure consistent variable naming
• Add type hinting to all functions

[softwarefactory-project-zuul[bot]]

Build succeeded. https://ansible.softwarefactory-project.io/zuul/buildset/80df7d489eb94bff9090adde101fcb7b

:heavy_check_mark: ansible-galaxy-importer SUCCESS in 3m 22s :heavy_check_mark: build-ansible-collection SUCCESS in 12m 44s :heavy_check_mark: ansible-test-splitter SUCCESS in 5m 29s :heavy_check_mark: integration-amazon.aws-1 SUCCESS in 11m 42s :heavy_check_mark: integration-amazon.aws-2 SUCCESS in 29m 50s :heavy_check_mark: integration-amazon.aws-3 SUCCESS in 31m 07s :heavy_check_mark: integration-amazon.aws-4 SUCCESS in 35m 13s :heavy_check_mark: integration-amazon.aws-5 SUCCESS in 24m 12s :heavy_check_mark: integration-amazon.aws-6 SUCCESS in 20m 27s :heavy_check_mark: integration-amazon.aws-7 SUCCESS in 20m 47s :heavy_check_mark: integration-amazon.aws-8 SUCCESS in 7m 23s :heavy_check_mark: integration-amazon.aws-9 SUCCESS in 8m 03s :heavy_check_mark: integration-amazon.aws-10 SUCCESS in 11m 09s :heavy_check_mark: integration-amazon.aws-11 SUCCESS in 16m 56s :heavy_check_mark: integration-amazon.aws-12 SUCCESS in 7m 38s :heavy_check_mark: integration-amazon.aws-13 SUCCESS in 11m 07s :heavy_check_mark: integration-amazon.aws-14 SUCCESS in 22m 18s :heavy_check_mark: integration-amazon.aws-15 SUCCESS in 21m 11s :heavy_check_mark: integration-amazon.aws-16 SUCCESS in 16m 27s :heavy_check_mark: integration-amazon.aws-17 SUCCESS in 23m 26s :heavy_check_mark: integration-amazon.aws-18 SUCCESS in 10m 50s :heavy_check_mark: integration-amazon.aws-19 SUCCESS in 16m 00s Skipped 25 jobs

[github-actions[bot]]

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/9702103281

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/autoscaling_group_info_module.html
• M collections/amazon/aws/aws_region_info_module.html
• M collections/amazon/aws/cloudformation_module.html
• M collections/amazon/aws/docsite/CHANGELOG.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/iam_group_module.html
• M collections/amazon/aws/iam_instance_profile_info_module.html
• M collections/amazon/aws/iam_instance_profile_module.html
• M collections/amazon/aws/iam_managed_policy_module.html
• M collections/amazon/aws/iam_mfa_device_info_module.html
• M collections/amazon/aws/iam_password_policy_module.html
• M collections/amazon/aws/iam_policy_info_module.html
• M collections/amazon/aws/iam_policy_module.html
• M collections/amazon/aws/iam_role_info_module.html
• M collections/amazon/aws/iam_role_module.html
• M collections/amazon/aws/iam_user_info_module.html
• M collections/amazon/aws/iam_user_module.html
• M collections/amazon/aws/index.html
• M collections/amazon/aws/kms_key_info_module.html
• M collections/amazon/aws/kms_key_module.html
• M collections/amazon/aws/lambda_alias_module.html
• M collections/amazon/aws/lambda_event_module.html
• M collections/amazon/aws/lambda_execute_module.html
• M collections/amazon/aws/lambda_info_module.html
• M collections/amazon/aws/lambda_layer_info_module.html
• M collections/amazon/aws/lambda_layer_module.html
• M collections/amazon/aws/lambda_module.html
• M collections/amazon/aws/lambda_policy_module.html
• M collections/amazon/aws/rds_cluster_module.html
• M collections/amazon/aws/rds_cluster_param_group_info_module.html
• M collections/amazon/aws/rds_cluster_param_group_module.html
• M collections/amazon/aws/rds_cluster_snapshot_module.html
• M collections/amazon/aws/rds_engine_versions_info_module.html
• M collections/amazon/aws/rds_global_cluster_info_module.html
• M collections/amazon/aws/rds_instance_info_module.html
• M collections/amazon/aws/rds_instance_module.html
• M collections/amazon/aws/rds_instance_param_group_module.html
• M collections/amazon/aws/rds_instance_snapshot_module.html
• M collections/amazon/aws/rds_option_group_info_module.html
• M collections/amazon/aws/rds_option_group_module.html
• M collections/amazon/aws/rds_snapshot_info_module.html
• M collections/amazon/aws/rds_subnet_group_module.html
• M collections/amazon/aws/route53_health_check_module.html
• M collections/amazon/aws/route53_info_module.html
• M collections/amazon/aws/route53_module.html
• M collections/amazon/aws/route53_zone_module.html
• M collections/amazon/aws/s3_bucket_info_module.html
• M collections/amazon/aws/s3_bucket_module.html
• M collections/amazon/aws/s3_object_info_module.html
• M collections/amazon/aws/s3_object_module.html
• M collections/amazon/aws/sts_assume_role_module.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/autoscaling_group_info_module.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/autoscaling_group_info_module.html index 723c444..02cf4d0 100644 --- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/autoscaling_group_info_module.html +++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/autoscaling_group_info_module.html @@ -402,201 +402,388 @@ see

-

auto_scaling_group_arn

-

string

+

results

+

list / elements=dictionary

-

The Amazon Resource Name of the ASG

-

Returned: success

-

Sample: "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:10787c52-0bcb-427d-82ba-c8e4b008ed2e:autoScalingGroupName/public-webapp-production-1"

+

A list of Auto Scaling Groups.

+

Returned: always

-

-

auto_scaling_group_name

-

string

+

+

auto_scaling_group_arn

+

string

-

Name of autoscaling group

+

The Amazon Resource Name of the ASG.

+

Returned: success

+

Sample: "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:10787c52-0bcb-427d-82ba-c8e4b008ed2e:autoScalingGroupName/dev11"

+

+ +

+

auto_scaling_group_name

+

string

+

+

Name of autoscaling group.

Returned: success

Sample: "public-webapp-production-1"

-

-

availability_zones

-

list / elements=string

+

+

availability_zones

+

list / elements=string

-

List of Availability Zones that are enabled for this ASG.

+

List of Availability Zones that are enabled for this ASG.

Returned: success

Sample: ["us-west-2a", "us-west-2b", "us-west-2a"]

-

-

created_time

-

string

+

+

created_time

+

string

-

The date and time this ASG was created, in ISO 8601 format.

+

The date and time this ASG was created, in ISO 8601 format.

Returned: success

Sample: "2015-11-25T00:05:36.309Z"

-

-

default_cooldown

-

integer

+

+

default_cooldown

+

integer

-

The default cooldown time in seconds.

+

The default cooldown time in seconds.

Returned: success

Sample: 300

-

-

desired_capacity

-

integer

+

+

desired_capacity

+

integer

-

The number of EC2 instances that should be running in this group.

+

The number of EC2 instances that should be running in this group.

Returned: success

Sample: 3

-

-

health_check_period

-

integer

+

+

enabled_metrics

+

list / elements=dictionary

-

Length of time in seconds after a new EC2 instance comes into service that Auto Scaling starts checking its health.

+

The metrics enabled for the group.

Returned: success

-

Sample: 30

+

Sample: [{"granularity": "1Minute", "metric": "GroupAndWarmPoolTotalCapacity"}]

-

-

health_check_type

-

string

+

+

granularity

+

string

-

The service you want the health status from, one of “EC2” or “ELB”.

+

The granularity of the metric. The only valid value is 1Minute.

+

Returned: success

+

Sample: "1Minute"

+

+ +

+

metric

+

string

+

+

Name of the metric.

+

Returned: success

+

Sample: "GroupAndWarmPoolTotalCapacity"

+

+ +

+

health_check_grace_period

+

integer

+

+

Length of time in seconds after a new EC2 instance comes into service that Auto Scaling starts checking its health.

+

Returned: success

+

Sample: 300

+

+ +

+

health_check_type

+

string

+

+

The service you want the health status from, one of “EC2” or “ELB”.

Returned: success

Sample: "ELB"

-

-

instances

-

list / elements=string

+

+

instances

+

list / elements=dictionary

-

List of EC2 instances and their status as it relates to the ASG.

+

List of EC2 instances associated with ASG and their status.

Returned: success

-

Sample: [{"availability_zone": "us-west-2a", "health_status": "Healthy", "instance_id": "i-es22ad25", "launch_configuration_name": "public-webapp-production-1", "lifecycle_state": "InService", "protected_from_scale_in": "false"}]

+

Sample: [{"availability_zone": "us-west-2a", "health_status": "Healthy", "instance_id": "i-es22ad25", "launch_configuration_name": "public-webapp-production-1", "launch_template": {"launch_template_id": "lt-0b19eb00123456789", "launch_template_name": "test-template", "version": "1"}, "lifecycle_state": "InService", "protected_from_scale_in": "false"}]

-

-

launch_config_name

-

string

+

+

availability_zone

+

string

-

Name of launch configuration associated with the ASG. Same as launch_configuration_name, provided for compatibility with amazon.aws.autoscaling_group module.

+

The Availability Zone of the instance.

+

Returned: success

+

Sample: "ap-southeast-2a"

+

+ +

+

health_status

+

string

+

+

The last reported health status of the instance.

+

Returned: success

+

Sample: "Healthy"

+

+ +

+

instance_id

+

string

+

+

The ID of the instance.

+

Returned: success

+

Sample: "i-012345678"

+

+ +

+

instance_type

+

string

+

+

The instance type size of the running instance.

+

Returned: success

+

Sample: "t2.micro"

+

+ +

+

launch_template

+

dictionary

+

+

The EC2 launch template to base instance configuration on.

+

Returned: success

+

+ +

+

launch_template_id

+

string

+

+

The ID of the launch template.

+

Returned: success

+

+ +

+

launch_template_name

+

string

+

+

The name of the launch template.

+

Returned: success

+

+ +

+

version

+

integer

+

+

The specific version of the launch template to use.

+

Returned: success

+

+ +

+

lifecycle_state

+

string

+

+

A description of the current lifecycle state.

+

Returned: success

+

+ +

+

protected_from_scale_in

+

boolean

+

+

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

+

Returned: success

+

+ +

+

launch_config_name

+

string

+

+

Name of launch configuration associated with the ASG. Same as launch_configuration_name, provided for compatibility with amazon.aws.autoscaling_group module.

Returned: success

Sample: "public-webapp-production-1"

-

-

launch_configuration_name

-

string

+

+

launch_configuration_name

+

string

-

Name of launch configuration associated with the ASG.

+

Name of launch configuration associated with the ASG.

Returned: success

Sample: "public-webapp-production-1"

-

-

lifecycle_hooks

-

list / elements=string

+

+

lifecycle_hooks

+

list / elements=string

-

List of lifecycle hooks for the ASG.

+

List of lifecycle hooks for the ASG.

Returned: success

Sample: [{"AutoScalingGroupName": "public-webapp-production-1", "DefaultResult": "ABANDON", "GlobalTimeout": 172800, "HeartbeatTimeout": 3600, "LifecycleHookName": "instance-launch", "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING"}, {"AutoScalingGroupName": "public-webapp-production-1", "DefaultResult": "ABANDON", "GlobalTimeout": 172800, "HeartbeatTimeout": 3600, "LifecycleHookName": "instance-terminate", "LifecycleTransition": "autoscaling:EC2_INSTANCE_TERMINATING"}]

-

-

load_balancer_names

-

list / elements=string

+

+

load_balancer_names

+

list / elements=string

-

List of load balancers names attached to the ASG.

+

List of load balancers names attached to the ASG.

Returned: success

Sample: ["elb-webapp-prod"]

-

-

max_size

-

integer

+

+

max_size

+

integer

-

Maximum size of group

+

Maximum size of group.

Returned: success

Sample: 3

-

-

min_size

-

integer

+

+

min_size

+

integer

-

Minimum size of group

+

Minimum size of group.

Returned: success

Sample: 1

-

-

new_instances_protected_from_scale_in

-

boolean

+

+

new_instances_protected_from_scale_in

+

boolean

-

Whether or not new instances a protected from automatic scaling in.

+

Whether or not new instances a protected from automatic scaling in.

Returned: success

Sample: false

-

-

placement_group

-

string

+

+

placement_group

+

string

-

Placement group into which instances are launched, if any.

+

Placement group into which instances are launched, if any.

Returned: success

Sample: "None"

-

-

status

-

string

+

+

service_linked_role_arn

+

string

-

The current state of the group when DeleteAutoScalingGroup is in progress.

+

The ARN of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf.

+

Returned: success

+

Sample: "arn:aws:iam::721234567890:role/aws-service-role/autoscaling.amazonaws.com/AWSServiceRoleForAutoScaling"

+

+ +

+

status

+

string

+

+

The current state of the group when DeleteAutoScalingGroup is in progress.

Returned: success

Sample: "None"

-

-

tags

-

list / elements=string

+

+

suspended_processes

+

list / elements=dictionary

-

List of tags for the ASG, and whether or not each tag propagates to instances at launch.

+

The suspended processes associated with the group.

+

Returned: success

+

Sample: [{"process_name": "AddToLoadBalancer", "suspension_reason": "User suspended at 2018-08-30T14:11:58Z"}]

+

+ +

+

process_name

+

string

+

+

The name of the suspended process.

+

Returned: success

+

+ +

+

suspension_reason

+

string

+

+

The reason that the process was suspended.

+

Returned: success

+

+ +

+

tags

+

list / elements=string

+

+

List of tags for the ASG, and whether or not each tag propagates to instances at launch.

Returned: success

Sample: [{"key": "Name", "propagate_at_launch": "true", "resource_id": "public-webapp-production-1", "resource_type": "auto-scaling-group", "value": "public-webapp-production-1"}, {"key": "env", "propagate_at_launch": "true", "resource_id": "public-webapp-production-1", "resource_type": "auto-scaling-group", "value": "production"}]

-

-

target_group_arns

-

list / elements=string

+

+

target_group_arns

+

list / elements=string

-

List of ARNs of the target groups that the ASG populates

+

List of ARNs of the target groups that the ASG populates.

Returned: success

Sample: ["arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:targetgroup/target-group-host-hello/1a2b3c4d5e6f1a2b", "arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:targetgroup/target-group-path-world/abcd1234abcd1234"]

-

-

softwarefactory-project-zuul[bot] commented 3 days ago

Build failed. https://ansible.softwarefactory-project.io/zuul/buildset/00442f3a5c7848e9b2c75ca8f985c5af

:heavy_check_mark: ansible-galaxy-importer SUCCESS in 4m 57s :heavy_check_mark: build-ansible-collection SUCCESS in 12m 34s :heavy_check_mark: ansible-test-splitter SUCCESS in 5m 01s :heavy_check_mark: integration-amazon.aws-1 SUCCESS in 21m 43s :heavy_check_mark: integration-amazon.aws-2 SUCCESS in 27m 33s :heavy_check_mark: integration-amazon.aws-3 SUCCESS in 36m 41s :heavy_check_mark: integration-amazon.aws-4 SUCCESS in 35m 20s :heavy_check_mark: integration-amazon.aws-5 SUCCESS in 39m 28s :heavy_check_mark: integration-amazon.aws-6 SUCCESS in 22m 14s :heavy_check_mark: integration-amazon.aws-7 SUCCESS in 29m 29s :heavy_check_mark: integration-amazon.aws-8 SUCCESS in 26m 31s :heavy_check_mark: integration-amazon.aws-9 SUCCESS in 35m 15s :heavy_check_mark: integration-amazon.aws-10 SUCCESS in 46m 45s :heavy_check_mark: integration-amazon.aws-11 SUCCESS in 41m 40s :heavy_check_mark: integration-amazon.aws-12 SUCCESS in 29m 22s :heavy_check_mark: integration-amazon.aws-13 SUCCESS in 14m 21s :heavy_check_mark: integration-amazon.aws-14 SUCCESS in 23m 31s :x: integration-amazon.aws-15 FAILURE in 38m 20s :heavy_check_mark: integration-amazon.aws-16 SUCCESS in 37m 11s :heavy_check_mark: integration-amazon.aws-17 SUCCESS in 41m 44s :heavy_check_mark: integration-amazon.aws-18 SUCCESS in 26m 58s :heavy_check_mark: integration-amazon.aws-19 SUCCESS in 28m 20s :heavy_check_mark: integration-amazon.aws-20 SUCCESS in 24m 20s :heavy_check_mark: integration-amazon.aws-21 SUCCESS in 32m 06s :heavy_check_mark: integration-amazon.aws-22 SUCCESS in 21m 16s :heavy_check_mark: integration-community.aws-1 SUCCESS in 25m 45s :heavy_check_mark: integration-community.aws-2 SUCCESS in 17m 14s :heavy_check_mark: integration-community.aws-3 SUCCESS in 26m 06s :heavy_check_mark: integration-community.aws-4 SUCCESS in 15m 11s :heavy_check_mark: integration-community.aws-5 SUCCESS in 22m 12s :heavy_check_mark: integration-community.aws-6 SUCCESS in 15m 32s :heavy_check_mark: integration-community.aws-7 SUCCESS in 18m 03s :heavy_check_mark: integration-community.aws-8 SUCCESS in 8m 07s :heavy_check_mark: integration-community.aws-9 SUCCESS in 8m 47s :heavy_check_mark: integration-community.aws-10 SUCCESS in 9m 42s :x: integration-community.aws-11 FAILURE in 42m 28s :heavy_check_mark: integration-community.aws-12 SUCCESS in 7m 28s :heavy_check_mark: integration-community.aws-13 SUCCESS in 7m 26s :heavy_check_mark: integration-community.aws-14 SUCCESS in 11m 18s :heavy_check_mark: integration-community.aws-15 SUCCESS in 10m 08s :heavy_check_mark: integration-community.aws-16 SUCCESS in 8m 11s Skipped 6 jobs

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