community / community.aws / 3.4.0 / module / cloudwatchlogs_log_group create or delete log_group in CloudWatchLogs | "added in version" 1.0.0 of community.aws" Authors: Willian Ricardo (@willricardo) <willricardo@gmail.com>community.aws.cloudwatchlogs_log_group (3.4.0) — module
Install with ansible-galaxy collection install community.aws:==3.4.0
collections: - name: community.aws version: 3.4.0
Create or delete log_group in CloudWatchLogs.
# Note: These examples do not set authentication details, see the AWS Guide for details. - community.aws.cloudwatchlogs_log_group: log_group_name: test-log-group
- community.aws.cloudwatchlogs_log_group: state: present log_group_name: test-log-group tags: { "Name": "test-log-group", "Env" : "QA" }
- community.aws.cloudwatchlogs_log_group: state: present log_group_name: test-log-group tags: { "Name": "test-log-group", "Env" : "QA" } kms_key_id: arn:aws:kms:region:account-id:key/key-id
- community.aws.cloudwatchlogs_log_group: state: absent log_group_name: test-log-group
tags: description: - The key-value pairs to use for the tags. required: false type: dict state: choices: - present - absent default: present description: - Whether the rule is present or absent. required: false 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 overwrite: default: false description: - Whether an existing log group should be overwritten on create. - Mutually exclusive with I(purge_retention_policy). required: false type: bool retention: description: - The number of days to retain the log events in the specified log group. - 'Valid values are: [1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653]' - Mutually exclusive with I(purge_retention_policy). required: false type: int 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). - Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict kms_key_id: description: - The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. required: false type: str aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Not used by boto 2 based modules. - '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 log_group_name: description: - The name of the log group. required: true type: str security_token: aliases: - 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. 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 purge_retention_policy: default: false description: - Whether to purge the retention policy or not. - Mutually exclusive with I(retention) and I(overwrite). required: false type: bool 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
log_groups: contains: arn: description: The Amazon Resource Name (ARN) of the log group. returned: always type: str creation_time: description: The creation time of the log group. returned: always type: int kms_key_id: description: The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. returned: always type: str log_group_name: description: The name of the log group. returned: always type: str metric_filter_count: description: The number of metric filters. returned: always type: int retention_in_days: description: The number of days to retain the log events in the specified log group. returned: always type: int stored_bytes: description: The number of bytes stored. returned: always type: str description: Return the list of complex objects representing log groups returned: success type: complex