Class QueuePolicy

The policy for an SQS Queue.

Inheritance
System.Object
Resource
QueuePolicy
Implements
Constructs.IConstruct
Constructs.IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.SQS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class QueuePolicy : Resource, IResource
Syntax (vb)
Public Class QueuePolicy
    Inherits Resource
    Implements IResource
Remarks

Policies define the operations that are allowed on this resource.

You almost never need to define this construct directly.

All AWS resources that support resource policies have a method called addToResourcePolicy(), which will automatically create a new resource policy if one doesn't exist yet, otherwise it will add to the existing policy.

Prefer to use addToResourcePolicy() instead.

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SQS;

Queue queue;

var queuePolicy = new QueuePolicy(this, "MyQueuePolicy", new QueuePolicyProps {
    Queues = new [] { queue }
});

Synopsis

Constructors

QueuePolicy(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
QueuePolicy(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
QueuePolicy(Construct, String, IQueuePolicyProps)

Properties

Document

The IAM policy document for this policy.
QueuePolicyId

Not currently supported by AWS CloudFormation.

Constructors

QueuePolicy(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected QueuePolicy(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

QueuePolicy(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected QueuePolicy(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

QueuePolicy(Construct, String, IQueuePolicyProps)

public QueuePolicy(Construct scope, string id, IQueuePolicyProps props)
Parameters
scope Constructs.Construct
id System.String
props IQueuePolicyProps

Properties

Document

The IAM policy document for this policy.

public virtual PolicyDocument Document { get; }
Property Value

PolicyDocument

QueuePolicyId

Not currently supported by AWS CloudFormation.

public virtual string QueuePolicyId { get; }
Property Value

System.String

Remarks

This attribute temporarily existed in CloudFormation, and then was removed again.

Attribute: true

Implements

Constructs.IConstruct
Constructs.IDependable