Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. sqs
  5. QueuePolicy
AWS v6.72.0 published on Tuesday, Mar 11, 2025 by Pulumi
pulumi/pulumi-aws

aws.sqs.QueuePolicy

Explore with Pulumi AI

aws logo
AWS v6.72.0 published on Tuesday, Mar 11, 2025 by Pulumi
pulumi/pulumi-aws

    Allows you to set a policy of an SQS Queue while referencing the ARN of the queue within the policy.

    !> AWS will hang indefinitely when creating or updating an aws.sqs.Queue with an associated policy if Version = "2012-10-17" is not explicitly set in the policy. See below for an example of how to avoid this issue.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const q = new aws.sqs.Queue("q", {name: "examplequeue"});
const test = q.arn.apply(arn => aws.iam.getPolicyDocumentOutput({
    statements: [{
        sid: "First",
        effect: "Allow",
        principals: [{
            type: "*",
            identifiers: ["*"],
        }],
        actions: ["sqs:SendMessage"],
        resources: [arn],
        conditions: [{
            test: "ArnEquals",
            variable: "aws:SourceArn",
            values: [example.arn],
        }],
    }],
}));
const testQueuePolicy = new aws.sqs.QueuePolicy("test", {
    queueUrl: q.id,
    policy: test.apply(test => test.json),
});

    import pulumi
import pulumi_aws as aws

q = aws.sqs.Queue("q", name="examplequeue")
test = q.arn.apply(lambda arn: aws.iam.get_policy_document_output(statements=[{
    "sid": "First",
    "effect": "Allow",
    "principals": [{
        "type": "*",
        "identifiers": ["*"],
    }],
    "actions": ["sqs:SendMessage"],
    "resources": [arn],
    "conditions": [{
        "test": "ArnEquals",
        "variable": "aws:SourceArn",
        "values": [example["arn"]],
    }],
}]))
test_queue_policy = aws.sqs.QueuePolicy("test",
    queue_url=q.id,
    policy=test.json)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sqs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
q, err := sqs.NewQueue(ctx, "q", &sqs.QueueArgs{
Name: pulumi.String("examplequeue"),
})
if err != nil {
return err
}
test := q.Arn.ApplyT(func(arn string) (iam.GetPolicyDocumentResult, error) {
return iam.GetPolicyDocumentResult(interface{}(iam.GetPolicyDocumentOutput(ctx, iam.GetPolicyDocumentOutputArgs{
Statements: []iam.GetPolicyDocumentStatement{
{
Sid: "First",
Effect: "Allow",
Principals: []iam.GetPolicyDocumentStatementPrincipal{
{
Type: "*",
Identifiers: []string{
"*",
},
},
},
Actions: []string{
"sqs:SendMessage",
},
Resources: []string{
arn,
},
Conditions: []iam.GetPolicyDocumentStatementCondition{
{
Test: "ArnEquals",
Variable: "aws:SourceArn",
Values: interface{}{
example.Arn,
},
},
},
},
},
}, nil))), nil
}).(iam.GetPolicyDocumentResultOutput)
_, err = sqs.NewQueuePolicy(ctx, "test", &sqs.QueuePolicyArgs{
QueueUrl: q.ID(),
Policy: pulumi.String(test.ApplyT(func(test iam.GetPolicyDocumentResult) (*string, error) {
return &test.Json, nil
}).(pulumi.StringPtrOutput)),
})
if err != nil {
return err
}
return nil
})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var q = new Aws.Sqs.Queue("q", new()
    {
        Name = "examplequeue",
    });

    var test = Aws.Iam.GetPolicyDocument.Invoke(new()
    {
        Statements = new[]
        {
            new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
            {
                Sid = "First",
                Effect = "Allow",
                Principals = new[]
                {
                    new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
                    {
                        Type = "*",
                        Identifiers = new[]
                        {
                            "*",
                        },
                    },
                },
                Actions = new[]
                {
                    "sqs:SendMessage",
                },
                Resources = new[]
                {
                    q.Arn,
                },
                Conditions = new[]
                {
                    new Aws.Iam.Inputs.GetPolicyDocumentStatementConditionInputArgs
                    {
                        Test = "ArnEquals",
                        Variable = "aws:SourceArn",
                        Values = new[]
                        {
                            example.Arn,
                        },
                    },
                },
            },
        },
    });

    var testQueuePolicy = new Aws.Sqs.QueuePolicy("test", new()
    {
        QueueUrl = q.Id,
        Policy = test.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
    });

});

    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.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
