> ## Documentation Index
> Fetch the complete documentation index at: https://cloudanix.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# PubSub Subscriptions Should Have Dead Letter Queue Topic Set For Failed Messages

### More Info:

Ensure that PubSub Subscriptions have set DLQ topic.

### Risk Level

Low

### Address

Reliability, Operational Maturity

### Compliance Standards

CBP

### Triage and Remediation

<Tabs>
  <Tab title="Remediation">
    ### Remediation

    <AccordionGroup>
      <Accordion title="Using Console" defaultOpen="true">
        Sure, here are the steps to remediate the misconfiguration "PubSub Subscriptions Should Have Dead Letter Queue Topic Set For Failed Messages" in GCP using GCP console:

        1. Open the Google Cloud Console and select the project that contains the Pub/Sub subscription that needs to be remediated.

        2. In the left-hand navigation menu, select "Pub/Sub" and then select "Subscriptions".

        3. Find the subscription that needs to be remediated and click on its name to open its details page.

        4. Scroll down to the "Dead-letter topic" section and click on the "Edit" button.

        5. In the "Edit dead-letter topic" dialog box, select the topic that will be used as the dead-letter queue for failed messages.

        6. Click on the "Save" button to confirm the changes.

        7. Verify that the dead-letter topic has been set correctly by checking the subscription details page.

        Congratulations, you have successfully remediated the misconfiguration "PubSub Subscriptions Should Have Dead Letter Queue Topic Set For Failed Messages" in GCP using GCP console.

        #
      </Accordion>

      <Accordion title="Using CLI">
        To remediate this misconfiguration for GCP using GCP CLI, follow these steps:

        1. Open the Cloud Shell in the GCP Console.

        2. Run the following command to set up a dead letter topic:

        ```
        gcloud pubsub topics create [DEAD_LETTER_TOPIC_NAME]
        ```

        Replace `[DEAD_LETTER_TOPIC_NAME]` with a name for your dead letter topic.

        3. Run the following command to create a subscription with a dead letter topic:

        ```
        gcloud pubsub subscriptions create [SUBSCRIPTION_NAME] --topic [TOPIC_NAME] --dead-letter-topic [DEAD_LETTER_TOPIC_NAME]
        ```

        Replace `[SUBSCRIPTION_NAME]` with the name of your subscription, `[TOPIC_NAME]` with the name of your topic, and `[DEAD_LETTER_TOPIC_NAME]` with the name of your dead letter topic.

        4. Verify that the subscription was created with the dead letter topic by running the following command:

        ```
        gcloud pubsub subscriptions describe [SUBSCRIPTION_NAME]
        ```

        This should display information about your subscription, including the dead letter topic.

        Your PubSub subscription should now have a dead letter queue topic set for failed messages.
      </Accordion>

      <Accordion title="Using Python">
        To remediate the misconfiguration "PubSub Subscriptions Should Have Dead Letter Queue Topic Set For Failed Messages" in GCP using python, you can follow the below steps:

        1. First, you need to create a Dead Letter Queue (DLQ) topic in GCP Pub/Sub. To do this, use the following code:

        ```python theme={null}
        from google.cloud import pubsub_v1

        project_id = "your-project-id"
        topic_name = "your-dlq-topic-name"

        publisher = pubsub_v1.PublisherClient()
        topic_path = publisher.topic_path(project_id, topic_name)

        topic = publisher.create_topic(request={"name": topic_path})
        print("Created topic: {}".format(topic.name))
        ```

        2. Once the DLQ topic is created, you need to update the subscription to use this DLQ topic for failed messages. To do this, use the following code:

        ```python theme={null}
        subscription_name = "your-subscription-name"
        subscription_path = publisher.subscription_path(project_id, subscription_name)

        update_mask = {"paths": ["dead_letter_policy.dead_letter_topic"]}

        dead_letter_policy = {
            "dead_letter_topic": topic_path,
            "max_delivery_attempts": 5
        }

        subscription = publisher.update_subscription(
            request={
                "subscription": subscription_path,
                "update_mask": update_mask,
                "dead_letter_policy": dead_letter_policy
            }
        )

        print("Updated subscription: {}".format(subscription.name))
        ```

        3. Finally, you can verify that the DLQ topic is set for the subscription using the following code:

        ```python theme={null}
        subscription = publisher.get_subscription(request={"subscription": subscription_path})
        print("Subscription: {}".format(subscription.name))
        print("DLQ topic: {}".format(subscription.dead_letter_policy.dead_letter_topic))
        ```

        These steps will remediate the misconfiguration "PubSub Subscriptions Should Have Dead Letter Queue Topic Set For Failed Messages" in GCP using python.
      </Accordion>
    </AccordionGroup>
  </Tab>
</Tabs>

### Additional Reading:

* [https://cloud.google.com/pubsub/docs/handling-failures](https://cloud.google.com/pubsub/docs/handling-failures)