文件操作 - sqs_queue.py
返回文件管理
返回主菜单
删除本文件
文件: /usr/lib/python3.12/site-packages/ansible_collections/community/aws/plugins/modules/sqs_queue.py
编辑文件内容
# -*- coding: utf-8 -*- # Copyright: Ansible Project # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) DOCUMENTATION = r""" --- module: sqs_queue version_added: 1.0.0 short_description: Creates or deletes AWS SQS queues description: - Create or delete AWS SQS queues. - Update attributes on existing queues. author: - Alan Loi (@loia) - Fernando Jose Pando (@nand0p) - Nadir Lloret (@nadirollo) - Dennis Podkovyrin (@sbj-ss) options: state: description: - Create or delete the queue. choices: ['present', 'absent'] default: 'present' type: str name: description: - Name of the queue. required: true type: str queue_type: description: - Standard or FIFO queue. - I(queue_type) can only be set at queue creation and will otherwise be ignored. choices: ['standard', 'fifo'] default: 'standard' type: str deduplication_scope: description: - Deduplication scope for FIFO queues. - C(messageGroup) is required for high throughput FIFO. - Defaults to C(queue) on creation. choices: ['queue', 'messageGroup'] type: str version_added: 5.3.0 fifo_throughput_limit: description: - Throughput limit for FIFO queues. - C(perMessageGroupId) is required for high throughput FIFO. - Defaults to C(perQueue) on creation. choices: ['perQueue', 'perMessageGroupId'] type: str version_added: 5.3.0 visibility_timeout: description: - The default visibility timeout in seconds. aliases: [default_visibility_timeout] type: int message_retention_period: description: - The message retention period in seconds. type: int maximum_message_size: description: - The maximum message size in bytes. type: int delay_seconds: description: - The delivery delay in seconds. aliases: [delivery_delay] type: int receive_message_wait_time_seconds: description: - The receive message wait time in seconds. aliases: [receive_message_wait_time] type: int policy: description: - Policy to attach to the queue. - Policy body can be YAML or JSON. - This is required for certain use cases for example with S3 bucket notifications. type: dict redrive_policy: description: - JSON dict with the redrive_policy (see example). type: dict kms_master_key_id: description: - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. - Specifying a valid I(kms_master_key_id) will enable encryption automatically. type: str kms_data_key_reuse_period_seconds: description: - The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. aliases: [kms_data_key_reuse_period] type: int content_based_deduplication: type: bool description: - Enables content-based deduplication. Used for FIFOs only. - Defaults to C(false). extends_documentation_fragment: - amazon.aws.common.modules - amazon.aws.region.modules - amazon.aws.tags - amazon.aws.boto3 """ RETURN = r""" content_based_deduplication: description: Enables content-based deduplication. Used for FIFOs only. type: bool returned: always sample: True fifo_throughput_limit: description: Which throughput limit strategy is applied. type: str returned: always sample: perQueue deduplication_scope: description: The deduplication setting. type: str returned: always sample: messageGroup visibility_timeout: description: The default visibility timeout in seconds. type: int returned: always sample: 30 delay_seconds: description: The delivery delay in seconds. type: int returned: always sample: 0 kms_master_key_id: description: The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. type: str returned: if value exists sample: alias/MyAlias kms_data_key_reuse_period_seconds: description: The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. type: int returned: always sample: 300 maximum_message_size: description: The maximum message size in bytes. type: int returned: always sample: 262144 message_retention_period: description: The message retention period in seconds. type: int returned: always sample: 345600 name: description: Name of the SQS Queue type: str returned: always sample: "queuename-987d2de0" queue_arn: description: The queue's Amazon resource name (ARN). type: str returned: on success sample: 'arn:aws:sqs:us-east-1:123456789012:queuename-987d2de0' queue_url: description: URL to access the queue type: str returned: on success sample: 'https://queue.amazonaws.com/123456789012/MyQueue' receive_message_wait_time_seconds: description: The receive message wait time in seconds. type: int returned: always sample: 0 region: description: Region that the queue was created within type: str returned: always sample: 'us-east-1' tags: description: List of queue tags type: dict returned: always sample: '{"Env": "prod"}' """ EXAMPLES = r""" - name: Create SQS queue with redrive policy community.aws.sqs_queue: name: my-queue region: ap-southeast-2 default_visibility_timeout: 120 message_retention_period: 86400 maximum_message_size: 1024 delivery_delay: 30 receive_message_wait_time: 20 policy: "{{ json_dict }}" redrive_policy: maxReceiveCount: 5 deadLetterTargetArn: arn:aws:sqs:eu-west-1:123456789012:my-dead-queue - name: Drop redrive policy community.aws.sqs_queue: name: my-queue region: ap-southeast-2 redrive_policy: {} - name: Create FIFO queue community.aws.sqs_queue: name: fifo-queue region: ap-southeast-2 queue_type: fifo content_based_deduplication: true - name: Tag queue community.aws.sqs_queue: name: fifo-queue region: ap-southeast-2 tags: example: SomeValue - name: Configure Encryption, automatically uses a new data key every hour community.aws.sqs_queue: name: fifo-queue region: ap-southeast-2 kms_master_key_id: alias/MyQueueKey kms_data_key_reuse_period_seconds: 3600 - name: Example queue allowing s3 bucket notifications sqs_queue: name: "S3Notifications" default_visibility_timeout: 120 message_retention_period: 86400 maximum_message_size: 1024 delivery_delay: 30 receive_message_wait_time: 20 policy: Version: 2012-10-17 Id: s3-queue-policy Statement: - Sid: allowNotifications Effect: Allow Principal: Service: s3.amazonaws.com Action: - SQS:SendMessage Resource: "arn:aws:sqs:*:*:S3Notifications" Condition: ArnLike: aws:SourceArn: "arn:aws:s3:*:*:SomeBucket" - name: Delete SQS queue community.aws.sqs_queue: name: my-queue region: ap-southeast-2 state: absent """ import json try: import botocore except ImportError: pass # handled by AnsibleAWSModule from ansible.module_utils.common.dict_transformations import camel_dict_to_snake_dict from ansible.module_utils.common.dict_transformations import snake_dict_to_camel_dict from ansible_collections.amazon.aws.plugins.module_utils.botocore import is_boto3_error_code from ansible_collections.amazon.aws.plugins.module_utils.policy import compare_policies from ansible_collections.amazon.aws.plugins.module_utils.retries import AWSRetry from ansible_collections.amazon.aws.plugins.module_utils.tagging import compare_aws_tags from ansible_collections.community.aws.plugins.module_utils.modules import AnsibleCommunityAWSModule as AnsibleAWSModule def get_queue_name(module, is_fifo=False): name = module.params.get("name") if not is_fifo or name.endswith(".fifo"): return name return name + ".fifo" # NonExistentQueue is explicitly expected when a queue doesn't exist @AWSRetry.jittered_backoff() def get_queue_url(client, name): try: return client.get_queue_url(QueueName=name)["QueueUrl"] except is_boto3_error_code("AWS.SimpleQueueService.NonExistentQueue"): return None def describe_queue(client, queue_url): """ Description a queue in snake format """ attributes = client.get_queue_attributes(QueueUrl=queue_url, AttributeNames=["All"], aws_retry=True)["Attributes"] description = dict(attributes) description.pop("Policy", None) description.pop("RedrivePolicy", None) description = camel_dict_to_snake_dict(description) description["policy"] = attributes.get("Policy", None) description["redrive_policy"] = attributes.get("RedrivePolicy", None) # Boto3 returns everything as a string, convert them back to integers/dicts if # that's what we expected. for key, value in description.items(): if value is None: continue if key in ["policy", "redrive_policy"]: policy = json.loads(value) description[key] = policy continue if key == "content_based_deduplication": try: description[key] = bool(value) except (TypeError, ValueError): pass try: if value == str(int(value)): description[key] = int(value) except (TypeError, ValueError): pass return description def create_or_update_sqs_queue(client, module): is_fifo = module.params.get("queue_type") == "fifo" kms_master_key_id = module.params.get("kms_master_key_id") queue_name = get_queue_name(module, is_fifo) result = dict( name=queue_name, region=module.params.get("region"), changed=False, ) queue_url = get_queue_url(client, queue_name) result["queue_url"] = queue_url # Create a dict() to hold attributes that will be passed to boto3 create_attributes = {} if not queue_url: if is_fifo: create_attributes["FifoQueue"] = "True" if kms_master_key_id: create_attributes["KmsMasterKeyId"] = kms_master_key_id result["changed"] = True if module.check_mode: return result queue_url = client.create_queue(QueueName=queue_name, Attributes=create_attributes, aws_retry=True)["QueueUrl"] changed, arn = update_sqs_queue(module, client, queue_url) result["changed"] |= changed result["queue_arn"] = arn changed, tags = update_tags(client, queue_url, module) result["changed"] |= changed result["tags"] = tags result.update(describe_queue(client, queue_url)) COMPATABILITY_KEYS = dict( delay_seconds="delivery_delay", receive_message_wait_time_seconds="receive_message_wait_time", visibility_timeout="default_visibility_timeout", kms_data_key_reuse_period_seconds="kms_data_key_reuse_period", ) for key in list(result.keys()): # The return values changed between boto and boto3, add the old keys too # for backwards compatibility return_name = COMPATABILITY_KEYS.get(key) if return_name: result[return_name] = result.get(key) return result def update_sqs_queue(module, client, queue_url): check_mode = module.check_mode changed = False existing_attributes = client.get_queue_attributes(QueueUrl=queue_url, AttributeNames=["All"], aws_retry=True)[ "Attributes" ] new_attributes = snake_dict_to_camel_dict(module.params, capitalize_first=True) attributes_to_set = dict() # Boto3 SQS deals with policies as strings, we want to deal with them as # dicts if module.params.get("policy") is not None: policy = module.params.get("policy") current_value = existing_attributes.get("Policy", "{}") current_policy = json.loads(current_value) if compare_policies(current_policy, policy): attributes_to_set["Policy"] = json.dumps(policy) changed = True if module.params.get("redrive_policy") is not None: policy = module.params.get("redrive_policy") current_value = existing_attributes.get("RedrivePolicy", "{}") current_policy = json.loads(current_value) if compare_policies(current_policy, policy): attributes_to_set["RedrivePolicy"] = json.dumps(policy) changed = True for attribute, value in existing_attributes.items(): # We handle these as a special case because they're IAM policies if attribute in ["Policy", "RedrivePolicy"]: continue if attribute not in new_attributes.keys(): continue if new_attributes.get(attribute) is None: continue new_value = new_attributes[attribute] if isinstance(new_value, bool): new_value = str(new_value).lower() value = str(value).lower() if str(new_value) == str(value): continue # Boto3 expects strings attributes_to_set[attribute] = str(new_value) changed = True if changed and not check_mode: client.set_queue_attributes(QueueUrl=queue_url, Attributes=attributes_to_set, aws_retry=True) return changed, existing_attributes.get("queue_arn") def delete_sqs_queue(client, module): is_fifo = module.params.get("queue_type") == "fifo" queue_name = get_queue_name(module, is_fifo) result = dict(name=queue_name, region=module.params.get("region"), changed=False) queue_url = get_queue_url(client, queue_name) if not queue_url: return result result["changed"] = bool(queue_url) if not module.check_mode: AWSRetry.jittered_backoff()(client.delete_queue)(QueueUrl=queue_url) return result def update_tags(client, queue_url, module): new_tags = module.params.get("tags") purge_tags = module.params.get("purge_tags") if new_tags is None: return False, {} try: existing_tags = client.list_queue_tags(QueueUrl=queue_url, aws_retry=True)["Tags"] except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError, KeyError) as e: existing_tags = {} tags_to_add, tags_to_remove = compare_aws_tags(existing_tags, new_tags, purge_tags=purge_tags) if not module.check_mode: if tags_to_remove: client.untag_queue(QueueUrl=queue_url, TagKeys=tags_to_remove, aws_retry=True) if tags_to_add: client.tag_queue(QueueUrl=queue_url, Tags=tags_to_add) existing_tags = client.list_queue_tags(QueueUrl=queue_url, aws_retry=True).get("Tags", {}) else: existing_tags = new_tags changed = bool(tags_to_remove) or bool(tags_to_add) return changed, existing_tags def main(): argument_spec = dict( state=dict(type="str", default="present", choices=["present", "absent"]), name=dict(type="str", required=True), queue_type=dict(type="str", default="standard", choices=["standard", "fifo"]), delay_seconds=dict(type="int", aliases=["delivery_delay"]), maximum_message_size=dict(type="int"), message_retention_period=dict(type="int"), policy=dict(type="dict"), receive_message_wait_time_seconds=dict(type="int", aliases=["receive_message_wait_time"]), redrive_policy=dict(type="dict"), visibility_timeout=dict(type="int", aliases=["default_visibility_timeout"]), kms_master_key_id=dict(type="str"), fifo_throughput_limit=dict(type="str", choices=["perQueue", "perMessageGroupId"]), deduplication_scope=dict(type="str", choices=["queue", "messageGroup"]), kms_data_key_reuse_period_seconds=dict(type="int", aliases=["kms_data_key_reuse_period"], no_log=False), content_based_deduplication=dict(type="bool"), tags=dict(type="dict", aliases=["resource_tags"]), purge_tags=dict(type="bool", default=True), ) module = AnsibleAWSModule(argument_spec=argument_spec, supports_check_mode=True) state = module.params.get("state") retry_decorator = AWSRetry.jittered_backoff(catch_extra_error_codes=["AWS.SimpleQueueService.NonExistentQueue"]) try: client = module.client("sqs", retry_decorator=retry_decorator) if state == "present": result = create_or_update_sqs_queue(client, module) elif state == "absent": result = delete_sqs_queue(client, module) except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e: module.fail_json_aws(e, msg="Failed to control sqs queue") else: module.exit_json(**result) if __name__ == "__main__": main()
修改文件时间
将文件时间修改为当前时间的前一年
删除文件