search

ansible-collections / amazon.aws

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

[PR #2124/7c1d8aae backport][stable-7] backup_plan: modify args spec and add examples for advanced_backup_settings parameter #2128

Open patchback[bot] opened 3 weeks ago

patchback[bot] commented 3 weeks ago

This is a backport of PR #2124 as merged into main (7c1d8aae83ff40119cc61e31d1dc5c02da6ac8ce).

Fixes #2110

This PR

ISSUE TYPE
COMPONENT NAME
ADDITIONAL INFORMATION
github-actions[bot] commented 3 weeks 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/9395302931

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/backup_plan_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. ```diff diff --git a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/backup_plan_module.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/backup_plan_module.html index 4fde887..ab4b4b8 100644 --- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/backup_plan_module.html +++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/backup_plan_module.html @@ -216,14 +216,21 @@ see

Specifies the backup option for a selected resource.

This option is only available for Windows VSS backup jobs.

+
+ +
+

WindowsVSS

+

string

+
+

Enable or disable WindowsVSS backup option.

Choices:

-
+

resource_type

string

@@ -235,7 +242,7 @@ see
+

aws_ca_bundle

path

@@ -243,7 +250,7 @@ see AWS_CA_BUNDLE environment variable may also be used.

-
+

aws_config

dictionary

@@ -251,7 +258,7 @@ see https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

-
+

backup_plan_name

aliases: name

@@ -260,14 +267,14 @@ see

The display name of a backup plan. Must contain 1 to 50 alphanumeric or ‘-_.’ characters.

-
+

creator_request_id

string

Identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned.

-
+

debug_botocore_endpoint_logs

boolean

@@ -280,7 +287,7 @@ see
+
@@ -294,7 +301,7 @@ see EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

-
+

profile

aliases: aws_profile

@@ -306,7 +313,7 @@ see
+

purge_tags

boolean

@@ -320,7 +327,7 @@ see
+

region

@@ -335,7 +342,7 @@ see EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

-
+

rules

list / elements=dictionary

@@ -343,7 +350,7 @@ see
+

completion_window_minutes

integer

@@ -352,21 +359,21 @@ see Default: 10080

-
+

copy_actions

list / elements=dictionary

An array of copy_action objects, which contains the details of the copy operation.

-
+

destination_backup_vault_arn

string / required

An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup.

-
+

lifecycle

dictionary

@@ -374,21 +381,21 @@ see
+

delete_after_days

integer

Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus move_to_cold_storage_after_days.

-
+

move_to_cold_storage_after_days

integer

Specifies the number of days after creation that a recovery point is moved to cold storage.

-
+

enable_continuous_backup

boolean

@@ -401,7 +408,7 @@ see
+

lifecycle

dictionary

@@ -409,35 +416,35 @@ see
+

delete_after_days

integer

Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus move_to_cold_storage_after_days.

-
+

move_to_cold_storage_after_days

integer

Specifies the number of days after creation that a recovery point is moved to cold storage.

-
+

recovery_point_tags

dictionary

To help organize your resources, you can assign your own metadata to the resources that you create.

-
+

rule_name

string / required

Name of the rule.

-
+

schedule_expression

string

@@ -445,7 +452,7 @@ see Default: "cron(0 5 ? * * *)"

-
+

schedule_expression_timezone

string

added in amazon.aws 7.3.0

@@ -456,7 +463,7 @@ see Default: "Etc/UTC"

-
+

start_window_minutes

integer

@@ -465,14 +472,14 @@ see Default: 480

-
+

target_backup_vault_name

string / required

Name of the Backup Vault this rule should target.

-
+
@@ -489,7 +496,7 @@ see EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

-
+
@@ -507,7 +514,7 @@ see EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

-
+

state

string

@@ -519,7 +526,7 @@ see
+

tags

@@ -529,7 +536,7 @@ see

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.

-
+

validate_certs

boolean

@@ -563,6 +570,10 @@ see backup_plan_name: elastic rules: - rule_name: daily + advanced_backup_settings: + - resource_type: "EC2" + backup_options: + WindowsVSS: enabled target_backup_vault_name: "{{ backup_vault_name }}" schedule_expression: 'cron(0 5 ? * * *)' start_window_minutes: 60 ```
softwarefactory-project-zuul[bot] commented 3 weeks ago

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

:heavy_check_mark: ansible-galaxy-importer SUCCESS in 5m 42s :heavy_check_mark: build-ansible-collection SUCCESS in 17m 38s :heavy_check_mark: ansible-test-splitter SUCCESS in 7m 28s :heavy_check_mark: integration-amazon.aws-1 SUCCESS in 6m 39s Skipped 43 jobs

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