amazon / amazon.cloud / 0.1.0 / module / backup_report_plan Create and manage report plans | "added in version" 0.1.0 of amazon.cloud" Authors: Ansible Cloud Team (@ansible-collections)amazon.cloud.backup_report_plan (0.1.0) — module
Install with ansible-galaxy collection install amazon.cloud:==0.1.0
collections: - name: amazon.cloud version: 0.1.0
Creates and manages report plans (list, create, update, describe, delete).
tags: aliases: - resource_tags description: - A dict of tags to apply to the resource. - To remove all tags set I(tags={}) and I(purge_tags=true). required: false type: dict wait: default: false description: - Wait for operation to complete before returning. type: bool state: choices: - present - absent - list - describe - get default: present description: - Goal state for resource. - I(state=present) creates the resource if it doesn't exist, or updates to the provided state if the resource already exists. - I(state=absent) ensures an existing instance is deleted. - I(state=list) get all the existing resources. - I(state=describe) or I(state=get) retrieves information on an existing resource. type: str region: aliases: - aws_region - ec2_region description: - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - 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. type: str profile: aliases: - aws_profile description: - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). type: dict purge_tags: default: true description: - Remove tags not listed in I(tags). required: false type: bool wait_timeout: default: 320 description: - How many seconds to wait for an operation to complete before timing out. type: int aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str report_setting: description: - Identifies the report template for the report. - Reports are built using a report template. required: true suboptions: framework_arns: description: - The Amazon Resource Names (ARNs) of the frameworks a report covers. elements: str type: list report_template: description: - Identifies the report template for the report. - Reports are built using a report template. - 'The report templates are: `C(BACKUP_JOB_REPORT) | C(COPY_JOB_REPORT) | C(RESTORE_JOB_REPORT)`' required: true type: str type: dict security_token: aliases: - aws_session_token - session_token - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. - Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool report_plan_arn: description: - An Amazon Resource Name (ARN) that uniquely identifies a resource. - The format of the ARN depends on the resource type. type: str report_plan_name: description: - The unique name of the report plan. - The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_). type: str report_plan_tags: description: - A key-value pair to associate with a resource. elements: dict suboptions: key: description: - The key name of the tag. - You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. - 'You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' type: str value: description: - The value for the tag. - You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. - 'You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' type: str type: list report_delivery_channel: description: - A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports. required: true suboptions: formats: description: - 'A list of the format of your reports: CSV, JSON, or both.' - If not specified, the default format is CSV. elements: str type: list s3_bucket_name: description: - The unique name of the S3 bucket that receives your reports. required: true type: str s3_key_prefix: description: - 'The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name.' - If not specified, there is no prefix. type: str type: dict report_plan_description: description: - An optional description of the report plan with a maximum of 1,024 characters. type: str debug_botocore_endpoint_logs: default: 'no' description: - 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. type: bool
result: contains: identifier: description: The unique identifier of the resource. type: str properties: description: The resource properties. type: dict description: Dictionary containing resource information. returned: always type: complex