AWS::SQS::QueueInlinePolicy - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::SQS::QueueInlinePolicy

The AWS::SQS::QueueInlinePolicy resource associates one Amazon SQS queue with one policy.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SQS::QueueInlinePolicy",
  "Properties" : {
      "PolicyDocument" : Json,
      "Queue" : String
    }
}

YAML

Type: AWS::SQS::QueueInlinePolicy
Properties:
  PolicyDocument: Json
  Queue: String

Properties

PolicyDocument

A policy document that contains the permissions for the specified Amazon SQS queues. For more information about Amazon SQS policies, see Using custom policies with the Amazon SQS access policy language in the Amazon SQS Developer Guide.

Required: Yes

Type: Json

Update requires: No interruption

Queue

The URLs of the queues to which you want to add the policy. You can use the Ref function to specify an AWS::SQS::Queue resource.

Required: Yes

Type: String

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the topic for which the policy was added.

For more information about using the Ref function, see Ref.