amazon / amazon.cloud / 0.4.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.4.0) — module
Install with ansible-galaxy collection install amazon.cloud:==0.4.0
collections: - name: amazon.cloud version: 0.4.0
Creates and manages report plans.
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). type: dict wait: default: false description: - Wait for operation to complete before returning. type: bool force: default: false description: - Cancel IN_PROGRESS and PENDING resource requestes. - Because you can only perform a single operation on a given resource at a time, there might be cases where you need to cancel the current resource operation to make the resource available so that another operation may be performed on it. 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. - For global services such as IAM, Route53 and CloudFront, I(region) is ignored. - The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used. - See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region). - The C(ec2_region) alias has been deprecated and will be removed in a release after 2024-12-01 - Support for the C(EC2_REGION) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str profile: aliases: - aws_profile description: - A named AWS profile to use for authentication. - See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html). - The C(AWS_PROFILE) environment variable may also be used. - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key) and I(security_token) options. type: str access_key: aliases: - aws_access_key_id - aws_access_key - ec2_access_key description: - AWS access key ID. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables may also be used in decreasing order of preference. - The I(aws_access_key) and I(profile) options are mutually exclusive. - The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_access_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found in the AWS documentation 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). type: bool secret_key: aliases: - aws_secret_access_key - aws_secret_key - ec2_secret_key description: - AWS secret access key. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variables may also be used in decreasing order of preference. - The I(secret_key) and I(profile) options are mutually exclusive. - The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_secret_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str endpoint_url: aliases: - ec2_url - aws_endpoint_url - s3_url description: - 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 C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing order of preference. - The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_URL) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str 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. - The C(AWS_CA_BUNDLE) environment variable may also be used. type: path session_token: aliases: - aws_session_token - security_token - aws_security_token - access_token description: - AWS STS session token for use with temporary credentials. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variables may also be used in decreasing order of preference. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with the parameter being renamed from I(security_token) to I(session_token) in release 6.0.0. - The I(security_token), I(aws_security_token), and I(access_token) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables has been deprecated and will be removed in a release after 2024-12-01. type: str report_setting: description: - Identifies the report template for the report. - Reports are built using a report template. suboptions: accounts: description: - The list of AWS accounts that a report covers. elements: str type: list framework_arns: description: - The Amazon Resource Names (ARNs) of the frameworks a report covers. elements: str type: list organization_units: description: - The list of AWS organization units that a report covers. elements: str type: list regions: description: - The list of AWS regions that 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).' type: str type: dict validate_certs: default: true description: - When set to C(false), SSL certificates will not be validated for communication with the AWS APIs. - Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider setting I(aws_ca_bundle) instead. 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. 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. 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: false description: - Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action") API calls made during a task, outputing the set to the resource_actions key in the task results. Use the C(aws_resource_action) callback to output to total list made during a playbook. - The C(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: - When I(state=list), it is a list containing dictionaries of resource information. - Otherwise, it is a dictionary of resource information. - When I(state=absent), it is an empty dictionary. returned: always type: complex