import com.pulumi.aws.sqs.QueuePolicy;
import com.pulumi.aws.sqs.QueuePolicyArgs;
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 q = new Queue("q", QueueArgs.builder()
            .name("examplequeue")
            .build());

        final var test = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
            .statements(GetPolicyDocumentStatementArgs.builder()
                .sid("First")
                .effect("Allow")
                .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                    .type("*")
                    .identifiers("*")
                    .build())
                .actions("sqs:SendMessage")
                .resources(q.arn())
                .conditions(GetPolicyDocumentStatementConditionArgs.builder()
                    .test("ArnEquals")
                    .variable("aws:SourceArn")
                    .values(example.arn())
                    .build())
                .build())
            .build());

        var testQueuePolicy = new QueuePolicy("testQueuePolicy", QueuePolicyArgs.builder()
            .queueUrl(q.id())
            .policy(test.applyValue(getPolicyDocumentResult -> getPolicyDocumentResult).applyValue(test -> test.applyValue(getPolicyDocumentResult -> getPolicyDocumentResult.json())))
            .build());

    }
}

    resources:
  q:
    type: aws:sqs:Queue
    properties:
      name: examplequeue
  testQueuePolicy:
    type: aws:sqs:QueuePolicy
    name: test
    properties:
      queueUrl: ${q.id}
      policy: ${test.json}
variables:
  test:
    fn::invoke:
      function: aws:iam:getPolicyDocument
      arguments:
        statements:
          - sid: First
            effect: Allow
            principals:
              - type: '*'
                identifiers:
                  - '*'
            actions:
              - sqs:SendMessage
            resources:
              - ${q.arn}
            conditions:
              - test: ArnEquals
                variable: aws:SourceArn
                values:
                  - ${example.arn}

    Timeout Problems Creating/Updating

    If Version = "2012-10-17" is not explicitly set in the policy, AWS may hang, causing the AWS provider to time out. To avoid this, make sure to include Version as shown in the example below.

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.s3.BucketV2("example", {bucket: "brodobaggins"});
const exampleQueue = new aws.sqs.Queue("example", {name: "be-giant"});
const exampleQueuePolicy = new aws.sqs.QueuePolicy("example", {
    queueUrl: exampleQueue.id,
    policy: pulumi.jsonStringify({
        Version: "2012-10-17",
        Statement: [{
            Sid: "Cejuwdam",
            Effect: "Allow",
            Principal: {
                Service: "s3.amazonaws.com",
            },
            Action: "SQS:SendMessage",
            Resource: exampleQueue.arn,
            Condition: {
                ArnLike: {
                    "aws:SourceArn": example.arn,
                },
            },
        }],
    }),
});

    import pulumi
import json
import pulumi_aws as aws

