Get Information about AWS Backup.
Version added: 0.0.1
- Get Information about AWS Backup.
- https://docs.aws.amazon.com/aws-backup/latest/devguide/API_Operations.html
The below requirements are needed on the host that executes this module.
- boto
- boto3
- botocore
- python >= 2.6
| 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.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aliases: ec2_access_key, access_key |
|
|
aws_ca_bundle
path
|
The location of a CA Bundle to use when validating SSL certificates.
Only used for boto3 based modules.
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.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
|
|
|
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.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aliases: ec2_secret_key, secret_key |
|
|
backup_plan_id
string
|
Id of Backup Plan.
Mutually Exclusive with list_backup_plans_include_deleted, list_backup_plan_templates.
list_backup_vaults, list_backup_jobs and list_copy_jobs
|
|
|
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.
|
|
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 |
|
|
list_backup_jobs
boolean
|
|
do you want to fetch backup jobs?
|
|
list_backup_jobs_by_account_id
string
|
fetch backup jobs by account id used in backup job.
|
|
|
list_backup_jobs_by_backup_vault_name
string
|
fetch backup jobs by backup vault name.
|
|
|
list_backup_jobs_by_resource_arn
string
|
fetch backup jobs by resource arn.
|
|
|
list_backup_jobs_by_resource_type
string
|
fetch backup jobs by resource type used in backup job.
|
|
|
list_backup_jobs_by_state
string
|
fetch backup jobs by job state.
|
|
|
list_backup_plan_templates
boolean
|
|
do you want to fetch backup plan templates?
|
|
list_backup_plan_versions
boolean
|
|
do you want to fetch backup plan versions?
|
|
list_backup_plans_include_deleted
boolean
|
|
do you want to include deleted backup plans?
|
|
list_backup_selections
boolean
|
|
do you want to fetch backup selections?
|
|
list_backup_vaults
boolean
|
|
do you want to fetch list of backup vaults?
|
|
list_copy_jobs
boolean
|
|
do you want to fetch backup copy jobs?
|
|
list_copy_jobs_by_account_id
boolean
|
|
fetch backup copy jobs by account id.
|
|
list_copy_jobs_by_destination_vault_arn
string
|
fetch backup copy jobs by destination vault arn?
|
|
|
list_copy_jobs_by_resource_arn
string
|
fetch backup copy jobs by resource arn.
|
|
|
list_copy_jobs_by_resource_type
string
|
fetch backup copy jobs by resource type.
|
|
|
list_copy_jobs_by_state
string
|
fetch backup copy jobs by state of job.
|
|
|
profile
string
|
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
aliases: aws_profile |
|
|
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 |
|
|
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.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aliases: aws_security_token, access_token |
|
|
validate_certs
boolean
|
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
Note
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URLorEC2_URL,AWS_PROFILEorAWS_DEFAULT_PROFILE,AWS_ACCESS_KEY_IDorAWS_ACCESS_KEYorEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYorAWS_SECRET_KEYorEC2_SECRET_KEY,AWS_SECURITY_TOKENorEC2_SECURITY_TOKEN,AWS_REGIONorEC2_REGION,AWS_CA_BUNDLE - Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGIONorEC2_REGIONcan be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file
- name: "get list of aws backup plans without deleted plans"
aws_backup_info:
register: __b
- name: "get list of aws backup plans with deleted plans"
aws_backup_info:
list_backup_plans_include_deleted: true
- name: "get basic details about specific backup plan"
aws_backup_info:
backup_plan_id: "{{ __b.backup_plans[0].backup_plan_id }}"
list_backup_selections: true
- name: "get list of backup plan versions about specific backup plan"
aws_backup_info:
backup_plan_id: "{{ __b.backup_plans[0].backup_plan_id }}"
list_backup_plan_versions: true
- name: "get list of backup plan templates"
aws_backup_info:
list_backup_plan_templates: true
- name: "get list of backup vaults"
aws_backup_info:
list_backup_vaults: true
- name: "get list of backup jobs for given backup vault name"
aws_backup_info:
list_backup_jobs: true
list_backup_jobs_by_backup_vault_name: 'rds-valut'
- name: "list of backup jobs for given vault name and state"
aws_backup_info:
list_backup_jobs: true
list_backup_jobs_by_backup_vault_name: 'rds-valut'
list_backup_jobs_by_state: 'COMPLETED'
- name: "list of backup copy jobs"
aws_backup_info:
list_copy_jobs: true
list_copy_jobs_by_state: 'COMPLETED'Common return values are documented here, the following are the fields unique to this module:
- Davinder Pal (@116davinder) <dpsangwal@gmail.com>