community / community.aws / 5.1.0 / module / sqs_queue Creates or deletes AWS SQS queues | "added in version" 1.0.0 of community.aws" Authors: Alan Loi (@loia), Fernando Jose Pando (@nand0p), Nadir Lloret (@nadirollo), Dennis Podkovyrin (@sbj-ss)community.aws.sqs_queue (5.1.0) — module
Install with ansible-galaxy collection install community.aws:==5.1.0
collections: - name: community.aws version: 5.1.0
Create or delete AWS SQS queues.
Update attributes on existing queues.
- 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
name: description: - Name of the queue. required: true type: str tags: aliases: - resource_tags description: - A dictionary representing the tags to be applied to the resource. - If the I(tags) parameter is not set then tags will not be modified. required: false type: dict state: choices: - present - absent default: present description: - Create or delete the queue. type: str 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 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: - If I(purge_tags=true) and I(tags) is set, existing tags will be purged from the resource to match exactly what is defined by I(tags) parameter. - If the I(tags) parameter is not set then tags will not be modified, even if I(purge_tags=True). - Tag keys beginning with C(aws:) are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the I(purge_tags) parameter. See the Amazon documentation for more information U(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions). required: false type: bool queue_type: choices: - standard - fifo default: standard description: - Standard or FIFO queue. - I(queue_type) can only be set at queue creation and will otherwise be ignored. type: str 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 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 delay_seconds: aliases: - delivery_delay description: - The delivery delay in seconds. type: int 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 redrive_policy: description: - JSON dict with the redrive_policy (see example). 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 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 visibility_timeout: aliases: - default_visibility_timeout description: - The default visibility timeout in seconds. type: int maximum_message_size: description: - The maximum message size in bytes. type: int message_retention_period: description: - The message retention period in seconds. type: int content_based_deduplication: description: - Enables content-based deduplication. Used for FIFOs only. - Defaults to C(false). type: bool 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 kms_data_key_reuse_period_seconds: aliases: - kms_data_key_reuse_period 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 receive_message_wait_time_seconds: aliases: - receive_message_wait_time description: - The receive message wait time in seconds. type: int
content_based_deduplication: description: Enables content-based deduplication. Used for FIFOs only. returned: always sample: true type: bool delay_seconds: description: The delivery delay in seconds. returned: always sample: 0 type: int 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. returned: always sample: 300 type: int kms_master_key_id: description: The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. returned: if value exists sample: alias/MyAlias type: str maximum_message_size: description: The maximum message size in bytes. returned: always sample: 262144 type: int message_retention_period: description: The message retention period in seconds. returned: always sample: 345600 type: int name: description: Name of the SQS Queue returned: always sample: queuename-987d2de0 type: str queue_arn: description: The queue's Amazon resource name (ARN). returned: on success sample: arn:aws:sqs:us-east-1:123456789012:queuename-987d2de0 type: str queue_url: description: URL to access the queue returned: on success sample: https://queue.amazonaws.com/123456789012/MyQueue type: str receive_message_wait_time_seconds: description: The receive message wait time in seconds. returned: always sample: 0 type: int region: description: Region that the queue was created within returned: always sample: us-east-1 type: str tags: description: List of queue tags returned: always sample: '{"Env": "prod"}' type: dict visibility_timeout: description: The default visibility timeout in seconds. returned: always sample: 30 type: int