UNPKG

1.28 kBTypeScriptView Raw
1import { PolicyDocument } from '@aws-cdk/aws-iam';
2import { Resource } from '@aws-cdk/core';
3import { Construct } from 'constructs';
4import { IQueue } from './queue-base';
5/**
6 * Properties to associate SQS queues with a policy
7 */
8export interface QueuePolicyProps {
9 /**
10 * The set of queues this policy applies to.
11 */
12 readonly queues: IQueue[];
13}
14/**
15 * The policy for an SQS Queue
16 *
17 * Policies define the operations that are allowed on this resource.
18 *
19 * You almost never need to define this construct directly.
20 *
21 * All AWS resources that support resource policies have a method called
22 * `addToResourcePolicy()`, which will automatically create a new resource
23 * policy if one doesn't exist yet, otherwise it will add to the existing
24 * policy.
25 *
26 * Prefer to use `addToResourcePolicy()` instead.
27 */
28export declare class QueuePolicy extends Resource {
29 /**
30 * The IAM policy document for this policy.
31 */
32 readonly document: PolicyDocument;
33 constructor(scope: Construct, id: string, props: QueuePolicyProps);
34 /**
35 * Not currently supported by AWS CloudFormation.
36 *
37 * This attribute temporarily existed in CloudFormation, and then was removed again.
38 *
39 * @attribute
40 */
41 get queuePolicyId(): string;
42}