aws logo
AWS Classic v5.32.0, Mar 17 23

aws.sqs.RedriveAllowPolicy

Provides a SQS Queue Redrive Allow Policy resource.

Example Usage

using System.Collections.Generic;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var exampleQueue = new Aws.Sqs.Queue("exampleQueue");

    var src = new Aws.Sqs.Queue("src", new()
    {
        RedrivePolicy = exampleQueue.Arn.Apply(arn => JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["deadLetterTargetArn"] = arn,
            ["maxReceiveCount"] = 4,
        })),
    });

    var exampleRedriveAllowPolicy = new Aws.Sqs.RedriveAllowPolicy("exampleRedriveAllowPolicy", new()
    {
        QueueUrl = exampleQueue.Id,
        RedriveAllowPolicyName = src.Arn.Apply(arn => JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["redrivePermission"] = "byQueue",
            ["sourceQueueArns"] = new[]
            {
                arn,
            },
        })),
    });

});
package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/sqs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleQueue, err := sqs.NewQueue(ctx, "exampleQueue", nil)
		if err != nil {
			return err
		}
		src, err := sqs.NewQueue(ctx, "src", &sqs.QueueArgs{
			RedrivePolicy: exampleQueue.Arn.ApplyT(func(arn string) (pulumi.String, error) {
				var _zero pulumi.String
				tmpJSON0, err := json.Marshal(map[string]interface{}{
					"deadLetterTargetArn": arn,
					"maxReceiveCount":     4,
				})
				if err != nil {
					return _zero, err
				}
				json0 := string(tmpJSON0)
				return pulumi.String(json0), nil
			}).(pulumi.StringOutput),
		})
		if err != nil {
			return err
		}
		_, err = sqs.NewRedriveAllowPolicy(ctx, "exampleRedriveAllowPolicy", &sqs.RedriveAllowPolicyArgs{
			QueueUrl: exampleQueue.ID(),
			RedriveAllowPolicy: src.Arn.ApplyT(func(arn string) (pulumi.String, error) {
				var _zero pulumi.String
				tmpJSON1, err := json.Marshal(map[string]interface{}{
					"redrivePermission": "byQueue",
					"sourceQueueArns": []string{
						arn,
					},
				})
				if err != nil {
					return _zero, err
				}
				json1 := string(tmpJSON1)
				return pulumi.String(json1), nil
			}).(pulumi.StringOutput),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sqs.Queue;
import com.pulumi.aws.sqs.QueueArgs;
import com.pulumi.aws.sqs.RedriveAllowPolicy;
import com.pulumi.aws.sqs.RedriveAllowPolicyArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleQueue = new Queue("exampleQueue");

        var src = new Queue("src", QueueArgs.builder()        
            .redrivePolicy(exampleQueue.arn().applyValue(arn -> serializeJson(
                jsonObject(
                    jsonProperty("deadLetterTargetArn", arn),
                    jsonProperty("maxReceiveCount", 4)
                ))))
            .build());

        var exampleRedriveAllowPolicy = new RedriveAllowPolicy("exampleRedriveAllowPolicy", RedriveAllowPolicyArgs.builder()        
            .queueUrl(exampleQueue.id())
            .redriveAllowPolicy(src.arn().applyValue(arn -> serializeJson(
                jsonObject(
                    jsonProperty("redrivePermission", "byQueue"),
                    jsonProperty("sourceQueueArns", jsonArray(arn))
                ))))
            .build());

    }
}
import pulumi
import json
import pulumi_aws as aws

example_queue = aws.sqs.Queue("exampleQueue")
src = aws.sqs.Queue("src", redrive_policy=example_queue.arn.apply(lambda arn: json.dumps({
    "deadLetterTargetArn": arn,
    "maxReceiveCount": 4,
})))
example_redrive_allow_policy = aws.sqs.RedriveAllowPolicy("exampleRedriveAllowPolicy",
    queue_url=example_queue.id,
    redrive_allow_policy=src.arn.apply(lambda arn: json.dumps({
        "redrivePermission": "byQueue",
        "sourceQueueArns": [arn],
    })))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleQueue = new aws.sqs.Queue("exampleQueue", {});
const src = new aws.sqs.Queue("src", {redrivePolicy: exampleQueue.arn.apply(arn => JSON.stringify({
    deadLetterTargetArn: arn,
    maxReceiveCount: 4,
}))});
const exampleRedriveAllowPolicy = new aws.sqs.RedriveAllowPolicy("exampleRedriveAllowPolicy", {
    queueUrl: exampleQueue.id,
    redriveAllowPolicy: src.arn.apply(arn => JSON.stringify({
        redrivePermission: "byQueue",
        sourceQueueArns: [arn],
    })),
});
resources:
  src:
    type: aws:sqs:Queue
    properties:
      redrivePolicy:
        fn::toJSON:
          deadLetterTargetArn: ${exampleQueue.arn}
          maxReceiveCount: 4
  exampleQueue:
    type: aws:sqs:Queue
  exampleRedriveAllowPolicy:
    type: aws:sqs:RedriveAllowPolicy
    properties:
      queueUrl: ${exampleQueue.id}
      redriveAllowPolicy:
        fn::toJSON:
          redrivePermission: byQueue
          sourceQueueArns:
            - ${src.arn}