example = aws.s3.BucketV2("example", bucket="brodobaggins")
example_queue = aws.sqs.Queue("example", name="be-giant")
example_queue_policy = aws.sqs.QueuePolicy("example",
    queue_url=example_queue.id,
    policy=pulumi.Output.json_dumps({
        "Version": "2012-10-17",
        "Statement": [{
            "Sid": "Cejuwdam",
            "Effect": "Allow",
            "Principal": {
                "Service": "s3.amazonaws.com",
            },
            "Action": "SQS:SendMessage",
            "Resource": example_queue.arn,
            "Condition": {
                "ArnLike": {
                    "aws:SourceArn": example.arn,
                },
            },
        }],
    }))

    package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/s3"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sqs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := s3.NewBucketV2(ctx, "example", &s3.BucketV2Args{
			Bucket: pulumi.String("brodobaggins"),
		})
		if err != nil {
			return err
		}
		exampleQueue, err := sqs.NewQueue(ctx, "example", &sqs.QueueArgs{
			Name: pulumi.String("be-giant"),
		})
		if err != nil {
			return err
		}
		_, err = sqs.NewQueuePolicy(ctx, "example", &sqs.QueuePolicyArgs{
			QueueUrl: exampleQueue.ID(),
			Policy: pulumi.All(exampleQueue.Arn, example.Arn).ApplyT(func(_args []interface{}) (string, error) {
				exampleQueueArn := _args[0].(string)
				exampleArn := _args[1].(string)
				var _zero string
				tmpJSON0, err := json.Marshal(map[string]interface{}{
					"Version": "2012-10-17",
					"Statement": []map[string]interface{}{
						map[string]interface{}{
							"Sid":    "Cejuwdam",
							"Effect": "Allow",
							"Principal": map[string]interface{}{
								"Service": "s3.amazonaws.com",
							},
							"Action":   "SQS:SendMessage",
							"Resource": exampleQueueArn,
							"Condition": map[string]interface{}{
								"ArnLike": map[string]interface{}{
									"aws:SourceArn": exampleArn,
								},
							},
						},
					},
				})
				if err != nil {
					return _zero, err
				}
				json0 := string(tmpJSON0)
				return json0, nil
			}).(pulumi.StringOutput),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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.S3.BucketV2("example", new()
    {
        Bucket = "brodobaggins",
    });

    var exampleQueue = new Aws.Sqs.Queue("example", new()
    {
        Name = "be-giant",
    });

    var exampleQueuePolicy = new Aws.Sqs.QueuePolicy("example", new()
    {
        QueueUrl = exampleQueue.Id,
        Policy = Output.JsonSerialize(Output.Create(new Dictionary<string, object?>
        {
            ["Version"] = "2012-10-17",
            ["Statement"] = new[]
            {
                new Dictionary<string, object?>
                {
                    ["Sid"] = "Cejuwdam",
                    ["Effect"] = "Allow",
                    ["Principal"] = new Dictionary<string, object?>
                    {
                        ["Service"] = "s3.amazonaws.com",
                    },
                    ["Action"] = "SQS:SendMessage",
                    ["Resource"] = exampleQueue.Arn,
                    ["Condition"] = new Dictionary<string, object?>
                    {
                        ["ArnLike"] = new Dictionary<string, object?>
                        {
                            ["aws:SourceArn"] = example.Arn,
                        },
                    },
                },
            },
        })),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.BucketV2;
import com.pulumi.aws.s3.BucketV2Args;
import com.pulumi.aws.sqs.Queue;
import com.pulumi.aws.sqs.QueueArgs;
import com.pulumi.aws.sqs.QueuePolicy;
import com.pulumi.aws.sqs.QueuePolicyArgs;
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 example = new BucketV2("example", BucketV2Args.builder()
            .bucket("brodobaggins")
            .build());

        var exampleQueue = new Queue("exampleQueue", QueueArgs.builder()
            .name("be-giant")
            .build());

        var exampleQueuePolicy = new QueuePolicy("exampleQueuePolicy", QueuePolicyArgs.builder()
            .queueUrl(exampleQueue.id())
            .policy(Output.tuple(exampleQueue.arn(), example.arn()).applyValue(values -> {
                var exampleQueueArn = values.t1;
                var exampleArn = values.t2;
                return serializeJson(
                    jsonObject(
                        jsonProperty("Version", "2012-10-17"),
                        jsonProperty("Statement", jsonArray(jsonObject(
                            jsonProperty("Sid", "Cejuwdam"),
                            jsonProperty("Effect", "Allow"),
                            jsonProperty("Principal", jsonObject(
                                jsonProperty("Service", "s3.amazonaws.com")
                            )),
                            jsonProperty("Action", "SQS:SendMessage"),
                            jsonProperty("Resource", exampleQueueArn),
                            jsonProperty("Condition", jsonObject(
                                jsonProperty("ArnLike", jsonObject(
                                    jsonProperty("aws:SourceArn", exampleArn)
                                ))
                            ))
                        )))
                    ));
            }))
            .build());

    }
}

    resources:
  example:
    type: aws:s3:BucketV2
    properties:
      bucket: brodobaggins
  exampleQueue:
    type: aws:sqs:Queue
    name: example
    properties:
      name: be-giant
  exampleQueuePolicy:
    type: aws:sqs:QueuePolicy
    name: example
    properties:
      queueUrl: ${exampleQueue.id}
      policy:
        fn::toJSON:
          Version: 2012-10-17
          Statement:
            - Sid: Cejuwdam
              Effect: Allow
              Principal:
                Service: s3.amazonaws.com
              Action: SQS:SendMessage
              Resource: ${exampleQueue.arn}
              Condition:
                ArnLike:
                  aws:SourceArn: ${example.arn}

    Create QueuePolicy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new QueuePolicy(name: string, args: QueuePolicyArgs, opts?: CustomResourceOptions);
    @overload
def QueuePolicy(resource_name: str,
                args: QueuePolicyArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def QueuePolicy(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                policy: Optional[str] = None,
                queue_url: Optional[str] = None)
    func NewQueuePolicy(ctx *Context, name string, args QueuePolicyArgs, opts ...ResourceOption) (*QueuePolicy, error)
    public QueuePolicy(string name, QueuePolicyArgs args, CustomResourceOptions? opts = null)
    public QueuePolicy(String name, QueuePolicyArgs args)
public QueuePolicy(String name, QueuePolicyArgs args, CustomResourceOptions options)

    type: aws:sqs:QueuePolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args QueuePolicyArgs
    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 QueuePolicyArgs
    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 QueuePolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args QueuePolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args QueuePolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var queuePolicyResource = new Aws.Sqs.QueuePolicy("queuePolicyResource", new()
{
    Policy = "string",
    QueueUrl = "string",
});

    example, err := sqs.NewQueuePolicy(ctx, "queuePolicyResource", &sqs.QueuePolicyArgs{
	Policy:   pulumi.Any("string"),
	QueueUrl: pulumi.String("string"),
})

    var queuePolicyResource = new QueuePolicy("queuePolicyResource", QueuePolicyArgs.builder()
    .policy("string")
    .queueUrl("string")
    .build());

    queue_policy_resource = aws.sqs.QueuePolicy("queuePolicyResource",
    policy="string",
    queue_url="string")

    const queuePolicyResource = new aws.sqs.QueuePolicy("queuePolicyResource", {
    policy: "string",
    queueUrl: "string",
});

    type: aws:sqs:QueuePolicy
properties:
    policy: string
    queueUrl: string

    QueuePolicy Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The QueuePolicy resource accepts the following input properties:

    Policy string | string
    QueueUrl string
    URL of the SQS Queue to which to attach the policy.
    Policy string | string
    QueueUrl string
    URL of the SQS Queue to which to attach the policy.
    policy String | String
    queueUrl String
    URL of the SQS Queue to which to attach the policy.
    policy string | PolicyDocument
    queueUrl string
    URL of the SQS Queue to which to attach the policy.
    policy str | str
    queue_url str
    URL of the SQS Queue to which to attach the policy.
    policy String |
    queueUrl String
    URL of the SQS Queue to which to attach the policy.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the QueuePolicy 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 QueuePolicy Resource

    Get an existing QueuePolicy 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?: QueuePolicyState, opts?: CustomResourceOptions): QueuePolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        policy: Optional[str] = None,
        queue_url: Optional[str] = None) -> QueuePolicy
    func GetQueuePolicy(ctx *Context, name string, id IDInput, state *QueuePolicyState, opts ...ResourceOption) (*QueuePolicy, error)
    public static QueuePolicy Get(string name, Input<string> id, QueuePolicyState? state, CustomResourceOptions? opts = null)
    public static QueuePolicy get(String name, Output<String> id, QueuePolicyState state, CustomResourceOptions options)
    resources:  _:    type: aws:sqs:QueuePolicy    get:      id: ${id}
    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:
    Policy string | string
    QueueUrl string
    URL of the SQS Queue to which to attach the policy.
    Policy string | string
    QueueUrl string
    URL of the SQS Queue to which to attach the policy.
    policy String | String
    queueUrl String
    URL of the SQS Queue to which to attach the policy.
    policy string | PolicyDocument
    queueUrl string
    URL of the SQS Queue to which to attach the policy.
    policy str | str
    queue_url str
    URL of the SQS Queue to which to attach the policy.
    policy String |
    queueUrl String
    URL of the SQS Queue to which to attach the policy.

    Import

    Using pulumi import, import SQS Queue Policies using the queue URL. For example:

    $ pulumi import aws:sqs/queuePolicy:QueuePolicy test https://queue.amazonaws.com/123456789012/myqueue

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.72.0 published on Tuesday, Mar 11, 2025 by Pulumi
    pulumi/pulumi-aws