RedriveAllowPolicy class
Provides a SQS Queue Redrive Allow Policy resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.sqs.Queue("example", {name: "examplequeue"});
const src = new aws.sqs.Queue("src", {
name: "srcqueue",
redrivePolicy: pulumi.jsonStringify({
deadLetterTargetArn: example.arn,
maxReceiveCount: 4,
}),
});
const exampleRedriveAllowPolicy = new aws.sqs.RedriveAllowPolicy("example", {
queueUrl: example.id,
redriveAllowPolicy: pulumi.jsonStringify({
redrivePermission: "byQueue",
sourceQueueArns: [src.arn],
}),
});
import pulumi
import json
import pulumi_aws as aws
example = aws.sqs.Queue("example", name="examplequeue")
src = aws.sqs.Queue("src",
name="srcqueue",
redrive_policy=pulumi.Output.json_dumps({
"deadLetterTargetArn": example.arn,
"maxReceiveCount": 4,
}))
example_redrive_allow_policy = aws.sqs.RedriveAllowPolicy("example",
queue_url=example.id,
redrive_allow_policy=pulumi.Output.json_dumps({
"redrivePermission": "byQueue",
"sourceQueueArns": [src.arn],
}))
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Sqs.Queue("example", new()
{
Name = "examplequeue",
});
var src = new Aws.Sqs.Queue("src", new()
{
Name = "srcqueue",
RedrivePolicy = Output.JsonSerialize(Output.Create(new Dictionary<string, object?>
{
["deadLetterTargetArn"] = example.Arn,
["maxReceiveCount"] = 4,
})),
});
var exampleRedriveAllowPolicy = new Aws.Sqs.RedriveAllowPolicy("example", new()
{
QueueUrl = example.Id,
RedriveAllowPolicyName = Output.JsonSerialize(Output.Create(new Dictionary<string, object?>
{
["redrivePermission"] = "byQueue",
["sourceQueueArns"] = new[]
{
src.Arn,
},
})),
});
});
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/sqs"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := sqs.NewQueue(ctx, "example", &sqs.QueueArgs{
Name: pulumi.String("examplequeue"),
})
if err != nil {
return err
}
src, err := sqs.NewQueue(ctx, "src", &sqs.QueueArgs{
Name: pulumi.String("srcqueue"),
RedrivePolicy: example.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, "example", &sqs.RedriveAllowPolicyArgs{
QueueUrl: example.ID().ToIDOutput().ToStringOutput(),
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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_sqs_queue" "src" {
name = "srcqueue"
redrive_policy = jsonencode({
"deadLetterTargetArn" = aws_sqs_queue.example.arn
"maxReceiveCount" = 4
})
}
resource "aws_sqs_queue" "example" {
name = "examplequeue"
}
resource "aws_sqs_redriveallowpolicy" "example" {
queue_url = aws_sqs_queue.example.id
redrive_allow_policy = jsonencode({
"redrivePermission" = "byQueue"
"sourceQueueArns" = [aws_sqs_queue.src.arn]
})
}
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.ArrayList;
import java.util.Arrays;
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 example = new Queue("example", QueueArgs.builder()
.name("examplequeue")
.build());
var src = new Queue("src", QueueArgs.builder()
.name("srcqueue")
.redrivePolicy(example.arn().applyValue(_arn -> serializeJson(
jsonObject(
jsonProperty("deadLetterTargetArn", _arn),
jsonProperty("maxReceiveCount", 4)
))))
.build());
var exampleRedriveAllowPolicy = new RedriveAllowPolicy("exampleRedriveAllowPolicy", RedriveAllowPolicyArgs.builder()
.queueUrl(example.id())
.redriveAllowPolicy(src.arn().applyValue(_arn -> serializeJson(
jsonObject(
jsonProperty("redrivePermission", "byQueue"),
jsonProperty("sourceQueueArns", jsonArray(_arn))
))))
.build());
}
}
resources:
src:
type: aws:sqs:Queue
properties:
name: srcqueue
redrivePolicy:
fn::toJSON:
deadLetterTargetArn: ${example.arn}
maxReceiveCount: 4
example:
type: aws:sqs:Queue
properties:
name: examplequeue
exampleRedriveAllowPolicy:
type: aws:sqs:RedriveAllowPolicy
name: example
properties:
queueUrl: ${example.id}
redriveAllowPolicy:
fn::toJSON:
redrivePermission: byQueue
sourceQueueArns:
- ${src.arn}
Import
Identity Schema
Required
queueUrl(String) URL of the SQS Queue.
Using pulumi import, import SQS Queue Redrive Allow Policies using the queue URL. For example:
$ pulumi import aws:sqs/redriveAllowPolicy:RedriveAllowPolicy test https://queue.amazonaws.com/123456789012/myqueue
Constructors
- RedriveAllowPolicy(String name, {RedriveAllowPolicyArgs? args, CustomResourceOptions? options})
-
Creates a new RedriveAllowPolicy.
nameThe Pulumi resource name.argsArguments used to configure this RedriveAllowPolicy. The set of arguments for RedriveAllowPolicy.optionsResource options controlling this resource's behavior. - RedriveAllowPolicy.reference(String urn)
- Creates a typed reference to an existing RedriveAllowPolicy resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
queueUrl
↔ Output<
String> -
The URL of the SQS Queue to which to attach the policy
latefinal
-
redriveAllowPolicy
↔ Output<
String> -
The JSON redrive allow policy for the SQS queue. Learn more in the Amazon SQS dead-letter queues documentation.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {RedriveAllowPolicyState? state, CustomResourceOptions? options}) → RedriveAllowPolicy -
Gets an existing RedriveAllowPolicy resource's state with the given
nameandid.