Create RedriveAllowPolicy Resource

new RedriveAllowPolicy(name: string, args: RedriveAllowPolicyArgs, opts?: CustomResourceOptions);
@overload
def RedriveAllowPolicy(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       queue_url: Optional[str] = None,
                       redrive_allow_policy: Optional[str] = None)
@overload
def RedriveAllowPolicy(resource_name: str,
                       args: RedriveAllowPolicyArgs,
                       opts: Optional[ResourceOptions] = None)
func NewRedriveAllowPolicy(ctx *Context, name string, args RedriveAllowPolicyArgs, opts ...ResourceOption) (*RedriveAllowPolicy, error)
public RedriveAllowPolicy(string name, RedriveAllowPolicyArgs args, CustomResourceOptions? opts = null)
public RedriveAllowPolicy(String name, RedriveAllowPolicyArgs args)
public RedriveAllowPolicy(String name, RedriveAllowPolicyArgs args, CustomResourceOptions options)
type: aws:sqs:RedriveAllowPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args RedriveAllowPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args RedriveAllowPolicyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args RedriveAllowPolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args RedriveAllowPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args RedriveAllowPolicyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

RedriveAllowPolicy Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The RedriveAllowPolicy resource accepts the following input properties:

QueueUrl string

The URL of the SQS Queue to which to attach the policy

RedriveAllowPolicyName string

The JSON redrive allow policy for the SQS queue. Learn more in the Amazon SQS dead-letter queues documentation.

QueueUrl string

The URL of the SQS Queue to which to attach the policy

RedriveAllowPolicy string

The JSON redrive allow policy for the SQS queue. Learn more in the Amazon SQS dead-letter queues documentation.

queueUrl String

The URL of the SQS Queue to which to attach the policy

redriveAllowPolicy String

The JSON redrive allow policy for the SQS queue. Learn more in the Amazon SQS dead-letter queues documentation.

queueUrl string

The URL of the SQS Queue to which to attach the policy

redriveAllowPolicy string

The JSON redrive allow policy for the SQS queue. Learn more in the Amazon SQS dead-letter queues documentation.

queue_url str

The URL of the SQS Queue to which to attach the policy

redrive_allow_policy str

The JSON redrive allow policy for the SQS queue. Learn more in the Amazon SQS dead-letter queues documentation.

queueUrl String

The URL of the SQS Queue to which to attach the policy

redriveAllowPolicy String

The JSON redrive allow policy for the SQS queue. Learn more in the Amazon SQS dead-letter queues documentation.

Outputs

All input properties are implicitly available as output properties. Additionally, the RedriveAllowPolicy resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing RedriveAllowPolicy Resource

Get an existing RedriveAllowPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: RedriveAllowPolicyState, opts?: CustomResourceOptions): RedriveAllowPolicy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        queue_url: Optional[str] = None,
        redrive_allow_policy: Optional[str] = None) -> RedriveAllowPolicy
func GetRedriveAllowPolicy(ctx *Context, name string, id IDInput, state *RedriveAllowPolicyState, opts ...ResourceOption) (*RedriveAllowPolicy, error)
public static RedriveAllowPolicy Get(string name, Input<string> id, RedriveAllowPolicyState? state, CustomResourceOptions? opts = null)
public static RedriveAllowPolicy get(String name, Output<String> id, RedriveAllowPolicyState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
QueueUrl string

The URL of the SQS Queue to which to attach the policy

RedriveAllowPolicyName string

The JSON redrive allow policy for the SQS queue. Learn more in the Amazon SQS dead-letter queues documentation.

QueueUrl string

The URL of the SQS Queue to which to attach the policy

RedriveAllowPolicy string

The JSON redrive allow policy for the SQS queue. Learn more in the Amazon SQS dead-letter queues documentation.

queueUrl String

The URL of the SQS Queue to which to attach the policy

redriveAllowPolicy String

The JSON redrive allow policy for the SQS queue. Learn more in the Amazon SQS dead-letter queues documentation.

queueUrl string

The URL of the SQS Queue to which to attach the policy

redriveAllowPolicy string

The JSON redrive allow policy for the SQS queue. Learn more in the Amazon SQS dead-letter queues documentation.

queue_url str

The URL of the SQS Queue to which to attach the policy

redrive_allow_policy str

The JSON redrive allow policy for the SQS queue. Learn more in the Amazon SQS dead-letter queues documentation.

queueUrl String

The URL of the SQS Queue to which to attach the policy

redriveAllowPolicy String

The JSON redrive allow policy for the SQS queue. Learn more in the Amazon SQS dead-letter queues documentation.

Import

SQS Queue Redrive Allow Policies can be imported using the queue URL, e.g.,

 $ pulumi import aws:sqs/redriveAllowPolicy:RedriveAllowPolicy test https://queue.amazonaws.com/0123456789012/myqueue

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.